Class SchemaTable
java.lang.Object
org.datanucleus.store.rdbms.table.AbstractTable
org.datanucleus.store.rdbms.table.TableImpl
org.datanucleus.store.rdbms.autostart.SchemaTable
- All Implemented Interfaces:
Table
,org.datanucleus.store.schema.table.Table
Class defining DataNucleus schema definition tables.
Represents a table in the datastore storing the class and table mappings.
This table is used when restarting a DataNucleus system so that it is 'aware' of what classes were supported the previous time this datastore was used.
It uses this information to pre-populate the RDBMSManager with the classes stored in this table.
The table names are not used as such, other than as a record of what table a class maps to - because it goes off and finds the MetaData for the
class which, with the DataNucleus naming scheme, defines the table name anyway.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate JavaTypeMapping
private String
private String
private String
private String
private String
private JavaTypeMapping
private JavaTypeMapping
private JavaTypeMapping
private JavaTypeMapping
private JavaTypeMapping
Fields inherited from class org.datanucleus.store.rdbms.table.AbstractTable
columns, columnsByIdentifier, dba, existsInDatastore, identifier, state, storeMgr, TABLE_STATE_INITIALIZED, TABLE_STATE_INITIALIZED_MODIFIED, TABLE_STATE_NEW, TABLE_STATE_PK_INITIALIZED, TABLE_STATE_VALIDATED
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addClass
(RDBMSStoreData data, org.datanucleus.store.connection.ManagedConnection conn) Method to insert a row in the SchemaTable.void
deleteAllClasses
(org.datanucleus.store.connection.ManagedConnection conn) Method to delete all classes from the SchemaTable.void
deleteClass
(String class_name, org.datanucleus.store.connection.ManagedConnection conn) Method to delete a class from the SchemaTable.Set
<org.datanucleus.store.StoreData> getAllClasses
(org.datanucleus.store.connection.ManagedConnection conn) Accessor for the classes already supported by this Schema Table.Accessor for a mapping for the ID (persistable) for this table.getMemberMapping
(org.datanucleus.metadata.AbstractMemberMetaData mmd) Accessor the for the mapping for a field/property stored in this table.private boolean
hasClass
(org.datanucleus.store.StoreData data, org.datanucleus.store.connection.ManagedConnection conn) Method to verify the a class is already stored in the table.void
initialize
(org.datanucleus.ClassLoaderResolver clr) Method to initialise the table.private boolean
tableExists
(Connection conn) Convenience existence checker.Methods inherited from class org.datanucleus.store.rdbms.table.TableImpl
createConstraints, dropConstraints, getExpectedCandidateKeys, getExpectedForeignKeys, getExpectedIndices, getPrimaryKey, getSQLAddCandidateKeyStatements, getSQLAddFKStatements, getSQLCreateIndexStatements, getSQLCreateStatements, getSQLDropStatements, initializeColumnInfoForPrimaryKeyColumns, initializeColumnInfoFromDatastore, logMapping, validate, validateColumns, validateConstraints, validatePrimaryKey
Methods inherited from class org.datanucleus.store.rdbms.table.AbstractTable
addColumn, addColumnInternal, allowDDLOutput, assertIsInitialized, assertIsInitializedModified, assertIsPKInitialized, assertIsPKUninitialized, assertIsUninitialized, assertIsValidated, create, drop, equals, executeDdlStatement, executeDdlStatementList, exists, getCatalogName, getClassMetaData, getColumn, getColumnForName, getColumnForPosition, getColumns, getDatastoreIdentifierFullyQualified, getDiscriminatorMetaData, getIdentifier, getMemberColumnMappingForEmbeddedMember, getMemberColumnMappingForMember, getMemberColumnMappings, getName, getNumberOfColumns, getSchemaName, getStoreManager, getSurrogateColumn, getSurrogateMapping, getVersionMetaData, hasColumn, hasColumnName, hashCode, isInitialized, isInitializedModified, isPKInitialized, isValidated, postInitialize, preInitialize, tableExistsInDatastore, toString
-
Field Details
-
classMapping
-
tableMapping
-
typeMapping
-
ownerMapping
-
versionMapping
-
interfaceNameMapping
-
insertStmt
-
deleteStmt
-
deleteAllStmt
-
fetchAllStmt
-
fetchStmt
-
-
Constructor Details
-
SchemaTable
Constructor.- Parameters:
storeMgr
- The RDBMSManager for this datastoretableName
- Name of the starter table (optional, uses NUCLEUS_TABLES when this is null)
-
-
Method Details
-
initialize
public void initialize(org.datanucleus.ClassLoaderResolver clr) Method to initialise the table.- Parameters:
clr
- The ClassLoaderResolver
-
getIdMapping
Accessor for a mapping for the ID (persistable) for this table.- Returns:
- The (persistable) ID mapping.
-
getAllClasses
public Set<org.datanucleus.store.StoreData> getAllClasses(org.datanucleus.store.connection.ManagedConnection conn) throws SQLException Accessor for the classes already supported by this Schema Table.- Parameters:
conn
- Connection for this datastore.- Returns:
- The HashSet of class names (StoreData)
- Throws:
SQLException
- Thrown when an error occurs in the process.
-
addClass
public void addClass(RDBMSStoreData data, org.datanucleus.store.connection.ManagedConnection conn) throws SQLException Method to insert a row in the SchemaTable. This is called when DataNucleus is now supporting a new class (and hence DB table).- Parameters:
data
- Data for the classconn
- Connection to the datastore- Throws:
SQLException
- Thrown when an error occurs inserting the schema.
-
hasClass
private boolean hasClass(org.datanucleus.store.StoreData data, org.datanucleus.store.connection.ManagedConnection conn) throws SQLException Method to verify the a class is already stored in the table.- Parameters:
data
- Data for the classconn
- Connection to the datastore- Returns:
- if the SchemaTable already has the class
- Throws:
SQLException
- Thrown when an error occurs inserting the schema.
-
deleteClass
public void deleteClass(String class_name, org.datanucleus.store.connection.ManagedConnection conn) throws SQLException Method to delete a class from the SchemaTable. This is called when DataNucleus is required to clean out support for a particular class.- Parameters:
class_name
- Name of class to deleteconn
- Connection to the datastore- Throws:
SQLException
- Thrown when an error occurs deleting the schema.
-
deleteAllClasses
public void deleteAllClasses(org.datanucleus.store.connection.ManagedConnection conn) throws SQLException Method to delete all classes from the SchemaTable. This is called when DataNucleus is required to clean out its supported classes (and hence DB table).- Parameters:
conn
- Connection to the datastore- Throws:
SQLException
- Thrown when an error occurs deleting the schema.
-
tableExists
Convenience existence checker. This shouldn't be needed since exists already does this!- Parameters:
conn
- Connection to use- Returns:
- Whether it has been created
- Throws:
SQLException
-
getMemberMapping
Accessor the for the mapping for a field/property stored in this table.- Parameters:
mmd
- MetaData for the field whose mapping we want- Returns:
- The mapping
-