Enum FacetValues

    • Enum Constant Detail


        public static final FacetValues FROM_SCOPED_QUERY_HIDE_UNSELECTED_PARENT_VALUES
        Values come from the scoped query however if a value is selected all other non selected values at the same category level are not shown. e.g. If every document is in both Aus and NZ and we selected Aus only the value Aus would be selected. If we configured facets to show states under the country we would still see the following values: (selected) Aus - NSW - ACT Where if we just used FROM_SCOPED_QUERY we would see: (selected) Aus NZ - NSW - ACT

        public static final FacetValues FROM_SCOPED_QUERY
        Values are from the query which may have facets applied.

        If you had selected `red cars` then (if each car has one colour) you would not see facet values for any other car colour.


        public static final FacetValues FROM_SCOPED_QUERY_WITH_FACET_UNSELECTED
        Values are from the query which may have facets applied, except the 'current' facet is not selected.

        For example if you had a tab facet that was selected and a radio facet which had this option set then the values for the radio facet would be from a query where the tab facet was selected but the radio facet was unselected.

        This is a good option for multi select OR and radio as it wont show options that lead to zero result pages.


        public static final FacetValues FROM_UNSCOPED_QUERY
        Values are from the unscoped query, that is the user's query without any facets selected.

        If you had selected `red cars` then you would still see the colours of other cars, as long as they also matched the user's query.


        public static final FacetValues FROM_UNSCOPED_ALL_QUERY
        Values are from running the all (padre null) query where no facets are selected.

        This is what is needed for tabs where even if the user query only has matches from one tab we would still show all tabs.

    • Constructor Detail

      • FacetValues

        private FacetValues()
    • Method Detail

      • values

        public static FacetValues[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (FacetValues c : FacetValues.values())
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static FacetValues valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        name - the name of the enum constant to be returned.
        the enum constant with the specified name
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null