com.attivio.sdk.search

Enum JoinFacetMode

java.lang.Object

java.lang.Enum<JoinFacetMode>

com.attivio.sdk.search.JoinFacetMode

All Implemented Interfaces:

Serializable, Comparable<JoinFacetMode>

public enum JoinFacetMode
extends Enum<JoinFacetMode>

Enumeration listing the possible facet modes for joined documents.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTINCT A child document will only be included in facet counts once, even it it is a child of multiple parent documents.
FULL A child document will be included in facet counts once for every parent document containing the child document.

Method Summary

Modifier and Type	Method and Description
static JoinFacetMode	fromExternal(String value) Converts an external value to a type value.
static JoinFacetMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static JoinFacetMode[]	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

DISTINCT

public static final JoinFacetMode DISTINCT

A child document will only be included in facet counts once, even it it is a child of multiple parent documents.

FULL

public static final JoinFacetMode FULL

A child document will be included in facet counts once for every parent document containing the child document.

NOTE: Using this mode will require significantly more memory during query execution.

Method Detail

values

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

Returns:

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

valueOf

public static JoinFacetMode 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

fromExternal

public static JoinFacetMode fromExternal(String value)

Converts an external value to a type value.