wt.pds
Interface ResultBuilder

All Superinterfaces:

Cloneable

All Known Implementing Classes:

AbstractCompoundResultBuilder, ObjectReferenceResultBuilder, SequentialResultBuilder

public interface ResultBuilder

extends Cloneable

This class handles building the select columns of the SQL statement and building result objects once the query has been executed. A ResultBuilder contains a number of ItemBuilders. Each ItemBuilder is used to handle one object in the query.

Supported API: false

Extendable: false

Field Summary

static String	ACCESS_CONTROLLER_PROCESSOR Label for the attribute.
static String	ATTRIBUTE_MAP_INFO Label for the attribute.
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	ITEM_BUILDERS Label for the attribute.
static String	OBJECT_TABLE Label for the attribute; Cache of objects valid for the lifetime of a retrieve.

Method Summary

void	addItemBuilder(ItemBuilder a_itemBuilder) Add an ItemBuilder that will be used to build results.
Object[]	build(ResultSet a_resultSet, StatementBuilder a_statementBuilder) Builds object from the result set.
String	buildSelect(Vector a_tableInfos, Vector a_aliases) Builds the select columns for the results.
Object	clone() Create a deep-copy of this object.
AccessControllerProcessor	getAccessControllerProcessor() Gets the object for the association that plays role: ACCESS_CONTROLLER_PROCESSOR.
AttributeMapInfo	getAttributeMapInfo() Gets the object for the association that plays role: ATTRIBUTE_MAP_INFO.
Vector	getItemBuilders() Gets the object for the association that plays role: ITEM_BUILDERS.
Class	getItemPrimaryClass(Vector a_classInfos, int a_itemBuilderIndex) Returns the primary class for the specified ItemBuilder.
ObjectTable	getObjectTable() Gets the value of the attribute: OBJECT_TABLE.
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	setAccessControllerProcessor(AccessControllerProcessor a_AccessControllerProcessor) Sets the object for the association that plays role: ACCESS_CONTROLLER_PROCESSOR.
void	setAttributeMapInfo(AttributeMapInfo a_AttributeMapInfo) Sets the object for the association that plays role: ATTRIBUTE_MAP_INFO.
boolean	setCurrentResultBuilder(ResultBuilder a_resultBuilder, int a_currentIndex) Supported API: false
void	setItemStartOffset(int a_itemStartOffset) Supported API: false
void	setNonEmptyComponentIndex(int a_nonEmptyComponentIndex) Supported API: false
void	setObjectTable(ObjectTable a_ObjectTable) Sets the value of the attribute: OBJECT_TABLE.

Field Detail

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

OBJECT_TABLE

public static final String OBJECT_TABLE

Label for the attribute; Cache of objects valid for the lifetime of a retrieve.

Supported API: false

See Also:

Constant Field Values

ITEM_BUILDERS

public static final String ITEM_BUILDERS

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ATTRIBUTE_MAP_INFO

public static final String ATTRIBUTE_MAP_INFO

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ACCESS_CONTROLLER_PROCESSOR

public static final String ACCESS_CONTROLLER_PROCESSOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

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

getObjectTable

public ObjectTable getObjectTable()

Gets the value of the attribute: OBJECT_TABLE. Cache of objects valid for the lifetime of a retrieve.

Supported API: false

Returns:

ObjectTable

setObjectTable

public void setObjectTable(ObjectTable a_ObjectTable)
                    throws WTPropertyVetoException

Sets the value of the attribute: OBJECT_TABLE. Cache of objects valid for the lifetime of a retrieve.

Supported API: false

Parameters:

a_ObjectTable -

Throws:

WTPropertyVetoException

getItemBuilders

public Vector getItemBuilders()

Gets the object for the association that plays role: ITEM_BUILDERS.

Supported API: false

Returns:

Vector

getAttributeMapInfo

public AttributeMapInfo getAttributeMapInfo()

Gets the object for the association that plays role: ATTRIBUTE_MAP_INFO.

Supported API: false

Returns:

AttributeMapInfo

setAttributeMapInfo

public void setAttributeMapInfo(AttributeMapInfo a_AttributeMapInfo)
                         throws WTPropertyVetoException

Sets the object for the association that plays role: ATTRIBUTE_MAP_INFO.

Supported API: false

Parameters:

a_AttributeMapInfo -

Throws:

WTPropertyVetoException

getAccessControllerProcessor

public AccessControllerProcessor getAccessControllerProcessor()

Gets the object for the association that plays role: ACCESS_CONTROLLER_PROCESSOR.

Supported API: false

Returns:

AccessControllerProcessor

setAccessControllerProcessor

public void setAccessControllerProcessor(AccessControllerProcessor a_AccessControllerProcessor)
                                  throws WTPropertyVetoException

Sets the object for the association that plays role: ACCESS_CONTROLLER_PROCESSOR.

Supported API: false

Parameters:

a_AccessControllerProcessor -

Throws:

WTPropertyVetoException

buildSelect

public String buildSelect(Vector a_tableInfos,
                          Vector a_aliases)
                   throws PersistenceException

Builds the select columns for the results.

Supported API: false

Parameters:

a_tableInfos - Vector of TableExpression instances to use for building the Select statement

a_aliases - Vector of String aliases to use for building the Select statement

Returns:

String

Throws:

PersistenceException

build

public Object[] build(ResultSet a_resultSet,
                      StatementBuilder a_statementBuilder)
               throws PersistenceException

Builds object from the result set.

Supported API: false

Parameters:

a_resultSet -

a_statementBuilder -

Returns:

Object[]

Throws:

PersistenceException

addItemBuilder

public void addItemBuilder(ItemBuilder a_itemBuilder)

Add an ItemBuilder that will be used to build results.

Supported API: false

Parameters:

a_itemBuilder -

getItemPrimaryClass

public Class getItemPrimaryClass(Vector a_classInfos,
                                 int a_itemBuilderIndex)

Returns the primary class for the specified ItemBuilder.

Supported API: false

Parameters:

a_classInfos -

a_itemBuilderIndex -

Returns:

Class

reset

public void reset()

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

Supported API: false

setItemStartOffset

public void setItemStartOffset(int a_itemStartOffset)

Supported API: false

Parameters:

a_itemStartOffset -

setCurrentResultBuilder

public boolean setCurrentResultBuilder(ResultBuilder a_resultBuilder,
                                       int a_currentIndex)

Supported API: false

Parameters:

a_resultBuilder -

a_currentIndex -

Returns:

boolean

setNonEmptyComponentIndex

public void setNonEmptyComponentIndex(int a_nonEmptyComponentIndex)

Supported API: false

Parameters:

a_nonEmptyComponentIndex -

clone

public Object clone()

Create a deep-copy of this object.