Package com.attivio.sdk.search.facet

Class FacetFilter

    • Constructor Summary

      Constructors 
      Constructor Description
      FacetFilter()  
      FacetFilter​(java.lang.String name, java.lang.String label, Query filter)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      FacetFilter clone()  
      boolean equals​(java.lang.Object other)  
      Query getFilter()
      Get the filter query.
      java.lang.String getLabel()
      Get a descriptive label for this filter.
      java.lang.String getName()
      Get the name of the facet that generated this filter.
      int hashCode()  
      void setFilter​(Query value)
      Get the filter query.
      void setLabel​(java.lang.String value)
      Set a descriptive label for this filter.
      void setName​(java.lang.String value)
      Set the name of the facet that generated this filter.
      java.lang.String toString()  
      static FacetFilter valueOf​(java.lang.Object value)
      Parse a FacetFilter specified in value.
      static FacetFilter valueOf​(java.lang.String value)
      Parse a FacetFilter specified in value.

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • FacetFilter

        public FacetFilter()

      • FacetFilter

        public FacetFilter​(java.lang.String name,
                   java.lang.String label,
                   Query filter)

    • Method Detail

      • getName

        @JsonPropertyDescription("The name of the facet selected for filtering")
public java.lang.String getName()
        Get the name of the facet that generated this filter.

      • setName

        public void setName​(java.lang.String value)
        Set the name of the facet that generated this filter.

      • getLabel

        @JsonPropertyDescription("The label for the bucket selected for filtering")
public java.lang.String getLabel()
        Get a descriptive label for this filter.

        This will typically be the display value of the bucket used for filtering.

      • setLabel

        public void setLabel​(java.lang.String value)
        Set a descriptive label for this filter.

        This will typically be the display value of the bucket used for filtering.

      • getFilter

        @JsonPropertyDescription("The filter for the bucket selected for filtering (in advanced query syntax)")
public Query getFilter()
        Get the filter query.

      • setFilter

        public void setFilter​(Query value)
        Get the filter query.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • clone

        public FacetFilter clone()
        Overrides:
        clone in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • valueOf

        public static FacetFilter valueOf​(java.lang.Object value)
        Parse a FacetFilter specified in value.

      • valueOf

        public static FacetFilter valueOf​(java.lang.String value)
        Parse a FacetFilter specified in value.