OracleNoSQLPlatform (EclipseLink NoSQL 2.6.6, build 'v20180105-e045b08' API Reference)

java.lang.Object
- org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform
- - org.eclipse.persistence.eis.EISPlatform
  - - org.eclipse.persistence.nosql.adapters.nosql.OracleNoSQLPlatform

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.eclipse.persistence.internal.core.databaseaccess.CorePlatform<org.eclipse.persistence.internal.helper.ConversionManager>, org.eclipse.persistence.internal.databaseaccess.Platform
```
public class OracleNoSQLPlatform
extends org.eclipse.persistence.eis.EISPlatform
```
Platform for Oracle NoSQL database.

See Also:
Serialized Form
Author:

James

Since:

EclipseLink 2.4

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CONSISTENCY`
`static java.lang.String`	`DURABILITY`
`static java.lang.String`	`OPERATION` OracleNoSQL interaction spec properties.
`static java.lang.String`	`TIMEOUT`
`static java.lang.String`	`VERSION`

Fields inherited from class org.eclipse.persistence.eis.EISPlatform
domMethod, isDOMRecordSupported, isIndexedRecordSupported, isMappedRecordSupported, recordConverter, requiresAutoCommit, shouldConvertDataToStrings, supportsLocalTransactions, xmlConversionManager

Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform
conversionManager, dataTypesConvertedFromAClass, dataTypesConvertedToAClass, defaultNativeSequenceToTable, defaultSequence, endDelimiter, platformOperators, sequences, sequencesLock, startDelimiter, tableQualifier, timestampQuery

Constructor Summary

Constructors
Constructor and Description

OracleNoSQLPlatform()
Default constructor.

Constructors
Constructor and Description
`OracleNoSQLPlatform()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`javax.resource.cci.InteractionSpec`	`buildInteractionSpec(org.eclipse.persistence.eis.interactions.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, org.eclipse.persistence.eis.interactions.EISInteraction interaction, org.eclipse.persistence.eis.EISAccessor accessor)` INTERNAL: Allow the platform to handle record to row conversion.
`java.util.Vector`	`buildRows(javax.resource.cci.Record record, org.eclipse.persistence.eis.interactions.EISInteraction interaction, org.eclipse.persistence.eis.EISAccessor accessor)` Allow the platform to handle record to row conversion.
`protected void`	`convertRecordBytesToString(org.eclipse.persistence.internal.nosql.adapters.nosql.OracleNoSQLRecord record)` INTERNAL: Convert the record and nested records bytes to strings.
`org.eclipse.persistence.internal.sessions.AbstractRecord`	`createDatabaseRowFromDOMRecord(javax.resource.cci.Record record, org.eclipse.persistence.eis.interactions.EISInteraction call, org.eclipse.persistence.eis.EISAccessor accessor)` Allow the platform to handle the creation of the Record for the DOM record.
`javax.resource.cci.Record`	`createInputRecord(org.eclipse.persistence.eis.interactions.EISInteraction interaction, org.eclipse.persistence.eis.EISAccessor accessor)` Allow the platform to create the appropriate type of record for the interaction.
`protected java.lang.Object`	`createMajorKey(org.eclipse.persistence.descriptors.ClassDescriptor descriptor, org.eclipse.persistence.internal.sessions.AbstractRecord record, org.eclipse.persistence.eis.interactions.EISInteraction interaction, org.eclipse.persistence.eis.EISAccessor accessor)` NoSQL stores the data in a single big map.
`protected org.eclipse.persistence.sequencing.Sequence`	`createPlatformDefaultSequence()` INTERNAL: NoSQL does not support id generation, so use UUID as the default.
`void`	`initializeDefaultQueries(org.eclipse.persistence.descriptors.DescriptorQueryManager queryManager, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Allow the platform to initialize the CRUD queries to defaults.
`void`	`setDOMInRecord(org.w3c.dom.Element dom, javax.resource.cci.Record record, org.eclipse.persistence.eis.interactions.EISInteraction interaction, org.eclipse.persistence.eis.EISAccessor accessor)` Stores the XML DOM value into the record.
`boolean`	`shouldPrepare(org.eclipse.persistence.queries.DatabaseQuery query)` Do not prepare to avoid errors being triggered for id and all queries.

Methods inherited from class org.eclipse.persistence.eis.EISPlatform
appendParameter, buildCallFromStatement, buildNativeCall, createDOMRecord, createOutputRecord, getConversionManager, getRecordConverter, getValueFromRecord, isDOMRecordSupported, isIndexedRecordSupported, isMappedRecordSupported, requiresAutoCommit, setIsDOMRecordSupported, setIsIndexedRecordSupported, setIsMappedRecordSupported, setRecordConverter, setRequiresAutoCommit, setShouldConvertDataToStrings, setSupportsLocalTransactions, setValueInRecord, shouldConvertDataToStrings, supportsLocalTransactions

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform
addOperator, addSequence, addSequence, buildSelectQueryForIdentity, buildSelectQueryForIdentity, buildSelectQueryForSequenceObject, buildSelectQueryForSequenceObject, clone, convertObject, copyInto, createConnectionCustomizer, getCustomModifyValueForCall, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultNativeSequenceToTable, 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, isHANA, isHSQL, isInformix, isMaxDB, isMySQL, isODBC, isOracle, isOracle9, isPervasive, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, isSybase, isSymfoware, isTimesTen, isTimesTen7, removeAllSequences, removeSequence, sequencesAfterCloneCleanup, setConversionManager, setDefaultNativeSequenceToTable, setDefaultSequence, setEndDelimiter, setSelectSequenceNumberQuery, setSequencePreallocationSize, setSequences, setStartDelimiter, setTableQualifier, setTimestampQuery, setUpdateSequenceQuery, shouldNativeSequenceUseTransaction, shouldSelectDistinctIncludeOrderBy, shouldSelectIncludeOrderBy, shouldUseCustomModifyForCall, supportsIdentity, supportsNativeSequenceNumbers, supportsSequenceObjects, toString, usesPlatformDefaultSequence

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OPERATION
```
public static java.lang.String OPERATION
```
OracleNoSQL interaction spec properties.

CONSISTENCY

public static java.lang.String CONSISTENCY

DURABILITY

public static java.lang.String DURABILITY

TIMEOUT
```
public static java.lang.String TIMEOUT
```

VERSION
```
public static java.lang.String VERSION
```

Constructor Detail
- OracleNoSQLPlatform
```
public OracleNoSQLPlatform()
```
  Default constructor.

Method Detail

buildInteractionSpec
```
public javax.resource.cci.InteractionSpec buildInteractionSpec(org.eclipse.persistence.eis.interactions.EISInteraction interaction)
```
Allow the platform to build the interaction spec based on properties defined in the interaction.

Overrides:

buildInteractionSpec in class org.eclipse.persistence.eis.EISPlatform

buildRow

public org.eclipse.persistence.internal.sessions.AbstractRecord buildRow(javax.resource.cci.Record record,
                                                                org.eclipse.persistence.eis.interactions.EISInteraction interaction,
                                                                org.eclipse.persistence.eis.EISAccessor accessor)

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

Overrides:: buildRow in class org.eclipse.persistence.eis.EISPlatform

buildRows

public java.util.Vector buildRows(javax.resource.cci.Record record,
                         org.eclipse.persistence.eis.interactions.EISInteraction interaction,
                         org.eclipse.persistence.eis.EISAccessor accessor)

Allow the platform to handle record to row conversion.

Overrides:: buildRows in class org.eclipse.persistence.eis.EISPlatform

convertRecordBytesToString

protected void convertRecordBytesToString(org.eclipse.persistence.internal.nosql.adapters.nosql.OracleNoSQLRecord record)

INTERNAL: Convert the record and nested records bytes to strings.

createInputRecord
```
public javax.resource.cci.Record createInputRecord(org.eclipse.persistence.eis.interactions.EISInteraction interaction,
                                          org.eclipse.persistence.eis.EISAccessor accessor)
```
Allow the platform to create the appropriate type of record for the interaction. Convert the nested local mapped record to a flat global keyed record.

Overrides:

createInputRecord in class org.eclipse.persistence.eis.EISPlatform

setDOMInRecord

public void setDOMInRecord(org.w3c.dom.Element dom,
                  javax.resource.cci.Record record,
                  org.eclipse.persistence.eis.interactions.EISInteraction interaction,
                  org.eclipse.persistence.eis.EISAccessor accessor)

Stores the XML DOM value into the record. XML is stored in Oracle NoSQL but storing the XML text, keyed on the object's "<dataTypeName>/<id>".

Overrides:: setDOMInRecord in class org.eclipse.persistence.eis.EISPlatform

createMajorKey

protected java.lang.Object createMajorKey(org.eclipse.persistence.descriptors.ClassDescriptor descriptor,
                              org.eclipse.persistence.internal.sessions.AbstractRecord record,
                              org.eclipse.persistence.eis.interactions.EISInteraction interaction,
                              org.eclipse.persistence.eis.EISAccessor accessor)

NoSQL stores the data in a single big map. The keys are called major keys (minor keys are used to store the attributes). Major keys can have multiple values (and normally do). The first value is normally the type, then the id.

createDatabaseRowFromDOMRecord

public org.eclipse.persistence.internal.sessions.AbstractRecord createDatabaseRowFromDOMRecord(javax.resource.cci.Record record,
                                                                                      org.eclipse.persistence.eis.interactions.EISInteraction call,
                                                                                      org.eclipse.persistence.eis.EISAccessor accessor)

Allow the platform to handle the creation of the Record for the DOM record. Creates a DOM record from the XML data stored as a value in the OracleNoSQLRecord.

Overrides:: createDatabaseRowFromDOMRecord in class org.eclipse.persistence.eis.EISPlatform

initializeDefaultQueries
```
public void initializeDefaultQueries(org.eclipse.persistence.descriptors.DescriptorQueryManager queryManager,
                            org.eclipse.persistence.internal.sessions.AbstractSession session)
```
INTERNAL: Allow the platform to initialize the CRUD queries to defaults. Configure the CRUD operations using GET/PUT and DELETE.

Overrides:

initializeDefaultQueries in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

shouldPrepare
```
public boolean shouldPrepare(org.eclipse.persistence.queries.DatabaseQuery query)
```
Do not prepare to avoid errors being triggered for id and all queries.

Overrides:

shouldPrepare in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

createPlatformDefaultSequence
```
protected org.eclipse.persistence.sequencing.Sequence createPlatformDefaultSequence()
```
INTERNAL: NoSQL does not support id generation, so use UUID as the default.

Overrides:

createPlatformDefaultSequence in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

Class OracleNoSQLPlatform

Field Summary

Fields inherited from class org.eclipse.persistence.eis.EISPlatform

Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.eis.EISPlatform

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

Methods inherited from class java.lang.Object

Field Detail

OPERATION

CONSISTENCY

DURABILITY

TIMEOUT

VERSION

Constructor Detail

OracleNoSQLPlatform

Method Detail

buildInteractionSpec

buildRow

buildRows

convertRecordBytesToString

createInputRecord

setDOMInRecord

createMajorKey

createDatabaseRowFromDOMRecord

initializeDefaultQueries

shouldPrepare

createPlatformDefaultSequence