Class CmsSearchConfigurationFacet

    • Field Summary

      Modifier and Type Field Description
      protected java.util.Set<java.lang.String> m_explicitExcludeTags
      Tags of filter-queries that should not be applied to the facet, explicitly configured.
      protected boolean m_ignoreFacetFilters
      A flag, indicating if checked entries from other facets should influence the facet or not.
      protected java.util.Set<java.lang.String> m_ignoreTags
      Tags of filter-queries that should not be applied to the facet.
      protected boolean m_isAndFacet
      A flag, indicating if facet filter queries should be concatenated by AND.
      protected java.lang.String m_label
      A label that can be displayed in the form, e.g., at top of the facet.
      protected java.lang.Integer m_minCount
      The minimal number of hits required to add an entry to a facet.
      protected java.lang.String m_name
      A name used to identify the facet when showing it in the search form.
      protected java.util.List<java.lang.String> m_preselection
      The sorting of facet entries.
    • Constructor Summary

      Constructor Description
      CmsSearchConfigurationFacet​(java.lang.Integer minCount, java.lang.String label, java.lang.String name, java.lang.Boolean isAndFacet, java.util.List<java.lang.String> preselection, java.lang.Boolean ignoreFiltersFromFacets, java.util.Collection<java.lang.String> excludeTags)
      The constructor setting all configuration options.
    • Method Summary

      All Methods Instance Methods Concrete 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.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait