Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.queries

Class StatementQueryMechanism

java.lang.Object

org.eclipse.persistence.internal.queries.DatabaseQueryMechanism

org.eclipse.persistence.internal.queries.DatasourceCallQueryMechanism

org.eclipse.persistence.internal.queries.CallQueryMechanism

org.eclipse.persistence.internal.queries.StatementQueryMechanism

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ExpressionQueryMechanism

public class StatementQueryMechanism
extends CallQueryMechanism

Purpose: Mechanism used for all statement objects.

Responsibilities: Executes the appropriate statement.

Since:

TOPLink/Java 1.0

Author:

Yvon Lavoie

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SQLStatement	sqlStatement
protected Vector	sqlStatements	Normally only a single statement is used, however multiple table may require multiple statements on write.

Fields inherited from class org.eclipse.persistence.internal.queries.DatasourceCallQueryMechanism

call, calls

Fields inherited from class org.eclipse.persistence.internal.queries.DatabaseQueryMechanism

query

Constructor Summary

Constructors

Constructor	Description
StatementQueryMechanism()
StatementQueryMechanism(DatabaseQuery query)	INTERNAL: Return a new mechanism for the query
StatementQueryMechanism(DatabaseQuery query, SQLStatement statement)	Return a new mechanism for the query

Method Summary

Modifier and Type	Method	Description
void	clearStatement()	The statement is no longer require after prepare so can be released.
DatabaseQueryMechanism	clone(DatabaseQuery queryClone)	Clone the mechanism for the specified query clone.
protected void	configureDatabaseCall(DatabaseCall call)	Set the call level query options into the call.
Integer	deleteObject()	INTERNAL: delete the object
Object	executeNoSelect()	Update the object
Expression	getSelectionCriteria()	Return the selection criteria for the statement.
SQLStatement	getSQLStatement()	INTERNAL: Return the sqlStatement
Vector	getSQLStatements()	Normally only a single statement is used, however multiple table may require multiple statements on write.
boolean	hasMultipleStatements()	Normally only a single statement is used, however multiple table may require multiple statements on write.
void	insertObject()	Insert the object
void	insertObject(boolean reprepare)	Insert the object if the reprepare flag is set, first reprepare the query.
boolean	isCallQueryMechanism()	Return true if this is a call query mechanism
boolean	isStatementQueryMechanism()	Return true if this is a statement query mechanism
void	prepare()	INTERNAL: This is different from 'prepareForExecution' in that this is called on the original query, and the other is called on the copy of the query.
void	prepareCursorSelectAllRows()	Pre-build the SQL call from the statement.
void	prepareDeleteAll()	Pre-build the SQL call from the statement.
void	prepareDeleteObject()	Pre-build the SQL call from the statement.
void	prepareDoesExist(DatabaseField field)	Pre-build the SQL call from the statement.
void	prepareExecuteNoSelect()	Pre-build the SQL call from the statement.
void	prepareExecuteSelect()	Pre-build the SQL call from the statement.
void	prepareInsertObject()	Pre-build the SQL call from the statement.
void	prepareSelectAllRows()	Pre-build the SQL call from the statement.
void	prepareSelectOneRow()	Pre-build the SQL call from the statement.
void	prepareUpdateAll()	Pre-build the SQL call from the statement.
void	prepareUpdateObject()	Pre-build the SQL call from the statement.
protected void	setCallFromStatement()	Pre-build the SQL call from the statement.
void	setSQLStatement(SQLStatement statement)	Set the sqlStatement
protected void	setSQLStatements(Vector sqlStatements)	Normally only a single statement is used, however multiple table may require multiple statements on write.
void	trimFieldsForInsert()	INTERNAL Remove a potential sequence number field and invoke the ReturningPolicy trimModifyRowsForInsert method
Integer	updateObject()	Update the object

Methods inherited from class org.eclipse.persistence.internal.queries.CallQueryMechanism

getDatabaseCall, prepareCall, prepareExecute, prepareJoining, setCallHasCustomSQLArguments, unprepare, updateForeignKeyFieldAfterInsert, updateForeignKeyFieldBeforeDelete

Methods inherited from class org.eclipse.persistence.internal.queries.DatasourceCallQueryMechanism

addCall, computeAndSetItemOffset, cursorSelectAllRows, deleteAll, deleteAllUsingTempTables, execute, executeCall, executeCall, executeDeferredCall, executeNoSelectCall, executeSelect, executeSelectCall, generateKeysExecuteNoSelect, getCall, getCalls, hasMultipleCalls, prepareReportQueryItems, prepareReportQuerySelectAllRows, prepareReportQuerySubSelect, selectAllReportQueryRows, selectAllRows, selectOneRow, selectResultSet, selectRowForDoesExist, setCall, setCalls, updateAll, updateAllUsingTempTables

Methods inherited from class org.eclipse.persistence.internal.queries.DatabaseQueryMechanism

addWriteLockFieldForInsert, buildSelectionCriteria, checkCacheForObject, clone, executeWrite, executeWriteWithChangeSet, getDescriptor, getExecutionSession, getModifyRow, getQuery, getReadObjectQuery, getSession, getTranslationRow, getWriteObjectQuery, insertObjectForWrite, isExpressionQueryMechanism, isJPQLCallQueryMechanism, isQueryByExampleMechanism, performUserDefinedInsert, performUserDefinedUpdate, performUserDefinedWrite, registerObjectInIdentityMap, setQuery, shallowInsertObjectForWrite, updateForeignKeyFieldAfterInsert, updateObjectAndRowWithReturnRow, updateObjectAndRowWithSequenceNumber, updateObjectAndRowWithSequenceNumber, updateObjectForWrite, updateObjectForWriteWithChangeSet

Methods inherited from class java.lang.Object

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

Field Detail

sqlStatement

protected SQLStatement sqlStatement

sqlStatements

protected Vector sqlStatements

Normally only a single statement is used, however multiple table may require multiple statements on write.

Constructor Detail

StatementQueryMechanism

public StatementQueryMechanism()

StatementQueryMechanism

public StatementQueryMechanism(DatabaseQuery query)

INTERNAL: Return a new mechanism for the query

Parameters:

query - - owner of mechanism

StatementQueryMechanism

public StatementQueryMechanism(DatabaseQuery query,
                               SQLStatement statement)

Return a new mechanism for the query

Parameters:

query - - owner of mechanism

statement - - sql statement

Method Detail

clearStatement

public void clearStatement()

The statement is no longer require after prepare so can be released.

clone

public DatabaseQueryMechanism clone(DatabaseQuery queryClone)

Clone the mechanism for the specified query clone.

Overrides:

clone in class DatasourceCallQueryMechanism

configureDatabaseCall

protected void configureDatabaseCall(DatabaseCall call)

Description copied from class: CallQueryMechanism

Set the call level query options into the call.

Overrides:

configureDatabaseCall in class CallQueryMechanism

deleteObject

public Integer deleteObject()
                     throws DatabaseException

INTERNAL: delete the object

Overrides:

deleteObject in class DatasourceCallQueryMechanism

Returns:

the row count.

Throws:

DatabaseException - - an error has occurred on the database.

executeNoSelect

public Object executeNoSelect()
                       throws DatabaseException

Update the object

Overrides:

executeNoSelect in class DatasourceCallQueryMechanism

Returns:

the row count.

Throws:

DatabaseException - - an error has occurred on the database.

getSelectionCriteria

public Expression getSelectionCriteria()

Return the selection criteria for the statement.

Overrides:

getSelectionCriteria in class DatabaseQueryMechanism

getSQLStatement

public SQLStatement getSQLStatement()

INTERNAL: Return the sqlStatement

getSQLStatements

public Vector getSQLStatements()

Normally only a single statement is used, however multiple table may require multiple statements on write. This is lazy initialied to conserv space.

hasMultipleStatements

public boolean hasMultipleStatements()

Normally only a single statement is used, however multiple table may require multiple statements on write. This is lazy initialized to conserve space.

insertObject

public void insertObject()
                  throws DatabaseException

Insert the object

Overrides:

insertObject in class DatasourceCallQueryMechanism

Throws:

DatabaseException - - an error has occurred on the database.

insertObject

public void insertObject(boolean reprepare)

Insert the object if the reprepare flag is set, first reprepare the query. Added for CR#3237

Overrides:

insertObject in class DatabaseQueryMechanism

Parameters:

reprepare - whether to reprepare the query.

trimFieldsForInsert

public void trimFieldsForInsert()

INTERNAL Remove a potential sequence number field and invoke the ReturningPolicy trimModifyRowsForInsert method

isCallQueryMechanism

public boolean isCallQueryMechanism()

Return true if this is a call query mechanism

Overrides:

isCallQueryMechanism in class DatasourceCallQueryMechanism

isStatementQueryMechanism

public boolean isStatementQueryMechanism()

Return true if this is a statement query mechanism

Overrides:

isStatementQueryMechanism in class DatabaseQueryMechanism

prepare

public void prepare()

INTERNAL: This is different from 'prepareForExecution' in that this is called on the original query, and the other is called on the copy of the query. This query is copied for concurrency so this prepare can only setup things that will apply to any future execution of this query.

Overrides:

prepare in class DatasourceCallQueryMechanism

prepareCursorSelectAllRows

public void prepareCursorSelectAllRows()

Pre-build the SQL call from the statement.

Overrides:

prepareCursorSelectAllRows in class CallQueryMechanism

prepareDeleteAll

public void prepareDeleteAll()

Pre-build the SQL call from the statement.

Overrides:

prepareDeleteAll in class CallQueryMechanism

prepareDeleteObject

public void prepareDeleteObject()

Pre-build the SQL call from the statement.

Overrides:

prepareDeleteObject in class CallQueryMechanism

prepareDoesExist

public void prepareDoesExist(DatabaseField field)

Pre-build the SQL call from the statement.

Overrides:

prepareDoesExist in class CallQueryMechanism

prepareExecuteNoSelect

public void prepareExecuteNoSelect()

Pre-build the SQL call from the statement.

Overrides:

prepareExecuteNoSelect in class DatasourceCallQueryMechanism

prepareExecuteSelect

public void prepareExecuteSelect()

Pre-build the SQL call from the statement.

Overrides:

prepareExecuteSelect in class CallQueryMechanism

prepareInsertObject

public void prepareInsertObject()

Pre-build the SQL call from the statement.

Overrides:

prepareInsertObject in class DatasourceCallQueryMechanism

prepareSelectAllRows

public void prepareSelectAllRows()

Pre-build the SQL call from the statement.

Overrides:

prepareSelectAllRows in class CallQueryMechanism

prepareSelectOneRow

public void prepareSelectOneRow()

Pre-build the SQL call from the statement.

Overrides:

prepareSelectOneRow in class CallQueryMechanism

prepareUpdateObject

public void prepareUpdateObject()

Pre-build the SQL call from the statement.

Overrides:

prepareUpdateObject in class CallQueryMechanism

prepareUpdateAll

public void prepareUpdateAll()

Pre-build the SQL call from the statement.

Overrides:

prepareUpdateAll in class DatasourceCallQueryMechanism

setCallFromStatement

protected void setCallFromStatement()

Pre-build the SQL call from the statement.

setSQLStatement

public void setSQLStatement(SQLStatement statement)

Set the sqlStatement

setSQLStatements

protected void setSQLStatements(Vector sqlStatements)

Normally only a single statement is used, however multiple table may require multiple statements on write. This is lazy initialized to conserve space.

updateObject

public Integer updateObject()
                     throws DatabaseException

Update the object

Overrides:

updateObject in class DatasourceCallQueryMechanism

Returns:

the row count.

Throws:

DatabaseException - - an error has occurred on the database.