com.goldencode.p2j.persist.orm

Class AbstractRowStructure

java.lang.Object

com.goldencode.p2j.persist.orm.AbstractRowStructure

All Implemented Interfaces:

RowStructure

Direct Known Subclasses:

AdaptiveRowStructure, FullRowStructure, OrderedRowStructure, UnorderedRowStructure

public abstract class AbstractRowStructure
extends java.lang.Object
implements RowStructure

Common behavior for all row structures. This aggregates all routines that are common like non-expanded extent hydration and non-expanded property detection.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<? extends DataModelObject>	dmoClass The DMO class.
protected DmoMeta	dmoMeta The DMO meta of the DMO class
protected boolean	hasExtents Check if this row structure should also hydrate the non-expanded extent fields.
private PropertyMeta[]	pm A cached value of the property meta array that can be found in the record meta

Constructor Summary

Constructors

Constructor and Description
AbstractRowStructure(DmoMeta dmoMeta) Create a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	addProperty(Property prop) Append a property to the row structure.
void	forceExtents() Force the non-expanded extents to be hydrated.
java.lang.Class<? extends DataModelObject>	getDmoClass() The DMO class whose properties are included in this structure.
DmoMeta	getDmoMeta() Retrieve the DMO meta for the provided DMO class.
protected PropertyMeta[]	getPropertyMeta() The property meta array - lazily computed based on the dmo meta.
boolean	hasExtents() Check if this structure requires a hydration of non-expanded properties.
protected void	hydrateExtents(Session session, BaseRecord r, int recOffset) Hydrate record's non-expanded extents.
protected boolean	isTempTable() Check if this row structure is for a temporary table.
java.lang.String	toString() Obtain a short description of this object used for debugging.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.persist.orm.RowStructure

addMultiplex, addRecid, getCount, getProps, hydrate, isIncomplete

Field Detail

dmoClass

protected final java.lang.Class<? extends DataModelObject> dmoClass

The DMO class.

dmoMeta

protected final DmoMeta dmoMeta

The DMO meta of the DMO class

hasExtents

protected boolean hasExtents

Check if this row structure should also hydrate the non-expanded extent fields.

pm

private PropertyMeta[] pm

A cached value of the property meta array that can be found in the record meta

Constructor Detail

AbstractRowStructure

public AbstractRowStructure(DmoMeta dmoMeta)

Create a new instance.

Parameters:

dmoMeta - The DMO metadata of the underlying DMO for this structure.

Method Detail

getDmoClass

public java.lang.Class<? extends DataModelObject> getDmoClass()

The DMO class whose properties are included in this structure.

Specified by:

getDmoClass in interface RowStructure

Returns:

The DMO class underlying this structure.

addProperty

public boolean addProperty(Property prop)

Append a property to the row structure. This doesn't check if the property actually belongs to the DMO class used for this structure. This is implemented in the abstract class to uniformly handle non-expanded extent fields.

Specified by:

addProperty in interface RowStructure

Parameters:

prop - The property to be appended to the structure.

Returns:

true if adding the prop to the row structure succeeded If there is some invariant on the structure, adding props may fail.

hasExtents

public boolean hasExtents()

Check if this structure requires a hydration of non-expanded properties. This will only return true if a non-expanded property was ever added through addProperty(com.goldencode.p2j.persist.orm.Property) or forceExtents() was called.

Specified by:

hasExtents in interface RowStructure

Returns:

true if this structure will also hydrate non-expanded properties.

forceExtents

public void forceExtents()

Force the non-expanded extents to be hydrated.

Specified by:

forceExtents in interface RowStructure

hydrateExtents

protected void hydrateExtents(Session session,
                              BaseRecord r,
                              int recOffset)
                       throws PersistenceException

Hydrate record's non-expanded extents.

Parameters:

session - The session to be used to query the non-expanded extent tables.

r - The record to be hydrated.

recOffset - The offset to which the extent data should be added into the record.

Throws:

PersistenceException - thrown when hydrating extents fails (as it requires extra SQL queries to be run).

toString

public java.lang.String toString()

Obtain a short description of this object used for debugging.

Overrides:

toString in class java.lang.Object

Returns:

a short description of this object used for debugging.

getDmoMeta

public DmoMeta getDmoMeta()

Retrieve the DMO meta for the provided DMO class. This should be initialized lazily, as not all implementations require the DMO meta.

Specified by:

getDmoMeta in interface RowStructure

Returns:

The meta of the underlying DMO class.

isTempTable

protected boolean isTempTable()

Check if this row structure is for a temporary table.

Returns:

true if this DMO structure is for a temporary table.

getPropertyMeta

protected PropertyMeta[] getPropertyMeta()

The property meta array - lazily computed based on the dmo meta.

Returns:

the array of property meta data.