Package com.attivio.sdk.search.fields

Enum MultiValueMode

java.lang.Object

java.lang.Enum<MultiValueMode>

com.attivio.sdk.search.fields.MultiValueMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MultiValueMode>

public enum MultiValueMode
extends java.lang.Enum<MultiValueMode>

Mode for handling multi-value arguments that don't have the same number of values.

Enum Constant Summary

Enum Constants

Enum Constant	Description
REPEAT	Repeat last value from shorter arguments for all remaining values for longer arguments.
TRUNCATE	Truncate values to the length of the shortest argument.

Method Summary

Modifier and Type	Method	Description
MultiValueMode	parseOptional(StringParser parser)	Parse an optional MultiValueMode from parser.
static MultiValueMode	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MultiValueMode[]	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

TRUNCATE

public static final MultiValueMode TRUNCATE

Truncate values to the length of the shortest argument.

So, if one argument has 3 values, and another argument has 1 value, Only the first value from each argument will be used to compute a single output value.

REPEAT

public static final MultiValueMode REPEAT

Repeat last value from shorter arguments for all remaining values for longer arguments.

So, if one argument has 3 values, and another argument has 1 value, the argument with 1 value will have that value repeated 3 times.

Method Detail

values

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

Returns:

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

valueOf

public static MultiValueMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

parseOptional

public MultiValueMode parseOptional(StringParser parser)

Parse an optional MultiValueMode from parser.