org.datavec.api.transform.join

Enum Join.JoinType

java.lang.Object

java.lang.Enum<Join.JoinType>

org.datavec.api.transform.join.Join.JoinType

All Implemented Interfaces:

Serializable, Comparable<Join.JoinType>

Enclosing class:

Join

public static enum Join.JoinType
extends Enum<Join.JoinType>

Type of join
Inner: Return examples where the join column values occur in both LeftOuter: Return all examples from left data, whether there is a matching right value or not. (If not: right values will have NullWritable instead)
RightOuter: Return all examples from the right data, whether there is a matching left value or not. (If not: left values will have NullWritable instead)
FullOuter: return all examples from both left/right, whether there is a matching value from the other side or not. (If not: other values will have NullWritable instead)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FullOuter
Inner
LeftOuter
RightOuter

Method Summary

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

LeftOuter

public static final Join.JoinType LeftOuter

RightOuter

public static final Join.JoinType RightOuter

FullOuter

public static final Join.JoinType FullOuter

Method Detail

values

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

Returns:

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

valueOf

public static Join.JoinType 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