com.goldencode.p2j.persist

Class DataSource.FieldReference

java.lang.Object

com.goldencode.p2j.persist.DataSource.FieldReference

Enclosing class:

DataSource

public static class DataSource.FieldReference
extends java.lang.Object

A reference to a field of a buffer. This is the 'lite' version of the FieldReference in the sense that it puts together the legacy field name to the reference of its buffer. This is a non-mutable object.

Field Summary

Fields

Modifier and Type	Field and Description
private BufferImpl	buffer The buffer whose field this object represents.
private int	extent The EXTENT attribute of this field, if any, otherwise 0.
private int	index The EXTENT index of this field, if any, otherwise 0.
private java.lang.String	name The legacy name of the field.
private java.lang.Integer	offset The field's resolved offset in the record's datum, for direct access.
private java.lang.Class<? extends BaseDataType>	type The field's resolved type.

Constructor Summary

Constructors

Constructor and Description
FieldReference(BufferImpl buffer, java.lang.String name, java.lang.Class<? extends BaseDataType> type, java.lang.Integer offset) The constructor initialize both non mutable fields.

Method Summary

Modifier and Type	Method and Description
BufferImpl	getBuffer() Obtains the buffer whose field this object represents.
int	getExtent() Obtains the extent of this field.
int	getIndex() Obtains the index (1-base) of extent field.
java.lang.String	getName() Obtains the legacy name of the field.
java.lang.Integer	getOffset() Get the field's offset in the record datum.
java.lang.Class<? extends BaseDataType>	getType() Get the field's data HandleResource.type().
java.lang.String	toString() Gets a string representation of the object which contains the name buffer and the name of the field.

Methods inherited from class java.lang.Object

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

Field Detail

buffer

private final BufferImpl buffer

The buffer whose field this object represents.

name

private final java.lang.String name

The legacy name of the field.

extent

private final int extent

The EXTENT attribute of this field, if any, otherwise 0.

index

private final int index

The EXTENT index of this field, if any, otherwise 0. extent must also be > 0.

type

private final java.lang.Class<? extends BaseDataType> type

The field's resolved type.

offset

private final java.lang.Integer offset

The field's resolved offset in the record's datum, for direct access. This will be used only when the buffer fill determines that the read and write can be done directly in the datum. Otherwise, this field can be null.

Constructor Detail

FieldReference

public FieldReference(BufferImpl buffer,
                      java.lang.String name,
                      java.lang.Class<? extends BaseDataType> type,
                      java.lang.Integer offset)

The constructor initialize both non mutable fields.

Parameters:

buffer - The buffer whose field this object represents.

name - The legacy name of the field.

type - The field's datatype.

offset - The field offset in the record datum.

Method Detail

getOffset

public java.lang.Integer getOffset()

Get the field's offset in the record datum.

Returns:

See above.

getType

public java.lang.Class<? extends BaseDataType> getType()

Get the field's data HandleResource.type().

Returns:

See above.

getBuffer

public BufferImpl getBuffer()

Obtains the buffer whose field this object represents.

Returns:

The buffer whose field thei object represents.

getName

public java.lang.String getName()

Obtains the legacy name of the field.

Returns:

The legacy name of the field.

getExtent

public int getExtent()

Obtains the extent of this field.

Returns:

The EXTENT attribute of this field, if any, otherwise 0.

getIndex

public int getIndex()

Obtains the index (1-base) of extent field. If this is not an extent, 0 is returned.

Returns:

the index (1-base) of extent field or 0 if this is not an extent.

toString

public java.lang.String toString()

Gets a string representation of the object which contains the name buffer and the name of the field. This method is a usual debug tool.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.