Enum FacetValuesOrder
- java.lang.Object
-
- java.lang.Enum<FacetValuesOrder>
-
- com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
- All Implemented Interfaces:
Serializable
,Comparable<FacetValuesOrder>
public enum FacetValuesOrder extends Enum<FacetValuesOrder>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CATEGORY_DEFINITION_ORDER
Values should be in the same order as the category definitions are in the facet configuration.COUNT_ASCENDING
Values should be sorted by the count of documents returned when the category value is selected.COUNT_DESCENDING
Values should be sorted by the count of documents returned when the category value is selected.CUSTOM_COMPARATOR
Uses a custom comparator that can be set on the Facet.DATE_ASCENDING
Sort values produced by the Date facet category in ascending order.DATE_DESCENDING
Sort values produced by the Date facet category in descending order.LABEL_AS_NUMBER_ASCENDING
Values are sorted by the first number found in the label, in increasing value.LABEL_AS_NUMBER_DESCENDING
Values are sorted by the first number found in the label, in decreasing value.LABEL_ASCENDING
Sort the values by lexicographically comparing the lowercase equivalent of the label, with lower values first e.g.LABEL_DESCENDING
Sort the values by lexicographically comparing the lowercase equivalent of the label, with higher values first e.g.SELECTED_FIRST
Values that have been selected are sorted before those that have not been selected.
-
Constructor Summary
Constructors Modifier Constructor Description private
FacetValuesOrder()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static FacetValuesOrder
valueOf(String name)
Returns the enum constant of this type with the specified name.static FacetValuesOrder[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
COUNT_DESCENDING
public static final FacetValuesOrder COUNT_DESCENDING
Values should be sorted by the count of documents returned when the category value is selected. Where the highest count is first.
-
COUNT_ASCENDING
public static final FacetValuesOrder COUNT_ASCENDING
Values should be sorted by the count of documents returned when the category value is selected. Where the lowest count is first.
-
SELECTED_FIRST
public static final FacetValuesOrder SELECTED_FIRST
Values that have been selected are sorted before those that have not been selected.
-
LABEL_ASCENDING
public static final FacetValuesOrder LABEL_ASCENDING
Sort the values by lexicographically comparing the lowercase equivalent of the label, with lower values first e.g. a before b.
-
LABEL_DESCENDING
public static final FacetValuesOrder LABEL_DESCENDING
Sort the values by lexicographically comparing the lowercase equivalent of the label, with higher values first e.g. b before a.
-
CATEGORY_DEFINITION_ORDER
public static final FacetValuesOrder CATEGORY_DEFINITION_ORDER
Values should be in the same order as the category definitions are in the facet configuration.
-
LABEL_AS_NUMBER_ASCENDING
public static final FacetValuesOrder LABEL_AS_NUMBER_ASCENDING
Values are sorted by the first number found in the label, in increasing value. for example $0.1 will be sorted before $2.2
-
LABEL_AS_NUMBER_DESCENDING
public static final FacetValuesOrder LABEL_AS_NUMBER_DESCENDING
Values are sorted by the first number found in the label, in decreasing value. For example $2.2 will be sorted before $0.1
-
DATE_ASCENDING
public static final FacetValuesOrder DATE_ASCENDING
Sort values produced by the Date facet category in ascending order. For example yesterday is sorted before today. Special categories like Past 6 weeks or Next year will always be displayed before specific years like 2013.
-
DATE_DESCENDING
public static final FacetValuesOrder DATE_DESCENDING
Sort values produced by the Date facet category in descending order. For example today is sorted before yesterday.
-
CUSTOM_COMPARATOR
public static final FacetValuesOrder CUSTOM_COMPARATOR
Uses a custom comparator that can be set on the Facet.
-
-
Method Detail
-
values
public static FacetValuesOrder[] 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 (FacetValuesOrder c : FacetValuesOrder.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FacetValuesOrder 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.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-