EclipseLink Core 4.0.2 · org.eclipse.persistence.eis.EISPlatform

Field Summary

Modifier and Type	Field and Description
protected Method	domMethod Used to reflectively provide XML record support as DOMRecord is not part of the JCA-CCI spec.
protected boolean	isDOMRecordSupported
protected boolean	isIndexedRecordSupported
protected boolean	isMappedRecordSupported
protected RecordConverter	recordConverter Can be used to convert from an adapter specific record.
protected boolean	requiresAutoCommit Can be used if a commit is required after every interaction outside of a local transaction.
protected boolean	shouldConvertDataToStrings Can be used for adapters that only support String data/XML.
protected boolean	supportsLocalTransactions Allows for usage of transaction to be disabled if not supported.
protected XMLConversionManager	xmlConversionManager For XML usage, an XMLConversionManager instance is required

Inherited from org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform:: conversionManager dataTypesConvertedFromAClass dataTypesConvertedToAClass defaultNativeSequenceToTable defaultSeqenceAtNextValue defaultSequence endDelimiter platformOperators sequences sequencesLock startDelimiter supportsReturnGeneratedKeys tableQualifier timestampQuery uuidQuery

Access	Constructor and Description
public	EISPlatform() Default constructor.

Access

Constructor and Description

public

EISPlatform()

Default constructor.

Method Summary

Modifier and Type	Method and Description
public void	appendParameter(Call call, Writer writer, Object parameter) Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.appendParameter. Implements org.eclipse.persistence.internal.databaseaccess.Platform.appendParameter. Add the parameter.
public DatasourceCall	buildCallFromStatement(SQLStatement statement, DatabaseQuery query, AbstractSession session) INTERNAL: Override this method to throw an exception by default.
public InteractionSpec	buildInteractionSpec(EISInteraction interaction) Allow the platform to build the interaction spec based on properties defined in the interaction.
public DatasourceCall	buildNativeCall(String queryString) Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.buildNativeCall. INTERNAL: Return the correct call type for the native query string.
public AbstractRecord	buildRow(Record record, EISInteraction interaction, EISAccessor accessor) INTERNAL: Allow the platform to handle record to row conversion.
public Vector<AbstractRecord>	buildRows(Record record, EISInteraction interaction, EISAccessor accessor) Allow the platform to handle record to row conversion.
public AbstractRecord	createDatabaseRowFromDOMRecord(Record record, EISInteraction call, EISAccessor accessor) INTERNAL: Allow the platform to handle the creation of the Record for the DOM record.
public Record	createDOMRecord(String recordName, EISAccessor accessor) Allow the platform to handle the creation of the DOM record.
public Record	createInputRecord(EISInteraction interaction, EISAccessor accessor) Allow the platform to create the appropriate type of record for the interaction.
public Record	createOutputRecord(EISInteraction interaction, AbstractRecord translationRow, EISAccessor accessor) Allow the platform to create the appropriate type of record for the interaction.
public ConversionManager	getConversionManager() Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.getConversionManager. Implements org.eclipse.persistence.internal.databaseaccess.Platform.getConversionManager. The platform holds its own instance of conversion manager to allow customization.
public RecordConverter	getRecordConverter() Return the record converter.
public Object	getValueFromRecord(String key, MappedRecord<K, V> record, EISAccessor accessor) Retrieves the field value from the record.
public boolean	isDOMRecordSupported() Return if this platform supports XML/DOM Records.
public boolean	isIndexedRecordSupported() Return if this platform supports JCA IndexedRecord.
public boolean	isMappedRecordSupported() Return if this platform supports JCA MappedRecord.
public boolean	requiresAutoCommit() Return if this platform requires auto commit of the local transaction for interactions outside of an interaction.
public void	setDOMInRecord(Element dom, Record record, EISInteraction call, EISAccessor accessor) Stores the XML DOM value into the record.
public void	setIsDOMRecordSupported(boolean isDOMRecordSupported) Set if this platform supports XML/DOM Records.
public void	setIsIndexedRecordSupported(boolean isIndexedRecordSupported) Set if this platform supports JCA IndexedRecord.
public void	setIsMappedRecordSupported(boolean isMappedRecordSupported) Set if this platform supports JCA MappedRecord.
public void	setRecordConverter(RecordConverter recordConverter) Set the record converter.
public void	setRequiresAutoCommit(boolean requiresAutoCommit) Set if this platform requires auto commit of the local transaction for interactions outside of an interaction.
public void	setShouldConvertDataToStrings(boolean shouldConvertDataToStrings) Set if all data set into the adapter should be first converted to strings.
public void	setSupportsLocalTransactions(boolean supportsLocalTransactions) Set if this platform supports local transactions.
public void	setValueInRecord(String key, Object value, MappedRecord<K, V> record, EISAccessor accessor) Stores the field value into the record.
public boolean	shouldConvertDataToStrings() Return if all data set into the adapter should be first converted to strings.
public boolean	supportsLocalTransactions() Return if this platform supports local transactions.

Modifier and Type

Method and Description

public void

appendParameter(Call call, Writer writer, Object parameter)

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.appendParameter.

Implements org.eclipse.persistence.internal.databaseaccess.Platform.appendParameter.

Add the parameter.

public DatasourceCall

buildCallFromStatement(SQLStatement statement, DatabaseQuery query, AbstractSession session)

INTERNAL: Override this method to throw an exception by default.

public InteractionSpec

buildInteractionSpec(EISInteraction interaction)

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

public DatasourceCall

buildNativeCall(String queryString)

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.buildNativeCall.

INTERNAL: Return the correct call type for the native query string.

public AbstractRecord

buildRow(Record record, EISInteraction interaction, EISAccessor accessor)

INTERNAL: Allow the platform to handle record to row conversion.

public Vector<AbstractRecord>

buildRows(Record record, EISInteraction interaction, EISAccessor accessor)

Allow the platform to handle record to row conversion.

public AbstractRecord

createDatabaseRowFromDOMRecord(Record record, EISInteraction call, EISAccessor accessor)

INTERNAL: Allow the platform to handle the creation of the Record for the DOM record.

public Record

createDOMRecord(String recordName, EISAccessor accessor)

Allow the platform to handle the creation of the DOM record.

public Record

createInputRecord(EISInteraction interaction, EISAccessor accessor)

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

public Record

createOutputRecord(EISInteraction interaction, AbstractRecord translationRow, EISAccessor accessor)

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

public ConversionManager

getConversionManager()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.getConversionManager.

Implements org.eclipse.persistence.internal.databaseaccess.Platform.getConversionManager.

The platform holds its own instance of conversion manager to allow customization.

public RecordConverter

getRecordConverter()

Return the record converter.

public Object

getValueFromRecord(String key, MappedRecord<K, V> record, EISAccessor accessor)

Retrieves the field value from the record.

public boolean

isDOMRecordSupported()

Return if this platform supports XML/DOM Records.

public boolean

isIndexedRecordSupported()

Return if this platform supports JCA IndexedRecord.

public boolean

isMappedRecordSupported()

Return if this platform supports JCA MappedRecord.

public boolean

requiresAutoCommit()

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

public void

setDOMInRecord(Element dom, Record record, EISInteraction call, EISAccessor accessor)

Stores the XML DOM value into the record.

public void

setIsDOMRecordSupported(boolean isDOMRecordSupported)

Set if this platform supports XML/DOM Records.

public void

setIsIndexedRecordSupported(boolean isIndexedRecordSupported)

Set if this platform supports JCA IndexedRecord.

public void

setIsMappedRecordSupported(boolean isMappedRecordSupported)

Set if this platform supports JCA MappedRecord.

public void

setRecordConverter(RecordConverter recordConverter)

Set the record converter.

public void

setRequiresAutoCommit(boolean requiresAutoCommit)

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

public void

setShouldConvertDataToStrings(boolean shouldConvertDataToStrings)

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

public void

setSupportsLocalTransactions(boolean supportsLocalTransactions)

Set if this platform supports local transactions.

public void

setValueInRecord(String key, Object value, MappedRecord<K, V> record, EISAccessor accessor)

Stores the field value into the record.

public boolean

shouldConvertDataToStrings()

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

public boolean

supportsLocalTransactions()

Return if this platform supports local transactions.

Field Detail

domMethod	back to summary
protected Method domMethod Used to reflectively provide XML record support as DOMRecord is not part of the JCA-CCI spec.

domMethod

back to summary

protected Method domMethod

Used to reflectively provide XML record support as DOMRecord is not part of the JCA-CCI spec.

isDOMRecordSupported	back to summary
protected boolean isDOMRecordSupported

isDOMRecordSupported

back to summary

protected boolean isDOMRecordSupported

isIndexedRecordSupported	back to summary
protected boolean isIndexedRecordSupported

isIndexedRecordSupported

back to summary

protected boolean isIndexedRecordSupported

isMappedRecordSupported	back to summary
protected boolean isMappedRecordSupported

isMappedRecordSupported

back to summary

protected boolean isMappedRecordSupported

recordConverter	back to summary
protected RecordConverter recordConverter Can be used to convert from an adapter specific record.

recordConverter

back to summary

protected RecordConverter recordConverter

Can be used to convert from an adapter specific record.

requiresAutoCommit	back to summary
protected boolean requiresAutoCommit Can be used if a commit is required after every interaction outside of a local transaction.

requiresAutoCommit

back to summary

protected boolean requiresAutoCommit

Can be used if a commit is required after every interaction outside of a local transaction.

shouldConvertDataToStrings	back to summary
protected boolean shouldConvertDataToStrings Can be used for adapters that only support String data/XML.

shouldConvertDataToStrings

back to summary

protected boolean shouldConvertDataToStrings

Can be used for adapters that only support String data/XML.

supportsLocalTransactions	back to summary
protected boolean supportsLocalTransactions Allows for usage of transaction to be disabled if not supported.

supportsLocalTransactions

back to summary

protected boolean supportsLocalTransactions

Allows for usage of transaction to be disabled if not supported.

xmlConversionManager	back to summary
protected XMLConversionManager xmlConversionManager For XML usage, an XMLConversionManager instance is required

xmlConversionManager

back to summary

protected XMLConversionManager xmlConversionManager

For XML usage, an XMLConversionManager instance is required

EISPlatform	back to summary
public EISPlatform() Default constructor.

EISPlatform

back to summary

public EISPlatform()

Default constructor.

Method Detail

appendParameter	back to summary
public void appendParameter(Call call, Writer writer, Object parameter) Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.appendParameter. Implements org.eclipse.persistence.internal.databaseaccess.Platform.appendParameter. Add the parameter. Convert the parameter to a string and write it. Convert rows to XML strings. Annotations @Override

appendParameter

back to summary

public void appendParameter(Call call, Writer writer, Object parameter)

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.appendParameter.

Implements org.eclipse.persistence.internal.databaseaccess.Platform.appendParameter.

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

Annotations

@Override

buildCallFromStatement	back to summary
public DatasourceCall buildCallFromStatement(SQLStatement statement, DatabaseQuery query, AbstractSession session) INTERNAL: Override this method to throw an exception by default. Platforms that support dynamic querying can override this to generate an EISInteraction.

buildInteractionSpec	back to summary
public InteractionSpec buildInteractionSpec(EISInteraction interaction) Allow the platform to build the interaction spec based on properties defined in the interaction.

buildNativeCall	back to summary
public DatasourceCall buildNativeCall(String queryString) Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.buildNativeCall. INTERNAL: Return the correct call type for the native query string. This allows EIS platforms to use different types of native calls. Annotations @Override

buildNativeCall

back to summary

public DatasourceCall buildNativeCall(String queryString)

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.buildNativeCall.

INTERNAL: Return the correct call type for the native query string. This allows EIS platforms to use different types of native calls.

Annotations

@Override

buildRow	back to summary
public AbstractRecord buildRow(Record record, EISInteraction interaction, EISAccessor accessor) INTERNAL: Allow the platform to handle record to row conversion.

buildRows	back to summary
public Vector<AbstractRecord> buildRows(Record record, EISInteraction interaction, EISAccessor accessor) Allow the platform to handle record to row conversion.

createDatabaseRowFromDOMRecord	back to summary
public AbstractRecord createDatabaseRowFromDOMRecord(Record record, EISInteraction call, EISAccessor accessor) INTERNAL: Allow the platform to handle the creation of the Record for the DOM record. By default instantiate an EISDOMRecord which introspects the record for a getDOM method.

createDOMRecord	back to summary
public Record createDOMRecord(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.

createInputRecord	back to summary
public Record createInputRecord(EISInteraction interaction, EISAccessor accessor) Allow the platform to create the appropriate type of record for the interaction.

createOutputRecord	back to summary
public Record createOutputRecord(EISInteraction interaction, AbstractRecord translationRow, EISAccessor accessor) Allow the platform to create the appropriate type of record for the interaction. If an output record is not required then null is returned.

getConversionManager	back to summary
public ConversionManager getConversionManager() Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.getConversionManager. Implements org.eclipse.persistence.internal.databaseaccess.Platform.getConversionManager. The platform holds its own instance of conversion manager to allow customization. Annotations @Override

getConversionManager

back to summary

public ConversionManager getConversionManager()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform.getConversionManager.

Implements org.eclipse.persistence.internal.databaseaccess.Platform.getConversionManager.

The platform holds its own instance of conversion manager to allow customization.

Annotations

@Override

getRecordConverter	back to summary
public RecordConverter getRecordConverter() Return the record converter.

getValueFromRecord	back to summary
public Object getValueFromRecord(String key, MappedRecord<K, V> record, EISAccessor accessor) Retrieves the field value from the record. This allows for the platform to perform any platform specific translation or conversion.

isDOMRecordSupported	back to summary
public boolean isDOMRecordSupported() Return if this platform supports XML/DOM Records.

isIndexedRecordSupported	back to summary
public boolean isIndexedRecordSupported() Return if this platform supports JCA IndexedRecord.

isMappedRecordSupported	back to summary
public boolean isMappedRecordSupported() Return if this platform supports JCA MappedRecord.

requiresAutoCommit	back to summary
public boolean requiresAutoCommit() Return if this platform requires auto commit of the local transaction for interactions outside of an interaction.

setDOMInRecord	back to summary
public void setDOMInRecord(Element dom, 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.

setIsDOMRecordSupported	back to summary
public void setIsDOMRecordSupported(boolean isDOMRecordSupported) Set if this platform supports XML/DOM Records.

setIsIndexedRecordSupported	back to summary
public void setIsIndexedRecordSupported(boolean isIndexedRecordSupported) Set if this platform supports JCA IndexedRecord.

setIsMappedRecordSupported	back to summary
public void setIsMappedRecordSupported(boolean isMappedRecordSupported) Set if this platform supports JCA MappedRecord.

setRecordConverter	back to summary
public void setRecordConverter(RecordConverter recordConverter) Set the record converter. Can be used to convert from an adapter specific record.

setRequiresAutoCommit	back to summary
public void setRequiresAutoCommit(boolean requiresAutoCommit) Set if this platform requires auto commit of the local transaction for interactions outside of an interaction.

setShouldConvertDataToStrings	back to summary
public void setShouldConvertDataToStrings(boolean shouldConvertDataToStrings) Set if all data set into the adapter should be first converted to strings.

setSupportsLocalTransactions	back to summary
public void setSupportsLocalTransactions(boolean supportsLocalTransactions) Set if this platform supports local transactions.

setValueInRecord	back to summary
public void setValueInRecord(String key, Object value, MappedRecord<K, V> record, EISAccessor accessor) Stores the field value into the record. This allows for the platform to perform any platform specific translation or conversion.

shouldConvertDataToStrings	back to summary
public boolean shouldConvertDataToStrings() Return if all data set into the adapter should be first converted to strings.

supportsLocalTransactions	back to summary
public boolean supportsLocalTransactions() Return if this platform supports local transactions.

public Class EISPlatform

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail