StateManagerImpl (DataNucleus Core 4.1.17-SNAPSHOT API)

java.lang.Object
- org.datanucleus.state.AbstractStateManager<Persistable>
- - org.datanucleus.state.StateManagerImpl

All Implemented Interfaces:

StateManager, ObjectProvider<Persistable>

Direct Known Subclasses:

ReferentialStateManagerImpl
```
public class StateManagerImpl
extends AbstractStateManager<Persistable>
implements StateManager
```
Implementation of a StateManager, supporting the bytecode enhancement contract of DataNucleus. Implemented here as one StateManager per Object so adds on functionality particular to each object. All Persistable objects will have a StateManager when they have had communication with the ExecutionContext. They will typically always have an identity also. The exception to that is for embedded/serialised objects.
Embedded/Serialised Objects
An object that is being embedded/serialised in an owning object will NOT have an identity unless the object is subject to a makePersistent() call also. When an object is embedded/serialised and a field is changed, the field will NOT be marked as dirty (unless it is also an object in its own right with an identity). When a field is changed any owning objects are updated so that they can update their tables accordingly.
Performance and Memory
StateManagers are very performance-critical, because for each Persistable object made persistent, there will be one StateManager instance, adding up to the total memory footprint of that object. In heap profiling analysis, StateManagerImpl showed to consume bytes 169 per StateManager by itself and about 500 bytes per StateManager when taking PC-individual child-object (like the OID) referred by the StateManager into account. With small Java objects this can mean a substantial memory overhead and for applications using such small objects can be critical. For this reason the StateManager should always be minimal in memory consumption.

Field Summary

Fields
Modifier and Type Field and Description

protected Persistable savedImage
Image of the Persistable instance when the instance is enlisted in the transaction.
- Fields inherited from class org.datanucleus.state.AbstractStateManager
  activity, cmd, currFM, dirty, dirtyFields, FLAG_ATTACHING, FLAG_BECOMING_DELETED, FLAG_CHANGING_STATE, FLAG_DETACHING, FLAG_DISCONNECTING, FLAG_FLUSHED_NEW, FLAG_FLUSHING, FLAG_LOADINGFPFIELDS, FLAG_MAKING_TRANSIENT, FLAG_NEED_INHERITANCE_VALIDATION, FLAG_POSTINSERT_UPDATE, FLAG_POSTLOAD_PENDING, FLAG_RESETTING_DETACHED_STATE, FLAG_RETRIEVING_DETACHED_STATE, FLAG_STORING_PC, FLAG_UPDATING_EMBEDDING_FIELDS_WITH_OWNER, flags, HOLLOWFIELDMANAGER, loadedFields, lock, lockMode, myEC, myFP, myID, myInternalID, myLC, myPC, myVersion, objectType, objectValGenerators, persistenceFlags, restoreValues, savedFlags, savedLoadedFields, transactionalVersion
- Fields inherited from interface org.datanucleus.state.ObjectProvider
  EMBEDDED_COLLECTION_ELEMENT_PC, EMBEDDED_MAP_KEY_PC, EMBEDDED_MAP_VALUE_PC, EMBEDDED_PC, ORIGINAL_FIELD_VALUE_KEY_PREFIX, PC

Fields
Modifier and Type	Field and Description
`protected Persistable`	`savedImage` Image of the Persistable instance when the instance is enlisted in the transaction.

Constructor Summary

Constructors
Constructor and Description
`StateManagerImpl(ExecutionContext ec, AbstractClassMetaData cmd)` Constructor for object of specified type managed by the provided ExecutionContext.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`attach(boolean embedded)` Method to attach the object managed by this StateManager.
`void`	`attach(Persistable detachedPC)` Method to attach the provided detached object into the managed instance.
`Persistable`	`attachCopy(Persistable detachedPC, boolean embedded)` Method to attach a copy of the detached persistable instance and return the (attached) copy.
`void`	`changeActivityState(ActivityState state)` Update the acitvity state.
`void`	`checkInheritance(FieldValues fv)` Deprecated. Dont use this, to be removed
`void`	`clearFields()` Method to clear all fields of the object.
`void`	`clearLoadedFlags()` Method to clear all loaded flags on the object.
`void`	`clearNonPrimaryKeyFields()` Method to clear all fields that are not part of the primary key of the object.
`void`	`clearSavedFields()` Method to clear all saved fields on the object.
`void`	`connect(ExecutionContext ec, AbstractClassMetaData cmd)` Method to (re)connect the provider to the specified ExecutionContext and object type.
`void`	`copyFieldsFromObject(Object obj, int[] fieldNumbers)` Convenience method to update our object with the field values from the passed object.
`void`	`deletePersistent()` Method to delete the object from persistence.
`void`	`detach(FetchPlanState state)` Method to detach this object.
`Persistable`	`detachCopy(FetchPlanState state)` Method to make detached copy of this instance If the object is detachable then the copy will be migrated to DETACHED state, otherwise will migrate the copy to TRANSIENT.
`void`	`disconnect()` Disconnect this ObjectProvider from the ExecutionContext and PC object.
`protected boolean`	`disconnectClone(Persistable pc)` Method to disconnect any cloned persistence capable objects from their StateManager.
`void`	`dump(PrintWriter out)` Utility to dump the contents of the StateManager.
`void`	`enlistInTransaction()` Method to enlist the managed object in the current transaction.
`void`	`evictFromTransaction()` Method to evict the managed object from the current transaction.
`void`	`flush()` Flushes any outstanding changes to the object to the datastore.
`boolean`	`getBooleanField(Persistable pc, int fieldNumber, boolean currentValue)` Return the value for the field.
`byte`	`getByteField(Persistable pc, int fieldNumber, byte currentValue)` Return the value for the field.
`char`	`getCharField(Persistable pc, int fieldNumber, char currentValue)` Return the value for the field.
`double`	`getDoubleField(Persistable pc, int fieldNumber, double currentValue)` Return the value for the field.
`ExecutionContextReference`	`getExecutionContext(Persistable pc)` Accessor for the ExecutionContext that owns this instance.
`Object`	`getExternalObjectId()` Return an object identity that can be used by the user for the managed object.
`protected Object`	`getExternalObjectId(Object obj)` Return an object id that the user can use.
`float`	`getFloatField(Persistable pc, int fieldNumber, float currentValue)` Return the value for the field.
`int`	`getIntField(Persistable pc, int fieldNumber, int currentValue)` Return the value for the field.
`long`	`getLongField(Persistable pc, int fieldNumber, long currentValue)` Return the value for the field.
`Persistable`	`getObject()` Accessor for the Persistent Capable object.
`Object`	`getObjectField(Persistable pc, int fieldNumber, Object currentValue)` Return the value for the field.
`Object`	`getObjectId(Persistable pc)` Return the object representing the JDO identity of the calling instance.
`short`	`getShortField(Persistable pc, int fieldNumber, short currentValue)` Return the value for the field.
`String`	`getStringField(Persistable pc, int fieldNumber, String currentValue)` Return the value for the field.
`Object`	`getTransactionalObjectId(Persistable pc)` Return the object representing the JDO identity of the calling instance.
`Object`	`getTransactionalVersion()` Return the transactional version of the managed object.
`Object`	`getVersion()` Method to return the current version of the managed object.
`Object`	`getVersion(Persistable pc)` Return the object representing the version of the calling instance.
`void`	`initialiseForCachedPC(CachedPC<Persistable> cachedPC, Object id)` Initialise the ObjectProvider, assigning the specified id to the object.
`void`	`initialiseForDetached(Persistable pc, Object id, Object version)` Initialises the StateManager to manage a Persistable object in detached state.
`void`	`initialiseForEmbedded(Persistable pc, boolean copyPc)` Initialises a state manager to manage a Persistable instance that will be EMBEDDED/SERIALISED into another Persistable object.
`void`	`initialiseForHollow(Object id, FieldValues fv, Class pcClass)` Initialises a state manager to manage a hollow instance having the given object ID and the given (optional) field values.
`void`	`initialiseForHollowAppId(FieldValues fv, Class pcClass)` Deprecated. Remove use of this and use initialiseForHollow
`void`	`initialiseForHollowPreConstructed(Object id, Persistable pc)` Initialises a state manager to manage the given hollow instance having the given object ID.
`void`	`initialiseForPersistentClean(Object id, Persistable pc)` Initialises a state manager to manage the passed persistent instance having the given object ID.
`void`	`initialiseForPersistentNew(Persistable pc, FieldValues preInsertChanges)` Initialises a state manager to manage a transient instance that is becoming newly persistent.
`void`	`initialiseForPNewToBeDeleted(Persistable pc)` Initialises the StateManager to manage a Persistable object that is not persistent but is about to be deleted.
`void`	`initialiseForTransactionalTransient(Persistable pc)` Initialises a state manager to manage a Transactional Transient instance.
`boolean`	`isDeleted()` Tests whether this object has been deleted.
`boolean`	`isDeleted(Persistable pc)` Tests whether this object has been deleted.
`boolean`	`isDirty(Persistable pc)` Tests whether this object is dirty.
`boolean`	`isLoaded(int fieldNumber)` Returns the loaded setting for the field of the managed object.
`boolean`	`isLoaded(Persistable pc, int fieldNumber)` Return true if the field is cached in the calling instance.
`boolean`	`isNew(Persistable pc)` Tests whether this object has been newly made persistent.
`boolean`	`isPersistent(Persistable pc)` Tests whether this object is persistent.
`boolean`	`isTransactional(Persistable pc)` Tests whether this object is transactional.
`void`	`loadField(int fieldNumber)` Convenience method to load the specified field if not loaded.
`void`	`loadFieldValues(FieldValues fv)` Convenience method to load the passed field values.
`protected void`	`loadSpecifiedFields(int[] fieldNumbers)` Fetch the specified fields from the database.
`void`	`loadUnloadedFields()` Fetch from the database all fields that are not currently loaded regardless of whether they are in the current fetch group or not.
`void`	`loadUnloadedFieldsInFetchPlan()` Fetchs from the database all fields that are not currently loaded and that are in the current fetch group.
`protected void`	`loadUnloadedFieldsInFetchPlanAndVersion()` Fetchs from the database all fields in current fetch plan that are not currently loaded as well as the version.
`void`	`loadUnloadedFieldsOfClassInFetchPlan(FetchPlan fetchPlan)` Fetchs from the database all fields in the actual fetch plan.
`void`	`loadUnloadedRelationFields()` Loads (from the database) all unloaded fields that store relations.
`void`	`makeDirty(int fieldNumber)` Marks the given field dirty.
`void`	`makeDirty(Persistable pc, String fieldName)` Mark the associated Persistable field dirty.
`void`	`makePersistent()` Method to make the object persistent.
`void`	`makeTransactional()` Method to change the object state to transactional.
`void`	`makeTransient(FetchPlanState state)` Method to change the object state to transient.
`protected static Object`	`peekField(Object obj, String fieldName)` Utility to take a peek at a field in the persistable object.
`protected void`	`postStateChange()` Method called after a change in state.
`protected void`	`postWriteField(boolean wasDirty)` Method called after the write of a field.
`void`	`preSerialize(Persistable pc)` Guarantee that the serializable transactional and persistent fields are loaded into the instance.
`protected boolean`	`preWriteField(int fieldNumber)` Method called before a write of the specified field.
`Object`	`provideField(int fieldNumber)` Method to return the current value of a particular field.
`protected Object`	`provideField(Persistable pc, int fieldNumber)` Method to retrieve the value of a field from the PC object.
`void`	`provideFields(int[] fieldNumbers, FieldManager fm)` Called from the StoreManager after StoreManager.update() is called to obtain updated values from the Persistable associated with this StateManager.
`void`	`refreshFieldsInFetchPlan()` Refreshes from the database all fields in fetch plan.
`void`	`refreshLoadedFields()` Refreshes from the database all fields currently loaded.
`void`	`replaceAllLoadedSCOFieldsWithValues()` Method to replace all loaded SCO fields that have wrappers with their value.
`void`	`replaceAllLoadedSCOFieldsWithWrappers()` Method to replace all loaded SCO fields with wrappers.
`void`	`replaceField(int fieldNumber, Object value)` Method to change the value of a particular field and not mark it dirty.
`protected void`	`replaceField(Persistable pc, int fieldNumber, Object value)` Method to change the value of a field in the PC object.
`protected void`	`replaceField(Persistable pc, int fieldNumber, Object value, boolean makeDirty)` Method to change the value of a field in the PC object.
`void`	`replaceFieldMakeDirty(int fieldNumber, Object value)` Method to change the value of a particular field and mark it dirty.
`void`	`replaceFields(int[] fieldNumbers, FieldManager fm)` Called from the StoreManager to refresh data in the Persistable object associated with this StateManager.
`void`	`replaceFields(int[] fieldNumbers, FieldManager fm, boolean replaceWhenDirty)` Called from the StoreManager to refresh data in the Persistable object associated with this StateManager.
`void`	`replaceFieldValue(int fieldNumber, Object newValue)` Convenience method to change the value of a field that is assumed loaded.
`void`	`replaceManagedPC(Persistable pc)` Method that replaces the PC managed by this StateManager to be the supplied object.
`void`	`replaceNonLoadedFields(int[] fieldNumbers, FieldManager fm)` Called from the StoreManager to refresh data in the Persistable object associated with this StateManager.
`protected void`	`replaceStateManager(Persistable pc, StateManager sm)` Utility to update the passed object with the passed StateManager (can be null).
`Object[]`	`replacingDetachedState(Detachable pc, Object[] currentState)` Method to update the "detached state" in the detached object to obtain the "detached state" from the detached object, or to reset it (to null).
`byte`	`replacingFlags(Persistable pc)` The StateManager uses this method to supply the value of jdoFlags to the associated Persistable instance.
`StateManager`	`replacingStateManager(Persistable pc, StateManager sm)` Replace the current value of jdoStateManager.
`void`	`resetDetachState()` Convenience method to reset the detached state in the current object.
`void`	`restoreFields()` Method to restore all fields of the object.
`void`	`retrieveDetachState(ObjectProvider op)` Convenience method to retrieve the detach state from the passed ObjectProvider's object.
`void`	`saveFields()` Method to save all fields of the object so we can potentially restore them later.
`void`	`setBooleanField(Persistable pc, int fieldNumber, boolean currentValue, boolean newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`void`	`setByteField(Persistable pc, int fieldNumber, byte currentValue, byte newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`void`	`setCharField(Persistable pc, int fieldNumber, char currentValue, char newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`void`	`setDoubleField(Persistable pc, int fieldNumber, double currentValue, double newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`void`	`setFloatField(Persistable pc, int fieldNumber, float currentValue, float newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`void`	`setIntField(Persistable pc, int fieldNumber, int currentValue, int newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`void`	`setLongField(Persistable pc, int fieldNumber, long currentValue, long newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`void`	`setObjectField(Persistable pc, int fieldNumber, Object currentValue, Object newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`void`	`setPostStoreNewObjectId(Object id)` If the id is obtained after inserting the object into the database, set new a new id for persistent classes (for example, increment).
`void`	`setShortField(Persistable pc, int fieldNumber, short currentValue, short newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`void`	`setStringField(Persistable pc, int fieldNumber, String currentValue, String newValue)` This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
`protected void`	`updateField(Persistable pc, int fieldNumber, Object value)` Convenience method to perform the update of a field value when a setter is invoked.
`void`	`updateFieldAfterInsert(Object pc, int fieldNumber)` Marks the given field dirty for issuing an update after the insert.
`void`	`updateOwnerFieldInEmbeddedField(int fieldNumber, Object value)` Method to update the "owner-field" in an embedded object with the owner object.
`void`	`validate()` Validates whether the persistence capable instance exists in the datastore.

Methods inherited from class org.datanucleus.state.AbstractStateManager
areFieldsLoaded, becomingDeleted, clearDirtyFlags, clearDirtyFlags, clearFieldsByNumbers, containsAssociatedValue, evict, getAllFieldsLoaded, getAssociatedValue, getCallbackHandler, getClassMetaData, getDirtyFieldNames, getDirtyFieldNumbers, getDirtyFields, getExecutionContext, getFieldNumbersOfLoadedOrDirtyFields, getInternalObjectId, getLifecycleState, getLoadedFieldNames, getLoadedFieldNumbers, getLoadedFields, getLockMode, getObjectAsPrintable, getObjectValueGenerator, getReferencedPC, getStoreManager, getTransactionalVersion, internalDeletePersistent, isAttaching, isChangingState, isDeleting, isDetaching, isDisconnecting, isEmbedded, isFieldLoaded, isFlushedNew, isFlushedToDatastore, isFlushing, isInserting, isMakingTransient, isPostLoadPending, isResettingDetachedState, isRestoreValues, isRetrievingDetachedState, isStoringPC, isWaitingToBeFlushedToDatastore, loadFieldFromDatastore, loadFieldsFromDatastore, loadFieldsFromLevel2Cache, loadFieldsInFetchPlan, locate, lock, makeNontransactional, makePersistentTransactionalTransient, markAsFlushed, markForInheritanceValidation, markPKFieldsAsLoaded, postCommit, preBegin, preRollback, preStateChange, providedBooleanField, providedByteField, providedCharField, providedDoubleField, providedFloatField, providedIntField, providedLongField, providedObjectField, providedShortField, providedStringField, refresh, registerTransactional, removeAssociatedValue, replacingBooleanField, replacingByteField, replacingCharField, replacingDoubleField, replacingFloatField, replacingIntField, replacingLongField, replacingObjectField, replacingShortField, replacingStringField, retrieve, setAssociatedValue, setFlushedNew, setFlushing, setPcObjectType, setStoringPC, setTransactionalVersion, setVersion, toString, transitionReadField, transitionWriteField, unloadField, unloadNonFetchPlanFields, unlock, unsetStoringPC, updateLevel2CacheForFields

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.datanucleus.enhancement.StateManager
providedBooleanField, providedByteField, providedCharField, providedDoubleField, providedFloatField, providedIntField, providedLongField, providedObjectField, providedShortField, providedStringField, replacingBooleanField, replacingByteField, replacingCharField, replacingDoubleField, replacingFloatField, replacingIntField, replacingLongField, replacingObjectField, replacingShortField, replacingStringField

- Field Detail
  - savedImage
```
protected Persistable savedImage
```
    Image of the Persistable instance when the instance is enlisted in the transaction.
- Constructor Detail
  - StateManagerImpl
```
public StateManagerImpl(ExecutionContext ec,
                        AbstractClassMetaData cmd)
```
    Constructor for object of specified type managed by the provided ExecutionContext.
    
    Parameters:
    
    ec - ExecutionContext
    
    cmd - the metadata for the class.
- Method Detail
  - connect
```
public void connect(ExecutionContext ec,
                    AbstractClassMetaData cmd)
```
    Description copied from class: AbstractStateManager
    
    Method to (re)connect the provider to the specified ExecutionContext and object type.
    
    Specified by:
    
    connect in interface ObjectProvider<Persistable>
    
    Overrides:
    
    connect in class AbstractStateManager<Persistable>
    
    Parameters:
    
    ec - ExecutionContext to connect to
    
    cmd - Metadata for this class
  - disconnect
```
public void disconnect()
```
    Disconnect this ObjectProvider from the ExecutionContext and PC object.
    
    Specified by:
    
    disconnect in interface ObjectProvider<Persistable>
  - initialiseForHollow
```
public void initialiseForHollow(Object id,
                                FieldValues fv,
                                Class pcClass)
```
    Initialises a state manager to manage a hollow instance having the given object ID and the given (optional) field values. This constructor is used for creating new instances of existing persistent objects, and consequently shouldnt be used when the StoreManager controls the creation of such objects (such as in an ODBMS).
    
    Specified by:
    
    initialiseForHollow in interface ObjectProvider<Persistable>
    
    Parameters:
    
    id - the JDO identity of the object.
    
    fv - the initial field values of the object (optional)
    
    pcClass - Class of the object that this will manage the state for
  - initialiseForHollowAppId
```
public void initialiseForHollowAppId(FieldValues fv,
                                     Class pcClass)
```
    Deprecated. Remove use of this and use initialiseForHollow
    
    Initialises a state manager to manage a HOLLOW / P_CLEAN instance having the given FieldValues. This constructor is used for creating new instances of existing persistent objects using application identity, and consequently shouldnt be used when the StoreManager controls the creation of such objects (such as in an ODBMS).
    
    Specified by:
    
    initialiseForHollowAppId in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fv - the initial field values of the object.
    
    pcClass - Class of the object that this will manage the state for
  - initialiseForHollowPreConstructed
```
public void initialiseForHollowPreConstructed(Object id,
                                              Persistable pc)
```
    Initialises a state manager to manage the given hollow instance having the given object ID. Unlike the initialiseForHollow(java.lang.Object, org.datanucleus.store.FieldValues, java.lang.Class) method, this method does not create a new instance and instead takes a pre-constructed instance (such as from an ODBMS).
    
    Specified by:
    
    initialiseForHollowPreConstructed in interface ObjectProvider<Persistable>
    
    Parameters:
    
    id - the identity of the object.
    
    pc - the object to be managed.
  - initialiseForPersistentClean
```
public void initialiseForPersistentClean(Object id,
                                         Persistable pc)
```
    Initialises a state manager to manage the passed persistent instance having the given object ID. Used where we have retrieved a PC object from a datastore directly (not field-by-field), for example on an object datastore. This initialiser will not add StateManagers to all related PCs. This must be done by any calling process. This simply adds the StateManager to the specified object and records the id, setting all fields of the object as loaded.
    
    Specified by:
    
    initialiseForPersistentClean in interface ObjectProvider<Persistable>
    
    Parameters:
    
    id - the identity of the object.
    
    pc - The object to be managed
  - initialiseForEmbedded
```
public void initialiseForEmbedded(Persistable pc,
                                  boolean copyPc)
```
    Initialises a state manager to manage a Persistable instance that will be EMBEDDED/SERIALISED into another Persistable object. The instance will not be assigned an identity in the process since it is a SCO.
    
    Specified by:
    
    initialiseForEmbedded in interface ObjectProvider<Persistable>
    
    Parameters:
    
    pc - The Persistable to manage (see copyPc also)
    
    copyPc - Whether the SM should manage a copy of the passed PC or that one
  - initialiseForPersistentNew
```
public void initialiseForPersistentNew(Persistable pc,
                                       FieldValues preInsertChanges)
```
    Initialises a state manager to manage a transient instance that is becoming newly persistent. A new object ID for the instance is obtained from the store manager and the object is inserted in the data store.
    This constructor is used for assigning state managers to existing instances that are transitioning to a persistent state.
    
    Specified by:
    
    initialiseForPersistentNew in interface ObjectProvider<Persistable>
    
    Parameters:
    
    pc - the instance being make persistent.
    
    preInsertChanges - Any changes to make before inserting
  - initialiseForTransactionalTransient
```
public void initialiseForTransactionalTransient(Persistable pc)
```
    Initialises a state manager to manage a Transactional Transient instance. A new object ID for the instance is obtained from the store manager and the object is inserted in the data store.
    This constructor is used for assigning state managers to Transient instances that are transitioning to a transient clean state.
    
    Specified by:
    
    initialiseForTransactionalTransient in interface ObjectProvider<Persistable>
    
    Parameters:
    
    pc - the instance being make persistent.
  - initialiseForDetached
```
public void initialiseForDetached(Persistable pc,
                                  Object id,
                                  Object version)
```
    Initialises the StateManager to manage a Persistable object in detached state.
    
    Specified by:
    
    initialiseForDetached in interface ObjectProvider<Persistable>
    
    Parameters:
    
    pc - the detach object.
    
    id - the identity of the object.
    
    version - the detached version
  - initialiseForPNewToBeDeleted
```
public void initialiseForPNewToBeDeleted(Persistable pc)
```
    Initialises the StateManager to manage a Persistable object that is not persistent but is about to be deleted.
    
    Specified by:
    
    initialiseForPNewToBeDeleted in interface ObjectProvider<Persistable>
    
    Parameters:
    
    pc - the object to delete
  - initialiseForCachedPC
```
public void initialiseForCachedPC(CachedPC<Persistable> cachedPC,
                                  Object id)
```
    Initialise the ObjectProvider, assigning the specified id to the object. This is used when getting objects out of the L2 Cache, where they have no ObjectProvider assigned, and returning them as associated with a particular ExecutionContext.
    
    Specified by:
    
    initialiseForCachedPC in interface ObjectProvider<Persistable>
    
    Parameters:
    
    cachedPC - The cached PC object
    
    id - Id to assign to the Persistable object
  - getObject
```
public Persistable getObject()
```
    Accessor for the Persistent Capable object.
    
    Specified by:
    
    getObject in interface ObjectProvider<Persistable>
    
    Specified by:
    
    getObject in class AbstractStateManager<Persistable>
    
    Returns:
    
    The PersistentCapable object
  - saveFields
```
public void saveFields()
```
    Method to save all fields of the object so we can potentially restore them later.
    
    Specified by:
    
    saveFields in interface ObjectProvider<Persistable>
  - clearSavedFields
```
public void clearSavedFields()
```
    Method to clear all saved fields on the object.
    
    Specified by:
    
    clearSavedFields in interface ObjectProvider<Persistable>
  - restoreFields
```
public void restoreFields()
```
    Method to restore all fields of the object.
    
    Specified by:
    
    restoreFields in interface ObjectProvider<Persistable>
  - enlistInTransaction
```
public void enlistInTransaction()
```
    Method to enlist the managed object in the current transaction.
    
    Specified by:
    
    enlistInTransaction in interface ObjectProvider<Persistable>
  - evictFromTransaction
```
public void evictFromTransaction()
```
    Method to evict the managed object from the current transaction.
    
    Specified by:
    
    evictFromTransaction in interface ObjectProvider<Persistable>
  - replaceStateManager
```
protected void replaceStateManager(Persistable pc,
                                   StateManager sm)
```
    Utility to update the passed object with the passed StateManager (can be null).
    
    Parameters:
    
    pc - The object to update
    
    sm - The new state manager
  - replacingStateManager
```
public StateManager replacingStateManager(Persistable pc,
                                          StateManager sm)
```
    Replace the current value of jdoStateManager.
    This method is called by the Persistable whenever jdoReplaceStateManager is called and there is already an owning StateManager. This is a security precaution to ensure that the owning StateManager is the only source of any change to its reference in the Persistable.
    
    Specified by:
    
    replacingStateManager in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    sm - the proposed new value for the jdoStateManager
    
    Returns:
    
    the new value for the jdoStateManager
  - replaceManagedPC
```
public void replaceManagedPC(Persistable pc)
```
    Method that replaces the PC managed by this StateManager to be the supplied object. This happens when we want to get an object for an id and create a Hollow object, and then validate against the datastore. This validation can pull in a new object graph from the datastore (e.g for DB4O)
    
    Specified by:
    
    replaceManagedPC in interface ObjectProvider<Persistable>
    
    Parameters:
    
    pc - The Persistable to use
  - getExecutionContext
```
public ExecutionContextReference getExecutionContext(Persistable pc)
```
    Accessor for the ExecutionContext that owns this instance.
    
    Specified by:
    
    getExecutionContext in interface StateManager
    
    Parameters:
    
    pc - The Persistable instance
    
    Returns:
    
    The ExecutionContext that owns this instance
  - isDirty
```
public boolean isDirty(Persistable pc)
```
    Tests whether this object is dirty. Instances that have been modified, deleted, or newly made persistent in the current transaction return true.
    Transient nontransactional instances return false (JDO spec).
    
    Specified by:
    
    isDirty in interface StateManager
    
    Parameters:
    
    pc - the calling persistable instance
    
    Returns:
    
    true if this instance has been modified in current transaction.
    
    See Also:
    
    Persistable.dnMakeDirty(String fieldName)
  - isTransactional
```
public boolean isTransactional(Persistable pc)
```
    Tests whether this object is transactional. Instances that respect transaction boundaries return true. These instances include transient instances made transactional as a result of being the target of a makeTransactional method call; newly made persistent or deleted persistent instances; persistent instances read in data store transactions; and persistent instances modified in optimistic transactions.
    Transient nontransactional instances return false.
    
    Specified by:
    
    isTransactional in interface StateManager
    
    Parameters:
    
    pc - the calling persistable instance
    
    Returns:
    
    true if this instance is transactional.
  - isPersistent
```
public boolean isPersistent(Persistable pc)
```
    Tests whether this object is persistent. Instances whose state is stored in the data store return true. Transient instances return false.
    
    Specified by:
    
    isPersistent in interface StateManager
    
    Parameters:
    
    pc - the calling persistable instance
    
    Returns:
    
    true if this instance is persistent.
  - isNew
```
public boolean isNew(Persistable pc)
```
    Tests whether this object has been newly made persistent. Instances that have been made persistent in the current transaction return true.
    Transient instances return false.
    
    Specified by:
    
    isNew in interface StateManager
    
    Parameters:
    
    pc - the calling persistable instance
    
    Returns:
    
    true if this instance was made persistent in the current transaction.
  - isDeleted
```
public boolean isDeleted()
```
    Description copied from interface: ObjectProvider
    
    Tests whether this object has been deleted. Instances that have been deleted in the current transaction return true. Transient instances return false.
    
    Specified by:
    
    isDeleted in interface ObjectProvider<Persistable>
    
    Returns:
    
    true if this instance was deleted in the current transaction.
  - isDeleted
```
public boolean isDeleted(Persistable pc)
```
    Tests whether this object has been deleted. Instances that have been deleted in the current transaction return true.
    Transient instances return false.
    
    Specified by:
    
    isDeleted in interface StateManager
    
    Parameters:
    
    pc - the calling persistable instance
    
    Returns:
    
    true if this instance was deleted in the current transaction.
  - getVersion
```
public Object getVersion(Persistable pc)
```
    Return the object representing the version of the calling instance.
    
    Specified by:
    
    getVersion in interface StateManager
    
    Parameters:
    
    pc - the calling persistable instance
    
    Returns:
    
    the object representing the version of the calling instance
    
    Since:
    
    JDO 2.0
  - getVersion
```
public Object getVersion()
```
    Method to return the current version of the managed object.
    
    Specified by:
    
    getVersion in interface ObjectProvider<Persistable>
    
    Returns:
    
    The version
  - getTransactionalVersion
```
public Object getTransactionalVersion()
```
    Return the transactional version of the managed object.
    
    Specified by:
    
    getTransactionalVersion in interface ObjectProvider<Persistable>
    
    Returns:
    
    Version of the managed instance at this point in the transaction
  - clearFields
```
public void clearFields()
```
    Method to clear all fields of the object.
    
    Specified by:
    
    clearFields in interface ObjectProvider<Persistable>
  - clearNonPrimaryKeyFields
```
public void clearNonPrimaryKeyFields()
```
    Method to clear all fields that are not part of the primary key of the object.
    
    Specified by:
    
    clearNonPrimaryKeyFields in interface ObjectProvider<Persistable>
  - clearLoadedFlags
```
public void clearLoadedFlags()
```
    Method to clear all loaded flags on the object. Note that the contract of this method implies, especially for object database backends, that the memory form of the object is outdated. Thus, for features like implicit saving of dirty object subgraphs should be switched off for this PC, even if the object actually looks like being dirty (because it is being changed to null values).
    
    Specified by:
    
    clearLoadedFlags in interface ObjectProvider<Persistable>
  - replacingFlags
```
public byte replacingFlags(Persistable pc)
```
    The StateManager uses this method to supply the value of jdoFlags to the associated Persistable instance.
    
    Specified by:
    
    replacingFlags in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    Returns:
    
    the value of jdoFlags to be stored in the Persistable instance
  - provideField
```
public Object provideField(int fieldNumber)
```
    Method to return the current value of a particular field.
    
    Specified by:
    
    provideField in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumber - Number of field
    
    Returns:
    
    The value of the field
  - provideField
```
protected Object provideField(Persistable pc,
                              int fieldNumber)
```
    Method to retrieve the value of a field from the PC object. Assumes that it is loaded.
    
    Parameters:
    
    pc - The PC object
    
    fieldNumber - Number of field
    
    Returns:
    
    The value of the field
  - provideFields
```
public void provideFields(int[] fieldNumbers,
                          FieldManager fm)
```
    Called from the StoreManager after StoreManager.update() is called to obtain updated values from the Persistable associated with this StateManager.
    
    Specified by:
    
    provideFields in interface ObjectProvider<Persistable>
    
    Specified by:
    
    provideFields in class AbstractStateManager<Persistable>
    
    Parameters:
    
    fieldNumbers - An array of field numbers to be updated by the Store
    
    fm - The updated values are stored in this object. This object is only valid for the duration of this call.
  - setBooleanField
```
public void setBooleanField(Persistable pc,
                            int fieldNumber,
                            boolean currentValue,
                            boolean newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setBooleanField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - setByteField
```
public void setByteField(Persistable pc,
                         int fieldNumber,
                         byte currentValue,
                         byte newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setByteField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - setCharField
```
public void setCharField(Persistable pc,
                         int fieldNumber,
                         char currentValue,
                         char newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setCharField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - setDoubleField
```
public void setDoubleField(Persistable pc,
                           int fieldNumber,
                           double currentValue,
                           double newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setDoubleField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - setFloatField
```
public void setFloatField(Persistable pc,
                          int fieldNumber,
                          float currentValue,
                          float newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setFloatField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - setIntField
```
public void setIntField(Persistable pc,
                        int fieldNumber,
                        int currentValue,
                        int newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setIntField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - setLongField
```
public void setLongField(Persistable pc,
                         int fieldNumber,
                         long currentValue,
                         long newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setLongField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - setShortField
```
public void setShortField(Persistable pc,
                          int fieldNumber,
                          short currentValue,
                          short newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setShortField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - setStringField
```
public void setStringField(Persistable pc,
                           int fieldNumber,
                           String currentValue,
                           String newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setStringField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - setObjectField
```
public void setObjectField(Persistable pc,
                           int fieldNumber,
                           Object currentValue,
                           Object newValue)
```
    This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
    
    Specified by:
    
    setObjectField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    newValue - the new value for the field
  - updateField
```
protected void updateField(Persistable pc,
                           int fieldNumber,
                           Object value)
```
    Convenience method to perform the update of a field value when a setter is invoked. Called by setXXXField methods.
    
    Parameters:
    
    pc - The PC object
    
    fieldNumber - The field number
    
    value - The new value
  - replaceField
```
protected void replaceField(Persistable pc,
                            int fieldNumber,
                            Object value)
```
    Method to change the value of a field in the PC object.
    
    Parameters:
    
    pc - The PC object
    
    fieldNumber - Number of field
    
    value - The new value of the field
  - disconnectClone
```
protected boolean disconnectClone(Persistable pc)
```
    Method to disconnect any cloned persistence capable objects from their StateManager.
    
    Parameters:
    
    pc - The Persistable object
    
    Returns:
    
    Whether the object was disconnected.
  - retrieveDetachState
```
public void retrieveDetachState(ObjectProvider op)
```
    Convenience method to retrieve the detach state from the passed ObjectProvider's object.
    
    Specified by:
    
    retrieveDetachState in interface ObjectProvider<Persistable>
    
    Parameters:
    
    op - ObjectProvider
  - resetDetachState
```
public void resetDetachState()
```
    Convenience method to reset the detached state in the current object.
    
    Specified by:
    
    resetDetachState in interface ObjectProvider<Persistable>
  - replacingDetachedState
```
public Object[] replacingDetachedState(Detachable pc,
                                       Object[] currentState)
```
    Method to update the "detached state" in the detached object to obtain the "detached state" from the detached object, or to reset it (to null).
    
    Specified by:
    
    replacingDetachedState in interface StateManager
    
    Parameters:
    
    pc - The Persistable beind updated
    
    currentState - The current state values
    
    Returns:
    
    The detached state to assign to the object
  - getBooleanField
```
public boolean getBooleanField(Persistable pc,
                               int fieldNumber,
                               boolean currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getBooleanField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - getByteField
```
public byte getByteField(Persistable pc,
                         int fieldNumber,
                         byte currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getByteField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - getCharField
```
public char getCharField(Persistable pc,
                         int fieldNumber,
                         char currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getCharField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - getDoubleField
```
public double getDoubleField(Persistable pc,
                             int fieldNumber,
                             double currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getDoubleField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - getFloatField
```
public float getFloatField(Persistable pc,
                           int fieldNumber,
                           float currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getFloatField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - getIntField
```
public int getIntField(Persistable pc,
                       int fieldNumber,
                       int currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getIntField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - getLongField
```
public long getLongField(Persistable pc,
                         int fieldNumber,
                         long currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getLongField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - getShortField
```
public short getShortField(Persistable pc,
                           int fieldNumber,
                           short currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getShortField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - getStringField
```
public String getStringField(Persistable pc,
                             int fieldNumber,
                             String currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getStringField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - getObjectField
```
public Object getObjectField(Persistable pc,
                             int fieldNumber,
                             Object currentValue)
```
    Description copied from interface: StateManager
    
    Return the value for the field.
    
    Specified by:
    
    getObjectField in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the field number
    
    currentValue - the current value of the field
    
    Returns:
    
    the new value for the field
  - checkInheritance
```
public void checkInheritance(FieldValues fv)
```
    Deprecated. Dont use this, to be removed
    
    Look to the database to determine which class this object is. This parameter is a hint. Set false, if it's already determined the correct pcClass for this pc "object" in a certain level in the hierarchy. Set to true and it will look to the database. TODO This is only called by some outdated code in LDAPUtils; remove it when that is fixed
    
    Specified by:
    
    checkInheritance in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fv - the initial field values of the object.
  - loadFieldValues
```
public void loadFieldValues(FieldValues fv)
```
    Convenience method to load the passed field values. Loads the fields using any required fetch plan and calls jdoPostLoad() as appropriate.
    
    Specified by:
    
    loadFieldValues in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fv - Field Values to load (including any fetch plan to use when loading)
  - makeDirty
```
public void makeDirty(int fieldNumber)
```
    Marks the given field dirty.
    
    Specified by:
    
    makeDirty in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumber - The no of field to mark as dirty.
  - makeDirty
```
public void makeDirty(Persistable pc,
                      String fieldName)
```
    Mark the associated Persistable field dirty.
    
    Specified by:
    
    makeDirty in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldName - the name of the field
  - getObjectId
```
public Object getObjectId(Persistable pc)
```
    Return the object representing the JDO identity of the calling instance. According to the JDO specification, if the JDO identity is being changed in the current transaction, this method returns the JDO identify as of the beginning of the transaction.
    
    Specified by:
    
    getObjectId in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    Returns:
    
    the object representing the JDO identity of the calling instance
  - getTransactionalObjectId
```
public Object getTransactionalObjectId(Persistable pc)
```
    Return the object representing the JDO identity of the calling instance. If the JDO identity is being changed in the current transaction, this method returns the current identity as changed in the transaction. In this implementation we don't allow change of identity so this is always the same as the result of getObjectId(Persistable).
    
    Specified by:
    
    getTransactionalObjectId in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    Returns:
    
    the object representing the JDO identity of the calling instance
  - setPostStoreNewObjectId
```
public void setPostStoreNewObjectId(Object id)
```
    If the id is obtained after inserting the object into the database, set new a new id for persistent classes (for example, increment).
    
    Specified by:
    
    setPostStoreNewObjectId in interface ObjectProvider<Persistable>
    
    Parameters:
    
    id - the id received from the datastore
  - getExternalObjectId
```
protected Object getExternalObjectId(Object obj)
```
    Return an object id that the user can use.
    
    Parameters:
    
    obj - the Persistable object
    
    Returns:
    
    the object id
  - getExternalObjectId
```
public Object getExternalObjectId()
```
    Return an object identity that can be used by the user for the managed object.
    
    Specified by:
    
    getExternalObjectId in interface ObjectProvider<Persistable>
    
    Returns:
    
    the object id
  - loadSpecifiedFields
```
protected void loadSpecifiedFields(int[] fieldNumbers)
```
    Fetch the specified fields from the database.
    
    Parameters:
    
    fieldNumbers - the numbers of the field(s) to fetch.
  - loadField
```
public void loadField(int fieldNumber)
```
    Convenience method to load the specified field if not loaded.
    
    Specified by:
    
    loadField in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumber - Absolute field number
  - loadUnloadedRelationFields
```
public void loadUnloadedRelationFields()
```
    Description copied from interface: ObjectProvider
    
    Loads (from the database) all unloaded fields that store relations.
    
    Specified by:
    
    loadUnloadedRelationFields in interface ObjectProvider<Persistable>
  - loadUnloadedFields
```
public void loadUnloadedFields()
```
    Fetch from the database all fields that are not currently loaded regardless of whether they are in the current fetch group or not. Called by lifecycle transitions.
    
    Specified by:
    
    loadUnloadedFields in interface ObjectProvider<Persistable>
  - loadUnloadedFieldsInFetchPlan
```
public void loadUnloadedFieldsInFetchPlan()
```
    Fetchs from the database all fields that are not currently loaded and that are in the current fetch group. Called by lifecycle transitions.
    
    Specified by:
    
    loadUnloadedFieldsInFetchPlan in interface ObjectProvider<Persistable>
  - loadUnloadedFieldsInFetchPlanAndVersion
```
protected void loadUnloadedFieldsInFetchPlanAndVersion()
```
    Fetchs from the database all fields in current fetch plan that are not currently loaded as well as the version. Called by lifecycle transitions.
  - loadUnloadedFieldsOfClassInFetchPlan
```
public void loadUnloadedFieldsOfClassInFetchPlan(FetchPlan fetchPlan)
```
    Fetchs from the database all fields in the actual fetch plan. Called by life-cycle transitions.
    
    Specified by:
    
    loadUnloadedFieldsOfClassInFetchPlan in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fetchPlan - The FetchPlan
  - refreshFieldsInFetchPlan
```
public void refreshFieldsInFetchPlan()
```
    Refreshes from the database all fields in fetch plan. Called by life-cycle transitions when the object undergoes a "transitionRefresh".
    
    Specified by:
    
    refreshFieldsInFetchPlan in interface ObjectProvider<Persistable>
  - refreshLoadedFields
```
public void refreshLoadedFields()
```
    Refreshes from the database all fields currently loaded. Called by life-cycle transitions when making transactional or reading fields.
    
    Specified by:
    
    refreshLoadedFields in interface ObjectProvider<Persistable>
  - isLoaded
```
public boolean isLoaded(int fieldNumber)
```
    Returns the loaded setting for the field of the managed object. Refer to the javadoc of isLoaded(Persistable, int);
    
    Specified by:
    
    isLoaded in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumber - the absolute field number
    
    Returns:
    
    always returns true (this implementation)
  - isLoaded
```
public boolean isLoaded(Persistable pc,
                        int fieldNumber)
```
    Return true if the field is cached in the calling instance. In this implementation, isLoaded() will always return true. If the field is not loaded, it will be loaded as a side effect of the call to this method. If it is in the default fetch group, the default fetch group, including this field, will be loaded.
    
    Specified by:
    
    isLoaded in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
    
    fieldNumber - the absolute field number
    
    Returns:
    
    always returns true (this implementation)
  - replaceFieldValue
```
public void replaceFieldValue(int fieldNumber,
                              Object newValue)
```
    Convenience method to change the value of a field that is assumed loaded. Will mark the object/field as dirty if it isn't previously. If the object is deleted then does nothing. Doesn't cater for embedded fields. *** Only for use in management of relations. ***
    
    Specified by:
    
    replaceFieldValue in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumber - Number of field
    
    newValue - The new value
  - replaceField
```
public void replaceField(int fieldNumber,
                         Object value)
```
    Method to change the value of a particular field and not mark it dirty.
    
    Specified by:
    
    replaceField in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumber - Number of field
    
    value - New value
  - replaceFieldMakeDirty
```
public void replaceFieldMakeDirty(int fieldNumber,
                                  Object value)
```
    Method to change the value of a particular field and mark it dirty.
    
    Specified by:
    
    replaceFieldMakeDirty in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumber - Number of field
    
    value - New value
  - replaceField
```
protected void replaceField(Persistable pc,
                            int fieldNumber,
                            Object value,
                            boolean makeDirty)
```
    Method to change the value of a field in the PC object. Adds on handling for embedded fields to the superclass handler.
    
    Parameters:
    
    pc - The PC object
    
    fieldNumber - Number of field
    
    value - The new value of the field
    
    makeDirty - Whether to make the field dirty while replacing its value (in embedded owners)
  - replaceFields
```
public void replaceFields(int[] fieldNumbers,
                          FieldManager fm,
                          boolean replaceWhenDirty)
```
    Called from the StoreManager to refresh data in the Persistable object associated with this StateManager.
    
    Specified by:
    
    replaceFields in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumbers - An array of field numbers to be refreshed by the Store
    
    fm - The updated values are stored in this object. This object is only valid for the duration of this call.
    
    replaceWhenDirty - Whether to replace the fields when they are dirty here
  - replaceFields
```
public void replaceFields(int[] fieldNumbers,
                          FieldManager fm)
```
    Called from the StoreManager to refresh data in the Persistable object associated with this StateManager.
    
    Specified by:
    
    replaceFields in interface ObjectProvider<Persistable>
    
    Specified by:
    
    replaceFields in class AbstractStateManager<Persistable>
    
    Parameters:
    
    fieldNumbers - An array of field numbers to be refreshed by the Store
    
    fm - The updated values are stored in this object. This object is only valid for the duration of this call.
  - replaceNonLoadedFields
```
public void replaceNonLoadedFields(int[] fieldNumbers,
                                   FieldManager fm)
```
    Called from the StoreManager to refresh data in the Persistable object associated with this StateManager. Only not loaded fields are refreshed
    
    Specified by:
    
    replaceNonLoadedFields in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumbers - An array of field numbers to be refreshed by the Store
    
    fm - The updated values are stored in this object. This object is only valid for the duration of this call.
  - replaceAllLoadedSCOFieldsWithWrappers
```
public void replaceAllLoadedSCOFieldsWithWrappers()
```
    Method to replace all loaded SCO fields with wrappers. If the loaded field already uses a SCO wrapper nothing happens to that field.
    
    Specified by:
    
    replaceAllLoadedSCOFieldsWithWrappers in interface ObjectProvider<Persistable>
  - replaceAllLoadedSCOFieldsWithValues
```
public void replaceAllLoadedSCOFieldsWithValues()
```
    Method to replace all loaded SCO fields that have wrappers with their value. If the loaded field doesnt have a SCO wrapper nothing happens to that field.
    
    Specified by:
    
    replaceAllLoadedSCOFieldsWithValues in interface ObjectProvider<Persistable>
  - updateOwnerFieldInEmbeddedField
```
public void updateOwnerFieldInEmbeddedField(int fieldNumber,
                                            Object value)
```
    Method to update the "owner-field" in an embedded object with the owner object. TODO Likely this should be moved into a replaceField method, or maybe Managed Relationships.
    
    Specified by:
    
    updateOwnerFieldInEmbeddedField in interface ObjectProvider<Persistable>
    
    Parameters:
    
    fieldNumber - The field number
    
    value - The value to initialise the wrapper with (if any)
  - makePersistent
```
public void makePersistent()
```
    Method to make the object persistent.
    
    Specified by:
    
    makePersistent in interface ObjectProvider<Persistable>
  - makeTransactional
```
public void makeTransactional()
```
    Method to change the object state to transactional.
    
    Specified by:
    
    makeTransactional in interface ObjectProvider<Persistable>
  - makeTransient
```
public void makeTransient(FetchPlanState state)
```
    Method to change the object state to transient.
    
    Specified by:
    
    makeTransient in interface ObjectProvider<Persistable>
    
    Parameters:
    
    state - Object containing the state of any fetchplan processing
  - detach
```
public void detach(FetchPlanState state)
```
    Method to detach this object. If the object is detachable then it will be migrated to DETACHED state, otherwise will migrate to TRANSIENT. Used by "DetachAllOnCommit"/"DetachAllOnRollback"
    
    Specified by:
    
    detach in interface ObjectProvider<Persistable>
    
    Parameters:
    
    state - State for the detachment process
  - detachCopy
```
public Persistable detachCopy(FetchPlanState state)
```
    Method to make detached copy of this instance If the object is detachable then the copy will be migrated to DETACHED state, otherwise will migrate the copy to TRANSIENT. Used by "ExecutionContext.detachObjectCopy()".
    
    Specified by:
    
    detachCopy in interface ObjectProvider<Persistable>
    
    Parameters:
    
    state - State for the detachment process
    
    Returns:
    
    the detached Persistable instance
  - attach
```
public void attach(Persistable detachedPC)
```
    Description copied from interface: ObjectProvider
    
    Method to attach the provided detached object into the managed instance.
    
    Specified by:
    
    attach in interface ObjectProvider<Persistable>
    
    Parameters:
    
    detachedPC - Detached object
  - attach
```
public void attach(boolean embedded)
```
    Method to attach the object managed by this StateManager.
    
    Specified by:
    
    attach in interface ObjectProvider<Persistable>
    
    Parameters:
    
    embedded - Whether it is embedded
  - attachCopy
```
public Persistable attachCopy(Persistable detachedPC,
                              boolean embedded)
```
    Method to attach a copy of the detached persistable instance and return the (attached) copy.
    
    Specified by:
    
    attachCopy in interface ObjectProvider<Persistable>
    
    Parameters:
    
    detachedPC - the detached persistable instance to be attached
    
    embedded - Whether the object is stored embedded/serialised in another object
    
    Returns:
    
    The attached copy
  - deletePersistent
```
public void deletePersistent()
```
    Method to delete the object from persistence.
    
    Specified by:
    
    deletePersistent in interface ObjectProvider<Persistable>
  - validate
```
public void validate()
```
    Validates whether the persistence capable instance exists in the datastore. If the instance doesn't exist in the datastore, this method will fail raising a NucleusObjectNotFoundException. If the object is transactional then does nothing. If the object has unloaded (non-SCO, non-PK) fetch plan fields then fetches them. Else it checks the existence of the object in the datastore.
    
    Specified by:
    
    validate in interface ObjectProvider<Persistable>
  - preWriteField
```
protected boolean preWriteField(int fieldNumber)
```
    Method called before a write of the specified field.
    
    Parameters:
    
    fieldNumber - The field to write
    
    Returns:
    
    true if the field was already dirty before
  - postWriteField
```
protected void postWriteField(boolean wasDirty)
```
    Method called after the write of a field.
    
    Parameters:
    
    wasDirty - whether before writing this field the pc was dirty
  - postStateChange
```
protected void postStateChange()
```
    Method called after a change in state.
    
    Specified by:
    
    postStateChange in class AbstractStateManager<Persistable>
  - preSerialize
```
public void preSerialize(Persistable pc)
```
    Guarantee that the serializable transactional and persistent fields are loaded into the instance. This method is called by the generated jdoPreSerialize method prior to serialization of the instance.
    
    Specified by:
    
    preSerialize in interface StateManager
    
    Parameters:
    
    pc - the calling Persistable instance
  - flush
```
public void flush()
```
    Flushes any outstanding changes to the object to the datastore. This will process :-
    - Any objects that have been marked as provisionally persistent yet haven't been flushed to the datastore.
    - Any objects that have been marked as provisionally deleted yet haven't been flushed to the datastore.
    - Any fields that have been updated.
    Specified by:
    
    flush in interface ObjectProvider<Persistable>
  - dump
```
public void dump(PrintWriter out)
```
    Utility to dump the contents of the StateManager.
    
    Parameters:
    
    out - PrintWriter to dump to
  - peekField
```
protected static Object peekField(Object obj,
                                  String fieldName)
```
    Utility to take a peek at a field in the persistable object.
    
    Parameters:
    
    obj - The persistable object
    
    fieldName - The field to peek at
    
    Returns:
    
    The value of the field.
  - changeActivityState
```
public void changeActivityState(ActivityState state)
```
    Description copied from interface: ObjectProvider
    
    Update the acitvity state.
    
    Specified by:
    
    changeActivityState in interface ObjectProvider<Persistable>
    
    Parameters:
    
    state - the activity state
  - updateFieldAfterInsert
```
public void updateFieldAfterInsert(Object pc,
                                   int fieldNumber)
```
    Description copied from interface: ObjectProvider
    
    Marks the given field dirty for issuing an update after the insert.
    
    Specified by:
    
    updateFieldAfterInsert in interface ObjectProvider<Persistable>
    
    Parameters:
    
    pc - The Persistable object
    
    fieldNumber - The no of field to mark as dirty.
  - copyFieldsFromObject
```
public void copyFieldsFromObject(Object obj,
                                 int[] fieldNumbers)
```
    Convenience method to update our object with the field values from the passed object. Objects need to be of the same type, and the other object should not have a StateManager. TODO Only used by XML plugin so strip this out into a convenience method.
    
    Specified by:
    
    copyFieldsFromObject in interface ObjectProvider<Persistable>
    
    Parameters:
    
    obj - The object that we should copy fields from
    
    fieldNumbers - Numbers of fields to copy

Class StateManagerImpl

Embedded/Serialised Objects

Performance and Memory

Field Summary

Fields inherited from class org.datanucleus.state.AbstractStateManager

Fields inherited from interface org.datanucleus.state.ObjectProvider

Constructor Summary

Method Summary

Methods inherited from class org.datanucleus.state.AbstractStateManager

Methods inherited from class java.lang.Object

Methods inherited from interface org.datanucleus.enhancement.StateManager

Field Detail

savedImage

Constructor Detail

StateManagerImpl

Method Detail

connect

disconnect

initialiseForHollow

initialiseForHollowAppId

initialiseForHollowPreConstructed

initialiseForPersistentClean

initialiseForEmbedded

initialiseForPersistentNew

initialiseForTransactionalTransient

initialiseForDetached

initialiseForPNewToBeDeleted

initialiseForCachedPC

getObject

saveFields

clearSavedFields

restoreFields

enlistInTransaction

evictFromTransaction

replaceStateManager

replacingStateManager

replaceManagedPC

getExecutionContext

isDirty

isTransactional

isPersistent

isNew

isDeleted

isDeleted

getVersion

getVersion

getTransactionalVersion

clearFields

clearNonPrimaryKeyFields

clearLoadedFlags

replacingFlags

provideField

provideField

provideFields

setBooleanField

setByteField

setCharField

setDoubleField

setFloatField

setIntField

setLongField

setShortField

setStringField

setObjectField

updateField

replaceField

disconnectClone

retrieveDetachState

resetDetachState

replacingDetachedState

getBooleanField

getByteField

getCharField

getDoubleField

getFloatField

getIntField

getLongField

getShortField

getStringField

getObjectField