wt.pds
Class ObjectReferenceItemBuilder

java.lang.Object
  extended bywt.pds.AttributeItemBuilder
      extended bywt.pds.ObjectReferenceItemBuilder
All Implemented Interfaces:
Externalizable, ItemBuilder, Serializable

public class ObjectReferenceItemBuilder
extends AttributeItemBuilder
implements Externalizable

This class provides the functionality for building an object reference from a result set.

The internal implementation uses the get methods of the ResultSet class. The Object Reference can be the OID of the object itself or a foreign key OID.

Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
private  boolean fullObjectMode
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.pds.AttributeItemBuilder
objectTable
 
Fields inherited from interface wt.pds.ItemBuilder
ACCESS_CONTROLLED_FROM_INDICIES, COLUMNS, DESCENDANT_QUERY_TYPE_COMPATIBLE, FROM_INDICIES, ITEM_COUNT
 
Constructor Summary
ObjectReferenceItemBuilder()
          

Supported API: false
ObjectReferenceItemBuilder(ColumnExpression a_className, ColumnExpression a_id, int a_classNameFromIndex, int a_idFromIndex)
          

Supported API: false
 
Method Summary
 Object build()
          Builds an object from the current row in the result set.
 boolean isFullObjectMode()
          Gets the value of the attribute: fullObjectMode; Indicates if full ObjectReference instances are built.
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
private  boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source, which is not the current version.
protected  boolean readVersion(ObjectReferenceItemBuilder thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setFullObjectMode(boolean a_FullObjectMode)
          Sets the value of the attribute: fullObjectMode; Indicates if full ObjectReference instances are built.
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 
Methods inherited from class wt.pds.AttributeItemBuilder
buildAliases, buildEmptyAggregateColumn, buildSelect, createPersistentRetrieve, getAccessControlledFromIndicies, getColumns, getFromIndicies, getItemCount, getJavaType, getOffset, getPrimaryClass, getResultSet, getResultSetObject, isColumnAliasEnabled, isDescendantQueryTypeCompatible, isSelectOnly, isTimestampProcessingEnabled, processClassAttributes, processTimestamp, readVersion, reset, setColumnAliasEnabled, setSelectOnly, setTimeStampAttributeTimestampDisabled, setTimestampProcessingEnabled, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

fullObjectMode

private boolean fullObjectMode

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

ObjectReferenceItemBuilder

public ObjectReferenceItemBuilder()


Supported API: false


ObjectReferenceItemBuilder

public ObjectReferenceItemBuilder(ColumnExpression a_className,
                                  ColumnExpression a_id,
                                  int a_classNameFromIndex,
                                  int a_idFromIndex)
                           throws WTPropertyVetoException


Supported API: false

Parameters:
a_className -
a_id -
a_classNameFromIndex -
a_idFromIndex -
Throws:
WTPropertyVetoException
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class AttributeItemBuilder
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class AttributeItemBuilder
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(ObjectReferenceItemBuilder thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

isFullObjectMode

public boolean isFullObjectMode()
Gets the value of the attribute: fullObjectMode; Indicates if full ObjectReference instances are built. Otherwise, only raw columns are returned in a RawOidHolder object.

Supported API: false

Returns:
boolean

setFullObjectMode

public void setFullObjectMode(boolean a_FullObjectMode)
                       throws WTPropertyVetoException
Sets the value of the attribute: fullObjectMode; Indicates if full ObjectReference instances are built. Otherwise, only raw columns are returned in a RawOidHolder object.

Supported API: false

Parameters:
a_FullObjectMode -
Throws:
WTPropertyVetoException

build

public Object build()
             throws PersistenceException
Builds an object from the current row in the result set.

Supported API: false

Specified by:
build in interface ItemBuilder
Overrides:
build in class AttributeItemBuilder
Returns:
Object
Throws:
PersistenceException