Class CmsSearchConfigurationFacetField

    • Field Detail

      • m_prefix

        protected java.lang.String m_prefix
        A prefix, all entries of a facet must start with.
      • m_field

        protected java.lang.String m_field
        The index field to use for the facet.
      • m_limit

        protected java.lang.Integer m_limit
        The maximal number of entries shown in a facet.
      • m_fiterQueryModifier

        protected java.lang.String m_fiterQueryModifier
        A modifier for filter queries.
    • Constructor Detail

      • CmsSearchConfigurationFacetField

        public CmsSearchConfigurationFacetField​(java.lang.String field,
                                                java.lang.String name,
                                                java.lang.Integer minCount,
                                                java.lang.Integer limit,
                                                java.lang.String prefix,
                                                java.lang.String label,
                                                I_CmsSearchConfigurationFacet.SortOrder order,
                                                java.lang.String filterQueryModifier,
                                                java.lang.Boolean isAndFacet,
                                                java.util.List<java.lang.String> preselection,
                                                java.lang.Boolean ignoreFiltersFromAllFacets,
                                                java.util.Collection<java.lang.String> excludeTags)
        Constructor directly setting all configuration values.
        field - The index field to use for the facet.
        name - The name of the facet. If null it defaults to the name of the index field.
        minCount - The minimal number of hits that is necessary to add a term to the facet.
        limit - The maximal number of facet entries.
        prefix - A prefix all entries of a facet must have.
        label - The label that can be shown over the facet entries in your search form.
        order - The sorting of the facet entries (either "count", which is default, or "index", which causes alphabetical sorting).
        filterQueryModifier - Modifier for the filter queries when a facet entry is checked. Can contain "%(value)" - what is replaced by the facet entry's value.
        isAndFacet - If set to true, the facets filters for results containing all checked entries. Otherwise it filters for results containing at least one checked entry.
        preselection - The list of facet items that should be preselected for the first search.
        ignoreFiltersFromAllFacets - A flag, indicating if filters from all facets should be ignored or not.
        excludeTags - The tags (keys) of (filter) queries to be not taken into account for the facet. If "ignoreFiltersFromFacets" is true, the according tags for facets and queries will be added.