de.julielab.elastic.query.components.data

Enum IFacetField.FacetType

java.lang.Object

java.lang.Enum<IFacetField.FacetType>

de.julielab.elastic.query.components.data.IFacetField.FacetType

All Implemented Interfaces:

Serializable, Comparable<IFacetField.FacetType>

Enclosing interface:

IFacetField

public static enum IFacetField.FacetType
extends Enum<IFacetField.FacetType>

This enumeration serves for the keys for possible facet types. For example, simple faceting just returns the number of occurrences - the count - for a term in the document search result set. More advanced faceting may include the document frequency - df - of each term as well for for further computations.

Author:

faessler

Enum Constant Summary

Enum Constants

Enum Constant and Description
count Simple facet count, i.e.
documentFrequency Document frequency of a term on the whole index, i.e.

Method Summary

Modifier and Type	Method and Description
static IFacetField.FacetType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IFacetField.FacetType[]	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

count

public static final IFacetField.FacetType count

Simple facet count, i.e. the number of documents returned by a query containing the term.

documentFrequency

public static final IFacetField.FacetType documentFrequency

Document frequency of a term on the whole index, i.e. the number of all, unrestricted index documents containing the term.

Method Detail

values

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

Returns:

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

valueOf

public static IFacetField.FacetType 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