com.solarmetric.kodo.runtime
Class StateManagerImpl

java.lang.Object
  |
  +--com.solarmetric.kodo.runtime.FieldManager
        |
        +--com.solarmetric.kodo.runtime.StateManagerImpl

All Implemented Interfaces:

PersistenceCapable.ObjectIdFieldConsumer, PersistenceCapable.ObjectIdFieldManager, PersistenceCapable.ObjectIdFieldSupplier, StateManager

public class StateManagerImpl

extends com.solarmetric.kodo.runtime.FieldManager

implements StateManager

Implementation of the StateManager interface for use with this runtime. Each StateManager manages the state of a single PersistenceCapable instance. The StateManager is also responsible for all communications about the instance to the StoreManager.

The StateManager uses the State pattern in both its interaction with the governed instance and its interaction with the PersistenceManager. In its interactions with the PersistenceCapable instance, it uses the FieldManager interface. Similarly, when interacting with the PersistenceManager, it uses the JDOState singleton that represents the current lifecycle state of the instance.

Method Summary

boolean	fetchBooleanField(int field)
byte	fetchByteField(int field)
char	fetchCharField(int field)
double	fetchDoubleField(int field)
float	fetchFloatField(int field)
int	fetchIntField(int field)
long	fetchLongField(int field)
Object	fetchObjectField(int field)
short	fetchShortField(int field)
String	fetchStringField(int field)
boolean	getBooleanField(PersistenceCapable pc, int field, boolean curVal)
byte	getByteField(PersistenceCapable pc, int field, byte curVal)
char	getCharField(PersistenceCapable pc, int field, char curVal)
BitSet	getDirty() Return which fields are dirty; should not be modified.
double	getDoubleField(PersistenceCapable pc, int field, double curVal)
float	getFloatField(PersistenceCapable pc, int field, float curVal)
Object	getImplData(Object key) Return the associated implementation object for the given key, if any.
int	getIntField(PersistenceCapable pc, int field, int curVal)
com.solarmetric.kodo.runtime.JDOState	getJDOState() Return the JDO state that this object is in.
BitSet	getLoaded() Return which fields are loaded; should not be modified.
long	getLongField(PersistenceCapable pc, int field, long curVal)
ClassMetaData	getMetaData() Return the metadata for the managed type.
Object	getNextVersion() Return the pending version indicator after successful commit.
Object	getObjectField(PersistenceCapable pc, int field, Object curVal)
Object	getObjectId(PersistenceCapable pc)
Object	getOid() Return the object ID of the instance.
PersistenceCapable	getPersistenceCapable() Return the PersistenceCapable instance managed by this StateManager.
PersistenceManagerImpl	getPersistenceManager() Return the owning PersistenceManagerImpl.
PersistenceManager	getPersistenceManager(PersistenceCapable pc)
short	getShortField(PersistenceCapable pc, int field, short curVal)
String	getStringField(PersistenceCapable pc, int field, String curVal)
Object	getTransactionalObjectId(PersistenceCapable pc)
Object	getVersion() Return the current version indicator.
void	initialize(PersistenceCapable pc, com.solarmetric.kodo.runtime.JDOState state) Initialize this state manager with the managed persistence capable object and the proper JDO lifecycle state.
boolean	isDeleted(PersistenceCapable pc)
boolean	isDirty(PersistenceCapable pc)
boolean	isLoaded(PersistenceCapable pc, int field)
boolean	isNew(PersistenceCapable pc)
boolean	isPersistent(PersistenceCapable pc)
boolean	isTransactional(PersistenceCapable pc)
void	makeDirty(PersistenceCapable pc, String field)
void	preSerialize(PersistenceCapable pc)
void	providedBooleanField(PersistenceCapable pc, int field, boolean curVal)
void	providedByteField(PersistenceCapable pc, int field, byte curVal)
void	providedCharField(PersistenceCapable pc, int field, char curVal)
void	providedDoubleField(PersistenceCapable pc, int field, double curVal)
void	providedFloatField(PersistenceCapable pc, int field, float curVal)
void	providedIntField(PersistenceCapable pc, int field, int curVal)
void	providedLongField(PersistenceCapable pc, int field, long curVal)
void	providedObjectField(PersistenceCapable pc, int field, Object curVal)
void	providedShortField(PersistenceCapable pc, int field, short curVal)
void	providedStringField(PersistenceCapable pc, int field, String curVal)
Object	queryField(String field) Return the value of the named field for use in a query.
void	removeImplData(Object key) Remove the given key from the store of implementation-specific data.
boolean	replacingBooleanField(PersistenceCapable pc, int field)
byte	replacingByteField(PersistenceCapable pc, int field)
char	replacingCharField(PersistenceCapable pc, int field)
double	replacingDoubleField(PersistenceCapable pc, int field)
byte	replacingFlags(PersistenceCapable pc)
float	replacingFloatField(PersistenceCapable pc, int field)
int	replacingIntField(PersistenceCapable pc, int field)
long	replacingLongField(PersistenceCapable pc, int field)
Object	replacingObjectField(PersistenceCapable pc, int field)
short	replacingShortField(PersistenceCapable pc, int field)
StateManager	replacingStateManager(PersistenceCapable pc, StateManager sm)
String	replacingStringField(PersistenceCapable pc, int field)
void	setBooleanField(PersistenceCapable pc, int field, boolean curVal, boolean newVal)
void	setByteField(PersistenceCapable pc, int field, byte curVal, byte newVal)
void	setCharField(PersistenceCapable pc, int field, char curVal, char newVal)
void	setDoubleField(PersistenceCapable pc, int field, double curVal, double newVal)
void	setFloatField(PersistenceCapable pc, int field, float curVal, float newVal)
void	setImplData(Object key, Object value) This method is provided to the concrete JDO implementation to allow the association of arbitrary extra data with an instance.
void	setIntField(PersistenceCapable pc, int field, int curVal, int newVal)
void	setLongField(PersistenceCapable pc, int field, long curVal, long newVal)
void	setNextVersion(Object version) Set the version indicator that this object should have after successful commit.
void	setObjectField(PersistenceCapable pc, int field, Object curVal, Object newVal)
void	setShortField(PersistenceCapable pc, int field, short curVal, short newVal)
void	setStringField(PersistenceCapable pc, int field, String curVal, String newVal)
void	setVersion(Object version) Set the current version indicator.
void	storeBooleanField(int field, boolean curVal)
void	storeByteField(int field, byte curVal)
void	storeCharField(int field, char curVal)
void	storeDoubleField(int field, double curVal)
void	storeFloatField(int field, float curVal)
void	storeIntField(int field, int curVal)
void	storeLongField(int field, long curVal)
void	storeObjectField(int field, Object curVal)
void	storeShortField(int field, short curVal)
void	storeStringField(int field, String curVal)

Methods inherited from class java.lang.Object

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

Method Detail

getPersistenceCapable

public final PersistenceCapable getPersistenceCapable()

Return the PersistenceCapable instance managed by this StateManager.

getPersistenceManager

public final PersistenceManagerImpl getPersistenceManager()

Return the owning PersistenceManagerImpl.

getOid

public final Object getOid()

Return the object ID of the instance.

getMetaData

public final ClassMetaData getMetaData()

Return the metadata for the managed type.

getLoaded

public final BitSet getLoaded()

Return which fields are loaded; should not be modified.

getDirty

public final BitSet getDirty()

Return which fields are dirty; should not be modified.

initialize

public void initialize(PersistenceCapable pc,
                       com.solarmetric.kodo.runtime.JDOState state)

Initialize this state manager with the managed persistence capable object and the proper JDO lifecycle state.

getVersion

public Object getVersion()

Return the current version indicator.

setVersion

public void setVersion(Object version)

Set the current version indicator. This method is used by the StoreManager during load to initialize version information. It represents the current version in the database of this row.

getNextVersion

public Object getNextVersion()

Return the pending version indicator after successful commit. This pending version will be the same as the current version prior to flush.

setNextVersion

public void setNextVersion(Object version)

Set the version indicator that this object should have after successful commit. The StoreManager is responsible for calling this method during flush. This will be the same as the current version for newly created objects.

getJDOState

public com.solarmetric.kodo.runtime.JDOState getJDOState()

Return the JDO state that this object is in.

getImplData

public Object getImplData(Object key)

Return the associated implementation object for the given key, if any.

removeImplData

public void removeImplData(Object key)

Remove the given key from the store of implementation-specific data.

setImplData

public void setImplData(Object key,
                        Object value)

This method is provided to the concrete JDO implementation to allow the association of arbitrary extra data with an instance.

queryField

public Object queryField(String field)

Return the value of the named field for use in a query. This method will cause state transitions to occur as if the field were accessed normally.

preSerialize

public void preSerialize(PersistenceCapable pc)

Specified by:

preSerialize in interface StateManager

isTransactional

public boolean isTransactional(PersistenceCapable pc)

Specified by:

isTransactional in interface StateManager

isPersistent

public boolean isPersistent(PersistenceCapable pc)

Specified by:

isPersistent in interface StateManager

isNew

public boolean isNew(PersistenceCapable pc)

Specified by:

isNew in interface StateManager

isDeleted

public boolean isDeleted(PersistenceCapable pc)

Specified by:

isDeleted in interface StateManager

isDirty

public boolean isDirty(PersistenceCapable pc)

Specified by:

isDirty in interface StateManager

getPersistenceManager

public PersistenceManager getPersistenceManager(PersistenceCapable pc)

Specified by:

getPersistenceManager in interface StateManager

getObjectId

public Object getObjectId(PersistenceCapable pc)

Specified by:

getObjectId in interface StateManager

getTransactionalObjectId

public Object getTransactionalObjectId(PersistenceCapable pc)

Specified by:

getTransactionalObjectId in interface StateManager

replacingFlags

public final byte replacingFlags(PersistenceCapable pc)

Specified by:

replacingFlags in interface StateManager

replacingStateManager

public StateManager replacingStateManager(PersistenceCapable pc,
                                          StateManager sm)

Specified by:

replacingStateManager in interface StateManager

isLoaded

public boolean isLoaded(PersistenceCapable pc,
                        int field)

Specified by:

isLoaded in interface StateManager

makeDirty

public void makeDirty(PersistenceCapable pc,
                      String field)

Specified by:

makeDirty in interface StateManager

getBooleanField

public boolean getBooleanField(PersistenceCapable pc,
                               int field,
                               boolean curVal)

Specified by:

getBooleanField in interface StateManager

getByteField

public byte getByteField(PersistenceCapable pc,
                         int field,
                         byte curVal)

Specified by:

getByteField in interface StateManager

getCharField

public char getCharField(PersistenceCapable pc,
                         int field,
                         char curVal)

Specified by:

getCharField in interface StateManager

getDoubleField

public double getDoubleField(PersistenceCapable pc,
                             int field,
                             double curVal)

Specified by:

getDoubleField in interface StateManager

getFloatField

public float getFloatField(PersistenceCapable pc,
                           int field,
                           float curVal)

Specified by:

getFloatField in interface StateManager

getIntField

public int getIntField(PersistenceCapable pc,
                       int field,
                       int curVal)

Specified by:

getIntField in interface StateManager

getLongField

public long getLongField(PersistenceCapable pc,
                         int field,
                         long curVal)

Specified by:

getLongField in interface StateManager

getObjectField

public Object getObjectField(PersistenceCapable pc,
                             int field,
                             Object curVal)

Specified by:

getObjectField in interface StateManager

getShortField

public short getShortField(PersistenceCapable pc,
                           int field,
                           short curVal)

Specified by:

getShortField in interface StateManager

getStringField

public String getStringField(PersistenceCapable pc,
                             int field,
                             String curVal)

Specified by:

getStringField in interface StateManager

setBooleanField

public void setBooleanField(PersistenceCapable pc,
                            int field,
                            boolean curVal,
                            boolean newVal)

Specified by:

setBooleanField in interface StateManager

setByteField

public void setByteField(PersistenceCapable pc,
                         int field,
                         byte curVal,
                         byte newVal)

Specified by:

setByteField in interface StateManager

setCharField

public void setCharField(PersistenceCapable pc,
                         int field,
                         char curVal,
                         char newVal)

Specified by:

setCharField in interface StateManager

setDoubleField

public void setDoubleField(PersistenceCapable pc,
                           int field,
                           double curVal,
                           double newVal)

Specified by:

setDoubleField in interface StateManager

setFloatField

public void setFloatField(PersistenceCapable pc,
                          int field,
                          float curVal,
                          float newVal)

Specified by:

setFloatField in interface StateManager

setIntField

public void setIntField(PersistenceCapable pc,
                        int field,
                        int curVal,
                        int newVal)

Specified by:

setIntField in interface StateManager

setLongField

public void setLongField(PersistenceCapable pc,
                         int field,
                         long curVal,
                         long newVal)

Specified by:

setLongField in interface StateManager

setObjectField

public void setObjectField(PersistenceCapable pc,
                           int field,
                           Object curVal,
                           Object newVal)

Specified by:

setObjectField in interface StateManager

setShortField

public void setShortField(PersistenceCapable pc,
                          int field,
                          short curVal,
                          short newVal)

Specified by:

setShortField in interface StateManager

setStringField

public void setStringField(PersistenceCapable pc,
                           int field,
                           String curVal,
                           String newVal)

Specified by:

setStringField in interface StateManager

providedBooleanField

public void providedBooleanField(PersistenceCapable pc,
                                 int field,
                                 boolean curVal)

Specified by:

providedBooleanField in interface StateManager

providedByteField

public void providedByteField(PersistenceCapable pc,
                              int field,
                              byte curVal)

Specified by:

providedByteField in interface StateManager

providedCharField

public void providedCharField(PersistenceCapable pc,
                              int field,
                              char curVal)

Specified by:

providedCharField in interface StateManager

providedDoubleField

public void providedDoubleField(PersistenceCapable pc,
                                int field,
                                double curVal)

Specified by:

providedDoubleField in interface StateManager

providedFloatField

public void providedFloatField(PersistenceCapable pc,
                               int field,
                               float curVal)

Specified by:

providedFloatField in interface StateManager

providedIntField

public void providedIntField(PersistenceCapable pc,
                             int field,
                             int curVal)

Specified by:

providedIntField in interface StateManager

providedLongField

public void providedLongField(PersistenceCapable pc,
                              int field,
                              long curVal)

Specified by:

providedLongField in interface StateManager

providedObjectField

public void providedObjectField(PersistenceCapable pc,
                                int field,
                                Object curVal)

Specified by:

providedObjectField in interface StateManager

providedShortField

public void providedShortField(PersistenceCapable pc,
                               int field,
                               short curVal)

Specified by:

providedShortField in interface StateManager

providedStringField

public void providedStringField(PersistenceCapable pc,
                                int field,
                                String curVal)

Specified by:

providedStringField in interface StateManager

replacingBooleanField

public boolean replacingBooleanField(PersistenceCapable pc,
                                     int field)

Specified by:

replacingBooleanField in interface StateManager

replacingByteField

public byte replacingByteField(PersistenceCapable pc,
                               int field)

Specified by:

replacingByteField in interface StateManager

replacingCharField

public char replacingCharField(PersistenceCapable pc,
                               int field)

Specified by:

replacingCharField in interface StateManager

replacingDoubleField

public double replacingDoubleField(PersistenceCapable pc,
                                   int field)

Specified by:

replacingDoubleField in interface StateManager

replacingFloatField

public float replacingFloatField(PersistenceCapable pc,
                                 int field)

Specified by:

replacingFloatField in interface StateManager

replacingIntField

public int replacingIntField(PersistenceCapable pc,
                             int field)

Specified by:

replacingIntField in interface StateManager

replacingLongField

public long replacingLongField(PersistenceCapable pc,
                               int field)

Specified by:

replacingLongField in interface StateManager

replacingObjectField

public Object replacingObjectField(PersistenceCapable pc,
                                   int field)

Specified by:

replacingObjectField in interface StateManager

replacingShortField

public short replacingShortField(PersistenceCapable pc,
                                 int field)

Specified by:

replacingShortField in interface StateManager

replacingStringField

public String replacingStringField(PersistenceCapable pc,
                                   int field)

Specified by:

replacingStringField in interface StateManager

fetchBooleanField

public boolean fetchBooleanField(int field)

Overrides:

fetchBooleanField in class com.solarmetric.kodo.runtime.FieldManager

fetchByteField

public byte fetchByteField(int field)

Overrides:

fetchByteField in class com.solarmetric.kodo.runtime.FieldManager

fetchCharField

public char fetchCharField(int field)

Overrides:

fetchCharField in class com.solarmetric.kodo.runtime.FieldManager

fetchDoubleField

public double fetchDoubleField(int field)

Overrides:

fetchDoubleField in class com.solarmetric.kodo.runtime.FieldManager

fetchFloatField

public float fetchFloatField(int field)

Overrides:

fetchFloatField in class com.solarmetric.kodo.runtime.FieldManager

fetchIntField

public int fetchIntField(int field)

Overrides:

fetchIntField in class com.solarmetric.kodo.runtime.FieldManager

fetchLongField

public long fetchLongField(int field)

Overrides:

fetchLongField in class com.solarmetric.kodo.runtime.FieldManager

fetchObjectField

public Object fetchObjectField(int field)

Overrides:

fetchObjectField in class com.solarmetric.kodo.runtime.FieldManager

fetchShortField

public short fetchShortField(int field)

Overrides:

fetchShortField in class com.solarmetric.kodo.runtime.FieldManager

fetchStringField

public String fetchStringField(int field)

Overrides:

fetchStringField in class com.solarmetric.kodo.runtime.FieldManager

storeBooleanField

public void storeBooleanField(int field,
                              boolean curVal)

Overrides:

storeBooleanField in class com.solarmetric.kodo.runtime.FieldManager

storeByteField

public void storeByteField(int field,
                           byte curVal)

Overrides:

storeByteField in class com.solarmetric.kodo.runtime.FieldManager

storeCharField

public void storeCharField(int field,
                           char curVal)

Overrides:

storeCharField in class com.solarmetric.kodo.runtime.FieldManager

storeDoubleField

public void storeDoubleField(int field,
                             double curVal)

Overrides:

storeDoubleField in class com.solarmetric.kodo.runtime.FieldManager

storeFloatField

public void storeFloatField(int field,
                            float curVal)

Overrides:

storeFloatField in class com.solarmetric.kodo.runtime.FieldManager

storeIntField

public void storeIntField(int field,
                          int curVal)

Overrides:

storeIntField in class com.solarmetric.kodo.runtime.FieldManager

storeLongField

public void storeLongField(int field,
                           long curVal)

Overrides:

storeLongField in class com.solarmetric.kodo.runtime.FieldManager

storeObjectField

public void storeObjectField(int field,
                             Object curVal)

Overrides:

storeObjectField in class com.solarmetric.kodo.runtime.FieldManager

storeShortField

public void storeShortField(int field,
                            short curVal)

Overrides:

storeShortField in class com.solarmetric.kodo.runtime.FieldManager

storeStringField

public void storeStringField(int field,
                             String curVal)

Overrides:

storeStringField in class com.solarmetric.kodo.runtime.FieldManager