EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.eis.interactions
Class EISInteraction

java.lang.Object
  extended by org.eclipse.persistence.internal.databaseaccess.DatasourceCall
      extended by org.eclipse.persistence.eis.interactions.EISInteraction
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Call
Direct Known Subclasses:
IndexedInteraction, MappedInteraction

public abstract class EISInteraction
extends org.eclipse.persistence.internal.databaseaccess.DatasourceCall

Defines the specification for a call to a JCA interaction. 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 arguments
          Defines the arguments to the interaction, these can be the values or argument names/fields the values come from.
protected  java.lang.String functionName
          Name of the function the interaction describes.
protected  java.lang.String inputRecordName
          Name to pass to the input record creation.
protected  org.eclipse.persistence.internal.sessions.AbstractRecord inputRow
          Holds database row of input values.
protected  javax.resource.cci.InteractionSpec interactionSpec
          Adapter specific interaction spec.
protected  java.util.Vector outputArgumentNames
          Defines the output argument names as defined in the output record for the interaction.
protected  java.util.Vector outputArguments
          Defines the field values the output arguments of the interaction map to.
protected  java.lang.String outputResultPath
          Path to the desired output record if nested.
protected  java.util.Map properties
          Adapter specific properties may be added.
 
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
EISInteraction()
          PUBLIC: Default constructor.
 
Method Summary
 void addOutputArgument(java.lang.String parameterAndArgumentFieldName)
          PUBLIC: Define the output argument to the interaction and the field/argument name to be substitute for it.
 void addOutputArgument(java.lang.String parameterName, java.lang.String argumentFieldName)
          PUBLIC: Define the output argument to the interaction and the field/argument name to be substitute for it.
abstract  org.eclipse.persistence.internal.sessions.AbstractRecord buildRow(javax.resource.cci.Record record, EISAccessor accessor)
          INTERNAL: Build a database row from the record returned from the interaction.
 java.util.Vector buildRows(javax.resource.cci.Record record, EISAccessor accessor)
          Build a collection of database rows from the Record returned from the interaction.
abstract  javax.resource.cci.Record createInputRecord(EISAccessor accessor)
          Create the appropriate input record for this interaction.
 java.lang.Object createRecordElement(java.lang.String elementName, java.lang.Object value, EISAccessor accessor)
          Create the appropriate record element for the data value.
 java.util.Vector getArguments()
          The argument fields or values to the interaction that map into the input record.
 java.lang.String getFunctionName()
          PUBLIC: Return the function name of the interaction.
 java.lang.String getInputRecordName()
          PUBLIC: Return the input record name.
 org.eclipse.persistence.internal.sessions.AbstractRecord getInputRow()
          INTERNAL: Return the input database row.
 javax.resource.cci.InteractionSpec getInteractionSpec()
          PUBLIC: Return the JCA InteractionSpec that defines this EIS interaction.
 java.lang.String getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)
          Return the string for logging purposes.
 java.util.Vector getOutputArgumentNames()
          The argument names for the output record.
 java.util.Vector getOutputArguments()
          The argument fields to the interaction that map into the output record.
 java.lang.String getOutputResultPath()
          PUBLIC: The output result path defines the root key for the MappedRecord that the desired interaction result is nested into.
 java.util.Map getProperties()
          Returns the adapter specific properties.
 java.lang.Object getProperty(java.lang.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(org.eclipse.persistence.internal.sessions.AbstractSession session)
          Set the default record name from the descriptor.
 void setArguments(java.util.Vector arguments)
          INTERNAL: The argument fields or values to the interaction that map into the input record.
 void setFunctionName(java.lang.String functionName)
          PUBLIC: Set the function name of the interaction.
 void setInputRecordName(java.lang.String recordName)
          PUBLIC: Set the input record name.
 void setInputRow(org.eclipse.persistence.internal.sessions.AbstractRecord inputRow)
          PUBLIC: Set the input database row.
 void setInteractionSpec(javax.resource.cci.InteractionSpec interactionSpec)
          PUBLIC: Set the JCA InteractionSpec that defines this EIS interaction.
 void setOutputArgumentNames(java.util.Vector outputArgumentNames)
          Set the output argument names.
 void setOutputArguments(java.util.Vector outputArguments)
          The output arguments.
 void setOutputResultPath(java.lang.String outputResultPath)
          PUBLIC: The output result path defines the root key for the MappedRecord that the desired interaction result is nested into.
 void setProperties(java.util.Map properties)
          Set the adapter specific properties.
 void setProperty(java.lang.String name, java.lang.Object value)
          PUBLIC: Set the adapter specific property.
 java.lang.String toString()
           
 void translate(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow, org.eclipse.persistence.internal.sessions.AbstractSession session)
          Arguments to the interaction can be passed two ways.
 
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

interactionSpec

protected javax.resource.cci.InteractionSpec interactionSpec
Adapter specific interaction spec.


functionName

protected java.lang.String functionName
Name of the function the interaction describes.


inputRecordName

protected java.lang.String inputRecordName
Name to pass to the input record creation.


properties

protected java.util.Map properties
Adapter specific properties may be added.


inputRow

protected org.eclipse.persistence.internal.sessions.AbstractRecord inputRow
Holds database row of input values.


arguments

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


outputArgumentNames

protected java.util.Vector 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 java.util.Vector outputArguments
Defines the field values the output arguments of the interaction map to. These are order dependent with the names.


outputResultPath

protected java.lang.String outputResultPath
Path to the desired output record if nested.

Constructor Detail

EISInteraction

public EISInteraction()
PUBLIC: Default constructor.

Method Detail

addOutputArgument

public void addOutputArgument(java.lang.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(java.lang.String parameterName,
                              java.lang.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 java.util.Vector getArguments()
The argument fields or values to the interaction that map into the input record.


setArguments

public void setArguments(java.util.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 org.eclipse.persistence.internal.databaseaccess.DatasourceCall

getOutputResultPath

public java.lang.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(java.lang.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 java.util.Vector getOutputArgumentNames()
The argument names for the output record.


getOutputArguments

public java.util.Vector getOutputArguments()
The argument fields to the interaction that map into the output record.


setOutputArguments

public void setOutputArguments(java.util.Vector outputArguments)
The output arguments.


setOutputArgumentNames

public void setOutputArgumentNames(java.util.Vector outputArgumentNames)
Set the output argument names.


hasOutputArguments

public boolean hasOutputArguments()
Return if argumented.


prepare

public void prepare(org.eclipse.persistence.internal.sessions.AbstractSession session)
Set the default record name from the descriptor.

Overrides:
prepare in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

createRecordElement

public java.lang.Object createRecordElement(java.lang.String elementName,
                                            java.lang.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 javax.resource.cci.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(javax.resource.cci.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 java.lang.String getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)
Return the string for logging purposes.

Specified by:
getLogString in interface Call
Specified by:
getLogString in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

translate

public void translate(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow,
                      org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow,
                      org.eclipse.persistence.internal.sessions.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 org.eclipse.persistence.internal.databaseaccess.DatasourceCall

createInputRecord

public abstract javax.resource.cci.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 org.eclipse.persistence.internal.sessions.AbstractRecord buildRow(javax.resource.cci.Record record,
                                                                                  EISAccessor accessor)
INTERNAL: Build a database row from the record returned from the interaction.


buildRows

public java.util.Vector buildRows(javax.resource.cci.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.util.Map getProperties()
Returns the adapter specific properties.


getProperty

public java.lang.Object getProperty(java.lang.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(java.util.Map properties)
Set the adapter specific properties.


setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
PUBLIC: Set the adapter specific property.


getInputRow

public org.eclipse.persistence.internal.sessions.AbstractRecord getInputRow()
INTERNAL: Return the input database row.


setInputRow

public void setInputRow(org.eclipse.persistence.internal.sessions.AbstractRecord inputRow)
PUBLIC: Set the input database row.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

EclipseLink 2.2.0, build 'v20110202-r8913' API Reference