org.jpox.state
Class AbstractFetchFieldManager

java.lang.Object
  org.jpox.store.fieldmanager.AbstractFieldManager
      org.jpox.state.AbstractFetchFieldManager

All Implemented Interfaces:

javax.jdo.spi.PersistenceCapable.ObjectIdFieldConsumer, javax.jdo.spi.PersistenceCapable.ObjectIdFieldManager, javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier, FieldManager

Direct Known Subclasses:

DetachFieldManager, MakeTransientFieldManager

public abstract class AbstractFetchFieldManager
extends AbstractFieldManager

Base field manager for handling the fetching of fields. Supports a FetchPlan to navigate down an object graph. This is extended by specific managers for the detachment and makeTransient processes.

Version:

$Revision: 1.10 $

Nested Class Summary

static class

AbstractFetchFieldManager.EndOfFetchPlanGraphException Exception thrown when we reach the end of the fetch depth in a branch of the object graph

Field Summary

protected FetchPlanImpl.FetchPlanForClass	fpClass Fetch Plan for the class of this object.
protected boolean[]	secondClassMutableFields Second class mutable fields for the class of this object.
protected StateManager	sm StateManager of the instance being fetched (detached or made transient).
protected FetchPlanState	state State for the fetch process.

Constructor Summary

AbstractFetchFieldManager(StateManager sm, boolean[] secondClassMutableFields, FetchPlanImpl.FetchPlanForClass fpClass, FetchPlanState state)
Constructor for a field manager for fetch plan processing.

Method Summary

protected abstract java.lang.Object	endOfGraphOperation(int fieldNumber) Method called when an end of graph is encountered.
boolean	fetchBooleanField(int fieldNumber)
byte	fetchByteField(int fieldNumber)
char	fetchCharField(int fieldNumber)
double	fetchDoubleField(int fieldNumber)
float	fetchFloatField(int fieldNumber)
int	fetchIntField(int fieldNumber)
long	fetchLongField(int fieldNumber)
java.lang.Object	fetchObjectField(int fieldNumber) Method to fetch an object field whether it is SCO collection, PC, or whatever.
short	fetchShortField(int fieldNumber)
java.lang.String	fetchStringField(int fieldNumber)
protected abstract java.lang.Object	internalFetchObjectField(int fieldNumber) Method to fetch an object field whether it is SCO collection, PC, or whatever.

Methods inherited from class org.jpox.store.fieldmanager.AbstractFieldManager

storeBooleanField, storeByteField, storeCharField, storeDoubleField, storeFloatField, storeIntField, storeLongField, storeObjectField, storeShortField, storeStringField

Methods inherited from class java.lang.Object

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

Field Detail

sm

protected final StateManager sm

StateManager of the instance being fetched (detached or made transient).

secondClassMutableFields

protected final boolean[] secondClassMutableFields

Second class mutable fields for the class of this object.

fpClass

protected FetchPlanImpl.FetchPlanForClass fpClass

Fetch Plan for the class of this object.

state

protected final FetchPlanState state

State for the fetch process.

Constructor Detail

AbstractFetchFieldManager

public AbstractFetchFieldManager(StateManager sm,
                                 boolean[] secondClassMutableFields,
                                 FetchPlanImpl.FetchPlanForClass fpClass,
                                 FetchPlanState state)

Constructor for a field manager for fetch plan processing.

Parameters:

sm - the StateManager of the instance being processed.

secondClassMutableFields -

fpClass - Fetch Plan for the class of this instance

state - Object containing the state of the fetch process

Method Detail

fetchObjectField

public java.lang.Object fetchObjectField(int fieldNumber)
                                  throws AbstractFetchFieldManager.EndOfFetchPlanGraphException

Method to fetch an object field whether it is SCO collection, PC, or whatever.

Specified by:

fetchObjectField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchObjectField in class AbstractFieldManager

Parameters:

fieldNumber - Number of the field

Returns:

The object

Throws:

AbstractFetchFieldManager.EndOfFetchPlanGraphException

internalFetchObjectField

protected abstract java.lang.Object internalFetchObjectField(int fieldNumber)

Method to fetch an object field whether it is SCO collection, PC, or whatever.

Parameters:

fieldNumber - Number of the field

Returns:

The object

endOfGraphOperation

protected abstract java.lang.Object endOfGraphOperation(int fieldNumber)

Method called when an end of graph is encountered.

Parameters:

fieldNumber - Number of the field

Returns:

Object to return

fetchBooleanField

public boolean fetchBooleanField(int fieldNumber)

Specified by:

fetchBooleanField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchBooleanField in class AbstractFieldManager

fetchByteField

public byte fetchByteField(int fieldNumber)

Specified by:

fetchByteField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchByteField in class AbstractFieldManager

fetchCharField

public char fetchCharField(int fieldNumber)

Specified by:

fetchCharField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchCharField in class AbstractFieldManager

fetchDoubleField

public double fetchDoubleField(int fieldNumber)

Specified by:

fetchDoubleField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchDoubleField in class AbstractFieldManager

fetchFloatField

public float fetchFloatField(int fieldNumber)

Specified by:

fetchFloatField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchFloatField in class AbstractFieldManager

fetchIntField

public int fetchIntField(int fieldNumber)

Specified by:

fetchIntField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchIntField in class AbstractFieldManager

fetchLongField

public long fetchLongField(int fieldNumber)

Specified by:

fetchLongField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchLongField in class AbstractFieldManager

fetchShortField

public short fetchShortField(int fieldNumber)

Specified by:

fetchShortField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchShortField in class AbstractFieldManager

fetchStringField

public java.lang.String fetchStringField(int fieldNumber)

Specified by:

fetchStringField in interface javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier

Overrides:

fetchStringField in class AbstractFieldManager