InsertRequest

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: 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 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 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 StateManagerInternal`	`sm` The state manager which is the subject of this request.

Constructor Summary
`(package private)`	`InsertRequest(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()`
`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)` Provides the means by which the value of a boolean field can be given by a StateManager to an object that needs the value.
`void`	`storeByteField(int fieldNum, byte value)` Provides the means by which the value of a byte field can be given by a StateManager to an object that needs the value.
`void`	`storeCharField(int fieldNum, char value)` Provides the means by which the value of a char field can be given by a StateManager to an object that needs the value.
`void`	`storeDoubleField(int fieldNum, double value)` Provides the means by which the value of a double field can be given by a StateManager to an object that needs the value.
`void`	`storeFloatField(int fieldNum, float value)` Provides the means by which the value of a field can be given by a StateManager to an object that needs the value.
`void`	`storeIntField(int fieldNum, int value)` Provides the means by which the value of a int field can be given by a StateManager to an object that needs the value.
`void`	`storeLongField(int fieldNum, long value)` Provides the means by which the value of a long field can be given by a StateManager to an object that needs the value.
`void`	`storeObjectField(int fieldNum, java.lang.Object value)` Provides the means by which the value of an Object field can be given by a StateManager to an object that needs the value.
`void`	`storeShortField(int fieldNum, short value)` Provides the means by which the value of a short field can be given by a StateManager to an object that needs the value.
`void`	`storeStringField(int fieldNum, java.lang.String value)` Provides the means by which the value of a String field can be given by a StateManager to an object that needs the 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 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 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 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(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)