|
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.DatasourcePlatform org.eclipse.persistence.eis.EISPlatform
public class EISPlatform
An EISPlatform
defines any EIS adapter specific behavior.
This may include:
EISPlatform
also supports behavior for specifying 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.
Field Summary | |
---|---|
protected java.lang.reflect.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 org.eclipse.persistence.internal.oxm.XMLConversionManager |
xmlConversionManager
For XML usage, an XMLConversionManager instance is required |
Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform |
---|
conversionManager, dataTypesConvertedFromAClass, dataTypesConvertedToAClass, defaultSequence, endDelimiter, platformOperators, sequences, startDelimiter, tableQualifier, timestampQuery |
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. |
org.eclipse.persistence.internal.sessions.AbstractRecord |
buildRow(javax.resource.cci.Record record,
EISInteraction interaction,
EISAccessor accessor)
INTERNAL: Allow the platform to handle record ro row conversion. |
java.util.Vector |
buildRows(javax.resource.cci.Record record,
EISInteraction interaction,
EISAccessor accessor)
Allow the platform to handle record ro row conversion. |
org.eclipse.persistence.internal.sessions.AbstractRecord |
createDatabaseRowFromDOMRecord(javax.resource.cci.Record record,
EISInteraction call,
EISAccessor accessor)
INTERNAL: Allow the platform to handle the creation of the Record for the DOM record. |
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. |
org.eclipse.persistence.internal.helper.ConversionManager |
getConversionManager()
The platform holds its own instance of conversion manager to allow customization. |
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 org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform |
---|
addOperator, addSequence, clone, convertObject, copyInto, createConnectionCustomizer, createPlatformDefaultSequence, createSequences, getCustomModifyValueForCall, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultSequence, getDefaultSequenceToWrite, getEndDelimiter, getIdentifierQuoteCharacter, getOperator, getPlatformOperators, getSelectSequenceQuery, getSequence, getSequencePreallocationSize, getSequences, getSequencesToWrite, getStartDelimiter, getTableQualifier, getTimestampFromServer, getTimestampQuery, getUpdateSequenceQuery, hasDefaultSequence, initialize, initializePlatformOperators, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isDerby, isFirebird, isH2, isHSQL, isInformix, isMaxDB, isMySQL, isODBC, isOracle, isOracle9, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, isSybase, isSymfoware, isTimesTen, isTimesTen7, removeAllSequences, removeSequence, sequencesAfterCloneCleanup, setConversionManager, setDefaultSequence, setEndDelimiter, setSelectSequenceNumberQuery, setSequencePreallocationSize, setSequences, setStartDelimiter, setTableQualifier, setTimestampQuery, setUpdateSequenceQuery, shouldUseCustomModifyForCall, toString, usesPlatformDefaultSequence |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected boolean isIndexedRecordSupported
protected boolean isMappedRecordSupported
protected boolean isDOMRecordSupported
protected boolean shouldConvertDataToStrings
protected boolean supportsLocalTransactions
protected boolean requiresAutoCommit
protected RecordConverter recordConverter
protected java.lang.reflect.Method domMethod
protected org.eclipse.persistence.internal.oxm.XMLConversionManager xmlConversionManager
Constructor Detail |
---|
public EISPlatform()
Method Detail |
---|
public RecordConverter getRecordConverter()
public void setRecordConverter(RecordConverter recordConverter)
public boolean requiresAutoCommit()
public void setRequiresAutoCommit(boolean requiresAutoCommit)
public boolean supportsLocalTransactions()
public void setSupportsLocalTransactions(boolean supportsLocalTransactions)
public boolean isIndexedRecordSupported()
public void setIsIndexedRecordSupported(boolean isIndexedRecordSupported)
public boolean isMappedRecordSupported()
public void setIsMappedRecordSupported(boolean isMappedRecordSupported)
public boolean isDOMRecordSupported()
public void setIsDOMRecordSupported(boolean isDOMRecordSupported)
public boolean shouldConvertDataToStrings()
public void setShouldConvertDataToStrings(boolean shouldConvertDataToStrings)
public javax.resource.cci.InteractionSpec buildInteractionSpec(EISInteraction interaction)
public javax.resource.cci.Record createInputRecord(EISInteraction interaction, EISAccessor accessor)
public javax.resource.cci.Record createOutputRecord(EISInteraction interaction, EISAccessor accessor)
public org.eclipse.persistence.internal.sessions.AbstractRecord buildRow(javax.resource.cci.Record record, EISInteraction interaction, EISAccessor accessor)
public java.util.Vector buildRows(javax.resource.cci.Record record, EISInteraction interaction, EISAccessor accessor)
public javax.resource.cci.Record createDOMRecord(java.lang.String recordName, EISAccessor accessor)
public org.eclipse.persistence.internal.sessions.AbstractRecord createDatabaseRowFromDOMRecord(javax.resource.cci.Record record, EISInteraction call, EISAccessor accessor)
public java.lang.Object getValueFromRecord(java.lang.String key, javax.resource.cci.MappedRecord record, EISAccessor accessor)
public void setDOMInRecord(org.w3c.dom.Element dom, javax.resource.cci.Record record, EISInteraction call, EISAccessor accessor)
public void setValueInRecord(java.lang.String key, java.lang.Object value, javax.resource.cci.MappedRecord record, EISAccessor accessor)
public void appendParameter(Call call, java.io.Writer writer, java.lang.Object parameter)
appendParameter
in interface org.eclipse.persistence.internal.databaseaccess.Platform
appendParameter
in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform
public org.eclipse.persistence.internal.helper.ConversionManager getConversionManager()
getConversionManager
in interface org.eclipse.persistence.internal.databaseaccess.Platform
getConversionManager
in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform
|
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 |