org.eclipse.jpt.db
Interface Table

All Superinterfaces:
java.lang.Comparable<Table>

public interface Table
extends java.lang.Comparable<Table>

Database table Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves. This interface is not intended to be implemented by clients.


Method Summary
 Column columnNamed(java.lang.String name)
          Return the column in the table with the specified name, respecting the database's case-sensitivity.
 java.util.Iterator<java.lang.String> columnNames()
          Return the names of the table's columns.
 java.util.Iterator<Column> columns()
          Return the table's columns.
 int columnsSize()
          Return the number of columns the table contains.
 boolean containsColumnNamed(java.lang.String name)
          Return whether the table contains a column with the specified name, respecting the database's case-sensitivity.
 boolean foreignKeyBaseColumnsContains(Column column)
          Return whether the specified column is a "base" column for any of the table's foreign keys.
 java.util.Iterator<ForeignKey> foreignKeys()
          Return the table's foreign keys.
 int foreignKeysSize()
          Return the number of foreign keys the table contains.
 java.lang.String getJavaFieldName()
          Return the table's name, converted to a Java-appropriate field identifier, respecting the database's case-sensitivity.
 java.lang.String getName()
          Return the table's name.
 java.lang.String getShortJavaClassName()
          Return the table's name, converted to a Java-appropriate class identifier, respecting the database's case-sensitivity.
 boolean matchesShortJavaClassName(java.lang.String shortJavaClassName)
          Return whether the table's name matches the specified Java-appropriate identifier, respecting the database's case-sensitivity.
 Column primaryKeyColumn()
          Return the table's single primary key column.
 java.util.Iterator<Column> primaryKeyColumns()
          Return the table's primary key columns.
 boolean primaryKeyColumnsContains(Column column)
          Return whether the specified column is one of the table's primary key columns.
 int primaryKeyColumnsSize()
          Return the number of primary key columns the table contains.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getName

java.lang.String getName()
Return the table's name.


columns

java.util.Iterator<Column> columns()
Return the table's columns.


columnsSize

int columnsSize()
Return the number of columns the table contains.


columnNames

java.util.Iterator<java.lang.String> columnNames()
Return the names of the table's columns.


containsColumnNamed

boolean containsColumnNamed(java.lang.String name)
Return whether the table contains a column with the specified name, respecting the database's case-sensitivity.


columnNamed

Column columnNamed(java.lang.String name)
Return the column in the table with the specified name, respecting the database's case-sensitivity.


primaryKeyColumns

java.util.Iterator<Column> primaryKeyColumns()
Return the table's primary key columns.


primaryKeyColumn

Column primaryKeyColumn()
Return the table's single primary key column. Throw an IllegalStateException if the table has more than one primary key column.


primaryKeyColumnsSize

int primaryKeyColumnsSize()
Return the number of primary key columns the table contains.


primaryKeyColumnsContains

boolean primaryKeyColumnsContains(Column column)
Return whether the specified column is one of the table's primary key columns.


foreignKeys

java.util.Iterator<ForeignKey> foreignKeys()
Return the table's foreign keys.


foreignKeysSize

int foreignKeysSize()
Return the number of foreign keys the table contains.


foreignKeyBaseColumnsContains

boolean foreignKeyBaseColumnsContains(Column column)
Return whether the specified column is a "base" column for any of the table's foreign keys.


getShortJavaClassName

java.lang.String getShortJavaClassName()
Return the table's name, converted to a Java-appropriate class identifier, respecting the database's case-sensitivity.


matchesShortJavaClassName

boolean matchesShortJavaClassName(java.lang.String shortJavaClassName)
Return whether the table's name matches the specified Java-appropriate identifier, respecting the database's case-sensitivity.


getJavaFieldName

java.lang.String getJavaFieldName()
Return the table's name, converted to a Java-appropriate field identifier, respecting the database's case-sensitivity.