org.datanucleus.store.mapped
Interface DatastoreAdapter

public interface DatastoreAdapter

Definition of a datastore adapter.

Field Summary

static String	ANALYSIS_METHODS Accessor for whether the SQL extensions CUBE, ROLLUP are supported.
static String	BIT_IS_REALLY_BOOLEAN Whether "Types.BIT" is really mapped as BOOLEAN.
static String	BOOLEAN_COMPARISON Whether we support Boolean comparisons.
static String	CATALOGS_IN_TABLE_DEFINITIONS Whether this datastore supports the use of the catalog name in ORM table definitions (DDL).
static String	ESCAPE_EXPRESSION_IN_LIKE_PREDICATE
static String	IDENTIFIERS_LOWERCASE
static String	IDENTIFIERS_LOWERCASE_QUOTED
static String	IDENTIFIERS_MIXEDCASE
static String	IDENTIFIERS_MIXEDCASE_QUOTED
static String	IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE
static String	IDENTIFIERS_MIXEDCASE_SENSITIVE
static String	IDENTIFIERS_UPPERCASE
static String	IDENTIFIERS_UPPERCASE_QUOTED
static String	IDENTITY_COLUMNS Whether this datastore adapter support identity fields.
static String	PROJECTION_IN_TABLE_REFERENCE_JOINS Whether this datastore supports "SELECT a.* FROM (SELECT * FROM TBL1 INNER JOIN TBL2 ON tbl1.x = tbl2.y ) a" If the database does not support the SQL statement generated is like "SELECT a.* FROM (TBL1 INNER JOIN TBL2 ON tbl1.x = tbl2.y ) a"
static String	SCHEMAS_IN_TABLE_DEFINITIONS Whether this datastore supports the use of the schema name in ORM table definitions (DDL).
static String	SEQUENCES Whether we support sequences.

Method Summary

long	getAdapterTime(Timestamp time) Utility to return the adapter time in case there are rounding issues with millisecs etc.
String	getCatalogSeparator() Accessor for the catalog separator (string to separate the catalog/schema and the identifier).
String	getDatastoreDriverName() Accessor for the datastore driver name.
String	getDatastoreDriverVersion() Accessor for the datastore driver version.
int	getDatastoreIdentifierMaxLength(IdentifierType identifierType) Method to return the maximum length of a datastore identifier of the specified type.
String	getDatastoreProductName() Accessor for the datastore product name.
String	getDatastoreProductVersion() Accessor for the datastore product version.
String	getIdentifierQuoteString() Accessor for the quote string to use when quoting identifiers.
MappingManager	getMappingManager(MappedStoreManager storeMgr) Accessor for a Mapping Manager suitable for use with this datastore adapter.
int	getMaxForeignKeys() Accessor for the maximum foreign keys by table permitted in this datastore.
int	getMaxIndexes() Accessor for the maximum indexes by table permitted in this datastore.
Collection<String>	getSupportedOptions() Accessor for the options that are supported by this datastore adapter and the underlying datastore.
String	getVendorID() Accessor for the Vendor ID for this datastore.
void	initialiseDatastore(Object conn) Creates the auxiliary functions/procedures in the datastore
void	initialiseTypes(StoreSchemaHandler handler, ManagedConnection mconn) Initialise the types for this datastore.
boolean	isIdentityFieldDataType(String columnDef) Verifies if the given columnDef is an identity field type for the datastore.
boolean	isReservedKeyword(String word) Method to check if a word is reserved for this datastore.
void	removeUnsupportedMappings(StoreSchemaHandler handler, ManagedConnection mconn) Remove all mappings from the mapping manager that don't have a datastore type initialised.
void	setProperties(Map<String,Object> props) Set any properties controlling how the adapter is configured.
boolean	supportsOption(String option) Accessor for whether the supplied option is supported.
boolean	supportsQueryFetchSize(int size) Whether the datastore will support setting the query fetch size to the supplied value.
String	toString() Method to return this object as a string.

Field Detail

IDENTITY_COLUMNS

static final String IDENTITY_COLUMNS

Whether this datastore adapter support identity fields. In SQL this would be things like "AUTOINCREMENT", "IDENTITY", "SERIAL".

See Also:

Constant Field Values

SEQUENCES

static final String SEQUENCES

Whether we support sequences.

See Also:

Constant Field Values

BIT_IS_REALLY_BOOLEAN

static final String BIT_IS_REALLY_BOOLEAN

Whether "Types.BIT" is really mapped as BOOLEAN.

See Also:

Constant Field Values

BOOLEAN_COMPARISON

static final String BOOLEAN_COMPARISON

Whether we support Boolean comparisons.

See Also:

Constant Field Values

ESCAPE_EXPRESSION_IN_LIKE_PREDICATE

static final String ESCAPE_EXPRESSION_IN_LIKE_PREDICATE

See Also:

Constant Field Values

PROJECTION_IN_TABLE_REFERENCE_JOINS

static final String PROJECTION_IN_TABLE_REFERENCE_JOINS

Whether this datastore supports "SELECT a.* FROM (SELECT * FROM TBL1 INNER JOIN TBL2 ON tbl1.x = tbl2.y ) a" If the database does not support the SQL statement generated is like "SELECT a.* FROM (TBL1 INNER JOIN TBL2 ON tbl1.x = tbl2.y ) a"

See Also:

Constant Field Values

ANALYSIS_METHODS

static final String ANALYSIS_METHODS

Accessor for whether the SQL extensions CUBE, ROLLUP are supported. TODO Move this to a plugin extension as cube and rollup options (separate)

See Also:

Constant Field Values

CATALOGS_IN_TABLE_DEFINITIONS

static final String CATALOGS_IN_TABLE_DEFINITIONS

Whether this datastore supports the use of the catalog name in ORM table definitions (DDL).

See Also:

Constant Field Values

SCHEMAS_IN_TABLE_DEFINITIONS

static final String SCHEMAS_IN_TABLE_DEFINITIONS

Whether this datastore supports the use of the schema name in ORM table definitions (DDL).

See Also:

Constant Field Values

IDENTIFIERS_LOWERCASE

static final String IDENTIFIERS_LOWERCASE

See Also:

Constant Field Values

IDENTIFIERS_MIXEDCASE

static final String IDENTIFIERS_MIXEDCASE

See Also:

Constant Field Values

IDENTIFIERS_UPPERCASE

static final String IDENTIFIERS_UPPERCASE

See Also:

Constant Field Values

IDENTIFIERS_LOWERCASE_QUOTED

static final String IDENTIFIERS_LOWERCASE_QUOTED

See Also:

Constant Field Values

IDENTIFIERS_MIXEDCASE_QUOTED

static final String IDENTIFIERS_MIXEDCASE_QUOTED

See Also:

Constant Field Values

IDENTIFIERS_UPPERCASE_QUOTED

static final String IDENTIFIERS_UPPERCASE_QUOTED

See Also:

Constant Field Values

IDENTIFIERS_MIXEDCASE_SENSITIVE

static final String IDENTIFIERS_MIXEDCASE_SENSITIVE

See Also:

Constant Field Values

IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE

static final String IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE

See Also:

Constant Field Values

Method Detail

getSupportedOptions

Collection<String> getSupportedOptions()

Accessor for the options that are supported by this datastore adapter and the underlying datastore.

Returns:

The options (Collection)

supportsOption

boolean supportsOption(String option)

Accessor for whether the supplied option is supported.

Parameters:

option - The option

Returns:

Whether supported.

getMappingManager

MappingManager getMappingManager(MappedStoreManager storeMgr)

Accessor for a Mapping Manager suitable for use with this datastore adapter.

Parameters:

storeMgr - The StoreManager

Returns:

The Mapping Manager.

getVendorID

String getVendorID()

Accessor for the Vendor ID for this datastore.

Returns:

Vendor id for this datastore

initialiseTypes

void initialiseTypes(StoreSchemaHandler handler,
                     ManagedConnection mconn)

Initialise the types for this datastore.

Parameters:

handler - SchemaHandler that we initialise the types for

mconn - Managed connection to use

setProperties

void setProperties(Map<String,Object> props)

Set any properties controlling how the adapter is configured.

Parameters:

props - The properties

removeUnsupportedMappings

void removeUnsupportedMappings(StoreSchemaHandler handler,
                               ManagedConnection mconn)

Remove all mappings from the mapping manager that don't have a datastore type initialised.

Parameters:

handler - Schema handler

mconn - Managed connection to use

isReservedKeyword

boolean isReservedKeyword(String word)

Method to check if a word is reserved for this datastore.

Parameters:

word - The word

Returns:

Whether it is reserved

initialiseDatastore

void initialiseDatastore(Object conn)

Creates the auxiliary functions/procedures in the datastore

Parameters:

conn - the connection to the datastore

getIdentifierQuoteString

String getIdentifierQuoteString()

Accessor for the quote string to use when quoting identifiers.

Returns:

The quote string for the identifier

getCatalogSeparator

String getCatalogSeparator()

Accessor for the catalog separator (string to separate the catalog/schema and the identifier).

Returns:

Catalog separator string.

getAdapterTime

long getAdapterTime(Timestamp time)

Utility to return the adapter time in case there are rounding issues with millisecs etc.

Parameters:

time - The timestamp

Returns:

The time in millisecs

getDatastoreProductName

String getDatastoreProductName()

Accessor for the datastore product name.

Returns:

product name

getDatastoreProductVersion

String getDatastoreProductVersion()

Accessor for the datastore product version.

Returns:

product version

getDatastoreDriverName

String getDatastoreDriverName()

Accessor for the datastore driver name.

Returns:

product name

getDatastoreDriverVersion

String getDatastoreDriverVersion()

Accessor for the datastore driver version.

Returns:

driver version

isIdentityFieldDataType

boolean isIdentityFieldDataType(String columnDef)

Verifies if the given columnDef is an identity field type for the datastore.

Parameters:

columnDef - the datastore type name

Returns:

true when the columnDef has values for identity generation in the datastore

getDatastoreIdentifierMaxLength

int getDatastoreIdentifierMaxLength(IdentifierType identifierType)

Method to return the maximum length of a datastore identifier of the specified type. If no limit exists then returns -1

Parameters:

identifierType - Type of identifier

Returns:

The max permitted length of this type of identifier

getMaxForeignKeys

int getMaxForeignKeys()

Accessor for the maximum foreign keys by table permitted in this datastore.

Returns:

Max number of foreign keys

getMaxIndexes

int getMaxIndexes()

Accessor for the maximum indexes by table permitted in this datastore.

Returns:

Max number of indices

supportsQueryFetchSize

boolean supportsQueryFetchSize(int size)

Whether the datastore will support setting the query fetch size to the supplied value.

Parameters:

size - The value to set to

Returns:

Whether it is supported.

toString

String toString()

Method to return this object as a string.

Overrides:

toString in class Object

Returns:

String version of this object.