ApiAdapter (DataNucleus Core 3.1.3 API)

All Superinterfaces:

Serializable
```
public interface ApiAdapter
extends Serializable
```
Adapter to allow the core runtime to expose multiple APIs to clients.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allowDeleteOfNonPersistentObject()` Whether the API allows deletion of a non-persistent object.
`boolean`	`allowPersistOfDeletedObject()` Whether the API allows (re-)persistence of a deleted object.
`boolean`	`allowReadFieldOfDeletedObject()` Whether the API allows reading a field of a deleted object.
`boolean`	`clearLoadedFlagsOnDeleteObject()` Whether the API requires clearing of the fields of an object when it is deleted.
`void`	`copyFieldsFromPersistableObject(Object pc, int[] fieldNumbers, Object pc2)` Method to copy field values from the first persistable object across to the second persistable object.
`RuntimeException`	`getApiExceptionForNucleusException(NucleusException ne)` Convenience method to convert the passed NucleusException into an exception for the API.
`Object`	`getCopyOfPersistableObject(Object pc, ObjectProvider sm, int[] fieldNumbers)` Method to return a copy of the provided object, managed by the passed StateManager, copying across the specified fields.
`RuntimeException`	`getDataStoreExceptionForException(String msg, Exception e)` Convenience method to return a datastore exception appropriate for this API.
`boolean`	`getDefaultCascadeDeleteForField()` Method to return the default setting for cascading delete of a field
`boolean`	`getDefaultCascadePersistForField()` Method to return the default setting for cascading persist of a field
`boolean`	`getDefaultCascadeRefreshForField()` Method to return the default setting for cascading refresh of a field
`boolean`	`getDefaultCascadeUpdateForField()` Method to return the default setting for cascading update of a field
`Map`	`getDefaultFactoryProperties()` Method to return a set of default properties for the factory (PMF, EMF, etc)
`ExecutionContext`	`getExecutionContext(Object pc)` Method to return the ExecutionContext (if any) associated with the passed object.
`Object`	`getIdForObject(Object obj)` Method to return the object identity for the passed persistable object.
`Class`	`getKeyTypeForSingleFieldIdentityType(Class idType)` Accessor for the type of the single field application-identity key given the single field identity type.
`LifeCycleState`	`getLifeCycleState(int stateType)` Returns the LifeCycleState for the state constant.
`String`	`getName()` Accessor for the name of the API.
`Object`	`getNewApplicationIdentityObjectId(ClassLoaderResolver clr, AbstractClassMetaData acmd, String value)` Utility to create a new application-identity when you know the metadata for the target class, and the toString() output of the identity.
`Object`	`getNewApplicationIdentityObjectId(Class cls, Object key)` Method to return a new object identity for the specified class, and key (possibly toString() output).
`Object`	`getNewApplicationIdentityObjectId(Object pc, AbstractClassMetaData cmd)` Method to create a new application-identity for the passed object with the supplied MetaData.
`Object`	`getNewSingleFieldIdentity(Class idType, Class pcType, Object value)` Utility to create a new SingleFieldIdentity using reflection when you know the type of the PersistenceCapable, and also which SingleFieldIdentity, and the value of the key.
`Object`	`getObjectId(ObjectProvider sm)` Accessor for the object id from the StateManager for this object.
`String`	`getObjectState(Object obj)` Accessor for the object state.
`String`	`getSingleFieldIdentityClassNameForByte()` Accessor for the class name to use for identities when there is a single Byte/byte field.
`String`	`getSingleFieldIdentityClassNameForChar()` Accessor for the class name to use for identities when there is a single Character/char field.
`String`	`getSingleFieldIdentityClassNameForInt()` Accessor for the class name to use for identities when there is a single Integer/int field.
`String`	`getSingleFieldIdentityClassNameForLong()` Accessor for the class name to use for identities when there is a single Long/long field.
`String`	`getSingleFieldIdentityClassNameForObject()` Accessor for the class name to use for identities when there is a single Object field.
`String`	`getSingleFieldIdentityClassNameForShort()` Accessor for the class name to use for identities when there is a single Short/short field.
`String`	`getSingleFieldIdentityClassNameForString()` Accessor for the class name to use for identities when there is a single String field.
`Class`	`getTargetClassForSingleFieldIdentity(Object id)` Accessor for the target class for the specified single field identity.
`String`	`getTargetClassNameForSingleFieldIdentity(Object id)` Accessor for the target class name for the specified single field identity.
`Object`	`getTargetKeyForSingleFieldIdentity(Object id)` Accessor for the key object for the specified single field identity.
`RuntimeException`	`getUserExceptionForException(String msg, Exception e)` Convenience method to return a user exception appropriate for this API when an unexpected exception occurs.
`Object`	`getVersion(ObjectProvider sm)` Accessor for the version from the StateManager for this object.
`Object`	`getVersionForObject(Object obj)` Method to return the object version for the passed persistable object.
`boolean`	`isDatastoreIdentity(Object id)` Accessor for whether the passed identity is a valid datastore-identity for this API.
`boolean`	`isDeleted(Object obj)` Accessor for whether the passed object is deleted.
`boolean`	`isDetachable(Object obj)` Method to return if the passed object is detachable using this API.
`boolean`	`isDetached(Object obj)` Accessor for whether the passed object is detached.
`boolean`	`isDirty(Object obj)` Accessor for whether the passed object is dirty.
`boolean`	`isLoaded(ObjectProvider sm, int fieldNumber)` Accessor for whether a field is loaded for the object managed by the StateManager
`boolean`	`isManaged(Object pc)` Whether the provided object is currently managed (has an ObjectManager).
`boolean`	`isNew(Object obj)` Accessor for whether the passed object is new.
`boolean`	`isPersistable(Class cls)` Utility method to check if the specified class is of a type that can be persisted for this API.
`boolean`	`isPersistable(Object obj)` Method to return if the passed object is persistable using this API.
`boolean`	`isPersistent(Object obj)` Accessor for whether the passed object is persistent.
`boolean`	`isSingleFieldIdentity(Object id)` Accessor for whether the passed identity is a valid single-field application-identity for this API.
`boolean`	`isSingleFieldIdentityClass(String className)` Accessor for whether the passed class name is a valid single-field application-identity for this API.
`boolean`	`isTransactional(Object obj)` Accessor for whether the passed object is transactional.
`boolean`	`isValidPrimaryKeyClass(Class pkClass, AbstractClassMetaData cmd, ClassLoaderResolver clr, int noOfPkFields, MetaDataManager mmgr)` Utility to check if a primary-key class is valid.
`void`	`makeDirty(Object obj, String member)` Method to make the member of the persistable object dirty.

- Method Detail
  - getName
```
String getName()
```
    Accessor for the name of the API.
    
    Returns:
    Name of the API
  - isManaged
```
boolean isManaged(Object pc)
```
    Whether the provided object is currently managed (has an ObjectManager).
    
    Returns:
    Whether it is managed
  - getExecutionContext
```
ExecutionContext getExecutionContext(Object pc)
```
    Method to return the ExecutionContext (if any) associated with the passed object. Supports persistable objects, and PersistenceManager.
    
    Parameters:
    pc - The object
    
    Returns:
    The ExecutionContext
  - getLifeCycleState
```
LifeCycleState getLifeCycleState(int stateType)
```
    Returns the LifeCycleState for the state constant.
    
    Parameters:
    stateType - the type as integer
    
    Returns:
    the type as LifeCycleState object
  - isPersistent
```
boolean isPersistent(Object obj)
```
    Accessor for whether the passed object is persistent.
    
    Parameters:
    obj - The object
    
    Returns:
    Whether it is persistent
  - isNew
```
boolean isNew(Object obj)
```
    Accessor for whether the passed object is new.
    
    Parameters:
    obj - The object
    
    Returns:
    Whether it is new
  - isDirty
```
boolean isDirty(Object obj)
```
    Accessor for whether the passed object is dirty.
    
    Parameters:
    obj - The object
    
    Returns:
    Whether it is dirty
  - isDeleted
```
boolean isDeleted(Object obj)
```
    Accessor for whether the passed object is deleted.
    
    Parameters:
    obj - The object
    
    Returns:
    Whether it is deleted
  - isDetached
```
boolean isDetached(Object obj)
```
    Accessor for whether the passed object is detached.
    
    Parameters:
    obj - The object
    
    Returns:
    Whether it is detached
  - isTransactional
```
boolean isTransactional(Object obj)
```
    Accessor for whether the passed object is transactional.
    
    Parameters:
    obj - The object
    
    Returns:
    Whether it is transactional
  - isPersistable
```
boolean isPersistable(Object obj)
```
    Method to return if the passed object is persistable using this API.
    
    Parameters:
    obj - The object
    
    Returns:
    Whether it is persistable
  - isPersistable
```
boolean isPersistable(Class cls)
```
    Utility method to check if the specified class is of a type that can be persisted for this API.
    
    Parameters:
    cls - The class to check
    
    Returns:
    Whether the class is persistable using this API.
  - isDetachable
```
boolean isDetachable(Object obj)
```
    Method to return if the passed object is detachable using this API.
    
    Parameters:
    obj - The object
    
    Returns:
    Whether it is detachable
  - getObjectState
```
String getObjectState(Object obj)
```
    Accessor for the object state.
    
    Parameters:
    obj - Object
    
    Returns:
    The state ("persistent-clean", "detached-dirty" etc)
  - makeDirty
```
void makeDirty(Object obj,
             String member)
```
    Method to make the member of the persistable object dirty.
    
    Parameters:
    obj - The object
    member - Name of the member
  - getIdForObject
```
Object getIdForObject(Object obj)
```
    Method to return the object identity for the passed persistable object. Returns null if it is not persistable, or has no identity.
    
    Parameters:
    obj - The object
    
    Returns:
    The identity
  - getVersionForObject
```
Object getVersionForObject(Object obj)
```
    Method to return the object version for the passed persistable object. Returns null if it is not persistable, or not versioned.
    
    Parameters:
    obj - The object
    
    Returns:
    The version
  - isValidPrimaryKeyClass
```
boolean isValidPrimaryKeyClass(Class pkClass,
                             AbstractClassMetaData cmd,
                             ClassLoaderResolver clr,
                             int noOfPkFields,
                             MetaDataManager mmgr)
```
    Utility to check if a primary-key class is valid. Will throw a InvalidPrimaryKeyException if it is invalid, otherwise returning true.
    
    Parameters:
    pkClass - The Primary Key class
    cmd - AbstractClassMetaData for the PersistenceCapable class
    clr - the ClassLoaderResolver
    noOfPkFields - Number of primary key fields
    mmgr - MetaData manager
    
    Returns:
    Whether it is valid
  - isSingleFieldIdentity
```
boolean isSingleFieldIdentity(Object id)
```
    Accessor for whether the passed identity is a valid single-field application-identity for this API.
    
    Returns:
    Whether it is valid
  - isDatastoreIdentity
```
boolean isDatastoreIdentity(Object id)
```
    Accessor for whether the passed identity is a valid datastore-identity for this API.
    
    Returns:
    Whether it is valid
  - isSingleFieldIdentityClass
```
boolean isSingleFieldIdentityClass(String className)
```
    Accessor for whether the passed class name is a valid single-field application-identity for this API.
    
    Parameters:
    className - Name of the class
    
    Returns:
    Whether it is valid
  - getSingleFieldIdentityClassNameForLong
```
String getSingleFieldIdentityClassNameForLong()
```
    Accessor for the class name to use for identities when there is a single Long/long field.
    
    Returns:
    Class name of identity class
  - getSingleFieldIdentityClassNameForInt
```
String getSingleFieldIdentityClassNameForInt()
```
    Accessor for the class name to use for identities when there is a single Integer/int field.
    
    Returns:
    Class name of identity class
  - getSingleFieldIdentityClassNameForShort
```
String getSingleFieldIdentityClassNameForShort()
```
    Accessor for the class name to use for identities when there is a single Short/short field.
    
    Returns:
    Class name of identity class
  - getSingleFieldIdentityClassNameForByte
```
String getSingleFieldIdentityClassNameForByte()
```
    Accessor for the class name to use for identities when there is a single Byte/byte field.
    
    Returns:
    Class name of identity class
  - getSingleFieldIdentityClassNameForChar
```
String getSingleFieldIdentityClassNameForChar()
```
    Accessor for the class name to use for identities when there is a single Character/char field.
    
    Returns:
    Class name of identity class
  - getSingleFieldIdentityClassNameForString
```
String getSingleFieldIdentityClassNameForString()
```
    Accessor for the class name to use for identities when there is a single String field.
    
    Returns:
    Class name of identity class
  - getSingleFieldIdentityClassNameForObject
```
String getSingleFieldIdentityClassNameForObject()
```
    Accessor for the class name to use for identities when there is a single Object field.
    
    Returns:
    Class name of identity class
  - getTargetClassForSingleFieldIdentity
```
Class getTargetClassForSingleFieldIdentity(Object id)
```
    Accessor for the target class for the specified single field identity.
    
    Parameters:
    id - The identity
    
    Returns:
    The target class
  - getTargetClassNameForSingleFieldIdentity
```
String getTargetClassNameForSingleFieldIdentity(Object id)
```
    Accessor for the target class name for the specified single field identity.
    
    Parameters:
    id - The identity
    
    Returns:
    The target class name
  - getTargetKeyForSingleFieldIdentity
```
Object getTargetKeyForSingleFieldIdentity(Object id)
```
    Accessor for the key object for the specified single field identity.
    
    Parameters:
    id - The identity
    
    Returns:
    The key object
  - getKeyTypeForSingleFieldIdentityType
```
Class getKeyTypeForSingleFieldIdentityType(Class idType)
```
    Accessor for the type of the single field application-identity key given the single field identity type.
    
    Parameters:
    idType - Single field identity type
    
    Returns:
    key type
  - getNewSingleFieldIdentity
```
Object getNewSingleFieldIdentity(Class idType,
                               Class pcType,
                               Object value)
```
    Utility to create a new SingleFieldIdentity using reflection when you know the type of the PersistenceCapable, and also which SingleFieldIdentity, and the value of the key.
    
    Parameters:
    idType - Type of SingleFieldIdentity
    pcType - Type of the PersistenceCapable
    value - The value for the identity (the Long, or Int, or ... etc).
    
    Returns:
    The single field identity
    
    Throws:
    
    NucleusException - if invalid input is received
  - getNewApplicationIdentityObjectId
```
Object getNewApplicationIdentityObjectId(ClassLoaderResolver clr,
                                       AbstractClassMetaData acmd,
                                       String value)
```
    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
    value - String form of the key
    
    Returns:
    The new identity object
    
    Throws:
    
    NucleusException - if invalid input is received
  - getNewApplicationIdentityObjectId
```
Object getNewApplicationIdentityObjectId(Object pc,
                                       AbstractClassMetaData cmd)
```
    Method to create a new application-identity for the passed object with the supplied MetaData.
    
    Parameters:
    pc - The persistable object
    cmd - Its metadata
    
    Returns:
    The new identity object
  - getNewApplicationIdentityObjectId
```
Object getNewApplicationIdentityObjectId(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
  - allowPersistOfDeletedObject
```
boolean allowPersistOfDeletedObject()
```
    Whether the API allows (re-)persistence of a deleted object.
    
    Returns:
    Whether you can call persist on a deleted object
  - allowDeleteOfNonPersistentObject
```
boolean allowDeleteOfNonPersistentObject()
```
    Whether the API allows deletion of a non-persistent object.
    
    Returns:
    Whether you can call delete on an object not yet persisted
  - allowReadFieldOfDeletedObject
```
boolean allowReadFieldOfDeletedObject()
```
    Whether the API allows reading a field of a deleted object.
    
    Returns:
    Whether you can read after deleting
  - clearLoadedFlagsOnDeleteObject
```
boolean clearLoadedFlagsOnDeleteObject()
```
    Whether the API requires clearing of the fields of an object when it is deleted.
    
    Returns:
    Whether to clear loaded fields at delete
  - getDefaultCascadePersistForField
```
boolean getDefaultCascadePersistForField()
```
    Method to return the default setting for cascading persist of a field
    
    Returns:
    default persist cascade setting.
  - getDefaultCascadeUpdateForField
```
boolean getDefaultCascadeUpdateForField()
```
    Method to return the default setting for cascading update of a field
    
    Returns:
    default cascade update setting.
  - getDefaultCascadeDeleteForField
```
boolean getDefaultCascadeDeleteForField()
```
    Method to return the default setting for cascading delete of a field
    
    Returns:
    default cascade delete setting.
  - getDefaultCascadeRefreshForField
```
boolean getDefaultCascadeRefreshForField()
```
    Method to return the default setting for cascading refresh of a field
    
    Returns:
    default cascade refresh setting.
  - getDefaultFactoryProperties
```
Map getDefaultFactoryProperties()
```
    Method to return a set of default properties for the factory (PMF, EMF, etc)
    
    Returns:
    The default properties (if any) for this API
  - getObjectId
```
Object getObjectId(ObjectProvider sm)
```
    Accessor for the object id from the StateManager for this object.
    
    Parameters:
    sm - StateManager
    
    Returns:
    object id
  - getVersion
```
Object getVersion(ObjectProvider sm)
```
    Accessor for the version from the StateManager for this object.
    
    Parameters:
    sm - StateManager
  - isLoaded
```
boolean isLoaded(ObjectProvider sm,
               int fieldNumber)
```
    Accessor for whether a field is loaded for the object managed by the StateManager
    
    Parameters:
    sm - StateManager
    fieldNumber - Number of the field
    
    Returns:
    Whether it is loaded
  - getApiExceptionForNucleusException
```
RuntimeException getApiExceptionForNucleusException(NucleusException ne)
```
    Convenience method to convert the passed NucleusException into an exception for the API.
    
    Parameters:
    ne - The NucleusException
    
    Returns:
    The Api Exception
  - getUserExceptionForException
```
RuntimeException getUserExceptionForException(String msg,
                                            Exception e)
```
    Convenience method to return a user exception appropriate for this API when an unexpected exception occurs.
    
    Parameters:
    msg - The message
    e - The cause (if any)
    
    Returns:
    The API exception
  - getDataStoreExceptionForException
```
RuntimeException getDataStoreExceptionForException(String msg,
                                                 Exception e)
```
    Convenience method to return a datastore exception appropriate for this API.
    
    Parameters:
    msg - The message
    e - The cause (if any)
    
    Returns:
    The exception
  - getCopyOfPersistableObject
```
Object getCopyOfPersistableObject(Object pc,
                                ObjectProvider sm,
                                int[] fieldNumbers)
```
    Method to return a copy of the provided object, managed by the passed StateManager, copying across the specified fields.
    
    Parameters:
    pc - Persistable object
    sm - The Object Provider
    fieldNumbers - Fields to copy
    
    Returns:
    The copy object
  - copyFieldsFromPersistableObject
```
void copyFieldsFromPersistableObject(Object pc,
                                   int[] fieldNumbers,
                                   Object pc2)
```
    Method to copy field values from the first persistable object across to the second persistable object. Objects are assumed to be the same type.
    
    Parameters:
    pc - First persistable object
    fieldNumbers - Fields to copy
    pc2 - Second persistable object (to have the values copied into it)

Interface ApiAdapter

Method Summary

Method Detail

getName

isManaged

getExecutionContext

getLifeCycleState

isPersistent

isNew

isDirty

isDeleted

isDetached

isTransactional

isPersistable

isPersistable

isDetachable

getObjectState

makeDirty

getIdForObject

getVersionForObject

isValidPrimaryKeyClass

isSingleFieldIdentity

isDatastoreIdentity

isSingleFieldIdentityClass

getSingleFieldIdentityClassNameForLong

getSingleFieldIdentityClassNameForInt

getSingleFieldIdentityClassNameForShort

getSingleFieldIdentityClassNameForByte

getSingleFieldIdentityClassNameForChar

getSingleFieldIdentityClassNameForString

getSingleFieldIdentityClassNameForObject

getTargetClassForSingleFieldIdentity

getTargetClassNameForSingleFieldIdentity

getTargetKeyForSingleFieldIdentity

getKeyTypeForSingleFieldIdentityType

getNewSingleFieldIdentity

getNewApplicationIdentityObjectId

getNewApplicationIdentityObjectId

getNewApplicationIdentityObjectId

allowPersistOfDeletedObject

allowDeleteOfNonPersistentObject

allowReadFieldOfDeletedObject

clearLoadedFlagsOnDeleteObject

getDefaultCascadePersistForField

getDefaultCascadeUpdateForField

getDefaultCascadeDeleteForField

getDefaultCascadeRefreshForField

getDefaultFactoryProperties

getObjectId

getVersion

isLoaded

getApiExceptionForNucleusException

getUserExceptionForException

getDataStoreExceptionForException

getCopyOfPersistableObject

copyFieldsFromPersistableObject