com.lucidworks.search.dsl.request

Enum Facets.FacetGroupingMethod

java.lang.Object

java.lang.Enum<Facets.FacetGroupingMethod>

com.lucidworks.search.dsl.request.Facets.FacetGroupingMethod

All Implemented Interfaces:

Serializable, Comparable<Facets.FacetGroupingMethod>

Enclosing class:

Facets

public static enum Facets.FacetGroupingMethod
extends Enum<Facets.FacetGroupingMethod>

This field switches between grouped field facets counted based on header docs after collapse, or based on number of groups which contain at least one document with a given value of a facet field.

Default value is HEADER_DOC}

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEADER_DOC Switches grouped field facet counts to be based on header docs after collapse.
UNIQUE Switches grouped field facet counts to be based on number of groups which contain at least one document with a given value of a facet field.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNIQUE

public static final Facets.FacetGroupingMethod UNIQUE

Switches grouped field facet counts to be based on number of groups which contain at least one document with a given value of a facet field.

This could be very costly in a case when a facet field is a high cardinality field and a group fields is a high cardinality field.

HEADER_DOC

public static final Facets.FacetGroupingMethod HEADER_DOC

Switches grouped field facet counts to be based on header docs after collapse.

Default value

Method Detail

values

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

Returns:

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

valueOf

public static Facets.FacetGroupingMethod 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

toString

public String toString()

Overrides:

toString in class Enum<Facets.FacetGroupingMethod>