org.datanucleus.store.rdbms.table

Class AbstractTable

java.lang.Object

org.datanucleus.store.rdbms.table.AbstractTable

All Implemented Interfaces:

org.datanucleus.store.schema.table.Table

Direct Known Subclasses:

TableImpl, ViewImpl

public abstract class AbstractTable
extends Object
implements Table

Abstract implementation of a table in the datastore. The table exists in various states. After initialisation it can be created in the datastore by calling create. At any point after initialisation it can be modified, but only by addition of columns. The table can be dropped from the datastore by calling drop.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.datanucleus.store.schema.table.Column>	columns Columns for this table.
protected Map<DatastoreIdentifier,Column>	columnsByIdentifier Index to the columns, keyed by name identifier.
protected DatastoreAdapter	dba Database Adapter being used.
protected Boolean	existsInDatastore Cache what we learned in a call to exists()
protected DatastoreIdentifier	identifier Identifier name for the table.
protected int	state State of the table
protected RDBMSStoreManager	storeMgr Manager for this table.
protected static int	TABLE_STATE_INITIALIZED Table object has been initialised.
protected static int	TABLE_STATE_INITIALIZED_MODIFIED Table object has been initialized but has had structural modifications since.
protected static int	TABLE_STATE_NEW Table object has just been created.
protected static int	TABLE_STATE_PK_INITIALIZED Table object is created and PK initialised.
protected static int	TABLE_STATE_VALIDATED Table object has been validated.

Constructor Summary

Constructors

Constructor and Description
AbstractTable(DatastoreIdentifier identifier, RDBMSStoreManager storeMgr) Constructor taking the table name and the RDBMSManager managing this table.

Method Summary

Modifier and Type	Method and Description
Column	addColumn(String storedJavaType, DatastoreIdentifier name, JavaTypeMapping mapping, org.datanucleus.metadata.ColumnMetaData colmd) Creates a new column in the table.
protected void	addColumnInternal(Column col) Utility method to add a column to the internal representation
protected boolean	allowDDLOutput() Determine whether we or our concrete class allow DDL to be written into a file instead of sending it to the DB.
protected void	assertIsInitialized()
protected void	assertIsInitializedModified()
protected void	assertIsPKInitialized()
protected void	assertIsPKUninitialized()
protected void	assertIsUninitialized()
protected void	assertIsValidated()
boolean	create(Connection conn) Method to create this table.
void	drop(Connection conn) Method to drop this table.
boolean	equals(Object obj) Equality operator.
protected void	executeDdlStatement(Statement stmt, String stmtText) Execute a single DDL SQL statement with appropriate logging.
protected void	executeDdlStatementList(List stmts, Connection conn) Method to perform the required SQL statements.
boolean	exists(Connection conn, boolean auto_create) Method to check the existence of the table/view, optionally auto creating it where required.
String	getCatalogName() Accessor for the Catalog Name.
org.datanucleus.metadata.AbstractClassMetaData	getClassMetaData()
Column	getColumn(DatastoreIdentifier identifier) Accessor for the Datastore field with the specified identifier.
org.datanucleus.store.schema.table.Column	getColumnForName(String name)
org.datanucleus.store.schema.table.Column	getColumnForPosition(int pos)
List<org.datanucleus.store.schema.table.Column>	getColumns()
org.datanucleus.store.schema.table.Column	getDatastoreIdColumn()
DatastoreIdentifier	getDatastoreIdentifierFullyQualified() Method that operates like toString except it returns a fully-qualified name that will always be fully-qualified even when the user hasnt specified the catalog/schema in PMF or MetaData.
org.datanucleus.store.schema.table.Column	getDiscriminatorColumn()
JavaTypeMapping	getDiscriminatorMapping(boolean allowSuperclasses) Accessor for the discriminator mapping specified .
org.datanucleus.metadata.DiscriminatorMetaData	getDiscriminatorMetaData() Accessor for Discriminator MetaData
DatastoreIdentifier	getIdentifier() Accessor for the SQL identifier (the table name).
org.datanucleus.store.schema.table.MemberColumnMapping	getMemberColumnMappingForEmbeddedMember(List<org.datanucleus.metadata.AbstractMemberMetaData> mmds)
org.datanucleus.store.schema.table.MemberColumnMapping	getMemberColumnMappingForMember(org.datanucleus.metadata.AbstractMemberMetaData mmd)
Set<org.datanucleus.store.schema.table.MemberColumnMapping>	getMemberColumnMappings()
org.datanucleus.store.schema.table.Column	getMultitenancyColumn()
JavaTypeMapping	getMultitenancyMapping() Accessor for the multi-tenancy mapping (if any).
String	getName()
int	getNumberOfColumns()
String	getSchemaName() Accessor for the Schema Name.
protected abstract List	getSQLCreateStatements(Properties props) Accessor for the SQL create statements.
protected abstract List	getSQLDropStatements() Accessor for the SQL drop statements.
RDBMSStoreManager	getStoreManager()
org.datanucleus.store.schema.table.Column	getVersionColumn()
JavaTypeMapping	getVersionMapping(boolean allowSuperclasses) Accessor for the version mapping specified.
org.datanucleus.metadata.VersionMetaData	getVersionMetaData() Accessor for Version MetaData
boolean	hasColumn(DatastoreIdentifier identifier) Checks if there is a column for the identifier
protected boolean	hasColumnName(DatastoreIdentifier colName) Utility to return if a column of this name exists.
int	hashCode() Accessor for the hascode of this table.
boolean	isInitialized() Accessor for whether the table is initialised.
boolean	isInitializedModified() Accessor for whether the table has been modified since initialisation.
boolean	isPKInitialized() Accessor for whether the primary key of the table is initialised.
boolean	isValidated() Accessor for whether the table is validated.
protected boolean	tableExistsInDatastore(Connection conn) Determine whether our table exists in the datastore (without modifying datastore).
String	toString() Method to return a string version of this table.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.datanucleus.store.rdbms.table.Table

getIdMapping, getMemberMapping, initialize, postInitialize, preInitialize, validate

Field Detail

TABLE_STATE_NEW

protected static final int TABLE_STATE_NEW

Table object has just been created.

See Also:

Constant Field Values

TABLE_STATE_PK_INITIALIZED

protected static final int TABLE_STATE_PK_INITIALIZED

Table object is created and PK initialised.

See Also:

Constant Field Values

TABLE_STATE_INITIALIZED

protected static final int TABLE_STATE_INITIALIZED

Table object has been initialised.

See Also:

Constant Field Values

TABLE_STATE_INITIALIZED_MODIFIED

protected static final int TABLE_STATE_INITIALIZED_MODIFIED

Table object has been initialized but has had structural modifications since.

See Also:

Constant Field Values

TABLE_STATE_VALIDATED

protected static final int TABLE_STATE_VALIDATED

Table object has been validated.

See Also:

Constant Field Values

storeMgr

protected final RDBMSStoreManager storeMgr

Manager for this table.

dba

protected final DatastoreAdapter dba

Database Adapter being used.

identifier

protected final DatastoreIdentifier identifier

Identifier name for the table. Includes the catalog/schema internally (if defined by the user).

state

protected int state

State of the table

columns

protected List<org.datanucleus.store.schema.table.Column> columns

Columns for this table.

columnsByIdentifier

protected Map<DatastoreIdentifier,Column> columnsByIdentifier

Index to the columns, keyed by name identifier. TODO Key this by the column name, not its identifier.

existsInDatastore

protected Boolean existsInDatastore

Cache what we learned in a call to exists()

Constructor Detail

AbstractTable

public AbstractTable(DatastoreIdentifier identifier,
                     RDBMSStoreManager storeMgr)

Constructor taking the table name and the RDBMSManager managing this table.

Parameters:

identifier - Name of the table

storeMgr - The RDBMS Manager

Method Detail

isInitialized

public boolean isInitialized()

Accessor for whether the table is initialised.

Returns:

Whether it is initialised

isPKInitialized

public boolean isPKInitialized()

Accessor for whether the primary key of the table is initialised.

Returns:

Whether the primary key of the table is initialised

isValidated

public boolean isValidated()

Accessor for whether the table is validated.

Returns:

Whether it is validated.

isInitializedModified

public boolean isInitializedModified()

Accessor for whether the table has been modified since initialisation.

Returns:

Whether it is modified since initialisation.

getStoreManager

public RDBMSStoreManager getStoreManager()

Specified by:

getStoreManager in interface org.datanucleus.store.schema.table.Table

getName

public String getName()

Specified by:

getName in interface org.datanucleus.store.schema.table.Table

getCatalogName

public String getCatalogName()

Accessor for the Catalog Name. This will be part of the fully qualified name IF the user has specified the catalog in the MetaData, OR if they have specified the catalog in the PMF.

Specified by:

getCatalogName in interface org.datanucleus.store.schema.table.Table

Returns:

Catalog Name

getSchemaName

public String getSchemaName()

Accessor for the Schema Name. This will be part of the fully qualified name IF the user has specified the schema in the MetaData, OR if they have specified the schema in the PMF.

Specified by:

getSchemaName in interface org.datanucleus.store.schema.table.Table

Returns:

Schema Name

getIdentifier

public DatastoreIdentifier getIdentifier()

Accessor for the SQL identifier (the table name).

Returns:

The name

getClassMetaData

public org.datanucleus.metadata.AbstractClassMetaData getClassMetaData()

Specified by:

getClassMetaData in interface org.datanucleus.store.schema.table.Table

getNumberOfColumns

public int getNumberOfColumns()

Specified by:

getNumberOfColumns in interface org.datanucleus.store.schema.table.Table

getColumns

public List<org.datanucleus.store.schema.table.Column> getColumns()

Specified by:

getColumns in interface org.datanucleus.store.schema.table.Table

getColumnForPosition

public org.datanucleus.store.schema.table.Column getColumnForPosition(int pos)

Specified by:

getColumnForPosition in interface org.datanucleus.store.schema.table.Table

getDatastoreIdColumn

public org.datanucleus.store.schema.table.Column getDatastoreIdColumn()

Specified by:

getDatastoreIdColumn in interface org.datanucleus.store.schema.table.Table

getVersionColumn

public org.datanucleus.store.schema.table.Column getVersionColumn()

Specified by:

getVersionColumn in interface org.datanucleus.store.schema.table.Table

getDiscriminatorColumn

public org.datanucleus.store.schema.table.Column getDiscriminatorColumn()

Specified by:

getDiscriminatorColumn in interface org.datanucleus.store.schema.table.Table

getMultitenancyColumn

public org.datanucleus.store.schema.table.Column getMultitenancyColumn()

Specified by:

getMultitenancyColumn in interface org.datanucleus.store.schema.table.Table

getColumnForName

public org.datanucleus.store.schema.table.Column getColumnForName(String name)

Specified by:

getColumnForName in interface org.datanucleus.store.schema.table.Table

getMemberColumnMappingForMember

public org.datanucleus.store.schema.table.MemberColumnMapping getMemberColumnMappingForMember(org.datanucleus.metadata.AbstractMemberMetaData mmd)

Specified by:

getMemberColumnMappingForMember in interface org.datanucleus.store.schema.table.Table

getMemberColumnMappingForEmbeddedMember

public org.datanucleus.store.schema.table.MemberColumnMapping getMemberColumnMappingForEmbeddedMember(List<org.datanucleus.metadata.AbstractMemberMetaData> mmds)

Specified by:

getMemberColumnMappingForEmbeddedMember in interface org.datanucleus.store.schema.table.Table

getMemberColumnMappings

public Set<org.datanucleus.store.schema.table.MemberColumnMapping> getMemberColumnMappings()

Specified by:

getMemberColumnMappings in interface org.datanucleus.store.schema.table.Table

getDiscriminatorMetaData

public org.datanucleus.metadata.DiscriminatorMetaData getDiscriminatorMetaData()

Accessor for Discriminator MetaData

Returns:

Returns the Discriminator MetaData.

getDiscriminatorMapping

public JavaTypeMapping getDiscriminatorMapping(boolean allowSuperclasses)

Accessor for the discriminator mapping specified .

Parameters:

allowSuperclasses - Whether we should return just the mapping from this table or whether we should return it when this table has none and the supertable has

Returns:

The mapping for the discriminator datastore field

getMultitenancyMapping

public JavaTypeMapping getMultitenancyMapping()

Description copied from interface: Table

Accessor for the multi-tenancy mapping (if any).

Returns:

The multi-tenancy mapping

getVersionMetaData

public org.datanucleus.metadata.VersionMetaData getVersionMetaData()

Accessor for Version MetaData

Returns:

Returns the Version MetaData.

getVersionMapping

public JavaTypeMapping getVersionMapping(boolean allowSuperclasses)

Accessor for the version mapping specified.

Parameters:

allowSuperclasses - Whether we should return just the mapping from this table or whether we should return it when this table has none and the supertable has

Returns:

The mapping for the version datastore field

addColumn

public Column addColumn(String storedJavaType,
                        DatastoreIdentifier name,
                        JavaTypeMapping mapping,
                        org.datanucleus.metadata.ColumnMetaData colmd)

Creates a new column in the table. Will add the new Column and return it. If the new column clashes in name with an existing column of the required name will throw a DuplicateColumnNameException except when :-

• The 2 columns are for same named fields in the class or its subclasses with the subclass(es) using "superclass-table" inheritance strategy. One of the columns has to come from a subclass - cant have both from the same class.

Parameters:

storedJavaType - the java type of the datastore field

name - the SQL identifier for the column to be added

mapping - the mapping for the column to be added

colmd - ColumnMetaData for the column to be added to the table

Returns:

the new Column

Throws:

DuplicateColumnException - if a column already exists with same name and not a supported situation.

hasColumn

public boolean hasColumn(DatastoreIdentifier identifier)

Checks if there is a column for the identifier

Parameters:

identifier - the identifier of the column

Returns:

true if the column exists for the identifier

getColumn

public Column getColumn(DatastoreIdentifier identifier)

Accessor for the Datastore field with the specified identifier. Returns null if has no column of this name.

Parameters:

identifier - The name of the column

Returns:

The column

create

public boolean create(Connection conn)
               throws SQLException

Method to create this table.

Parameters:

conn - Connection to the datastore.

Returns:

true if the table was created

Throws:

SQLException - Thrown if an error occurs creating the table.

drop

public void drop(Connection conn)
          throws SQLException

Method to drop this table.

Parameters:

conn - Connection to the datastore.

Throws:

SQLException - Thrown if an error occurs dropping the table.

exists

public boolean exists(Connection conn,
                      boolean auto_create)
               throws SQLException

Method to check the existence of the table/view, optionally auto creating it where required. If it doesn't exist and auto creation isn't specified this throws a MissingTableException.

Parameters:

conn - The JDBC Connection

auto_create - Whether to auto create the table if not existing

Returns:

Whether the table was added

Throws:

SQLException - Thrown when an error occurs in the JDBC calls

equals

public final boolean equals(Object obj)

Equality operator.

Overrides:

equals in class Object

Parameters:

obj - The object to compare against

Returns:

Whether the objects are equal

hashCode

public final int hashCode()

Accessor for the hascode of this table.

Overrides:

hashCode in class Object

Returns:

The hash code.

toString

public final String toString()

Method to return a string version of this table. This name is the fully-qualified name of the table,including catalog/schema names, where these are appropriate. They are included where the user has either specified the catalog/schema for the PMF, or in the MetaData. They are also only included where the datastore adapter supports their use.

Overrides:

toString in class Object

Returns:

String name of the table (catalog.schema.table)

getDatastoreIdentifierFullyQualified

public DatastoreIdentifier getDatastoreIdentifierFullyQualified()

Method that operates like toString except it returns a fully-qualified name that will always be fully-qualified even when the user hasnt specified the catalog/schema in PMF or MetaData. That is, it will add on any auto-calculated catalog/schema for the datastore. Note that this will never include any quoting strings required for insert/select etc.

Returns:

The fully qualified name

addColumnInternal

protected void addColumnInternal(Column col)

Utility method to add a column to the internal representation

Parameters:

col - The column

hasColumnName

protected boolean hasColumnName(DatastoreIdentifier colName)

Utility to return if a column of this name exists.

Parameters:

colName - The column name

Returns:

Whether the column of this name exists

getSQLCreateStatements

protected abstract List getSQLCreateStatements(Properties props)

Accessor for the SQL create statements.

Parameters:

props - Properties controlling the table creation

Returns:

The SQL Create statements

getSQLDropStatements

protected abstract List getSQLDropStatements()

Accessor for the SQL drop statements.

Returns:

The SQL Drop statements

assertIsPKUninitialized

protected void assertIsPKUninitialized()

assertIsUninitialized

protected void assertIsUninitialized()

assertIsInitialized

protected void assertIsInitialized()

assertIsInitializedModified

protected void assertIsInitializedModified()

assertIsPKInitialized

protected void assertIsPKInitialized()

assertIsValidated

protected void assertIsValidated()

allowDDLOutput

protected boolean allowDDLOutput()

Determine whether we or our concrete class allow DDL to be written into a file instead of sending it to the DB. Defaults to true.

Returns:

Whether it allows DDL outputting

executeDdlStatementList

protected void executeDdlStatementList(List stmts,
                                       Connection conn)
                                throws SQLException

Method to perform the required SQL statements.

Parameters:

stmts - A List of statements

conn - The Connection to the datastore

Throws:

SQLException - Any exceptions thrown by the statements

executeDdlStatement

protected void executeDdlStatement(Statement stmt,
                                   String stmtText)
                            throws SQLException

Execute a single DDL SQL statement with appropriate logging. If ddlWriter is set, do not actually execute the SQL but write it to that Writer.

Parameters:

stmt - The JDBC Statement object to execute on

stmtText - The actual SQL statement text

Throws:

SQLException - Thrown if an error occurs

tableExistsInDatastore

protected boolean tableExistsInDatastore(Connection conn)
                                  throws SQLException

Determine whether our table exists in the datastore (without modifying datastore). Result is cached

Parameters:

conn - The Connection

Returns:

Whether the table exists in the datastore

Throws:

SQLException - Thrown if an error occurs