Package org.opencms.jsp.search.config

Interface I_CmsSearchConfigurationFacet

All Known Subinterfaces:
I_CmsSearchConfigurationFacetField, I_CmsSearchConfigurationFacetQuery, I_CmsSearchConfigurationFacetRange
All Known Implementing Classes:
CmsSearchConfigurationFacet, CmsSearchConfigurationFacetField, CmsSearchConfigurationFacetQuery, CmsSearchConfigurationFacetRange
public interface I_CmsSearchConfigurationFacet
Configuration common to all facets. Used as base interface for all special facet interfaces.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    I_CmsSearchConfigurationFacet.SortOrder
    Sort orders available for Solr facet entries.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getIgnoreAllFacetFilters()
    Returns true if the filters of all facets are not applied when calculating the facet items.
    String
    getIgnoreMaxParamKey()
    Returns the facet specific request parameter used to send the information if the maximum number of facet entries should be ignored.
    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.
    String
    getLabel()
    Returns the label that is intended to be displayed over the facet's entries.
    Integer
    getMinCount()
    Returns the minimal number of hits necessary to show a facet entry.
    String
    getName()
    Returns the name used to identify the facet.
    String
    getParamKey()
    Returns the facet specific request parameter used to send the checked facet entries.
    List<String>
    getPreSelection()
    A list of facet-entries that should be preselected, if the search form is rendered the first time.
    void
    propagateAllFacetNames(Collection<String> names)
    Propagate the names of the other facets that are configured.

  • Method Details

    • 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

      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

      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

      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

      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

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

    • getParamKey

      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

      List<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(Collection<String> names)
      Propagate the names of the other facets that are configured.
      Parameters:
      names - the names of the other facets