Package com.sleepycat.persist.model

Enum Class Relationship

java.lang.Object

java.lang.Enum<Relationship>

com.sleepycat.persist.model.Relationship

All Implemented Interfaces:

Serializable, Comparable<Relationship>, Constable

public enum Relationship
extends Enum<Relationship>

Defines the relationship between instances of the entity class and the secondary keys. This can be specified using a SecondaryKey.relate() annotation.

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
MANY_TO_MANY	Relates many entities to many secondary keys.
MANY_TO_ONE	Relates many entities to one secondary key.
ONE_TO_MANY	Relates one entity to many secondary keys.
ONE_TO_ONE	Relates one entity to one secondary key.

Method Summary

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

MANY_TO_ONE

public static final Relationship MANY_TO_ONE

Relates many entities to one secondary key.

The secondary index will have non-unique keys; in other words, duplicates will be allowed.

The secondary key field is singular, in other words, it may not be an array or collection type.

ONE_TO_MANY

public static final Relationship ONE_TO_MANY

Relates one entity to many secondary keys.

The secondary index will have unique keys, in other words, duplicates will not be allowed.

The secondary key field must be an array or collection type.

MANY_TO_MANY

public static final Relationship MANY_TO_MANY

Relates many entities to many secondary keys.

The secondary index will have non-unique keys, in other words, duplicates will be allowed.

The secondary key field must be an array or collection type.

ONE_TO_ONE

public static final Relationship ONE_TO_ONE

Relates one entity to one secondary key.

The secondary index will have unique keys, in other words, duplicates will not be allowed.

The secondary key field is singular, in other words, it may not be an array or collection type.

Method Details

values

public static Relationship[] 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 Relationship 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