org.jpox.store.rdbms.table
Class SequenceTable

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

All Implemented Interfaces:

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

public class SequenceTable
extends TableImpl

Class defining a table for storing generated values. The table has 2 columns : a primary key String, and a value Long.

Version:

$Revision: 1.58 $

Field Summary

Fields inherited from class org.jpox.store.rdbms.table.AbstractTable

columns, columnsByName, completeDdl, dba, ddlWriter, existsInDatastore, identifier, LOCALISER, state, storeMgr

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

SequenceTable(org.jpox.store.mapped.DatastoreIdentifier identifier, RDBMSManager storeMgr, java.lang.String seqNameColName, java.lang.String nextValColName)
Constructor

Method Summary

void	deleteAllSequences(org.jpox.ManagedConnection conn) Method to delete all sequences
void	deleteSequence(java.lang.String sequenceName, org.jpox.ManagedConnection conn) Method to delete a sequence
java.util.HashSet	getFetchAllSequences(org.jpox.ManagedConnection conn) Accessor for the sequences
org.jpox.store.mapped.mapping.JavaTypeMapping	getFieldMapping(org.jpox.metadata.AbstractMemberMetaData fmd) Accessor the for the mapping for a field store in this table
org.jpox.store.mapped.mapping.JavaTypeMapping	getIDMapping() Accessor for a mapping for the ID (PersistenceCapable) for this table.
java.lang.Long	getNextVal(java.lang.String sequenceName, org.jpox.ManagedConnection conn, int incrementBy, org.jpox.store.mapped.DatastoreIdentifier tableIdentifier, java.lang.String columnName, int initialValue) Accessor for the nextval of a sequence
void	initialize(org.jpox.ClassLoaderResolver clr) Method to initialise the table.

Methods inherited from class org.jpox.store.rdbms.table.TableImpl

createConstraints, dropConstraints, getExpectedCandidateKeys, getExpectedForeignKeys, getExpectedIndices, getPrimaryKey, getSQLAddCandidateKeyStatements, getSQLAddFKStatements, getSQLCreateIndexStatements, getSQLCreateStatements, getSQLDropStatements, initializeColumnInfoForPrimaryKeyColumns, initializeColumnInfoFromDatastore, postInitialize, preInitialize, validate, validateColumns, validateConstraints, validatePrimaryKey

Methods inherited from class org.jpox.store.rdbms.table.AbstractTable

addColumnInternal, addDatastoreField, allowDDLOutput, assertIsInitialized, assertIsInitializedModified, assertIsPKInitialized, assertIsPKUninitialized, assertIsUninitialized, assertIsValidated, create, drop, equals, executeDdlStatement, executeDdlStatementList, exists, getCatalogName, getDatastoreFieldsMetaData, getDatastoreIdentifierFullyQualified, getDiscriminatorMapping, getDiscriminatorMetaData, getIdentifier, getSchemaName, getStoreManager, getVersionMapping, getVersionMetaData, hasColumnName, hasDatastoreField, hashCode, isCompleteDdl, isInitialized, isInitializedModified, isOutputtingDDL, isPKInitialized, isValidated, setCompleteDdl, setDdlWriter, tableExistsInDatastore, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceTable

public SequenceTable(org.jpox.store.mapped.DatastoreIdentifier identifier,
                     RDBMSManager storeMgr,
                     java.lang.String seqNameColName,
                     java.lang.String nextValColName)

Constructor

Parameters:

identifier - Datastore identifier for this table

storeMgr - The RDBMSManager for this datastore

seqNameColName - Name for the "sequence name" column

nextValColName - Name for the "next value" column

Method Detail

initialize

public void initialize(org.jpox.ClassLoaderResolver clr)

Method to initialise the table.

Parameters:

clr - The ClassLoaderResolver

getIDMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getIDMapping()

Accessor for a mapping for the ID (PersistenceCapable) for this table.

Returns:

The (PersistenceCapable) ID mapping.

getFetchAllSequences

public java.util.HashSet getFetchAllSequences(org.jpox.ManagedConnection conn)
                                       throws java.sql.SQLException

Accessor for the sequences

Parameters:

conn - Connection for this datastore.

Returns:

The HashSet of Sequence names

Throws:

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

getNextVal

public java.lang.Long getNextVal(java.lang.String sequenceName,
                                 org.jpox.ManagedConnection conn,
                                 int incrementBy,
                                 org.jpox.store.mapped.DatastoreIdentifier tableIdentifier,
                                 java.lang.String columnName,
                                 int initialValue)
                          throws java.sql.SQLException

Accessor for the nextval of a sequence

Parameters:

conn - Connection for this datastore.

sequenceName - The sequence name (the key)

incrementBy - The amount to increment (from the current value)

tableIdentifier - Identifier for the table being incremented (used when there is no current value)

columnName - Name of the column being incremented (used when there is no current value)

initialValue - Initial value (if not using tableIdentifier/columnName to find the initial value)

Returns:

The next value that should be used

Throws:

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

deleteSequence

public void deleteSequence(java.lang.String sequenceName,
                           org.jpox.ManagedConnection conn)
                    throws java.sql.SQLException

Method to delete a sequence

Parameters:

sequenceName -

conn - Connection to the datastore

Throws:

java.sql.SQLException - Thrown when an error occurs deleting the schema.

deleteAllSequences

public void deleteAllSequences(org.jpox.ManagedConnection conn)
                        throws java.sql.SQLException

Method to delete all sequences

Parameters:

conn - Connection to the datastore

Throws:

java.sql.SQLException - Thrown when an error occurs deleting.

getFieldMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getFieldMapping(org.jpox.metadata.AbstractMemberMetaData fmd)

Accessor the for the mapping for a field store in this table

Parameters:

fmd - MetaData for the field whose mapping we want

Returns:

The mapping