com.attivio.sdk.search.query

Enum JoinMode

java.lang.Object

java.lang.Enum<JoinMode>

com.attivio.sdk.search.query.JoinMode

All Implemented Interfaces:

Serializable, Comparable<JoinMode>

public enum JoinMode
extends Enum<JoinMode>

The JoinMode for a JoinClause.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INNER Perform inner join on this clause
OUTER Perform outer join on this clause

Method Summary

Modifier and Type	Method and Description
static JoinMode	fromExternal(String value) Converts an external value to a JoinMode value.
abstract boolean	isRequired() true if the clause with this mode must match.
static JoinMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static JoinMode[]	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

INNER

public static final JoinMode INNER

Perform inner join on this clause

OUTER

public static final JoinMode OUTER

Perform outer join on this clause

Method Detail

values

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

Returns:

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

valueOf

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

isRequired

public abstract boolean isRequired()

true if the clause with this mode must match.

fromExternal

public static JoinMode fromExternal(String value)

Converts an external value to a JoinMode value.

Parameters:

value - the external value

Returns:

the type