Skip navigation links

oracle.toplink.eis
Class EISPlatform

java.lang.Object
oracle.toplink.internal.databaseaccess.DatasourcePlatform
oracle.toplink.eis.EISPlatform

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.toplink.internal.databaseaccess.Platform

Direct Known Subclasses:

AQPlatform, AttunityPlatform, BlackboxPlatform, JMSPlatform, XMLFilePlatform

public class EISPlatform

extends oracle.toplink.internal.databaseaccess.DatasourcePlatform

An EISPlatform defines any EIS adapter specific behavoir. This may include:

• Instantiation of the adapter InteractionSpec
• Conversion from an adapter custom Record
• Perform platform specific record access
• Provide XML DOM record conversion
• Provide sequence support

EISPlatform also supports behavoir for specifing the record types supported and automatic data-conversion to strings.

Although use of the generic EISPlatform may be sufficient, some adapters may require that a specific platform be defined.

Since:

OracleAS TopLink 10g (10.0.3)

See Also:

Serialized Form

Constructor Summary

EISPlatform()
Default constructor.

Method Summary

void	appendParameter(Call call, java.io.Writer writer, java.lang.Object parameter) Add the parameter.
javax.resource.cci.InteractionSpec	buildInteractionSpec(EISInteraction interaction) Allow the platform to build the interaction spec based on properties defined in the interaction.
java.util.Vector	buildRows(javax.resource.cci.Record record, EISInteraction interaction, EISAccessor accessor) Allow the platform to handle record ro row conversion.
javax.resource.cci.Record	createDOMRecord(java.lang.String recordName, EISAccessor accessor) Allow the platform to handle the creation of the DOM record.
javax.resource.cci.Record	createInputRecord(EISInteraction interaction, EISAccessor accessor) Allow the platform to create the appropiate type of record for the interaction.
javax.resource.cci.Record	createOutputRecord(EISInteraction interaction, EISAccessor accessor) Allow the platform to create the appropiate type of record for the interaction.
RecordConverter	getRecordConverter() Return the record converter.
java.lang.Object	getValueFromRecord(java.lang.String key, javax.resource.cci.MappedRecord record, EISAccessor accessor) Retrieves the field value from the record.
boolean	isDOMRecordSupported() Return if this platform supports XML/DOM Records.
boolean	isIndexedRecordSupported() Return if this platform supports JCA IndexedRecord.
boolean	isMappedRecordSupported() Return if this platform supports JCA MappedRecord.
boolean	requiresAutoCommit() Return if this platform requires auto commit of the local transaction for interactions outside of an interaction.
void	setDOMInRecord(org.w3c.dom.Element dom, javax.resource.cci.Record record, EISInteraction call, EISAccessor accessor) Stores the XML DOM value into the record.
void	setIsDOMRecordSupported(boolean isDOMRecordSupported) Set if this platform supports XML/DOM Records.
void	setIsIndexedRecordSupported(boolean isIndexedRecordSupported) Set if this platform supports JCA IndexedRecord.
void	setIsMappedRecordSupported(boolean isMappedRecordSupported) Set if this platform supports JCA MappedRecord.
void	setRecordConverter(RecordConverter recordConverter) Set the record converter.
void	setRequiresAutoCommit(boolean requiresAutoCommit) Set if this platform requires auto commit of the local transaction for interactions outside of an interaction.
void	setShouldConvertDataToStrings(boolean shouldConvertDataToStrings) Set if all data set into the adapter should be first converted to strings.
void	setSupportsLocalTransactions(boolean supportsLocalTransactions) Set if this platform supports local transactions.
void	setValueInRecord(java.lang.String key, java.lang.Object value, javax.resource.cci.MappedRecord record, EISAccessor accessor) Stores the field value into the record.
boolean	shouldConvertDataToStrings() Return if all data set into the adapter should be first converted to strings.
boolean	supportsLocalTransactions() Return if this platform supports local transactions.

Methods inherited from class oracle.toplink.internal.databaseaccess.DatasourcePlatform

addSequence, clone, convertObject, copyInto, getConversionManager, getCustomModifyValueForCall, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultSequence, getOperator, getPlatformOperators, getSelectSequenceQuery, getSequence, getSequencePreallocationSize, getTableQualifier, getTimestampFromServer, getTimestampQuery, getUpdateSequenceQuery, hasDefaultSequence, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isDerby, isHSQL, isInformix, isMySQL, isODBC, isOracle, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, isSybase, isTimesTen, isTimesTen7, removeAllSequences, removeSequence, setConversionManager, setDefaultSequence, setSelectSequenceNumberQuery, setSequencePreallocationSize, setTableQualifier, setTimestampQuery, setUpdateSequenceQuery, shouldUseCustomModifyForCall, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EISPlatform

public EISPlatform()

Default constructor.

Method Detail

getRecordConverter

public RecordConverter getRecordConverter()

Return the record converter.

setRecordConverter

public void setRecordConverter(RecordConverter recordConverter)

Set the record converter. Can be used to convert from an adapter specific record.

requiresAutoCommit

public boolean requiresAutoCommit()

Return if this platform requires auto commit of the local transaction for interactions outside of an interaction.

setRequiresAutoCommit

public void setRequiresAutoCommit(boolean requiresAutoCommit)

Set if this platform requires auto commit of the local transaction for interactions outside of an interaction.

supportsLocalTransactions

public boolean supportsLocalTransactions()

Return if this platform supports local transactions.

setSupportsLocalTransactions

public void setSupportsLocalTransactions(boolean supportsLocalTransactions)

Set if this platform supports local transactions.

isIndexedRecordSupported

public boolean isIndexedRecordSupported()

Return if this platform supports JCA IndexedRecord.

setIsIndexedRecordSupported

public void setIsIndexedRecordSupported(boolean isIndexedRecordSupported)

Set if this platform supports JCA IndexedRecord.

isMappedRecordSupported

public boolean isMappedRecordSupported()

Return if this platform supports JCA MappedRecord.

setIsMappedRecordSupported

public void setIsMappedRecordSupported(boolean isMappedRecordSupported)

Set if this platform supports JCA MappedRecord.

isDOMRecordSupported

public boolean isDOMRecordSupported()

Return if this platform supports XML/DOM Records.

setIsDOMRecordSupported

public void setIsDOMRecordSupported(boolean isDOMRecordSupported)

Set if this platform supports XML/DOM Records.

shouldConvertDataToStrings

public boolean shouldConvertDataToStrings()

Return if all data set into the adapter should be first converted to strings.

setShouldConvertDataToStrings

public void setShouldConvertDataToStrings(boolean shouldConvertDataToStrings)

Set if all data set into the adapter should be first converted to strings.

buildInteractionSpec

public javax.resource.cci.InteractionSpec buildInteractionSpec(EISInteraction interaction)

Allow the platform to build the interaction spec based on properties defined in the interaction.

createInputRecord

public javax.resource.cci.Record createInputRecord(EISInteraction interaction,
                                                   EISAccessor accessor)

Allow the platform to create the appropiate type of record for the interaction.

createOutputRecord

public javax.resource.cci.Record createOutputRecord(EISInteraction interaction,
                                                    EISAccessor accessor)

Allow the platform to create the appropiate type of record for the interaction. If an output record is not required then null is returned.

buildRows

public java.util.Vector buildRows(javax.resource.cci.Record record,
                  EISInteraction interaction,
                  EISAccessor accessor)

Allow the platform to handle record ro row conversion.

createDOMRecord

public javax.resource.cci.Record createDOMRecord(java.lang.String recordName,
                                                 EISAccessor accessor)

Allow the platform to handle the creation of the DOM record. By default create a mapped record an assume it implements DOM as well.

getValueFromRecord

public java.lang.Object getValueFromRecord(java.lang.String key,
                                           javax.resource.cci.MappedRecord record,
                                           EISAccessor accessor)

Retrieves the field value from the record. This allows for the platform to perform any platform specific translation or conversion.

setDOMInRecord

public void setDOMInRecord(org.w3c.dom.Element dom,
                           javax.resource.cci.Record record,
                           EISInteraction call,
                           EISAccessor accessor)

Stores the XML DOM value into the record. This must be implemented by the platform if it support XML/DOM records.

setValueInRecord

public void setValueInRecord(java.lang.String key,
                             java.lang.Object value,
                             javax.resource.cci.MappedRecord record,
                             EISAccessor accessor)

Stores the field value into the record. This allows for the platform to perform any platform specific translation or conversion.

appendParameter

public void appendParameter(Call call,
                            java.io.Writer writer,
                            java.lang.Object parameter)

Add the parameter. Convert the parameter to a string and write it. Convert rows to XML strings.

Specified by:

appendParameter in interface oracle.toplink.internal.databaseaccess.Platform

Overrides:

appendParameter in class oracle.toplink.internal.databaseaccess.DatasourcePlatform

Skip navigation links