org.datanucleus.metadata
Class FieldRole

java.lang.Object
  org.datanucleus.metadata.FieldRole

public class FieldRole
extends java.lang.Object

Series of roles that fields can be performing in the (ORM) mapping process. This is typically for use by mapped datastores, but relates to MetaData definitions too, so is stored in org.datanucleus.metadata.

Field Summary

static int	ROLE_ARRAY_ELEMENT Field is to be treated as the element of an array.
static int	ROLE_COLLECTION_ELEMENT Field is to be treated as the element of a collection.
static int	ROLE_CUSTOM User defined name specified for the field, for use only with identifier creation.
static int	ROLE_FIELD Field is a reference to another object.
static int	ROLE_INDEX Field is to be treated as an ordering or index in a List.
static int	ROLE_MAP_KEY Field is to be treated as the key of a map.
static int	ROLE_MAP_VALUE Field is to be treated as the value of a map.
static int	ROLE_NONE No role defined for this field.
static int	ROLE_OWNER Field is the owner of a relation.

Constructor Summary

FieldRole()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROLE_CUSTOM

public static final int ROLE_CUSTOM

User defined name specified for the field, for use only with identifier creation.

See Also:

Constant Field Values

ROLE_NONE

public static final int ROLE_NONE

No role defined for this field.

See Also:

Constant Field Values

ROLE_OWNER

public static final int ROLE_OWNER

Field is the owner of a relation.

See Also:

Constant Field Values

ROLE_FIELD

public static final int ROLE_FIELD

Field is a reference to another object.

See Also:

Constant Field Values

ROLE_COLLECTION_ELEMENT

public static final int ROLE_COLLECTION_ELEMENT

Field is to be treated as the element of a collection.

See Also:

Constant Field Values

ROLE_ARRAY_ELEMENT

public static final int ROLE_ARRAY_ELEMENT

Field is to be treated as the element of an array.

See Also:

Constant Field Values

ROLE_MAP_KEY

public static final int ROLE_MAP_KEY

Field is to be treated as the key of a map.

See Also:

Constant Field Values

ROLE_MAP_VALUE

public static final int ROLE_MAP_VALUE

Field is to be treated as the value of a map.

See Also:

Constant Field Values

ROLE_INDEX

public static final int ROLE_INDEX

Field is to be treated as an ordering or index in a List.

See Also:

Constant Field Values

Constructor Detail

FieldRole

public FieldRole()