Top Description Fields Constructors Methods
org.eclipse.persistence.eis.interactions

public Class QueryStringInteraction

extends MappedInteraction
implements QueryStringCall
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.internal.databaseaccess.QueryStringCall, org.eclipse.persistence.queries.Call, java.io.Serializable, java.lang.Cloneable
Imports
java.util.*, java.io.*, org.eclipse.persistence.internal.databaseaccess.Accessor, .QueryStringCall, org.eclipse.persistence.internal.helper.*, org.eclipse.persistence.internal.sessions.AbstractRecord, .AbstractSession
Defines the specification for a call to a JCA interaction that uses a query string. This can be used for generic query translation support (i.e. VSAM, BETRIEVE, ADA, etc.) Arguments are defined in the query string through #<field-name> (i.e. #EMP_ID) Translates the query string from the query arguments. Builds the input and output records.
Author
James
Since
OracleAS TopLink 10g (10.0.3)

Field Summary

Modifier and TypeField and Description
protected String
queryString

Inherited from org.eclipse.persistence.eis.interactions.MappedInteraction:
argumentNamesinputResultPath

Constructor Summary

AccessConstructor and Description
public
QueryStringInteraction()

Default constructor.

public
QueryStringInteraction(String queryString)

Construct interaction with the query string.

Method Summary

Modifier and TypeMethod and Description
public String
getLogString(Accessor accessor)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.getLogString.

Implements org.eclipse.persistence.queries.Call.getLogString.

Return the string for logging purposes.
public String
getQueryString()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.getQueryString.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.getQueryString.

PUBLIC: Return the query string.
public boolean
isQueryStringCall()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.isQueryStringCall.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.isQueryStringCall.

Should return true.
public void
prepare(AbstractSession session)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.prepare.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.prepare.

Translate the custom query markers.
public void
setQueryString(String queryString)

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.setQueryString.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.setQueryString.

PUBLIC: Set the query string.
public void
translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.translate.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.translate.

Allow the call to translate the query arguments.
Inherited from org.eclipse.persistence.eis.interactions.MappedInteraction:
addArgumentaddArgumentaddArgumentValuebuildRowcreateInputRecordcreateTranslationRecordgetArgumentNamesgetInputResultPathsetArgumentNamessetInputResultPath

Field Detail

queryStringback to summary
protected String queryString

Constructor Detail

QueryStringInteractionback to summary
public QueryStringInteraction()

Default constructor.

QueryStringInteractionback to summary
public QueryStringInteraction(String queryString)

Construct interaction with the query string.

Method Detail

getLogStringback to summary
public String getLogString(Accessor accessor)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.getLogString.

Implements org.eclipse.persistence.queries.Call.getLogString.

Return the string for logging purposes.

Annotations
@Override
getQueryStringback to summary
public String getQueryString()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.getQueryString.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.getQueryString.

PUBLIC: Return the query string.

Annotations
@Override
isQueryStringCallback to summary
public boolean isQueryStringCall()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.isQueryStringCall.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.isQueryStringCall.

Doc from org.eclipse.persistence.internal.databaseaccess.QueryStringCall.isQueryStringCall.

Should return true.

Annotations
@Override
prepareback to summary
public void prepare(AbstractSession session)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.prepare.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.prepare.

Translate the custom query markers.

Annotations
@Override
setQueryStringback to summary
public void setQueryString(String queryString)

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.setQueryString.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.setQueryString.

PUBLIC: Set the query string.

Annotations
@Override
translateback to summary
public void translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.translate.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.translate.

Allow the call to translate the query arguments.

Annotations
@Override