Top Description Methods

org.eclipse.persistence.internal.databaseaccess

public Interface QueryStringCall

Known Direct Implementers: org.eclipse.persistence.eis.interactions.QueryStringInteraction, org.eclipse.persistence.eis.interactions.XQueryInteraction, org.eclipse.persistence.queries.SQLCall
Imports: java.io.Writer, java.util.List, org.eclipse.persistence.internal.databaseaccess.DatasourceCall.ParameterType, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.sessions.AbstractRecord, .AbstractSession, org.eclipse.persistence.queries.Call

INTERNAL: Purpose: Used to define query string calls. These include SQLCall, XQueryInteraction which reuse translation behavior through this interface.

Author: James Sutherland
Since: OracleAS TopLink 10g (10.0.3)

Method Summary

Modifier and Type	Method and Description
public void	appendLiteral(Writer writer, Object literal) All values are printed as ?
public void	appendModify(Writer writer, DatabaseField modifyField) All values are printed as ?
public void	appendParameter(Writer writer, Object parameter, boolean shouldBind, AbstractSession session) Add the parameter.
public void	appendTranslation(Writer writer, DatabaseField modifyField) All values are printed as ?
public List<Object>	getParameters() The parameters are the values in order of occurance in the SQL statement.
public List<DatasourceCall.ParameterType>	getParameterTypes() The parameter types determine if the parameter is a modify, translation or litteral type.
public String	getQueryString() Return the query string of the call.
public boolean	hasParameters() The parameters are the values in order of occurance in call.
public boolean	isQueryStringCall() Should return true.
public void	prepare(AbstractSession session) Allow pre-printing of the query/SQL string for fully bound calls, to save from reprinting.
public void	setQueryString(String queryString) Set the query string of the call.
public void	translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session) Allow the call to translate from the translation for predefined calls.
public void	translateCustomQuery() Parse the query string for # markers for custom query based on a query language.
public void	translateQueryString(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session) Allow the call to translate from the translation for predefined calls.

Inherited from org.eclipse.persistence.queries.Call:: buildNewQueryMechanism buildQueryMechanism clone getLogString isFinished isNothingReturned isOneRowReturned

Method Detail

appendLiteral	back to summary
public void appendLiteral(Writer writer, Object literal) All values are printed as ? to allow for parameter binding or translation during the execute of the call.

appendModify	back to summary
public void appendModify(Writer writer, DatabaseField modifyField) All values are printed as ? to allow for parameter binding or translation during the execute of the call.

appendParameter	back to summary
public void appendParameter(Writer writer, Object parameter, boolean shouldBind, AbstractSession session) Add the parameter. If using binding bind the parameter otherwise let the platform print it. The platform may also decide to bind the value.

appendTranslation	back to summary
public void appendTranslation(Writer writer, DatabaseField modifyField) All values are printed as ? to allow for parameter binding or translation during the execute of the call.

getParameters	back to summary
public List<Object> getParameters() The parameters are the values in order of occurance in the SQL statement. This is lazy initialized to conserv space on calls that have no parameters.

getParameterTypes	back to summary
public List<DatasourceCall.ParameterType> getParameterTypes() The parameter types determine if the parameter is a modify, translation or litteral type.

getQueryString	back to summary
public String getQueryString() Return the query string of the call. This must be overwritten by subclasses that support query language translation (SQLCall, XQueryCall).

hasParameters	back to summary
public boolean hasParameters() The parameters are the values in order of occurance in call. This is lazy initialized to conserv space on calls that have no parameters.

isQueryStringCall	back to summary
public boolean isQueryStringCall() Should return true.

prepare	back to summary
public void prepare(AbstractSession session) Allow pre-printing of the query/SQL string for fully bound calls, to save from reprinting. This should call translateCustomQuery() in the call implementation.

setQueryString	back to summary
public void setQueryString(String queryString) Set the query string of the call. This must be overwritten by subclasses that support query language translation (SQLCall, XQueryCall).

translate	back to summary
public void translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session) Allow the call to translate from the translation for predefined calls. This should call translateQueryString() in the call implementation.

translateCustomQuery	back to summary
public void translateCustomQuery() Parse the query string for # markers for custom query based on a query language. This is used by SQLCall and XQuery call, but can be reused by other query languages.

translateQueryString	back to summary
public void translateQueryString(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session) Allow the call to translate from the translation for predefined calls.