EclipseLink Core 4.0.2 · org.eclipse.persistence.tools.schemaframework.TableDefinition

Modifier and Type	Field and Description
private boolean	createSQLFiles
private boolean	createVPDCalls
protected String	creationPrefix
protected String	creationSuffix
protected List<FieldDefinition>	fields
protected Map<String, ForeignKeyConstraint>	foreignKeyMap
protected boolean	hasUserDefinedForeignKeyConstraints
protected List<IndexDefinition>	indexes
protected DatabaseTable	table
private String	tenantFieldName
protected List<UniqueKeyConstraint>	uniqueKeys

Access	Constructor and Description
public	TableDefinition()

Method Summary

Modifier and Type	Method and Description
public void	addField(String fieldName, Class<?> is the Java class type corresponding to the database type. type) PUBLIC: Add the field to the table, default sizes are used.
public void	addField(String fieldName, Class<?> is the Java class type corresponding to the database type. type, int fieldSize) PUBLIC: Add the field to the table.
public void	addField(String fieldName, Class<?> is the Java class type corresponding to the database type. type, int fieldSize, int fieldSubSize) PUBLIC: Add the field to the table.
public void	addField(String fieldName, String is the name of the nested type. typeName) PUBLIC: Add the field to the type to a nested type.
public void	addField(FieldDefinition field) PUBLIC: Add the field to the table.
public void	addFieldOnDatabase(final AbstractSession session, FieldDefinition field) INTERNAL: Execute the SQL alter table to add the field to the table.
public void	addForeignKeyConstraint(String name, String sourceField, String targetField, String targetTable) PUBLIC: Add a foreign key constraint to the table.
public void	addForeignKeyConstraint(ForeignKeyConstraint foreignKey) PUBLIC: Add a foreign key constraint to the table.
public void	addIdentityField(String fieldName, Class<?> is the Java class type corresponding to the database type. type) PUBLIC: Add the field to the table, default sizes are used.
public void	addIdentityField(String fieldName, Class<?> is the Java class type corresponding to the database type. type, int fieldSize) PUBLIC: Add the field to the table, default sizes are used.
public void	addIndex(IndexDefinition index) PUBLIC: Add an index to the table.
public void	addPrimaryKeyField(String fieldName, Class<?> is the Java class type corresponding to the database type. type) PUBLIC: Add the field to the table, default sizes are used.
public void	addPrimaryKeyField(String fieldName, Class<?> is the Java class type corresponding to the database type. type, int fieldSize) PUBLIC: Add the field to the table, default sizes are used.
public void	addUniqueKeyConstraint(String name, String sourceField) PUBLIC: Add a unique key constraint to the table.
public void	addUniqueKeyConstraint(String name, String[] sourceFields) PUBLIC: Add a unique key constraint to the table.
public void	addUniqueKeyConstraint(UniqueKeyConstraint uniqueKey) PUBLIC: Add a unique key constraint to the table.
public Writer	buildAddFieldWriter(AbstractSession session, FieldDefinition field, Writer writer) INTERNAL: Return the alter table statement to add a field to the table.
public Writer	buildConstraintCreationWriter(AbstractSession session, ForeignKeyConstraint foreignKey, Writer writer) INTERNAL: Return the alter table statement to add the constraints.
public Writer	buildConstraintDeletionWriter(AbstractSession session, ForeignKeyConstraint foreignKey, Writer writer) INTERNAL: Return the alter table statement to drop the constraints.
public Writer	buildCreationWriter(AbstractSession session, Writer writer) Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildCreationWriter. INTERNAL: Return the create table statement.
protected Writer	buildDatabaseSchemaCreationWriter(AbstractSession session, Writer writer, Set<String> createdDatabaseSchemas) INTERNAL: Build the create schema DDL.
protected Writer	buildDatabaseSchemaDeletionWriter(AbstractSession session, Writer writer) INTERNAL: Build the drop schema DDL.
public Writer	buildDeletionWriter(AbstractSession session, Writer writer) Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildDeletionWriter. INTERNAL: Return the drop table statement.
protected void	buildFieldTypes(AbstractSession session) INTERNAL: Build the foreign key constraints.
protected ForeignKeyConstraint	buildForeignKeyConstraint(FieldDefinition field, DatabasePlatform platform) Build a foreign key constraint using FieldDefinition.getForeignKeyFieldName().
protected ForeignKeyConstraint	buildForeignKeyConstraint(List<String> fkFieldNames, List<String> pkFieldNames, TableDefinition targetTable, DatabasePlatform platform) Build a foreign key constraint.
protected String	buildForeignKeyConstraintName(String tableName, String fieldName, int maximumNameLength, DatabasePlatform platform) Return foreign key constraint name built from the table and field name with the specified maximum length.
public IndexDefinition	buildIndex(AbstractSession session, String key, List<String> columnNames, boolean isUniqueSetOnField) INTERNAL: Return the index creation statement.
public Writer	buildIndexDeletionWriter(AbstractSession session, String key, Writer writer, boolean isUniqueSetOnField) INTERNAL: Return the index drop statement.
protected String	buildIndexName(String tableName, String key, String indexPrefix, int maximumNameLength, DatabasePlatform platform) Return key constraint name built from the table and key name with the specified maximum length and index prefix.
public Writer	buildUniqueConstraintCreationWriter(AbstractSession session, UniqueKeyConstraint uniqueKey, Writer writer) INTERNAL: Return the alter table statement to add the constraints.
public Writer	buildUniqueConstraintDeletionWriter(AbstractSession session, UniqueKeyConstraint uniqueKey, Writer writer) INTERNAL: Return the alter table statement to drop the constraints.
protected UniqueKeyConstraint	buildUniqueKeyConstraint(String name, List<String> fieldNames, int serialNumber, DatabasePlatform platform)
protected String	buildUniqueKeyConstraintName(String tableName, int serialNumber, int maximumNameLength) Return unique key constraint name built from the table name and sequence number with the specified maximum length.
public Writer	buildVPDCreationFunctionWriter(AbstractSession session, Writer writer) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildVPDCreationFunctionWriter. INTERNAL:
public Writer	buildVPDCreationPolicyWriter(AbstractSession session, Writer writer) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildVPDCreationPolicyWriter. INTERNAL:
public Writer	buildVPDDeletionWriter(AbstractSession session, Writer writer) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildVPDDeletionWriter. INTERNAL:
public Object	clone() Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.clone. PUBLIC: Performs a deep copy of this table definition.
public void	createConstraints(AbstractSession session, Writer schemaWriter) INTERNAL: Execute the SQL alter table constraint creation string.
public void	createConstraintsOnDatabase(AbstractSession session) INTERNAL: Execute the SQL alter table constraint creation string.
public void	createDatabaseSchema(AbstractSession session, Writer writer, Set<String> createdDatabaseSchemas) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.createDatabaseSchema. INTERNAL: Execute the DDL to create the database schema for this object.
public void	createDatabaseSchemaOnDatabase(AbstractSession session, Set<String> createdDatabaseSchemas) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.createDatabaseSchemaOnDatabase. INTERNAL: Execute the DDL to create the database schema for this object.
pack-priv void	createForeignConstraints(final AbstractSession session, final Writer schemaWriter)
pack-priv void	createForeignConstraintsOnDatabase(final AbstractSession session)
public void	createIndexes(AbstractSession session, Writer writer) INTERNAL: Write the SQL create index string to create index if passed a writer, else delegate to a method that executes the string on the database.
pack-priv void	createUniqueConstraints(final AbstractSession session, final Writer schemaWriter)
pack-priv void	createUniqueConstraintsOnDatabase(final AbstractSession session)
public String	deletionStringFor(DatabaseAccessor accessor) INTERNAL: Return the delete SQL string.
public void	dropConstraints(AbstractSession session, Writer schemaWriter) INTERNAL: Execute the SQL alter table constraint creation string.
public void	dropConstraintsOnDatabase(AbstractSession session) INTERNAL: Execute the SQL alter table constraint creation string.
public void	dropDatabaseSchema(AbstractSession session, Writer writer) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.dropDatabaseSchema. INTERNAL: Execute the DDL to drop the database schema for this object.
public void	dropDatabaseSchemaOnDatabase(AbstractSession session) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.dropDatabaseSchemaOnDatabase. INTERNAL: Execute the DDL to drop the database schema for this object.
private void	dropForeignConstraintsOnDatabase(final AbstractSession session)
public void	dropIndexes(AbstractSession session, Writer writer) INTERNAL: Write the SQL drop index string to drop indexes if passed a writer, else delegate to a method that executes the string on the database.
private void	dropUniqueConstraintsOnDatabase(final AbstractSession session)
public String	getCreationPrefix() INTERNAL: Return the beginning of the sql create statement - the part before the name.
public String	getCreationSuffix() INTERNAL: Return the end of the sql create statement - the part after the field list.
public String	getDatabaseSchema() Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.getDatabaseSchema. PUBLIC: Return the schema associated with this table.
public FieldDefinition	getField(String fieldName) PUBLIC: Return the field the corresponds to the name.
public List<FieldDefinition>	getFields() PUBLIC:
public Map<String, ForeignKeyConstraint>	getForeignKeyMap() INTERNAL:
public Collection<ForeignKeyConstraint>	getForeignKeys() PUBLIC: Returns the ForeignKeyConstraint list.
public List<IndexDefinition>	getIndexes() PUBLIC:
public List<String>	getPrimaryKeyFieldNames() PUBLIC:
public DatabaseTable	getTable()
public List<UniqueKeyConstraint>	getUniqueKeys() PUBLIC:
public void	postCreateObject(AbstractSession session, Writer createSchemaWriter, boolean createSQLFiles) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.postCreateObject. Execute any statements required after the creation of the object
public void	preDropObject(AbstractSession session, Writer dropSchemaWriter, boolean createSQLFiles) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.preDropObject. Execute any statements required before the deletion of the object
public void	setCreateSQLFiles(boolean genFlag) PUBLIC:
public void	setCreateVPDCalls(boolean createVPDCalls, String tenantFieldName) PUBLIC:
public void	setCreationPrefix(String creationPrefix) INTERNAL: Set the beginning of the sql create statement - the part before the name.
public void	setCreationSuffix(String creationSuffix) INTERNAL: Set the end of the sql create statement - the part after the field list.
public void	setFields(List<FieldDefinition> fields) PUBLIC:
public void	setForeignKeyMap(Map<String, ForeignKeyConstraint> foreignKeyMap) INTERNAL:
public void	setForeignKeys(List<ForeignKeyConstraint> foreignKeys) PUBLIC: Set the ForeignKeyConstraint list.
public void	setIndexes(List<IndexDefinition> indexes) PUBLIC:
public void	setTable(DatabaseTable table)
public void	setUniqueKeys(List<UniqueKeyConstraint> uniqueKeys) PUBLIC:
public void	setUserDefinedForeignKeyConstraints(Map<String, ForeignKeyConstraint> foreignKeyConstraints) PUBLIC: Set the foreign key constraints for this table.
public boolean	shouldCreateDatabaseSchema(Set<String> createdDatabaseSchemas) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.shouldCreateDatabaseSchema. If this table has a schema (and catalog specified) make sure it is created.
public boolean	shouldCreateVPDCalls(AbstractSession session) Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.shouldCreateVPDCalls. INTERNAL: Subclasses who care should override this method.
public void	writeLineSeperator(AbstractSession session, Writer writer)

Inherited from org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition:: createObject createOnDatabase dropFromDatabase dropObject getFieldTypeDefinition getFieldTypeDefinition getFullName getName getQualifier hasDatabaseSchema setName setQualifier toString

public Class TableDefinition

Field Summary

Constructor Summary

Method Summary