wt.pds
Interface ItemBuilder

All Known Implementing Classes:

AbstractColumnAccessControlItemBuilder, AbstractItemBuilder, AttributeItemBuilder, ClassNameItemBuilder, PersistableItemBuilder

public interface ItemBuilder

This class is an abstraction for building an object from a result set (i.e. PersistentRetrieveIfc). It is responsible for both generating the needed columns in the SQL statement and building the object from the result set. It does not control the traversal of the result set. It only reads the values at the current position.

Supported API: false

Extendable: false

Field Summary

static String	ACCESS_CONTROLLED_FROM_INDICIES Label for the attribute; Array of index values for items in the FromClause.
static String	COLUMNS Label for the attribute; Returns ColumnExpressions for this item.
static String	DESCENDANT_QUERY_TYPE_COMPATIBLE Label for the attribute; Indicates whether descendant query results will be guranteed to be type compatible (i.e.
static String	FROM_INDICIES Label for the attribute; Array of index values for items in the FromClause.
static String	ITEM_COUNT Label for the attribute; Number of items that are built.

Method Summary

Object	build() Builds an object from the current row in the result set.
int	buildEmptyAggregateColumn(AttributeMapInfo a_attributeMapInfo, StringBuffer a_select) Builds the select columns for building an object.
int	buildSelect(Vector a_tableInfos, Vector a_aliases, AttributeMapInfo a_attributeMapInfo, StringBuffer a_select) Builds the select columns for building an object.
int	createPersistentRetrieve(ResultSet a_resultSet, ObjectTable a_objectTable, int a_resultOffset, AttributeMapInfo a_attributeMapInfo) Creates the persistent retrieve object for this item.
int[]	getAccessControlledFromIndicies() Gets the value of the attribute: ACCESS_CONTROLLED_FROM_INDICIES.
ColumnExpression[]	getColumns() Gets the value of the attribute: COLUMNS.
int[]	getFromIndicies() Gets the value of the attribute: FROM_INDICIES.
int	getItemCount() Gets the value of the attribute: ITEM_COUNT.
Class	getPrimaryClass(Vector a_classInfos) Returns the primary class for this Item.
boolean	isDescendantQueryTypeCompatible() Gets the value of the attribute: DESCENDANT_QUERY_TYPE_COMPATIBLE.
void	reset() Resets the instance so that it can be re-used to process a new result.
void	setTimeStampAttributeTimestampDisabled() Set the DateExpression in the ItemBuilder to the TimstampEnabled to false Supported API: false

Field Detail

ITEM_COUNT

public static final String ITEM_COUNT

Label for the attribute; Number of items that are built.

Supported API: false

See Also:

Constant Field Values

DESCENDANT_QUERY_TYPE_COMPATIBLE

public static final String DESCENDANT_QUERY_TYPE_COMPATIBLE

Label for the attribute; Indicates whether descendant query results will be guranteed to be type compatible (i.e. all corressponding columns have the same type.

Supported API: false

See Also:

Constant Field Values

ACCESS_CONTROLLED_FROM_INDICIES

public static final String ACCESS_CONTROLLED_FROM_INDICIES

Label for the attribute; Array of index values for items in the FromClause. This ItemBuilder provides Access Control for these FromExpressions.

Supported API: false

See Also:

Constant Field Values

FROM_INDICIES

public static final String FROM_INDICIES

Label for the attribute; Array of index values for items in the FromClause. This ItemBuilder accesses these FromExpressions to build the item.

Supported API: false

See Also:

Constant Field Values

COLUMNS

public static final String COLUMNS

Label for the attribute; Returns ColumnExpressions for this item. If null is returned, then this item cannot be resolved to a list of ColumnExpressions.

Supported API: false

See Also:

Constant Field Values

Method Detail

getItemCount

public int getItemCount()

Gets the value of the attribute: ITEM_COUNT. Number of items that are built.

Supported API: false

Returns:

int

isDescendantQueryTypeCompatible

public boolean isDescendantQueryTypeCompatible()

Gets the value of the attribute: DESCENDANT_QUERY_TYPE_COMPATIBLE. Indicates whether descendant query results will be guranteed to be type compatible (i.e. all corressponding columns have the same type.

Supported API: false

Returns:

boolean

getAccessControlledFromIndicies

public int[] getAccessControlledFromIndicies()

Gets the value of the attribute: ACCESS_CONTROLLED_FROM_INDICIES. Array of index values for items in the FromClause. This ItemBuilder provides Access Control for these FromExpressions.

Supported API: false

Returns:

int[]

getFromIndicies

public int[] getFromIndicies()

Gets the value of the attribute: FROM_INDICIES. Array of index values for items in the FromClause. This ItemBuilder accesses these FromExpressions to build the item.

Supported API: false

Returns:

int[]

getColumns

public ColumnExpression[] getColumns()
                              throws WTException

Gets the value of the attribute: COLUMNS. Returns ColumnExpressions for this item. If null is returned, then this item cannot be resolved to a list of ColumnExpressions.

Supported API: false

Returns:

ColumnExpression[]

Throws:

WTException

buildSelect

public int buildSelect(Vector a_tableInfos,
                       Vector a_aliases,
                       AttributeMapInfo a_attributeMapInfo,
                       StringBuffer a_select)
                throws PersistenceException

Builds the select columns for building an object.

Supported API: false

Parameters:

a_tableInfos -

a_aliases -

a_attributeMapInfo -

a_select -

Throws:

PersistenceException

build

public Object build()
             throws PersistenceException

Builds an object from the current row in the result set.

Supported API: false

Returns:

Object

Throws:

PersistenceException

createPersistentRetrieve

public int createPersistentRetrieve(ResultSet a_resultSet,
                                    ObjectTable a_objectTable,
                                    int a_resultOffset,
                                    AttributeMapInfo a_attributeMapInfo)
                             throws PersistenceException

Creates the persistent retrieve object for this item.

Supported API: false

Parameters:

a_resultSet -

a_objectTable -

a_resultOffset -

a_attributeMapInfo -

Returns:

int

Throws:

PersistenceException

getPrimaryClass

public Class getPrimaryClass(Vector a_classInfos)

Returns the primary class for this Item.

Supported API: false

Parameters:

a_classInfos -

Returns:

Class

reset

public void reset()

Resets the instance so that it can be re-used to process a new result.

Supported API: false

buildEmptyAggregateColumn

public int buildEmptyAggregateColumn(AttributeMapInfo a_attributeMapInfo,
                                     StringBuffer a_select)
                              throws PersistenceException

Builds the select columns for building an object.

Supported API: false

Parameters:

a_attributeMapInfo -

a_select -

Throws:

PersistenceException

setTimeStampAttributeTimestampDisabled

public void setTimeStampAttributeTimestampDisabled()
                                            throws WTException

Set the DateExpression in the ItemBuilder to the TimstampEnabled to false

Supported API: false

Throws:

WTException