com.sleepycat.persist.impl

Interface EntityInput

public interface EntityInput

Used for reading object fields.

Unlike TupleInput, Strings are returned by readObject() when using this class.

Author:

Mark Hayes

Method Summary

Modifier and Type	Method and Description
com.sleepycat.persist.impl.Catalog	getCatalog() Returns the Catalog associated with this input.
boolean	isRawAccess() Return whether this input is in raw mode, i.e., whether it is returning raw instances.
int	readArrayLength() Called by ObjectArrayFormat and PrimitiveArrayFormat to read the array length.
BigInteger	readBigInteger()
boolean	readBoolean()
byte	readByte()
char	readChar()
int	readEnumConstant(String[] names) Called by EnumFormat to read and return index of the enum constant.
int	readInt()
Object	readKeyObject(Format format) Called for a primary key field or a composite key field with a reference type.
long	readLong()
Object	readObject() Called via Accessor to read all fields with reference types, except for the primary key field and composite key fields (see readKeyObject below).
short	readShort()
BigDecimal	readSortedBigDecimal()
double	readSortedDouble()
float	readSortedFloat()
String	readString()
Object	readStringObject() Called for a String field, that is not a primary key field or a composite key field with a reference type.
void	registerPriKeyObject(Object o) Called via Accessor.readSecKeyFields for a primary key field with a reference type.
void	registerPriStringKeyObject(Object o) Called via Accessor.readSecKeyFields for a primary String key field.
boolean	setRawAccess(boolean rawAccessParam) Changes raw mode and returns the original mode, which is normally restored later.
void	skipField(Format declaredFormat) Called via PersistKeyCreator to skip fields prior to the secondary key field.

Method Detail

getCatalog

com.sleepycat.persist.impl.Catalog getCatalog()

Returns the Catalog associated with this input.

isRawAccess

boolean isRawAccess()

Return whether this input is in raw mode, i.e., whether it is returning raw instances.

setRawAccess

boolean setRawAccess(boolean rawAccessParam)

Changes raw mode and returns the original mode, which is normally restored later. For temporarily changing the mode during a conversion.

readObject

Object readObject()
           throws RefreshException

Called via Accessor to read all fields with reference types, except for the primary key field and composite key fields (see readKeyObject below).

Throws:

RefreshException

readKeyObject

Object readKeyObject(Format format)
              throws RefreshException

Called for a primary key field or a composite key field with a reference type.

For such key fields, no formatId is present nor can the object already be present in the visited object set.

Throws:

RefreshException

readStringObject

Object readStringObject()
                 throws RefreshException

Called for a String field, that is not a primary key field or a composite key field with a reference type.

For the new String format, no formatId is present nor can the object already be present in the visited object set. For the old String format, this method simply calls readObject for compatibility.

Throws:

RefreshException

registerPriKeyObject

void registerPriKeyObject(Object o)

Called via Accessor.readSecKeyFields for a primary key field with a reference type. This method must be called before reading any other fields.

registerPriStringKeyObject

void registerPriStringKeyObject(Object o)

Called via Accessor.readSecKeyFields for a primary String key field. This method must be called before reading any other fields.

readArrayLength

int readArrayLength()

Called by ObjectArrayFormat and PrimitiveArrayFormat to read the array length.

readEnumConstant

int readEnumConstant(String[] names)

Called by EnumFormat to read and return index of the enum constant.

skipField

void skipField(Format declaredFormat)
        throws RefreshException

Called via PersistKeyCreator to skip fields prior to the secondary key field. Also called during class evolution so skip deleted fields.

Throws:

RefreshException

readString

String readString()
           throws RefreshException

Throws:

RefreshException

readChar

char readChar()
       throws RefreshException

Throws:

RefreshException

readBoolean

boolean readBoolean()
             throws RefreshException

Throws:

RefreshException

readByte

byte readByte()
       throws RefreshException

Throws:

RefreshException

readShort

short readShort()
         throws RefreshException

Throws:

RefreshException

readInt

int readInt()
     throws RefreshException

Throws:

RefreshException

readLong

long readLong()
       throws RefreshException

Throws:

RefreshException

readSortedFloat

float readSortedFloat()
               throws RefreshException

Throws:

RefreshException

readSortedDouble

double readSortedDouble()
                 throws RefreshException

Throws:

RefreshException

readBigInteger

BigInteger readBigInteger()
                   throws RefreshException

Throws:

RefreshException

readSortedBigDecimal

BigDecimal readSortedBigDecimal()
                         throws RefreshException

Throws:

RefreshException