com.browseengine.bobo.api

Enum FacetSpec.FacetSortSpec

java.lang.Object

java.lang.Enum<FacetSpec.FacetSortSpec>

com.browseengine.bobo.api.FacetSpec.FacetSortSpec

All Implemented Interfaces:

Serializable, Comparable<FacetSpec.FacetSortSpec>

Enclosing class:

FacetSpec

public static enum FacetSpec.FacetSortSpec
extends Enum<FacetSpec.FacetSortSpec>

Sort options for facets

Enum Constant Summary

Enum Constants

Enum Constant and Description
OrderByCustom custom order, must have a comparator
OrderHitsDesc Order by the facet hit counts in descending order
OrderValueAsc Order by the facet values in lexographical ascending order

Method Summary

Methods

Modifier and Type	Method and Description
static FacetSpec.FacetSortSpec	valueOf(String name) Returns the enum constant of this type with the specified name.
static FacetSpec.FacetSortSpec[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OrderValueAsc

public static final FacetSpec.FacetSortSpec OrderValueAsc

Order by the facet values in lexographical ascending order

OrderHitsDesc

public static final FacetSpec.FacetSortSpec OrderHitsDesc

Order by the facet hit counts in descending order

OrderByCustom

public static final FacetSpec.FacetSortSpec OrderByCustom

custom order, must have a comparator

Method Detail

values

public static FacetSpec.FacetSortSpec[] 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 (FacetSpec.FacetSortSpec c : FacetSpec.FacetSortSpec.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FacetSpec.FacetSortSpec 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 name

NullPointerException - if the argument is null