org.jpox.store.rdbms.table
Class AbstractTable

java.lang.Object
  org.jpox.store.rdbms.table.AbstractTable

All Implemented Interfaces:

org.jpox.store.mapped.DatastoreContainerObject, org.jpox.store.mapped.DatastoreObject, Table

Direct Known Subclasses:

TableImpl, ViewImpl

public abstract class AbstractTable
extends java.lang.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.

Version:

$Revision: 1.63 $

Field Summary

protected java.util.List	columns Columns for this table.
protected java.util.HashMap	columnsByName Index to the columns, keyed by name.
protected static boolean	completeDdl Whether we must produce complete DDL (when allowDDLOutput() && isOutputtingDdl()), or only for missing elements
protected RDBMSAdapter	dba Database Adapter being used.
protected static java.io.Writer	ddlWriter Writer to output any DDL.
protected java.lang.Boolean	existsInDatastore Cache what we learned in a call to exists()
protected org.jpox.store.mapped.DatastoreIdentifier	identifier Identifier name for the table.
protected static org.jpox.util.Localiser	LOCALISER Localiser for messages.
protected int	state State of the table
protected RDBMSManager	storeMgr Manager for this table.

Fields inherited from interface org.jpox.store.rdbms.table.Table

TABLE_STATE_INITIALIZED, TABLE_STATE_INITIALIZED_MODIFIED, TABLE_STATE_NEW, TABLE_STATE_PK_INITIALIZED, TABLE_STATE_VALIDATED, TABLE_TYPE_MISSING, TABLE_TYPE_TABLE, TABLE_TYPE_UNKNOWN, TABLE_TYPE_VIEW

Constructor Summary

AbstractTable(org.jpox.store.mapped.DatastoreIdentifier identifier, RDBMSManager storeMgr)
Constructor taking the table name and the RDBMSManager managing this table.

Method Summary

protected void	addColumnInternal(Column col) Utility method to add a column to the internal representation
org.jpox.store.mapped.DatastoreField	addDatastoreField(java.lang.String storedJavaType, org.jpox.store.mapped.DatastoreIdentifier name, org.jpox.store.mapped.mapping.JavaTypeMapping mapping, org.jpox.metadata.MetaData colmd) Creates a new column in the table.
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(java.sql.Connection conn) Method to create this table.
void	drop(java.sql.Connection conn) Method to drop this table.
boolean	equals(java.lang.Object obj) Equality operator.
protected void	executeDdlStatement(java.sql.Statement stmt, java.lang.String stmtText) Execute a single DDL SQL statement with appropriate logging.
protected void	executeDdlStatementList(java.util.List stmts, java.sql.Connection conn) Method to perform the required SQL statements.
boolean	exists(java.sql.Connection conn, boolean auto_create) Method to check the existence of the table/view, optionally auto creating it where required.
java.lang.String	getCatalogName() Accessor for the Catalog Name.
org.jpox.store.mapped.DatastoreField[]	getDatastoreFieldsMetaData() Accessor for the DatastoreFields infered from the java and metadata files.
org.jpox.store.mapped.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.jpox.store.mapped.mapping.JavaTypeMapping	getDiscriminatorMapping(boolean allowSuperclasses) Accessor for the discriminator mapping specified .
org.jpox.metadata.DiscriminatorMetaData	getDiscriminatorMetaData() Accessor for Discriminator MetaData
org.jpox.store.mapped.DatastoreIdentifier	getIdentifier() Accessor for the SQL identifier (the table name).
java.lang.String	getSchemaName() Accessor for the Schema Name.
protected abstract java.util.List	getSQLCreateStatements(java.util.Properties props) Accessor for the SQL create statements.
protected abstract java.util.List	getSQLDropStatements() Accessor for the SQL drop statements.
org.jpox.store.mapped.MappedStoreManager	getStoreManager() Accessor for the Store Manager.
org.jpox.store.mapped.mapping.JavaTypeMapping	getVersionMapping(boolean allowSuperclasses) Accessor for the version mapping specified.
org.jpox.metadata.VersionMetaData	getVersionMetaData() Accessor for Version MetaData
protected boolean	hasColumnName(org.jpox.store.mapped.DatastoreIdentifier colName) Utility to return if a column of this name exists.
boolean	hasDatastoreField(org.jpox.store.mapped.DatastoreIdentifier identifier) Checks if there is a DatastoreField for the identifier
int	hashCode() Accessor for the hascode of this table.
static boolean	isCompleteDdl()
boolean	isInitialized() Accessor for whether the table is initialised.
boolean	isInitializedModified() Accessor for whether the table has been modified since initialisation.
static boolean	isOutputtingDDL() Whether a writer is defined to output DDL
boolean	isPKInitialized() Accessor for whether the primary key of the table is initialised.
boolean	isValidated() Accessor for whether the table is validated.
static void	setCompleteDdl(boolean completeDdl) Whether DDL should be generated regardless of whether table is missing or not
static void	setDdlWriter(java.io.Writer writer) Set the file where any subsequent DDL SQL commands will be written to instead of issuing them to the database.
protected boolean	tableExistsInDatastore(java.sql.Connection conn) Determine whether our table exists in the datastore (without modifying datastore).
java.lang.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.jpox.store.rdbms.table.Table

initialize, postInitialize, preInitialize, validate

Methods inherited from interface org.jpox.store.mapped.DatastoreContainerObject

getFieldMapping, getIDMapping

Field Detail

LOCALISER

protected static final org.jpox.util.Localiser LOCALISER

Localiser for messages.

storeMgr

protected final RDBMSManager storeMgr

Manager for this table.

dba

protected final RDBMSAdapter dba

Database Adapter being used.

identifier

protected final org.jpox.store.mapped.DatastoreIdentifier identifier

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

state

protected int state

State of the table

columns

protected java.util.List columns

Columns for this table.

columnsByName

protected java.util.HashMap columnsByName

Index to the columns, keyed by name.

ddlWriter

protected static java.io.Writer ddlWriter

Writer to output any DDL. TODO Refactor this out and provide cleaner interface to DDL

completeDdl

protected static boolean completeDdl

Whether we must produce complete DDL (when allowDDLOutput() && isOutputtingDdl()), or only for missing elements

existsInDatastore

protected java.lang.Boolean existsInDatastore

Cache what we learned in a call to exists()

Constructor Detail

AbstractTable

public AbstractTable(org.jpox.store.mapped.DatastoreIdentifier identifier,
                     RDBMSManager 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.

Specified by:

isInitialized in interface Table

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.

Specified by:

isValidated in interface Table

Returns:

Whether it is validated.

isInitializedModified

public boolean isInitializedModified()

Accessor for whether the table has been modified since initialisation.

Specified by:

isInitializedModified in interface Table

Returns:

Whether it is modified since initialisation.

getStoreManager

public org.jpox.store.mapped.MappedStoreManager getStoreManager()

Accessor for the Store Manager.

Specified by:

getStoreManager in interface org.jpox.store.mapped.DatastoreObject

Returns:

Store Manager

getCatalogName

public java.lang.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 Table

Returns:

Catalog Name

getSchemaName

public java.lang.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 Table

Returns:

Schema Name

getIdentifier

public org.jpox.store.mapped.DatastoreIdentifier getIdentifier()

Accessor for the SQL identifier (the table name).

Specified by:

getIdentifier in interface org.jpox.store.mapped.DatastoreObject

Returns:

The name

addDatastoreField

public org.jpox.store.mapped.DatastoreField addDatastoreField(java.lang.String storedJavaType,
                                                              org.jpox.store.mapped.DatastoreIdentifier name,
                                                              org.jpox.store.mapped.mapping.JavaTypeMapping mapping,
                                                              org.jpox.metadata.MetaData 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.

Specified by:

addDatastoreField in interface org.jpox.store.mapped.DatastoreContainerObject

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:

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

hasDatastoreField

public boolean hasDatastoreField(org.jpox.store.mapped.DatastoreIdentifier identifier)

Checks if there is a DatastoreField for the identifier

Specified by:

hasDatastoreField in interface org.jpox.store.mapped.DatastoreContainerObject

Parameters:

identifier - the identifier of the DatastoreField

Returns:

true if the DatastoreField exists for the identifier

getDatastoreFieldsMetaData

public org.jpox.store.mapped.DatastoreField[] getDatastoreFieldsMetaData()

Accessor for the DatastoreFields infered from the java and metadata files.

Specified by:

getDatastoreFieldsMetaData in interface org.jpox.store.mapped.DatastoreContainerObject

Returns:

the DatastoreField[]

create

public boolean create(java.sql.Connection conn)
               throws java.sql.SQLException

Method to create this table.

Specified by:

create in interface Table

Parameters:

conn - Connection to the datastore.

Returns:

true if the table was created

Throws:

java.sql.SQLException - Thrown if an error occurs creating the table.

drop

public void drop(java.sql.Connection conn)
          throws java.sql.SQLException

Method to drop this table.

Specified by:

drop in interface Table

Parameters:

conn - Connection to the datastore.

Throws:

java.sql.SQLException - Thrown if an error occurs dropping the table.

exists

public boolean exists(java.sql.Connection conn,
                      boolean auto_create)
               throws java.sql.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.

Specified by:

exists in interface Table

Parameters:

conn - The JDBC Connection

auto_create - Whether to auto create the table if not existing

Returns:

Whether the table was added

Throws:

java.sql.SQLException - Thrown when an error occurs in the JDBC calls

equals

public final boolean equals(java.lang.Object obj)

Equality operator.

Overrides:

equals in class java.lang.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 java.lang.Object

Returns:

The hash code.

toString

public final java.lang.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 java.lang.Object

Returns:

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

getDatastoreIdentifierFullyQualified

public org.jpox.store.mapped.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(org.jpox.store.mapped.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 java.util.List getSQLCreateStatements(java.util.Properties props)

Accessor for the SQL create statements.

Parameters:

props - Properties controlling the table creation

Returns:

The SQL Create statements

getSQLDropStatements

protected abstract java.util.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

isOutputtingDDL

public static boolean isOutputtingDDL()

Whether a writer is defined to output DDL

Returns:

true if a writer is set

setDdlWriter

public static void setDdlWriter(java.io.Writer writer)

Set the file where any subsequent DDL SQL commands will be written to instead of issuing them to the database. The default null means normal operation, i.e. DDL SQL commands will be sent to the DB.

Parameters:

writer - The writer to use for outputting DDL

executeDdlStatementList

protected void executeDdlStatementList(java.util.List stmts,
                                       java.sql.Connection conn)
                                throws java.sql.SQLException

Method to perform the required SQL statements.

Parameters:

stmts - A List of statements

conn - The Connection to the datastore

Throws:

java.sql.SQLException - Any exceptions thrown by the statements

executeDdlStatement

protected void executeDdlStatement(java.sql.Statement stmt,
                                   java.lang.String stmtText)
                            throws java.sql.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:

java.sql.SQLException - Thrown if an error occurs

See Also:

setDdlWriter(Writer)

getDiscriminatorMetaData

public org.jpox.metadata.DiscriminatorMetaData getDiscriminatorMetaData()

Accessor for Discriminator MetaData

Specified by:

getDiscriminatorMetaData in interface org.jpox.store.mapped.DatastoreContainerObject

Returns:

Returns the Discriminator MetaData.

getDiscriminatorMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getDiscriminatorMapping(boolean allowSuperclasses)

Accessor for the discriminator mapping specified .

Specified by:

getDiscriminatorMapping in interface org.jpox.store.mapped.DatastoreContainerObject

Returns:

The mapping for the discriminator datastore field

getVersionMetaData

public org.jpox.metadata.VersionMetaData getVersionMetaData()

Accessor for Version MetaData

Specified by:

getVersionMetaData in interface org.jpox.store.mapped.DatastoreContainerObject

Returns:

Returns the Version MetaData.

getVersionMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getVersionMapping(boolean allowSuperclasses)

Accessor for the version mapping specified.

Specified by:

getVersionMapping in interface org.jpox.store.mapped.DatastoreContainerObject

Returns:

The mapping for the version datastore field

tableExistsInDatastore

protected boolean tableExistsInDatastore(java.sql.Connection conn)
                                  throws java.sql.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:

java.sql.SQLException - Thrown if an error occurs

isCompleteDdl

public static boolean isCompleteDdl()

setCompleteDdl

public static void setCompleteDdl(boolean completeDdl)

Whether DDL should be generated regardless of whether table is missing or not

Parameters:

completeDdl -