org.eclipse.persistence.eis.interactions
Class MappedInteraction

java.lang.Object
  org.eclipse.persistence.internal.databaseaccess.DatasourceCall
      org.eclipse.persistence.eis.interactions.EISInteraction
          org.eclipse.persistence.eis.interactions.MappedInteraction

All Implemented Interfaces:

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

Direct Known Subclasses:

QueryStringInteraction, XMLInteraction

public class MappedInteraction
extends EISInteraction

Defines the specification for a call to a JCA interaction using Mapped records. Builds the input and output records from the arguments.

See Also:

Serialized Form

Author:

James

Since:

OracleAS TopLink 10g (10.0.3)

Field Summary

protected java.util.Vector	argumentNames
protected java.lang.String	inputResultPath

Fields inherited from class org.eclipse.persistence.eis.interactions.EISInteraction

arguments, functionName, inputRecordName, inputRow, interactionSpec, outputArgumentNames, outputArguments, outputResultPath, properties

Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

CUSTOM_MODIFY, IN, INOUT, isNativeConnectionRequired, isPrepared, LITERAL, MODIFY, NO_RETURN, OUT, OUT_CURSOR, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, TRANSLATION

Constructor Summary

MappedInteraction()
Default constructor.

Method Summary

void	addArgument(java.lang.String parameterAndArgumentFieldName) PUBLIC: Define the argument to the interaction and the field/argument name to be substitute for it.
void	addArgument(java.lang.String parameterName, java.lang.String argumentFieldName) PUBLIC: Define the argument to the interaction and the field/argument name to be substitute for it.
void	addArgumentValue(java.lang.String parameterName, java.lang.Object argumentValue) PUBLIC: Define the argument to the interaction and the value name to be input for it.
org.eclipse.persistence.internal.sessions.AbstractRecord	buildRow(javax.resource.cci.Record record, EISAccessor accessor) Build a database row from the record returned from the interaction.
javax.resource.cci.Record	createInputRecord(EISAccessor accessor) Create a mapped input record for this interaction.
javax.resource.cci.Record	createTranslationRecord(org.eclipse.persistence.internal.sessions.AbstractRecord transaltionRow, EISAccessor accessor) Create a mapped input record for this interaction.
java.util.Vector	getArgumentNames() The argument names for the input record.
java.lang.String	getInputResultPath() PUBLIC: The input result path defines the root key for the MappedRecord that the interaction argument is nested into.
void	setArgumentNames(java.util.Vector argumentNames) INTERNAL: The argument names for the input record.
void	setInputResultPath(java.lang.String inputResultPath) PUBLIC: The input result path defines the root key for the MappedRecord that the interaction argument is nested into.

Methods inherited from class org.eclipse.persistence.eis.interactions.EISInteraction

addOutputArgument, addOutputArgument, buildRows, createRecordElement, getArguments, getFunctionName, getInputRecordName, getInputRow, getInteractionSpec, getLogString, getOutputArgumentNames, getOutputArguments, getOutputResultPath, getProperties, getProperty, hasArguments, hasOutputArguments, isEISInteraction, prepare, setArguments, setFunctionName, setInputRecordName, setInputRow, setInteractionSpec, setOutputArgumentNames, setOutputArguments, setOutputResultPath, setProperties, setProperty, toString, translate

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

appendIn, appendInOut, appendLiteral, appendModify, appendOut, appendParameter, appendTranslation, areManyRowsReturned, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createField, createInOutParameter, getParameters, getParameterTypes, getQuery, getQueryString, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isCursorReturned, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredProcedureCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setQueryString, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, whitespace

Methods inherited from class java.lang.Object

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

Field Detail

inputResultPath

protected java.lang.String inputResultPath

argumentNames

protected java.util.Vector argumentNames

Constructor Detail

MappedInteraction

public MappedInteraction()

Default constructor.

Method Detail

addArgument

public void addArgument(java.lang.String parameterAndArgumentFieldName)

PUBLIC: Define the argument to the interaction and the field/argument name to be substitute for it. This is only required if an input row is not used. The parameterAndArgumentFieldName is the name of the input record argument, and is the field or argument name to be used to pass to the interaction. These names are assumed to be the same, if not this method can be called with two arguments.

addArgument

public void addArgument(java.lang.String parameterName,
                        java.lang.String argumentFieldName)

PUBLIC: Define the argument to the interaction and the field/argument name to be substitute for it. This is only required if an input row is not used. The parameterName is the name of the input record argument. The argumentFieldName is the field or argument name to be used to pass to the interaction. If these names are the same (as they normally are) this method can be called with a single argument.

addArgumentValue

public void addArgumentValue(java.lang.String parameterName,
                             java.lang.Object argumentValue)

PUBLIC: Define the argument to the interaction and the value name to be input for it. This is only required if an input row is not used. The parameterName is the name of the input record argument. The argumentValue is the value of the input record argument.

getInputResultPath

public java.lang.String getInputResultPath()

PUBLIC: The input result path defines the root key for the MappedRecord that the interaction argument is nested into. This is required for write interaction that take the row build from the mapped object and need the input to contain that row record as part of the input, instead of the entire input.

setInputResultPath

public void setInputResultPath(java.lang.String inputResultPath)

PUBLIC: The input result path defines the root key for the MappedRecord that the interaction argument is nested into. This is required for write interaction that take the row build from the mapped object and need the input to contain that row record as part of the input, instead of the entire input.

getArgumentNames

public java.util.Vector getArgumentNames()

The argument names for the input record.

setArgumentNames

public void setArgumentNames(java.util.Vector argumentNames)

INTERNAL: The argument names for the input record.

createInputRecord

public javax.resource.cci.Record createInputRecord(EISAccessor accessor)

Create a mapped input record for this interaction. Populate the data into the record from this interaction's arguments.

Specified by:

createInputRecord in class EISInteraction

createTranslationRecord

public javax.resource.cci.Record createTranslationRecord(org.eclipse.persistence.internal.sessions.AbstractRecord transaltionRow,
                                                         EISAccessor accessor)

Create a mapped input record for this interaction. Populate the data into the record from this interaction's translation row.

buildRow

public org.eclipse.persistence.internal.sessions.AbstractRecord buildRow(javax.resource.cci.Record record,
                                                                         EISAccessor accessor)

Build a database row from the record returned from the interaction.

Specified by:

buildRow in class EISInteraction