FileDocCategorySizeDatePackage
QueryStringCall.javaAPI DocGlassfish v2 API5504Tue May 22 16:54:22 BST 2007oracle.toplink.essentials.internal.databaseaccess

QueryStringCall

public interface QueryStringCall implements Call
INTERNAL: Purpose: Used to define query string calls. These include SQLCall, XQueryInteraction which reuse translation behavoir through this interface.
author
James Sutherland
since
OracleAS TopLink 10g (10.0.3)

Fields Summary
Constructors Summary
Methods Summary
public voidappendLiteral(java.io.Writer writer, java.lang.Object literal)
All values are printed as ? to allow for parameter binding or translation during the execute of the call.

public voidappendModify(java.io.Writer writer, oracle.toplink.essentials.internal.helper.DatabaseField modifyField)
All values are printed as ? to allow for parameter binding or translation during the execute of the call.

public voidappendParameter(java.io.Writer writer, java.lang.Object parameter, oracle.toplink.essentials.internal.sessions.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.

public voidappendTranslation(java.io.Writer writer, oracle.toplink.essentials.internal.helper.DatabaseField modifyField)
All values are printed as ? to allow for parameter binding or translation during the execute of the call.

public java.util.VectorgetParameterTypes()
The parameter types determine if the parameter is a modify, translation or litteral type.

public java.util.VectorgetParameters()
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.

public java.lang.StringgetQueryString()
Return the query string of the call. This must be overwritten by subclasses that support query language translation (SQLCall, XQueryCall).

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

public booleanisQueryStringCall()
Should return true.

public voidprepare(oracle.toplink.essentials.internal.sessions.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.

public voidsetQueryString(java.lang.String queryString)
Set the query string of the call. This must be overwritten by subclasses that support query language translation (SQLCall, XQueryCall).

public voidtranslate(oracle.toplink.essentials.internal.sessions.AbstractRecord translationRow, oracle.toplink.essentials.internal.sessions.AbstractRecord modifyRow, oracle.toplink.essentials.internal.sessions.AbstractSession session)
Allow the call to translate from the translation for predefined calls. This should call translateQueryString() in the call implementation.

public voidtranslateCustomQuery()
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.

public voidtranslateQueryString(oracle.toplink.essentials.internal.sessions.AbstractRecord translationRow, oracle.toplink.essentials.internal.sessions.AbstractRecord modifyRow, oracle.toplink.essentials.internal.sessions.AbstractSession session)
Allow the call to translate from the translation for predefined calls.