wt.pds
Interface StatementBuilder

All Known Implementing Classes:

BasicStatementBuilder

public interface StatementBuilder

This class encapsulates functionality for building SQL statements. It contains an array of SQL statements and can provide a JDBC PreparedStatement corresponding to one of these internal SQL statements.

Supported API: false

Extendable: false

Field Summary

static String	CHUNKING_ENABLED Label for the attribute; Indicates if chunking is enabled.
static String	FETCH_SIZE Label for the attribute.
static String	SQL_STATEMENTS Label for the attribute; Array of SQL statements.
static String	STATEMENT_COUNT Label for the attribute; Number of SQL statements.

Method Summary

String[]	buildSQL(ResultBuilder a_resultBuilder, WTConnection a_connection, boolean a_isComponent) Returns an array of SQL statements to execute.
String[]	buildSQL(ResultBuilder a_resultBuilder, WTConnection a_connection, boolean a_isComponent, boolean a_isComponentChunkSupported) Returns an array of SQL statements to execute.
int	getFetchSize() Gets the value of the attribute: FETCH_SIZE.
String[]	getSqlStatements() Gets the value of the attribute: SQL_STATEMENTS.
PreparedStatement	getStatement(WTConnection a_connection, int a_sqlIndex) Returns an array of JDBC statements to execute.
Vector	getStatementBindParameters(int a_sqlIndex) Returns a Vector of bind parameters for the specified statement.
int	getStatementCount() Gets the value of the attribute: STATEMENT_COUNT.
boolean	isChunkingEnabled() Gets the value of the attribute: CHUNKING_ENABLED.
void	setChunkingEnabled(boolean a_ChunkingEnabled) Sets the value of the attribute: CHUNKING_ENABLED.
void	setFetchSize(int a_FetchSize) Sets the value of the attribute: FETCH_SIZE.

Field Detail

SQL_STATEMENTS

public static final String SQL_STATEMENTS

Label for the attribute; Array of SQL statements. Valid only after a call to buildSQL().

Supported API: false

See Also:

Constant Field Values

STATEMENT_COUNT

public static final String STATEMENT_COUNT

Label for the attribute; Number of SQL statements. Valid only after a call to buildSQL().

Supported API: false

See Also:

Constant Field Values

FETCH_SIZE

public static final String FETCH_SIZE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CHUNKING_ENABLED

public static final String CHUNKING_ENABLED

Label for the attribute; Indicates if chunking is enabled.

Supported API: false

See Also:

Constant Field Values

Method Detail

getSqlStatements

public String[] getSqlStatements()

Gets the value of the attribute: SQL_STATEMENTS. Array of SQL statements. Valid only after a call to buildSQL().

Supported API: false

Returns:

String[]

getStatementCount

public int getStatementCount()

Gets the value of the attribute: STATEMENT_COUNT. Number of SQL statements. Valid only after a call to buildSQL().

Supported API: false

Returns:

int

getFetchSize

public int getFetchSize()

Gets the value of the attribute: FETCH_SIZE.

Supported API: false

Returns:

int

setFetchSize

public void setFetchSize(int a_FetchSize)

Sets the value of the attribute: FETCH_SIZE.

Supported API: false

Parameters:

a_FetchSize -

isChunkingEnabled

public boolean isChunkingEnabled()

Gets the value of the attribute: CHUNKING_ENABLED. Indicates if chunking is enabled.

Supported API: false

Returns:

boolean

setChunkingEnabled

public void setChunkingEnabled(boolean a_ChunkingEnabled)
                        throws WTPropertyVetoException

Sets the value of the attribute: CHUNKING_ENABLED. Indicates if chunking is enabled.

Supported API: false

Parameters:

a_ChunkingEnabled -

Throws:

WTPropertyVetoException

getStatement

public PreparedStatement getStatement(WTConnection a_connection,
                                      int a_sqlIndex)
                               throws PersistenceException

Returns an array of JDBC statements to execute.

Supported API: false

Parameters:

a_connection -

a_sqlIndex -

Returns:

PreparedStatement

Throws:

PersistenceException

buildSQL

public String[] buildSQL(ResultBuilder a_resultBuilder,
                         WTConnection a_connection,
                         boolean a_isComponent,
                         boolean a_isComponentChunkSupported)
                  throws PersistenceException

Returns an array of SQL statements to execute.

Supported API: false

Parameters:

a_resultBuilder -

a_connection -

a_isComponent - Indicates that these SQL statements will be used as nested components of another SQL statement.

a_isComponentChunkSupported - Indicates that these SQL statements will support chunk or not, and the value will be false when a_isComponent is false, and can be true or false when a_isComponents is true.

Returns:

String[]

Throws:

PersistenceException

getStatementBindParameters

public Vector getStatementBindParameters(int a_sqlIndex)
                                  throws PersistenceException

Returns a Vector of bind parameters for the specified statement.

Supported API: false

Parameters:

a_sqlIndex -

Returns:

Vector

Throws:

PersistenceException

buildSQL

public String[] buildSQL(ResultBuilder a_resultBuilder,
                         WTConnection a_connection,
                         boolean a_isComponent)
                  throws PersistenceException

Returns an array of SQL statements to execute.

Supported API: false

Parameters:

a_resultBuilder -

a_connection -

a_isComponent - Indicates that these SQL statements will be used as nested components of another SQL statement.

Returns:

String[]

Throws:

PersistenceException