EclipseLink Core 4.0.2 · org.eclipse.persistence.internal.helper.DatabaseTable

Field Summary

Modifier and Type	Field and Description
protected String	creationSuffix
protected Map<String, ForeignKeyConstraint>	foreignKeyConstraints JPA 2.1 Foreign key specification data
protected List<IndexDefinition>	indexes Store the set of indexes defined through meta-data for the table.
protected String	name
protected String	qualifiedName
protected String	tableQualifier
protected Map<String, List<List<String>>>	uniqueConstraints Contains the user specified unique constraints.
protected boolean	useDelimiters

Constructor Summary

Access	Constructor and Description
public	DatabaseTable() Initialize the newly allocated instance of this class.
public	DatabaseTable(String possiblyQualifiedName)
public	DatabaseTable(String possiblyQualifiedName, String startDelimiter, String endDelimiter)
public	DatabaseTable(String tableName, String qualifier)
public	DatabaseTable(String tableName, String qualifier, boolean useDelimiters, String startDelimiter, String endDelimiter)

Method Summary

Modifier and Type	Method and Description
public void	addForeignKeyConstraint(ForeignKeyConstraint foreignKeyConstraint)
public void	addIndex(IndexDefinition index) Add an index definition to this table.
public void	addUniqueConstraints(String name, List<String> columnNames) Add the unique constraint for the columns names.
public DatabaseTable	clone() Overrides java.lang.Object.clone. Return a shallow copy of the receiver.
public boolean	equals(Object the reference object with which to compare. object) Overrides java.lang.Object.equals. Two tables are equal if their names and tables are equal, or their names are equal and one does not have a qualifier assigned.
public boolean	equals(DatabaseTable table) Two tables are equal if their names and tables are equal, or their names are equal and one does not have a qualifier assigned.
public String	getCreationSuffix() returns the suffix applied to the CREATE table statement on this field for DDL generation.
public ForeignKeyConstraint	getForeignKeyConstraint(String name)
public Map<String, ForeignKeyConstraint>	getForeignKeyConstraints()
public List<IndexDefinition>	getIndexes() Return a list of index definitions.
public String	getName() Get method for table name.
public String	getNameDelimited(DatasourcePlatform platform) Get method for table name.
public String	getQualifiedName()
public String	getQualifiedNameDelimited(DatasourcePlatform platform)
public String	getTableQualifier()
public String	getTableQualifierDelimited(DatasourcePlatform platform)
public Map<String, List<List<String>>>	getUniqueConstraints() Return a list of the unique constraints for this table.
public boolean	hasForeignKeyConstraints()
public int	hashCode() Overrides java.lang.Object.hashCode. Return the hashcode of the name, because it is fairly unique.
public boolean	hasIndexes()
public boolean	hasName() Determine whether the receiver has any identification information.
public boolean	hasUniqueConstraints()
public boolean	isDecorated() INTERNAL: Is this decorated / has an AS OF (some past time) clause.
public void	printSQL(ExpressionSQLPrinter printer) Print the table's SQL from clause.
protected void	resetQualifiedName()
public void	setCreationSuffix(String creationSuffix)
public void	setName(String name) Set the table name.
public void	setName(String name, String startDelimiter, String endDelimiter) Set the table name.
public void	setPossiblyQualifiedName(String possiblyQualifiedName) Used to map the project xml.
public void	setPossiblyQualifiedName(String possiblyQualifiedName, String startDelimiter, String endDelimiter)
public void	setTableQualifier(String qualifier)
public void	setTableQualifier(String qualifier, String startDelimiter, String endDelimiter)
public void	setUseDelimiters(boolean useDelimiters)
public boolean	shouldUseDelimiters()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

Field Detail

creationSuffix	back to summary
protected String creationSuffix

foreignKeyConstraints	back to summary
protected Map<String, ForeignKeyConstraint> foreignKeyConstraints JPA 2.1 Foreign key specification data

indexes	back to summary
protected List<IndexDefinition> indexes Store the set of indexes defined through meta-data for the table.

name	back to summary
protected String name

qualifiedName	back to summary
protected String qualifiedName

tableQualifier	back to summary
protected String tableQualifier

uniqueConstraints	back to summary
protected Map<String, List<List<String>>> uniqueConstraints Contains the user specified unique constraints. JPA 2.0 introduced the name element, therefore, if specified we will use that name to create the constraint. Constraints with no name will be added to the map under the null key and generated with a default name. Therefore, when a name is given the list size should only ever be 1. We will validate. The null key could have multiples however they will have their names defaulted (as we did before).

uniqueConstraints

back to summary

protected Map<String, List<List<String>>> uniqueConstraints

Contains the user specified unique constraints. JPA 2.0 introduced the name element, therefore, if specified we will use that name to create the constraint. Constraints with no name will be added to the map under the null key and generated with a default name. Therefore, when a name is given the list size should only ever be 1. We will validate. The null key could have multiples however they will have their names defaulted (as we did before).

useDelimiters	back to summary
protected boolean useDelimiters

Constructor Detail

DatabaseTable	back to summary
public DatabaseTable() Initialize the newly allocated instance of this class. By default their is no qualifier.

DatabaseTable	back to summary
public DatabaseTable(String possiblyQualifiedName)

DatabaseTable	back to summary
public DatabaseTable(String possiblyQualifiedName, String startDelimiter, String endDelimiter)

DatabaseTable	back to summary
public DatabaseTable(String tableName, String qualifier)

DatabaseTable	back to summary
public DatabaseTable(String tableName, String qualifier, boolean useDelimiters, String startDelimiter, String endDelimiter)

Method Detail

addForeignKeyConstraint	back to summary
public void addForeignKeyConstraint(ForeignKeyConstraint foreignKeyConstraint)

addIndex	back to summary
public void addIndex(IndexDefinition index) Add an index definition to this table.

addUniqueConstraints	back to summary
public void addUniqueConstraints(String name, List<String> columnNames) Add the unique constraint for the columns names. Used for DDL generation. For now we just add all the unique constraints as we would have before when we didn't have a name.

clone	back to summary
public DatabaseTable clone() Overrides java.lang.Object.clone. Return a shallow copy of the receiver. Returns:DatabaseTable Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public DatabaseTable clone()

Overrides java.lang.Object.clone.

Return a shallow copy of the receiver.

Returns:DatabaseTable

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Two tables are equal if their names and tables are equal, or their names are equal and one does not have a qualifier assigned. This allows an unqualified table to equal the same fully qualified one. Parameters object:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Two tables are equal if their names and tables are equal, or their names are equal and one does not have a qualifier assigned. This allows an unqualified table to equal the same fully qualified one.

Parameters

object:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

equals	back to summary
public boolean equals(DatabaseTable table) Two tables are equal if their names and tables are equal, or their names are equal and one does not have a qualifier assigned. This allows an unqualified table to equal the same fully qualified one.

getCreationSuffix	back to summary
public String getCreationSuffix() returns the suffix applied to the CREATE table statement on this field for DDL generation.

getForeignKeyConstraint	back to summary
public ForeignKeyConstraint getForeignKeyConstraint(String name)

getForeignKeyConstraints	back to summary
public Map<String, ForeignKeyConstraint> getForeignKeyConstraints()

getIndexes	back to summary
public List<IndexDefinition> getIndexes() Return a list of index definitions. Used for DDL generation.

getName	back to summary
public String getName() Get method for table name.

getNameDelimited	back to summary
public String getNameDelimited(DatasourcePlatform platform) Get method for table name.

getQualifiedName	back to summary
public String getQualifiedName()

getQualifiedNameDelimited	back to summary
public String getQualifiedNameDelimited(DatasourcePlatform platform)

getTableQualifier	back to summary
public String getTableQualifier()

getTableQualifierDelimited	back to summary
public String getTableQualifierDelimited(DatasourcePlatform platform)

getUniqueConstraints	back to summary
public Map<String, List<List<String>>> getUniqueConstraints() Return a list of the unique constraints for this table. Used for DDL generation.

hasForeignKeyConstraints	back to summary
public boolean hasForeignKeyConstraints()

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Return the hashcode of the name, because it is fairly unique. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Return the hashcode of the name, because it is fairly unique.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations

@Override

hasIndexes	back to summary
public boolean hasIndexes()

hasName	back to summary
public boolean hasName() Determine whether the receiver has any identification information. Return true if the name or qualifier of the receiver are nonempty.

hasUniqueConstraints	back to summary
public boolean hasUniqueConstraints()

isDecorated	back to summary
public boolean isDecorated() INTERNAL: Is this decorated / has an AS OF (some past time) clause. Example: SELECT ... FROM EMPLOYEE AS OF TIMESTAMP (exp) t0 ...

printSQL	back to summary
public void printSQL(ExpressionSQLPrinter printer) throws IOException Print the table's SQL from clause.

resetQualifiedName	back to summary
protected void resetQualifiedName()

setCreationSuffix	back to summary
public void setCreationSuffix(String creationSuffix)

setName	back to summary
public void setName(String name) Set the table name. Used when aliasing table names.

setName	back to summary
public void setName(String name, String startDelimiter, String endDelimiter) Set the table name. Used when aliasing table names. If the name contains database delimiters, they will be stripped and a flag will be set to have them added when the DatabaseTable is written to SQL

setPossiblyQualifiedName	back to summary
public void setPossiblyQualifiedName(String possiblyQualifiedName) Used to map the project xml. Any time a string name is read from the project xml, we must check if it is fully qualified and split the actual name from the qualifier.

setPossiblyQualifiedName	back to summary
public void setPossiblyQualifiedName(String possiblyQualifiedName, String startDelimiter, String endDelimiter)

setTableQualifier	back to summary
public void setTableQualifier(String qualifier)

setTableQualifier	back to summary
public void setTableQualifier(String qualifier, String startDelimiter, String endDelimiter)

setUseDelimiters	back to summary
public void setUseDelimiters(boolean useDelimiters)

shouldUseDelimiters	back to summary
public boolean shouldUseDelimiters()

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Class DatabaseTable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail