org.apache.jdo.impl.fostore
Class InsertRequest

java.lang.Object
  org.apache.jdo.impl.fostore.AbstractRequest
      org.apache.jdo.impl.fostore.AbstractFieldRequest
          org.apache.jdo.impl.fostore.InsertRequest

All Implemented Interfaces:

org.apache.jdo.state.FieldManager, Request

Direct Known Subclasses:

UpdateRequest, VerifyRequest

class InsertRequest

extends AbstractFieldRequest

Represents a request to write a new object to the datastore.

Version:

1.0.1

Author:

Dave Bristor

Field Summary

private int[]	clidOffsets
private java.util.Set	clids
private java.lang.Class	cls
protected FOStoreSchemaUID	fsuid uid corresponding to the same java.lang.Class that initializes jdoClass.
protected org.apache.jdo.model.jdo.JDOClass	jdoClass Class meta data of the object represented by the constructor's given state manager
protected static int	LENGTH_COOKIE
(package private) static org.apache.commons.logging.Log	logger Logger
private FOStoreModel	model
protected static org.apache.jdo.util.I18NHelper	msg
private int	numClidOffsets
private int	numOidOffsets
private OID	oid
private java.util.ArrayList	oidOffsets
protected FOStoreOutput	out Stream to which request writes itself.
protected FOStorePMF	pmf PersistenceManagerFactory via which request is being done.
protected org.apache.jdo.state.StateManagerInternal	sm The state manager which is the subject of this request.

Constructor Summary

(package private)

InsertRequest(org.apache.jdo.state.StateManagerInternal sm, Message m, FOStorePMF pmf)

Method Summary

private void	addArrayCLIDs(java.lang.Object arr)
private void	addCLID(java.lang.Object o)
private void	addCollectionCLIDs(java.util.Collection c)
private void	addMapCLIDs(java.util.Map m)
void	doRequest() Does whatever it is that the kind of request does in actually making a request of the store.
protected void	doRequestBody() Provides detail about data being inserted in an InsertRequest.
boolean	fetchBooleanField(int fieldNum)
byte	fetchByteField(int fieldNum)
char	fetchCharField(int fieldNum)
double	fetchDoubleField(int fieldNum)
float	fetchFloatField(int fieldNum)
int	fetchIntField(int fieldNum)
long	fetchLongField(int fieldNum)
java.lang.Object	fetchObjectField(int fieldNum)
short	fetchShortField(int fieldNum)
java.lang.String	fetchStringField(int fieldNum)
protected RequestId	getId()
protected OID	getOID()
org.apache.jdo.state.StateManagerInternal	getStateManager() Get the StateManager associated with this request, null if none.
void	handleReply(Status status, java.io.DataInput in, int length) Reads the oid, and notifies the persistence manager and state manager of the new oid.
private void	insertFields(int[] fields, boolean identifying) Writes values of the specified fields.
void	storeBooleanField(int fieldNum, boolean value)
void	storeByteField(int fieldNum, byte value)
void	storeCharField(int fieldNum, char value)
void	storeDoubleField(int fieldNum, double value)
void	storeFloatField(int fieldNum, float value)
void	storeIntField(int fieldNum, int value)
void	storeLongField(int fieldNum, long value)
void	storeObjectField(int fieldNum, java.lang.Object value)
void	storeShortField(int fieldNum, short value)
void	storeStringField(int fieldNum, java.lang.String value)
protected int	writeBlock(int[] fields, boolean identifying) Writes a data block, which consists of the values of the specified fields, plus the CLID's and corresponding class names of referenced objects.

Methods inherited from class java.lang.Object

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

Field Detail

oid

private final OID oid

model

private final FOStoreModel model

cls

private final java.lang.Class cls

clids

private java.util.Set clids

oidOffsets

private java.util.ArrayList oidOffsets

numOidOffsets

private int numOidOffsets

clidOffsets

private int[] clidOffsets

numClidOffsets

private int numClidOffsets

sm

protected org.apache.jdo.state.StateManagerInternal sm

The state manager which is the subject of this request.

pmf

protected final FOStorePMF pmf

PersistenceManagerFactory via which request is being done.

out

protected final FOStoreOutput out

Stream to which request writes itself.

jdoClass

protected org.apache.jdo.model.jdo.JDOClass jdoClass

Class meta data of the object represented by the constructor's given state manager

fsuid

protected FOStoreSchemaUID fsuid

uid corresponding to the same java.lang.Class that initializes jdoClass.

msg

protected static final org.apache.jdo.util.I18NHelper msg

logger

static final org.apache.commons.logging.Log logger

Logger

LENGTH_COOKIE

protected static final int LENGTH_COOKIE

See Also:

Constant Field Values

Constructor Detail

InsertRequest

InsertRequest(org.apache.jdo.state.StateManagerInternal sm,
              Message m,
              FOStorePMF pmf)

Method Detail

doRequestBody

protected void doRequestBody()
                      throws java.io.IOException

Provides detail about data being inserted in an InsertRequest. The format of this request is (aside from the request header):

 oid: OID
 length of data block containing classname, field values, CLID info: int
 className: String (fully qualified name of class of object)
 fostoreSchemaUID for class
 length of the field values part of this block: int
 fieldValue: Object... (repeats numFields times)
 number of [CLID, classname] pairs for Object fields of this object
 [CLID, classname]...
 (the following are not in the above noted length bytes of this block)
 number of provisional OID's written in this request
 OID offset...
 number of the above written CLIDs that are provisional
 CLID offset...
 

In the case of both the OID and CLID offsets, the offset is from the beginning of the block. In the case of the CLIDs and the OID and CLID offsets, the size of each set written may be zero but that size is always written.

Note that the number of CLID/classname pairs and the CLID/classname pairs themselves are part of the data block that is intended to be stored by the database server (and hence later returned upon fetch/getExtent). That is, the size written includes those pairs. The offsets, however, are not part of the datablock; they are used by the database server and discarded.

Specified by:

doRequestBody in class AbstractRequest

Throws:

java.io.IOException

See Also:

AbstractRequest.doRequestBody()

handleReply

public void handleReply(Status status,
                        java.io.DataInput in,
                        int length)
                 throws java.io.IOException

Reads the oid, and notifies the persistence manager and state manager of the new oid.

Parameters:

in - the input stream.

length - the length of data in the stream.

status - Indication as to the success, failure, etc. of the request as handled by the store.

Throws:

java.io.IOException - if any problems reading the stream.

See Also:

Request.handleReply(org.apache.jdo.impl.fostore.Status, java.io.DataInput, int)

storeBooleanField

public void storeBooleanField(int fieldNum,
                              boolean value)

Specified by:

storeBooleanField in interface org.apache.jdo.state.FieldManager

Overrides:

storeBooleanField in class AbstractFieldRequest

See Also:

FieldManager.storeBooleanField(int fieldNum, boolean value)

storeCharField

public void storeCharField(int fieldNum,
                           char value)

Specified by:

storeCharField in interface org.apache.jdo.state.FieldManager

Overrides:

storeCharField in class AbstractFieldRequest

See Also:

FieldManager.storeCharField(int fieldNum, char value)

storeByteField

public void storeByteField(int fieldNum,
                           byte value)

Specified by:

storeByteField in interface org.apache.jdo.state.FieldManager

Overrides:

storeByteField in class AbstractFieldRequest

See Also:

FieldManager.storeByteField(int fieldNum, byte value)

storeShortField

public void storeShortField(int fieldNum,
                            short value)

Specified by:

storeShortField in interface org.apache.jdo.state.FieldManager

Overrides:

storeShortField in class AbstractFieldRequest

See Also:

FieldManager.storeShortField(int fieldNum, short value)

storeIntField

public void storeIntField(int fieldNum,
                          int value)

Specified by:

storeIntField in interface org.apache.jdo.state.FieldManager

Overrides:

storeIntField in class AbstractFieldRequest

See Also:

FieldManager.storeIntField(int fieldNum, int value)

storeLongField

public void storeLongField(int fieldNum,
                           long value)

Specified by:

storeLongField in interface org.apache.jdo.state.FieldManager

Overrides:

storeLongField in class AbstractFieldRequest

See Also:

FieldManager.storeLongField(int fieldNum, long value)

storeFloatField

public void storeFloatField(int fieldNum,
                            float value)

Specified by:

storeFloatField in interface org.apache.jdo.state.FieldManager

Overrides:

storeFloatField in class AbstractFieldRequest

See Also:

FieldManager.storeFloatField(int fieldNum, float value)

storeDoubleField

public void storeDoubleField(int fieldNum,
                             double value)

Specified by:

storeDoubleField in interface org.apache.jdo.state.FieldManager

Overrides:

storeDoubleField in class AbstractFieldRequest

See Also:

FieldManager.storeDoubleField(int fieldNum, double value)

storeStringField

public void storeStringField(int fieldNum,
                             java.lang.String value)

Specified by:

storeStringField in interface org.apache.jdo.state.FieldManager

Overrides:

storeStringField in class AbstractFieldRequest

See Also:

FieldManager.storeStringField(int fieldNum, String value)

storeObjectField

public void storeObjectField(int fieldNum,
                             java.lang.Object value)

Specified by:

storeObjectField in interface org.apache.jdo.state.FieldManager

Overrides:

storeObjectField in class AbstractFieldRequest

See Also:

FieldManager.storeObjectField(int fieldNum, Object value)

getOID

protected OID getOID()

writeBlock

protected int writeBlock(int[] fields,
                         boolean identifying)
                  throws java.io.IOException

Writes a data block, which consists of the values of the specified fields, plus the CLID's and corresponding class names of referenced objects.

Parameters:

fields - Field numbers of the fields to be written

identifying - If true, write before/flushed image fields, otherwise write current fields.

Returns:

Position in output stream at which data block starts

Throws:

java.io.IOException

insertFields

private void insertFields(int[] fields,
                          boolean identifying)
                   throws java.io.IOException

Writes values of the specified fields. If identifying is true, writes identifying fields, otherwise writes current fields.

Throws:

java.io.IOException

addCollectionCLIDs

private void addCollectionCLIDs(java.util.Collection c)

addMapCLIDs

private void addMapCLIDs(java.util.Map m)

addArrayCLIDs

private void addArrayCLIDs(java.lang.Object arr)

addCLID

private void addCLID(java.lang.Object o)

fetchBooleanField

public boolean fetchBooleanField(int fieldNum)

Specified by:

fetchBooleanField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchBooleanField(int fieldNum)

fetchCharField

public char fetchCharField(int fieldNum)

Specified by:

fetchCharField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchCharField(int fieldNum)

fetchByteField

public byte fetchByteField(int fieldNum)

Specified by:

fetchByteField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchByteField(int fieldNum)

fetchShortField

public short fetchShortField(int fieldNum)

Specified by:

fetchShortField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchShortField(int fieldNum)

fetchIntField

public int fetchIntField(int fieldNum)

Specified by:

fetchIntField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchIntField(int fieldNum)

fetchLongField

public long fetchLongField(int fieldNum)

Specified by:

fetchLongField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchLongField(int fieldNum)

fetchFloatField

public float fetchFloatField(int fieldNum)

Specified by:

fetchFloatField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchFloatField(int fieldNum)

fetchDoubleField

public double fetchDoubleField(int fieldNum)

Specified by:

fetchDoubleField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchDoubleField(int fieldNum)

fetchStringField

public java.lang.String fetchStringField(int fieldNum)

Specified by:

fetchStringField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchStringField(int fieldNum)

fetchObjectField

public java.lang.Object fetchObjectField(int fieldNum)

Specified by:

fetchObjectField in interface org.apache.jdo.state.FieldManager

See Also:

FieldManager.fetchObjectField(int fieldNum)

getId

protected RequestId getId()

doRequest

public final void doRequest()
                     throws java.io.IOException

Description copied from interface: Request

Does whatever it is that the kind of request does in actually making a request of the store.

Specified by:

doRequest in interface Request

Throws:

java.io.IOException - in case of errors with the stream.

See Also:

Request.doRequest()

getStateManager

public org.apache.jdo.state.StateManagerInternal getStateManager()

Get the StateManager associated with this request, null if none.

Specified by:

getStateManager in interface Request

Returns:

the StateManager.