com.ibm.commerce.foundation.server.services.dataaccess.db.jdbc

Class SQLComposer

java.lang.Object

com.ibm.commerce.foundation.server.services.dataaccess.db.jdbc.SQLComposer

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GiftListFindByStatusSQLComposer, GiftListSearchSQLComposer, LayoutSearchSQLComposer, PromotionSearchSQLComposer, SearchTermAssociationSQLComposer, SubscriptionSQLComposer

public abstract class SQLComposer
extends java.lang.Object
implements java.io.Serializable

The component extended abstract class to supply dynamic sql statement at run-time or augmenting the sql statement given in the query template. The implementation must have a default constuctor

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SQLComposer.SQLComposerInfo This class represented the updated information from a SQLComposer

Constructor Summary

Constructors

Constructor and Description
SQLComposer()

Method Summary

Modifier and Type	Method and Description
abstract SQLComposer.SQLComposerInfo	composeSQLStatement(java.lang.String sqlName, java.lang.String entityTableName, java.util.List resultSetInfo, java.lang.String sqlstatement, java.util.List params) Compose the final SQL statement.
SelectionCriteria	getSelectionCriteria() Gets the SelectionCriteria object which contains the search expression information.
void	setSelectionCriteria(SelectionCriteria aSelectionCriteria) Sets the selectin criteria information from the caller.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SQLComposer

public SQLComposer()

Method Detail

composeSQLStatement

public abstract SQLComposer.SQLComposerInfo composeSQLStatement(java.lang.String sqlName,
                                                                java.lang.String entityTableName,
                                                                java.util.List resultSetInfo,
                                                                java.lang.String sqlstatement,
                                                                java.util.List params)
                                                         throws DataServiceSystemException

Compose the final SQL statement. This is the extension point where a SQLComposer can modify the SQL statement. If the composer modify the select clause, it should update the resultSetInfo accordingly.

Parameters:

sqlName - The name of the sql statement specified in the query template

entityTableName - The entity table name specified in the query template

resultSetInfo - The current resultSet info, which is a list of ResultSetData. If there is no result set info, this will an empty list and the value will never be null.

sqlstatement - The optional SQL statement specified in the query template. This could be null if there is no SQL statement specified in the query template

params - A list of optional parameters of type String specified in the query template. If no parameters are specified, this would be an empty list and will never be null.

Returns:

DataServiceSQL A structure representing the final SQL statement, its resultSet info.

Throws:

DataServiceSystemException

getSelectionCriteria

public SelectionCriteria getSelectionCriteria()

Gets the SelectionCriteria object which contains the search expression information.

Returns:

The caller's search information.

setSelectionCriteria

public void setSelectionCriteria(SelectionCriteria aSelectionCriteria)

Sets the selectin criteria information from the caller.

Parameters:

aSelectionCriteria - the caller's selection critieria information.