|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.persistence.internal.databaseaccess.DatasourceCall org.eclipse.persistence.eis.interactions.EISInteraction
public abstract class EISInteraction
Defines the specification for a call to a JCA interaction. Builds the input and output records from the arguments.
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 |
---|
protected javax.resource.cci.InteractionSpec interactionSpec
protected java.lang.String functionName
protected java.lang.String inputRecordName
protected java.util.Map properties
protected org.eclipse.persistence.internal.sessions.AbstractRecord inputRow
protected java.util.Vector arguments
protected java.util.Vector outputArgumentNames
protected java.util.Vector outputArguments
protected java.lang.String outputResultPath
Constructor Detail |
---|
public EISInteraction()
Method Detail |
---|
public void addOutputArgument(java.lang.String parameterAndArgumentFieldName)
public void addOutputArgument(java.lang.String parameterName, java.lang.String argumentFieldName)
public java.util.Vector getArguments()
public void setArguments(java.util.Vector arguments)
public boolean hasArguments()
public boolean isEISInteraction()
isEISInteraction
in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
public java.lang.String getOutputResultPath()
public void setOutputResultPath(java.lang.String outputResultPath)
public java.util.Vector getOutputArgumentNames()
public java.util.Vector getOutputArguments()
public void setOutputArguments(java.util.Vector outputArguments)
public void setOutputArgumentNames(java.util.Vector outputArgumentNames)
public boolean hasOutputArguments()
public void prepare(org.eclipse.persistence.internal.sessions.AbstractSession session)
prepare
in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
public java.lang.Object createRecordElement(java.lang.String elementName, java.lang.Object value, EISAccessor accessor)
public javax.resource.cci.InteractionSpec getInteractionSpec()
public void setInteractionSpec(javax.resource.cci.InteractionSpec interactionSpec)
public java.lang.String getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)
getLogString
in interface Call
getLogString
in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
public void translate(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow, org.eclipse.persistence.internal.sessions.AbstractSession session)
translate
in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
public abstract javax.resource.cci.Record createInputRecord(EISAccessor accessor)
public abstract org.eclipse.persistence.internal.sessions.AbstractRecord buildRow(javax.resource.cci.Record record, EISAccessor accessor)
public java.util.Vector buildRows(javax.resource.cci.Record record, EISAccessor accessor)
public java.lang.String getFunctionName()
public void setFunctionName(java.lang.String functionName)
public java.lang.String getInputRecordName()
public void setInputRecordName(java.lang.String recordName)
public java.util.Map getProperties()
public java.lang.Object getProperty(java.lang.String name)
public void setProperties(java.util.Map properties)
public void setProperty(java.lang.String name, java.lang.Object value)
public org.eclipse.persistence.internal.sessions.AbstractRecord getInputRow()
public void setInputRow(org.eclipse.persistence.internal.sessions.AbstractRecord inputRow)
public java.lang.String toString()
toString
in class java.lang.Object
|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |