org.datanucleus.store.schema

Class AbstractStoreSchemaHandler

java.lang.Object

org.datanucleus.store.schema.AbstractStoreSchemaHandler

All Implemented Interfaces:

StoreSchemaHandler

Direct Known Subclasses:

DefaultStoreSchemaHandler

public abstract class AbstractStoreSchemaHandler
extends Object
implements StoreSchemaHandler

Abstract base for any StoreSchemaHandler.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoCreateColumns Whether to auto create any columns that are missing.
protected boolean	autoCreateConstraints Whether to auto create any constraints
protected boolean	autoCreateDatabase Whether to auto create any database (catalog/schema).
protected boolean	autoCreateTables Whether to auto create any tables.
protected boolean	autoCreateWarnOnError Whether to warn only when any errors occur on auto-create.
protected boolean	autoDeleteColumns Whether to auto delete any columns that are present but not in the metadata.
protected StoreManager	storeMgr
protected boolean	validateColumns Whether to validate any columns
protected boolean	validateConstraints Whether to validate any constraints
protected boolean	validateTables Whether to validate any tables

Constructor Summary

Constructors

Constructor and Description
AbstractStoreSchemaHandler(StoreManager storeMgr)

Method Summary

Modifier and Type	Method and Description
void	clear() Method to clear out any cached schema information.
void	createDatabase(String catalogName, String schemaName, Properties props, Object connection) Method to create the specified database (catalog/schema).
void	createSchemaForClasses(Set<String> classNames, Properties props, Object connection) Method to generate the required schema for the supplied classes.
void	deleteDatabase(String catalogName, String schemaName, Properties props, Object connection) Method to delete the specified database (catalog/schema).
void	deleteSchemaForClasses(Set<String> classNames, Properties props, Object connection) Method to delete the schema for the supplied classes.
StoreSchemaData	getSchemaData(Object connection, String name, Object[] values) Accessor for schema data store under the provided name and defined by the specified values.
StoreManager	getStoreManager()
boolean	isAutoCreateColumns()
boolean	isAutoCreateConstraints()
boolean	isAutoCreateDatabase()
boolean	isAutoCreateTables()
boolean	isAutoCreateWarnOnError()
boolean	isAutoDeleteColumns()
boolean	isValidateColumns()
boolean	isValidateConstraints()
boolean	isValidateTables()
void	validateSchema(Set<String> classNames, Properties props, Object connection) Method to validate the schema for the supplied classes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

storeMgr

protected StoreManager storeMgr

autoCreateDatabase

protected final boolean autoCreateDatabase

Whether to auto create any database (catalog/schema).

autoCreateTables

protected final boolean autoCreateTables

Whether to auto create any tables.

autoCreateColumns

protected final boolean autoCreateColumns

Whether to auto create any columns that are missing.

autoCreateConstraints

protected final boolean autoCreateConstraints

Whether to auto create any constraints

autoCreateWarnOnError

protected final boolean autoCreateWarnOnError

Whether to warn only when any errors occur on auto-create.

autoDeleteColumns

protected final boolean autoDeleteColumns

Whether to auto delete any columns that are present but not in the metadata.

validateTables

protected final boolean validateTables

Whether to validate any tables

validateColumns

protected final boolean validateColumns

Whether to validate any columns

validateConstraints

protected final boolean validateConstraints

Whether to validate any constraints

Constructor Detail

AbstractStoreSchemaHandler

public AbstractStoreSchemaHandler(StoreManager storeMgr)

Method Detail

getStoreManager

public StoreManager getStoreManager()

Specified by:

getStoreManager in interface StoreSchemaHandler

isAutoCreateDatabase

public boolean isAutoCreateDatabase()

Specified by:

isAutoCreateDatabase in interface StoreSchemaHandler

isAutoCreateTables

public boolean isAutoCreateTables()

Specified by:

isAutoCreateTables in interface StoreSchemaHandler

isAutoCreateColumns

public boolean isAutoCreateColumns()

Specified by:

isAutoCreateColumns in interface StoreSchemaHandler

isAutoCreateConstraints

public boolean isAutoCreateConstraints()

Specified by:

isAutoCreateConstraints in interface StoreSchemaHandler

isAutoCreateWarnOnError

public boolean isAutoCreateWarnOnError()

Specified by:

isAutoCreateWarnOnError in interface StoreSchemaHandler

isAutoDeleteColumns

public boolean isAutoDeleteColumns()

Specified by:

isAutoDeleteColumns in interface StoreSchemaHandler

isValidateTables

public boolean isValidateTables()

Specified by:

isValidateTables in interface StoreSchemaHandler

isValidateColumns

public boolean isValidateColumns()

Specified by:

isValidateColumns in interface StoreSchemaHandler

isValidateConstraints

public boolean isValidateConstraints()

Specified by:

isValidateConstraints in interface StoreSchemaHandler

clear

public void clear()

Description copied from interface: StoreSchemaHandler

Method to clear out any cached schema information.

Specified by:

clear in interface StoreSchemaHandler

createDatabase

public void createDatabase(String catalogName,
                           String schemaName,
                           Properties props,
                           Object connection)

Description copied from interface: StoreSchemaHandler

Method to create the specified database (catalog/schema).

Specified by:

createDatabase in interface StoreSchemaHandler

Parameters:

catalogName - Name of the catalog

schemaName - Name of the schema

props - Any properties controlling the schema generation

connection - Connection to use (null implies this will obtain its own connection)

deleteDatabase

public void deleteDatabase(String catalogName,
                           String schemaName,
                           Properties props,
                           Object connection)

Description copied from interface: StoreSchemaHandler

Method to delete the specified database (catalog/schema).

Specified by:

deleteDatabase in interface StoreSchemaHandler

Parameters:

catalogName - Name of the catalog

schemaName - Name of the schema

props - Any properties controlling the schema deletion

connection - Connection to use (null implies this will obtain its own connection)

createSchemaForClasses

public void createSchemaForClasses(Set<String> classNames,
                                   Properties props,
                                   Object connection)

Description copied from interface: StoreSchemaHandler

Method to generate the required schema for the supplied classes. Note that this does not generate a "schema", just the tables. Refer to createDatabase to create a "schema".

Specified by:

createSchemaForClasses in interface StoreSchemaHandler

Parameters:

classNames - Names of the classes we want the schema generating for.

props - Any properties controlling the schema generation

connection - Connection to use (null implies this will obtain its own connection)

deleteSchemaForClasses

public void deleteSchemaForClasses(Set<String> classNames,
                                   Properties props,
                                   Object connection)

Description copied from interface: StoreSchemaHandler

Method to delete the schema for the supplied classes. Note that this does not delete a "schema", just the tables. Refer to deleteDatabase to delete a "schema".

Specified by:

deleteSchemaForClasses in interface StoreSchemaHandler

Parameters:

classNames - Names of the classes we want the schema deleting for.

props - Any properties controlling the schema deletion

connection - Connection to use (null implies this will obtain its own connection)

validateSchema

public void validateSchema(Set<String> classNames,
                           Properties props,
                           Object connection)

Description copied from interface: StoreSchemaHandler

Method to validate the schema for the supplied classes.

Specified by:

validateSchema in interface StoreSchemaHandler

Parameters:

classNames - Names of classes

props - Any properties controlling schema validation

connection - Connection to use (null implies this will obtain its own connection)

getSchemaData

public StoreSchemaData getSchemaData(Object connection,
                                     String name,
                                     Object[] values)

Description copied from interface: StoreSchemaHandler

Accessor for schema data store under the provided name and defined by the specified values. The supported types of values is particular to the implementation.

Specified by:

getSchemaData in interface StoreSchemaHandler

Parameters:

connection - Connection to the datastore

name - Name of the schema component to return.

values - Value(s) to use as qualifier(s) for selecting the schema component

Returns:

Schema data definition for this name