Package org.opencms.jsp.search.config

Interface I_CmsSearchConfigurationFacet

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getIgnoreAllFacetFilters()
      Returns true if the filters of all facets are not applied when calculating the facet items.
      java.lang.String getIgnoreMaxParamKey()
      Returns the facet specific request parameter used to send the information if the maximum number of facet entries should be ignored.
      java.lang.String getIgnoreTags()
      Returns the tags of other facets, for which the filters from this facet should be ignored.
      boolean getIsAndFacet()
      Returns true if the facet filters, such that only documents with all checked facet entries appear, otherwise false.
      java.lang.String getLabel()
      Returns the label that is intended to be displayed over the facet's entries.
      java.lang.Integer getMinCount()
      Returns the minimal number of hits necessary to show a facet entry.
      java.lang.String getName()
      Returns the name used to identify the facet.
      java.lang.String getParamKey()
      Returns the facet specific request parameter used to send the checked facet entries.
      java.util.List<java.lang.String> getPreSelection()
      A list of facet-entries that should be preselected, if the search form is rendered the first time.
      void propagateAllFacetNames​(java.util.Collection<java.lang.String> names)
      Propagate the names of the other facets that are configured.

    • Method Detail

      • getIgnoreAllFacetFilters

        boolean getIgnoreAllFacetFilters()
        Returns true if the filters of all facets are not applied when calculating the facet items. Otherwise returns false.
        Returns:
        A flag, indicating if the filters of facet's should be ignored or not.

      • getIgnoreMaxParamKey

        java.lang.String getIgnoreMaxParamKey()
        Returns the facet specific request parameter used to send the information if the maximum number of facet entries should be ignored.
        Returns:
        The facet specific request parameter used to send the information if the maximum number of facet entries should be ignored.

      • getIgnoreTags

        java.lang.String getIgnoreTags()
        Returns the tags of other facets, for which the filters from this facet should be ignored.
        Returns:
        the tags of other facets, for which the filters from this facet should be ignored.

      • getIsAndFacet

        boolean getIsAndFacet()
        Returns true if the facet filters, such that only documents with all checked facet entries appear, otherwise false.
        Returns:
        A flag, indicating if the facet's filters are concatenated by AND (or OR).

      • getLabel

        java.lang.String getLabel()
        Returns the label that is intended to be displayed over the facet's entries.
        Returns:
        The label that is intended to be displayed over the facet's entries.

      • getMinCount

        java.lang.Integer getMinCount()
        Returns the minimal number of hits necessary to show a facet entry.
        Returns:
        The minimal number of hits necessary to show a facet entry. (Solr: facet.mincount)

      • getName

        java.lang.String getName()
        Returns the name used to identify the facet.
        Returns:
        The name used to identify the facet.

      • getParamKey

        java.lang.String getParamKey()
        Returns the facet specific request parameter used to send the checked facet entries.
        Returns:
        The facet specific request parameter used to send the checked facet entries.

      • getPreSelection

        java.util.List<java.lang.String> getPreSelection()
        A list of facet-entries that should be preselected, if the search form is rendered the first time.
        Returns:
        The list of facet-entries that should be preselected, if the search form is rendered the first time.

      • propagateAllFacetNames

        void propagateAllFacetNames​(java.util.Collection<java.lang.String> names)
        Propagate the names of the other facets that are configured.
        Parameters:
        names - the names of the other facets