Enum FacetRequest.ResultMode
- java.lang.Object
-
- java.lang.Enum<FacetRequest.ResultMode>
-
- org.apache.lucene.facet.search.params.FacetRequest.ResultMode
-
- All Implemented Interfaces:
Serializable
,Comparable<FacetRequest.ResultMode>
- Enclosing class:
- FacetRequest
public static enum FacetRequest.ResultMode extends Enum<FacetRequest.ResultMode>
Result structure manner of applying request's limits such asFacetRequest.getNumLabel()
andFacetRequest.getNumResults()
.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description GLOBAL_FLAT
Limits are applied globally, on total number of results, and the result has a flat structure.PER_NODE_IN_TREE
Limits are applied per node, and the result has a full tree structure.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static FacetRequest.ResultMode
valueOf(String name)
Returns the enum constant of this type with the specified name.static FacetRequest.ResultMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
PER_NODE_IN_TREE
public static final FacetRequest.ResultMode PER_NODE_IN_TREE
Limits are applied per node, and the result has a full tree structure.
-
GLOBAL_FLAT
public static final FacetRequest.ResultMode GLOBAL_FLAT
Limits are applied globally, on total number of results, and the result has a flat structure.
-
-
Method Detail
-
values
public static FacetRequest.ResultMode[] 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 (FacetRequest.ResultMode c : FacetRequest.ResultMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FacetRequest.ResultMode 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
-
-