Class TableCreator
- java.lang.Object
-
- org.eclipse.persistence.tools.schemaframework.TableCreator
-
public class TableCreator extends java.lang.ObjectPurpose: This class is responsible for creating the tables defined in the project. A specific subclass of this class is created for each project. The specific table information is defined in the subclass.- Author:
- Peter Krogh
- Since:
- TopLink 2.0
-
-
Field Summary
Fields Modifier and Type Field Description static booleanCHECK_EXISTENCEFlag to disable table existence check before create.protected booleanignoreDatabaseExceptionprotected java.lang.Stringnameprotected java.util.List<TableDefinition>tableDefinitions
-
Constructor Summary
Constructors Constructor Description TableCreator()TableCreator(java.util.List<TableDefinition> tableDefinitions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddTableDefinition(TableDefinition tableDefinition)Add the table.voidaddTableDefinitions(java.util.Collection<TableDefinition> tableDefs)Add a set of tables.protected voidbuildConstraints(SchemaManager schemaManager, boolean build)Convert any field constraint to constraint objects.voidcreateConstraints(java.util.List<TableDefinition> tables, DatabaseSession session, SchemaManager schemaManager, boolean build)Create constraints.voidcreateConstraints(DatabaseSession session)Create constraints.voidcreateConstraints(DatabaseSession session, SchemaManager schemaManager)Create constraints.voidcreateConstraints(DatabaseSession session, SchemaManager schemaManager, boolean build)Create constraints.voidcreateTables(DatabaseSession session)This creates the tables on the database.voidcreateTables(DatabaseSession session, SchemaManager schemaManager)This creates the tables on the database.voidcreateTables(DatabaseSession session, SchemaManager schemaManager, boolean build)This creates the tables on the database.voidcreateTables(DatabaseSession session, SchemaManager schemaManager, boolean build, boolean check, boolean createSequenceTables, boolean createSequences)This creates the tables on the database.voiddropConstraints(DatabaseSession session)Drop the table constraints from the database.voiddropConstraints(DatabaseSession session, SchemaManager schemaManager)Drop the table constraints from the database.voiddropConstraints(DatabaseSession session, SchemaManager schemaManager, boolean build)Drop the table constraints from the database.voiddropTables(DatabaseSession session)Drop the tables from the database.voiddropTables(DatabaseSession session, SchemaManager schemaManager)Drop the tables from the database.voiddropTables(DatabaseSession session, SchemaManager schemaManager, boolean build)Drop the tables from the database.voidextendTables(DatabaseSession session, SchemaManager schemaManager)Create or extend the tables on the database.voidextendTables(DatabaseSession session, SchemaManager schemaManager, boolean build)This creates/extends the tables on the database.protected voidextendTablesAndConstraints(SchemaManager schemaManager, DatabaseSession session)java.lang.StringgetName()Return the name.protected java.lang.StringgetSequenceTableName(Session session)This returns the Sequence Table's qualified name, without delimiting.java.util.List<TableDefinition>getTableDefinitions()Return the tables.voidreplaceTables(DatabaseSession session)Recreate the tables on the database.voidreplaceTables(DatabaseSession session, SchemaManager schemaManager)Recreate the tables on the database.voidreplaceTables(DatabaseSession session, SchemaManager schemaManager, boolean createSequenceTables)Recreate the tables on the database.voidreplaceTables(DatabaseSession session, SchemaManager schemaManager, boolean createSequenceTables, boolean createSequences)Recreate the tables on the database.protected voidreplaceTablesAndConstraints(SchemaManager schemaManager, DatabaseSession session)protected voidreplaceTablesAndConstraints(SchemaManager schemaManager, DatabaseSession session, boolean createSequenceTables, boolean createSequences)voidsetIgnoreDatabaseException(boolean ignoreDatabaseException)Set flag whether DatabaseException should be ignored.voidsetName(java.lang.String name)Set the name.voidsetTableDefinitions(java.util.Vector tableDefinitions)Set the tables.booleanshouldIgnoreDatabaseException()Return true if DatabaseException is to be ignored.
-
-
-
Field Detail
-
CHECK_EXISTENCE
public static boolean CHECK_EXISTENCE
Flag to disable table existence check before create.
-
tableDefinitions
protected java.util.List<TableDefinition> tableDefinitions
-
name
protected java.lang.String name
-
ignoreDatabaseException
protected boolean ignoreDatabaseException
-
-
Constructor Detail
-
TableCreator
public TableCreator()
-
TableCreator
public TableCreator(java.util.List<TableDefinition> tableDefinitions)
-
-
Method Detail
-
addTableDefinition
public void addTableDefinition(TableDefinition tableDefinition)
Add the table.
-
addTableDefinitions
public void addTableDefinitions(java.util.Collection<TableDefinition> tableDefs)
Add a set of tables.
-
createConstraints
public void createConstraints(DatabaseSession session)
Create constraints.
-
createConstraints
public void createConstraints(DatabaseSession session, SchemaManager schemaManager)
Create constraints.
-
createConstraints
public void createConstraints(DatabaseSession session, SchemaManager schemaManager, boolean build)
Create constraints.
-
createConstraints
public void createConstraints(java.util.List<TableDefinition> tables, DatabaseSession session, SchemaManager schemaManager, boolean build)
Create constraints.
-
createTables
public void createTables(DatabaseSession session)
This creates the tables on the database. If the table already exists this will fail.
-
createTables
public void createTables(DatabaseSession session, SchemaManager schemaManager)
This creates the tables on the database. If the table already exists this will fail.
-
createTables
public void createTables(DatabaseSession session, SchemaManager schemaManager, boolean build)
This creates the tables on the database. If the table already exists this will fail.
-
createTables
public void createTables(DatabaseSession session, SchemaManager schemaManager, boolean build, boolean check, boolean createSequenceTables, boolean createSequences)
This creates the tables on the database. If the table already exists this will fail.
-
dropConstraints
public void dropConstraints(DatabaseSession session)
Drop the table constraints from the database.
-
dropConstraints
public void dropConstraints(DatabaseSession session, SchemaManager schemaManager)
Drop the table constraints from the database.
-
dropConstraints
public void dropConstraints(DatabaseSession session, SchemaManager schemaManager, boolean build)
Drop the table constraints from the database.
-
dropTables
public void dropTables(DatabaseSession session)
Drop the tables from the database.
-
dropTables
public void dropTables(DatabaseSession session, SchemaManager schemaManager)
Drop the tables from the database.
-
dropTables
public void dropTables(DatabaseSession session, SchemaManager schemaManager, boolean build)
Drop the tables from the database.
-
getName
public java.lang.String getName()
Return the name.
-
getTableDefinitions
public java.util.List<TableDefinition> getTableDefinitions()
Return the tables.
-
replaceTables
public void replaceTables(DatabaseSession session)
Recreate the tables on the database. This will drop the tables if they exist and recreate them.
-
replaceTables
public void replaceTables(DatabaseSession session, SchemaManager schemaManager)
Recreate the tables on the database. This will drop the tables if they exist and recreate them.
-
replaceTables
public void replaceTables(DatabaseSession session, SchemaManager schemaManager, boolean createSequenceTables)
Recreate the tables on the database. This will drop the tables if they exist and recreate them.
-
replaceTables
public void replaceTables(DatabaseSession session, SchemaManager schemaManager, boolean createSequenceTables, boolean createSequences)
Recreate the tables on the database. This will drop the tables if they exist and recreate them.
-
replaceTablesAndConstraints
protected void replaceTablesAndConstraints(SchemaManager schemaManager, DatabaseSession session, boolean createSequenceTables, boolean createSequences)
-
replaceTablesAndConstraints
protected void replaceTablesAndConstraints(SchemaManager schemaManager, DatabaseSession session)
-
buildConstraints
protected void buildConstraints(SchemaManager schemaManager, boolean build)
Convert any field constraint to constraint objects.
-
setName
public void setName(java.lang.String name)
Set the name.
-
setTableDefinitions
public void setTableDefinitions(java.util.Vector tableDefinitions)
Set the tables.
-
shouldIgnoreDatabaseException
public boolean shouldIgnoreDatabaseException()
Return true if DatabaseException is to be ignored.
-
setIgnoreDatabaseException
public void setIgnoreDatabaseException(boolean ignoreDatabaseException)
Set flag whether DatabaseException should be ignored.
-
getSequenceTableName
protected java.lang.String getSequenceTableName(Session session)
This returns the Sequence Table's qualified name, without delimiting.- Parameters:
session-- Returns:
- the qualified table name
-
extendTables
public void extendTables(DatabaseSession session, SchemaManager schemaManager)
Create or extend the tables on the database. This will alter existing tables to add missing fields or create the table otherwise. It will also create Sequences tables and objects.
-
extendTablesAndConstraints
protected void extendTablesAndConstraints(SchemaManager schemaManager, DatabaseSession session)
-
extendTables
public void extendTables(DatabaseSession session, SchemaManager schemaManager, boolean build)
This creates/extends the tables on the database.
-
-