com.attivio.sdk.search

Enum JoinRollupMode

java.lang.Object

java.lang.Enum<JoinRollupMode>

com.attivio.sdk.search.JoinRollupMode

All Implemented Interfaces:

Serializable, Comparable<JoinRollupMode>

public enum JoinRollupMode
extends Enum<JoinRollupMode>

Enumeration listing the possible rollup modes for joined documents.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATE Child documents will be aggregated into the primary document.
SQL Experimental: Result tree is flattened.
TREE Child documents will be represented as a tree of attached documents.

Method Summary

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

AGGREGATE

public static final JoinRollupMode AGGREGATE

Child documents will be aggregated into the primary document.

TREE

public static final JoinRollupMode TREE

Child documents will be represented as a tree of attached documents.

SQL

public static final JoinRollupMode SQL

Experimental: Result tree is flattened.

Method Detail

values

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

Returns:

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

valueOf

public static JoinRollupMode 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 JoinRollupMode fromExternal(String value)

Converts an external value to a type value.

Parameters:

value - the external value

Returns:

the type