Package io.deephaven.api

Enum Class NaturalJoinType

java.lang.Object

java.lang.Enum<NaturalJoinType>

io.deephaven.api.NaturalJoinType

All Implemented Interfaces:

Serializable, Comparable<NaturalJoinType>, java.lang.constant.Constable

public enum NaturalJoinType
extends Enum<NaturalJoinType>

Specifies the type of natural join to perform, specifically how to handle duplicate and missing right hand table rows.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR_ON_DUPLICATE	Throw an error if a duplicate right hand table row is found.
EXACTLY_ONE_MATCH	Match exactly one right hand table row; throw an error if there are zero or more than one matches.
FIRST_MATCH	Match the first right hand table row and ignore later duplicates.
LAST_MATCH	Match the last right hand table row and ignore earlier duplicates.

Method Summary

Modifier and Type	Method	Description
static NaturalJoinType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NaturalJoinType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ERROR_ON_DUPLICATE

public static final NaturalJoinType ERROR_ON_DUPLICATE

Throw an error if a duplicate right hand table row is found. This is the default behavior if not specified.

FIRST_MATCH

public static final NaturalJoinType FIRST_MATCH

Match the first right hand table row and ignore later duplicates.

LAST_MATCH

public static final NaturalJoinType LAST_MATCH

Match the last right hand table row and ignore earlier duplicates.

EXACTLY_ONE_MATCH

public static final NaturalJoinType EXACTLY_ONE_MATCH

Match exactly one right hand table row; throw an error if there are zero or more than one matches.

Method Details

values

public static NaturalJoinType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static NaturalJoinType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null