Module org.datanucleus

Package org.datanucleus.identity

Interface IdentityManager

All Known Implementing Classes:

IdentityManagerImpl

public interface IdentityManager

Manager for identity creation etc.

Field Summary

Fields

Modifier and Type	Field	Description
static String	IDENTITY_CLASS_TARGET_CLASS_NAME_FIELD

Method Summary

Modifier and Type	Method	Description
Object	getApplicationId(Class cls, Object key)	Method to return a new object identity for the specified class, and key (possibly toString() output).
Object	getApplicationId(Object pc, AbstractClassMetaData cmd)	Method to create a new object identity for the passed object with the supplied MetaData.
Object	getApplicationId(ClassLoaderResolver clr, AbstractClassMetaData acmd, String keyToString)	Utility to create a new application identity when you know the metadata for the target class, and the toString() output of the identity.
DatastoreId	getDatastoreId(long value)	Method to return a datastore-unique datastore identity, with the specified value.
DatastoreId	getDatastoreId(String oidString)	Method to return a datastore identity, for the specified string which comes from the output of toString().
DatastoreId	getDatastoreId(String className, Object value)	Method to return a datastore identity, representing the persistable object with specified class name and key value.
Class	getDatastoreIdClass()
IdentityKeyTranslator	getIdentityKeyTranslator()	Accessor for the current identity key translator to use (if any).
IdentityStringTranslator	getIdentityStringTranslator()	Accessor for the current identity string translator to use (if any).
SingleFieldId	getSingleFieldId(Class idType, Class pcType, Object key)	Method to return a single-field identity, for the persistable type specified, and for the idType of SingleFieldId.

Field Detail

IDENTITY_CLASS_TARGET_CLASS_NAME_FIELD

static final String IDENTITY_CLASS_TARGET_CLASS_NAME_FIELD

See Also:

Constant Field Values

Method Detail

getDatastoreIdClass

Class getDatastoreIdClass()

getIdentityStringTranslator

IdentityStringTranslator getIdentityStringTranslator()

Accessor for the current identity string translator to use (if any).

Returns:

Identity string translator instance (or null if persistence property not set)

getIdentityKeyTranslator

IdentityKeyTranslator getIdentityKeyTranslator()

Accessor for the current identity key translator to use (if any).

Returns:

Identity key translator instance (or null if persistence property not set)

getDatastoreId

DatastoreId getDatastoreId(String className,
                           Object value)

Method to return a datastore identity, representing the persistable object with specified class name and key value.

Parameters:

className - The class name for the persistable

value - The key value for the persistable

Returns:

The datastore id

getDatastoreId

DatastoreId getDatastoreId(long value)

Method to return a datastore-unique datastore identity, with the specified value.

Parameters:

value - The long value that is unique across the datastore.

Returns:

The datastore id

getDatastoreId

DatastoreId getDatastoreId(String oidString)

Method to return a datastore identity, for the specified string which comes from the output of toString().

Parameters:

oidString - The toString() value

Returns:

The datastore id

getSingleFieldId

SingleFieldId getSingleFieldId(Class idType,
                               Class pcType,
                               Object key)

Method to return a single-field identity, for the persistable type specified, and for the idType of SingleFieldId.

Parameters:

idType - Type of the id

pcType - Type of the Persistable

key - The value for the identity (the Long, or Int, or ... etc).

Returns:

Single field identity

getApplicationId

Object getApplicationId(ClassLoaderResolver clr,
                        AbstractClassMetaData acmd,
                        String keyToString)

Utility to create a new application identity when you know the metadata for the target class, and the toString() output of the identity.

Parameters:

clr - ClassLoader resolver

acmd - MetaData for the target class

keyToString - String form of the key

Returns:

The identity

getApplicationId

Object getApplicationId(Object pc,
                        AbstractClassMetaData cmd)

Method to create a new object identity for the passed object with the supplied MetaData. Only applies to application-identity cases.

Parameters:

pc - The persistable object

cmd - Its metadata

Returns:

The new identity object

getApplicationId

Object getApplicationId(Class cls,
                        Object key)

Method to return a new object identity for the specified class, and key (possibly toString() output).

Parameters:

cls - Persistable class

key - form of the object id

Returns:

The object identity