oracle.toplink.sdk
Class AbstractSDKCall

java.lang.Object
oracle.toplink.sdk.AbstractSDKCall

All Implemented Interfaces:

Call, java.lang.Cloneable, SDKCall, java.io.Serializable

Direct Known Subclasses:

XMLCall

public abstract class AbstractSDKCall

extends java.lang.Object

implements SDKCall

AbstractSDKCall provides a base implementation of SDKCall. It associates the call with its executing query. It also associates the call with the appropriate SDK query mechanism. It also provides for a call-specific field translator that allows the database row to be translated on its way to and from the data store. Subclasses are still required to implement #execute(DatabaseRow, Accessor).

Since:

TOPLink/Java 3.0

See Also:

SDKQueryMechanism, DatabaseQuery, FieldTranslator, DefaultFieldTranslator, Serialized Form

Method Summary

void	addReadTranslation(java.lang.String dataStoreFieldName, java.lang.String mappingFieldName) Add a translation.
void	addReadTranslations(java.lang.String[] dataStoreFieldNames, java.lang.String[] mappingFieldNames) Add translations.
void	addReadTranslations(java.util.Vector translations) Add translations.
void	addWriteTranslation(java.lang.String mappingFieldName, java.lang.String dataStoreFieldName) Add a translation.
void	addWriteTranslations(java.lang.String[] mappingFieldNames, java.lang.String[] dataStoreFieldNames) Add translations.
void	addWriteTranslations(java.util.Vector translations) Add translations.
FieldTranslator	buildDefaultTranslator() Build and return the default field translator that converts database row field names.
oracle.toplink.internal.queryframework.DatabaseQueryMechanism	buildNewQueryMechanism(DatabaseQuery query) Return the appropriate mechanism, with the call added as necessary.
oracle.toplink.internal.queryframework.DatabaseQueryMechanism	buildQueryMechanism(DatabaseQuery query, oracle.toplink.internal.queryframework.DatabaseQueryMechanism mechanism) Return the appropriate mechanism, with the call added as necessary.
java.lang.Object	clone() INTERNAL: Return a clone of the call.
SDKCall	clone(DatabaseQuery queryClone) Clone the call with the new query.
FieldTranslator	getFieldTranslator() Return the translator that converts database row field names.
java.lang.String	getLogString() Return a string appropriate for the session log.
boolean	isFinished() Return whether the call is finished returning all of its results (e.g. a call that returns a cursor that will continue to access the data store after the initial invocation will answer false).
void	setFieldTranslator(FieldTranslator fieldTranslator) Set the translator that converts database row field names.
java.lang.String	toString() Call #toString(PrintWriter), to allow subclasses to insert additional information.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.toplink.sdk.SDKCall

execute

Method Detail

addReadTranslation

public void addReadTranslation(java.lang.String dataStoreFieldName,
                               java.lang.String mappingFieldName)

Add a translation. When a database row is read from the data store, any field with the specified data store field name will be translated to the specified mapping field name. The corresponding write translation will also be added.

addReadTranslations

public void addReadTranslations(java.lang.String[] dataStoreFieldNames,
                                java.lang.String[] mappingFieldNames)

Add translations. When a database row is read from the data store, any field with the specified data store field name will be translated to the specified mapping field name. The corresponding write translations will also be added.

addReadTranslations

public void addReadTranslations(java.util.Vector translations)

Add translations. When a database row is read from the data store, any field with the specified data store field name will be translated to the specified mapping field name. The corresponding write translations will also be added.

addWriteTranslation

public void addWriteTranslation(java.lang.String mappingFieldName,
                                java.lang.String dataStoreFieldName)

Add a translation. When a database row is to be written to the data store, any field with the specified mapping field name will be translated to the specified data store field name. The corresponding read translation will also be added.

addWriteTranslations

public void addWriteTranslations(java.lang.String[] mappingFieldNames,
                                 java.lang.String[] dataStoreFieldNames)

Add translations. When a database row is to be written to the data store, any field with the specified mapping field name will be translated to the specified data store field name. The corresponding read translations will also be added.

addWriteTranslations

public void addWriteTranslations(java.util.Vector translations)

Add translations. When a database row is to be written to the data store, any field with the specified mapping field name will be translated to the specified data store field name. The corresponding read translations will also be added.

buildDefaultTranslator

public FieldTranslator buildDefaultTranslator()

Build and return the default field translator that converts database row field names.

buildNewQueryMechanism

public oracle.toplink.internal.queryframework.DatabaseQueryMechanism buildNewQueryMechanism(DatabaseQuery query)

Return the appropriate mechanism, with the call added as necessary.

Specified by:

buildNewQueryMechanism in interface Call

buildQueryMechanism

public oracle.toplink.internal.queryframework.DatabaseQueryMechanism buildQueryMechanism(DatabaseQuery query,
                                                                                         oracle.toplink.internal.queryframework.DatabaseQueryMechanism mechanism)

Return the appropriate mechanism, with the call added as necessary.

Specified by:

buildQueryMechanism in interface Call

clone

public java.lang.Object clone()

Description copied from interface: Call

INTERNAL: Return a clone of the call.

Specified by:

clone in interface Call

clone

public SDKCall clone(DatabaseQuery queryClone)

Clone the call with the new query. This is the only place where the query is actually set. The query is only used *after* the cloning of the call.

Specified by:

clone in interface SDKCall

getFieldTranslator

public FieldTranslator getFieldTranslator()

Return the translator that converts database row field names.

getLogString

public java.lang.String getLogString()

Return a string appropriate for the session log.

Specified by:

getLogString in interface Call

isFinished

public boolean isFinished()

Return whether the call is finished returning all of its results (e.g. a call that returns a cursor that will continue to access the data store after the initial invocation will answer false). The default is true.

Specified by:

isFinished in interface Call

setFieldTranslator

public void setFieldTranslator(FieldTranslator fieldTranslator)

Set the translator that converts database row field names.

toString

public java.lang.String toString()

Call #toString(PrintWriter), to allow subclasses to insert additional information.