Module org.eclipse.persistence.core

Package org.eclipse.persistence.eis.interactions

Class EISInteraction

java.lang.Object

org.eclipse.persistence.internal.databaseaccess.DatasourceCall

org.eclipse.persistence.eis.interactions.EISInteraction

All Implemented Interfaces:

Serializable, Cloneable, Call

Direct Known Subclasses:

IndexedInteraction, MappedInteraction

public abstract class EISInteraction
extends DatasourceCall

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

Since:

OracleAS TopLink 10g (10.0.3)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

DatasourceCall.ParameterType

Field Summary

Fields

Modifier and Type	Field	Description
protected Vector	arguments	Defines the arguments to the interaction, these can be the values or argument names/fields the values come from.
protected String	functionName	Name of the function the interaction describes.
protected String	inputRecordName	Name to pass to the input record creation.
protected AbstractRecord	inputRow	Holds database row of input values.
protected InteractionSpec	interactionSpec	Adapter specific interaction spec.
protected Vector<String>	outputArgumentNames	Defines the output argument names as defined in the output record for the interaction.
protected Vector<DatabaseField>	outputArguments	Defines the field values the output arguments of the interaction map to.
protected String	outputResultPath	Path to the desired output record if nested.
protected Map<String,Object>	properties	Adapter specific properties may be added.

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

EXECUTE_UPDATE, isNativeConnectionRequired, isPrepared, NO_RETURN, outputCursors, parameterBindings, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, usesBinding

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EISInteraction()	PUBLIC: Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addOutputArgument(String parameterAndArgumentFieldName)	PUBLIC: Define the output argument to the interaction and the field/argument name to be substitute for it.
void	addOutputArgument(String parameterName, String argumentFieldName)	PUBLIC: Define the output argument to the interaction and the field/argument name to be substitute for it.
abstract AbstractRecord	buildRow(Record record, EISAccessor accessor)	INTERNAL: Build a database row from the record returned from the interaction.
Vector<AbstractRecord>	buildRows(Record record, EISAccessor accessor)	Build a collection of database rows from the Record returned from the interaction.
abstract Record	createInputRecord(EISAccessor accessor)	Create the appropriate input record for this interaction.
Object	createRecordElement(String elementName, Object value, EISAccessor accessor)	Create the appropriate record element for the data value.
Vector	getArguments()	The argument fields or values to the interaction that map into the input record.
String	getFunctionName()	PUBLIC: Return the function name of the interaction.
String	getInputRecordName()	PUBLIC: Return the input record name.
AbstractRecord	getInputRow()	INTERNAL: Return the input database row.
InteractionSpec	getInteractionSpec()	PUBLIC: Return the JCA InteractionSpec that defines this EIS interaction.
String	getLogString(Accessor accessor)	Return the string for logging purposes.
Vector<String>	getOutputArgumentNames()	The argument names for the output record.
Vector<DatabaseField>	getOutputArguments()	The argument fields to the interaction that map into the output record.
String	getOutputResultPath()	PUBLIC: The output result path defines the root key for the MappedRecord that the desired interaction result is nested into.
Map<String,Object>	getProperties()	Returns the adapter specific properties.
Object	getProperty(String name)	PUBLIC: Returns the adapter property associated the given name.
boolean	hasArguments()	Return if argumented.
boolean	hasOutputArguments()	Return if argumented.
boolean	isEISInteraction()
void	prepare(AbstractSession session)	Set the default record name from the descriptor.
void	setArguments(Vector arguments)	INTERNAL: The argument fields or values to the interaction that map into the input record.
void	setFunctionName(String functionName)	PUBLIC: Set the function name of the interaction.
void	setInputRecordName(String recordName)	PUBLIC: Set the input record name.
void	setInputRow(AbstractRecord inputRow)	PUBLIC: Set the input database row.
void	setInteractionSpec(InteractionSpec interactionSpec)	PUBLIC: Set the JCA InteractionSpec that defines this EIS interaction.
void	setOutputArgumentNames(Vector<String> outputArgumentNames)	Set the output argument names.
void	setOutputArguments(Vector<DatabaseField> outputArguments)	The output arguments.
void	setOutputResultPath(String outputResultPath)	PUBLIC: The output result path defines the root key for the MappedRecord that the desired interaction result is nested into.
void	setProperties(Map<String,Object> properties)	Set the adapter specific properties.
void	setProperty(String name, Object value)	PUBLIC: Set the adapter specific property.
String	toString()
void	translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session)	Arguments to the interaction can be passed two ways.

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

appendIn, appendIn, appendIn, appendInOut, appendInOut, appendInOut, appendInOut, appendInOut, appendLiteral, appendLiteral, appendLiteral, appendModify, appendModify, appendModify, appendOut, appendOut, appendOut, appendOutCursor, appendOutCursor, appendParameter, appendTranslation, appendTranslation, appendTranslation, areManyRowsReturned, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createField, createInOutParameter, getOutputCursors, getParameterBindings, getParameters, getParameterTypes, getQuery, getQueryString, getReturnType, getValueForInOutParameter, getValueForInParameter, hasOutputCursors, hasParameters, isCursorReturned, isExecuteUpdate, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredPLSQLFunctionCall, isStoredPLSQLProcedureCall, isStoredProcedureCall, isUsesBindingSet, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, setIsNativeConnectionRequired, setIsPrepared, setParameterBindings, setParameters, setParameterTypes, setQuery, setQueryString, setReturnType, setUsesBinding, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, translateQueryStringAndBindParameters, translateQueryStringForParameterizedIN, usesBinding, usesBinding, usesBinding, whitespace

Methods inherited from class java.lang.Object

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

Field Details

interactionSpec

protected InteractionSpec interactionSpec

Adapter specific interaction spec.

functionName

protected String functionName

Name of the function the interaction describes.

inputRecordName

protected String inputRecordName

Name to pass to the input record creation.

properties

protected Map<String,Object> properties

Adapter specific properties may be added.

inputRow

protected AbstractRecord inputRow

Holds database row of input values.

arguments

protected Vector arguments

Defines the arguments to the interaction, these can be the values or argument names/fields the values come from.

outputArgumentNames

protected Vector<String> outputArgumentNames

Defines the output argument names as defined in the output record for the interaction. This is shared as indexed interaction may still have mapped results.

outputArguments

protected Vector<DatabaseField> outputArguments

Defines the field values the output arguments of the interaction map to. These are order dependent with the names.

outputResultPath

protected String outputResultPath

Path to the desired output record if nested.

Constructor Details

EISInteraction

protected EISInteraction()

PUBLIC: Default constructor.

Method Details

addOutputArgument

public void addOutputArgument(String parameterAndArgumentFieldName)

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

addOutputArgument

public void addOutputArgument(String parameterName,
 String argumentFieldName)

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

getArguments

public Vector getArguments()

The argument fields or values to the interaction that map into the input record.

setArguments

public void setArguments(Vector arguments)

INTERNAL: The argument fields or values to the interaction that map into the input record.

hasArguments

public boolean hasArguments()

Return if argumented.

isEISInteraction

public boolean isEISInteraction()

Overrides:

isEISInteraction in class DatasourceCall

getOutputResultPath

public String getOutputResultPath()

PUBLIC: The output result path defines the root key for the MappedRecord that the desired interaction result is nested into. This is required for read interactions that need a nested record to build from the mapped object.

setOutputResultPath

public void setOutputResultPath(String outputResultPath)

PUBLIC: The output result path defines the root key for the MappedRecord that the desired interaction result is nested into. This is required for read interactions that need a nested record to build from the mapped object.

getOutputArgumentNames

public Vector<String> getOutputArgumentNames()

The argument names for the output record.

getOutputArguments

public Vector<DatabaseField> getOutputArguments()

The argument fields to the interaction that map into the output record.

setOutputArguments

public void setOutputArguments(Vector<DatabaseField> outputArguments)

The output arguments.

setOutputArgumentNames

public void setOutputArgumentNames(Vector<String> outputArgumentNames)

Set the output argument names.

hasOutputArguments

public boolean hasOutputArguments()

Return if argumented.

prepare

public void prepare(AbstractSession session)

Set the default record name from the descriptor.

Overrides:

prepare in class DatasourceCall

createRecordElement

public Object createRecordElement(String elementName,
 Object value,
 EISAccessor accessor)

Create the appropriate record element for the data value. If the value is a collection, create a collection of elements, if the value is a map, create a nested map, otherwise just return the value (primitive data).

getInteractionSpec

public InteractionSpec getInteractionSpec()

PUBLIC: Return the JCA InteractionSpec that defines this EIS interaction. The InteractionSpec is JCA adapter specific and typically defines the function name.

setInteractionSpec

public void setInteractionSpec(InteractionSpec interactionSpec)

PUBLIC: Set the JCA InteractionSpec that defines this EIS interaction. The InteractionSpec is JCA adapter specific and typically defines the function name.

getLogString

public String getLogString(Accessor accessor)

Return the string for logging purposes.

Specified by:

getLogString in interface Call

Specified by:

getLogString in class DatasourceCall

translate

public void translate(AbstractRecord translationRow,
 AbstractRecord modifyRow,
 AbstractSession session)

Arguments to the interaction can be passed two ways. The entire argument row can be converted to the input record, or the arguments from the row can be translated into the interaction parameters.

Overrides:

translate in class DatasourceCall

createInputRecord

public abstract Record createInputRecord(EISAccessor accessor)

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

buildRow

public abstract AbstractRecord buildRow(Record record,
 EISAccessor accessor)

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

buildRows

public Vector<AbstractRecord> buildRows(Record record,
 EISAccessor accessor)

Build a collection of database rows from the Record returned from the interaction. This handles IndexedRecords used as sets of result records, and a single MappedRecord with a list of result records.

getFunctionName

public String getFunctionName()

PUBLIC: Return the function name of the interaction. A function name is a common properties for a CCI InteractionSpec. This cannot be generically set on the spec as it is not in the interface however the EIS platform may make use of this in build the interaction spec.

setFunctionName

public void setFunctionName(String functionName)

PUBLIC: Set the function name of the interaction. A function name is a common properties for a CCI InteractionSpec. This cannot be generically set on the spec as it is not in the interface however the EIS platform may make use of this in build the interaction spec.

getInputRecordName

public String getInputRecordName()

PUBLIC: Return the input record name. This is used as the name passed to the adapter when creating the input record.

setInputRecordName

public void setInputRecordName(String recordName)

PUBLIC: Set the input record name. This is used as the name passed to the adapter when creating the input record.

getProperties

public Map<String,Object> getProperties()

Returns the adapter specific properties.

getProperty

public Object getProperty(String name)

PUBLIC: Returns the adapter property associated the given name. If the interaction is associated with a query that has a descriptor, The descriptor's properties are automatically inherited.

setProperties

public void setProperties(Map<String,Object> properties)

Set the adapter specific properties.

setProperty

public void setProperty(String name,
 Object value)

PUBLIC: Set the adapter specific property.

getInputRow

public AbstractRecord getInputRow()

INTERNAL: Return the input database row.

setInputRow

public void setInputRow(AbstractRecord inputRow)

PUBLIC: Set the input database row.

toString

public String toString()

Overrides:

toString in class Object