com.goldencode.p2j.persist.orm

Class FullRowStructure

java.lang.Object

com.goldencode.p2j.persist.orm.AbstractRowStructure

com.goldencode.p2j.persist.orm.FullRowStructure

All Implemented Interfaces:

RowStructure

public class FullRowStructure
extends AbstractRowStructure

Very fast row structure that knows that all properties should be hydrated and the order in the structure is the same as the one desired by the hydrated record. The primary key is always first, followed by _temp specific fields if any (including multiplex). All other fields are retrieved in the order specified by the data array, honoring any datetime-tz fields (that require 2 columns from the result-set), expanded extents (nothing special here) and non-expanded extents (eagerly hydrated using separate loading SQLs.

Field Summary

Fields inherited from class com.goldencode.p2j.persist.orm.AbstractRowStructure

dmoClass, dmoMeta, hasExtents

Constructor Summary

Constructors

Constructor and Description
FullRowStructure(DmoMeta meta) Basic constructor over a specific DMO class.

Method Summary

Modifier and Type	Method and Description
boolean	addMultiplex(Property multiplex) Append the multiplex to the row structure.
boolean	addProperty(Property prop) Append a property to the row structure.
boolean	addRecid(Property recid) Append the recid to the row structure.
int	getCount() Retrieve the number of SQL fields that will be interpreted by this row structure.
java.util.Iterator<Property>	getProps() Retrieve an iterator to all properties in this structure, including the recid and multiplex.
int	hydrate(Session session, java.sql.ResultSet resultSet, int rsOffset, BaseRecord r) Hydrate a record knowing that the result-set selected ALL of its properties in order.
boolean	isIncomplete() Check if this structure is used for an incomplete record.

Methods inherited from class com.goldencode.p2j.persist.orm.AbstractRowStructure

forceExtents, getDmoClass, getDmoMeta, getPropertyMeta, hasExtents, hydrateExtents, isTempTable, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FullRowStructure

public FullRowStructure(DmoMeta meta)

Basic constructor over a specific DMO class.

Parameters:

meta - A DMO meta for the DMO over which this row structure is constructed.

Method Detail

addRecid

public boolean addRecid(Property recid)

Append the recid to the row structure. This is a no-op, as this kind of row structure (full) already presumes that the recid is part of the structure.

Parameters:

recid - The recid property to be appended to the structure.

Returns:

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

addMultiplex

public boolean addMultiplex(Property multiplex)

Append the multiplex to the row structure. This is a no-op, as this kind of row structure (full) already presumes that the multiplex may be part of the structure (if temp).

Parameters:

multiplex - The multiplex property to be appended to the structure.

Returns:

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

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 a no-op, as this kind of row structure (full) already presumes that all properties of a specifc DMO are already part of the structure.

Specified by:

addProperty in interface RowStructure

Overrides:

addProperty in class AbstractRowStructure

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.

getCount

public int getCount()

Retrieve the number of SQL fields that will be interpreted by this row structure. This is not the same as the number of properties (e.g. datetime-tz consumes 2 SQL columns)

Returns:

The number of SQL fields that are covered by this row structure.

getProps

public java.util.Iterator<Property> getProps()

Retrieve an iterator to all properties in this structure, including the recid and multiplex.

Returns:

An iterator to all properties in this structure, in order of their append.

hydrate

public int hydrate(Session session,
                   java.sql.ResultSet resultSet,
                   int rsOffset,
                   BaseRecord r)
            throws PersistenceException,
                   java.sql.SQLException

Hydrate a record knowing that the result-set selected ALL of its properties in order. Using this invariant, the recid is always the first property. It is followed by the multiplex and _temp reserved properties (if the table is temporary). Afterwards, all of the DMO properties are listed in order. If there are any non-expanded extents, they will be loaded at the end of this method.

Parameters:

session - The underlying session that generated the result-set. It is used only to emit load SQLs for the non-expanded extents. If this is null, the non-expanded extents will be skipped.

resultSet - The result-set that provides the low-level data that should be hydrated into the record.

rsOffset - The offset where the DMO starts. This is the case for queries that had joins, so the current record may not start at index 1.

r - The record to be hydrated.

Returns:

The next rsOffset, from where the next DMO in the result-set will start (if any).

Throws:

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

java.sql.SQLException - throw when failing to hydrate from the result-set.

isIncomplete

public boolean isIncomplete()

Check if this structure is used for an incomplete record. This specific row structure (full) will always retrieve the whole record.

Returns:

true by default.