org.eclipse.jpt.core.context
Interface Table

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, Model
All Known Subinterfaces:
JavaJoinTable, JavaSecondaryTable, JavaTable, JoinTable, OrmJoinTable, OrmSecondaryTable, OrmTable, SecondaryTable

public interface Table
extends JpaContextNode

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.


Field Summary
static java.lang.String DEFAULT_CATALOG_PROPERTY
           
static java.lang.String DEFAULT_NAME_PROPERTY
           
static java.lang.String DEFAULT_SCHEMA_PROPERTY
           
static java.lang.String SPECIFIED_CATALOG_PROPERTY
           
static java.lang.String SPECIFIED_NAME_PROPERTY
           
static java.lang.String SPECIFIED_SCHEMA_PROPERTY
           
static java.lang.String UNIQUE_CONSTRAINTS_LIST
           
 
Method Summary
 UniqueConstraint addUniqueConstraint(int index)
          Add a unique constraint to the table and return the object representing it.
 boolean connectionProfileIsActive()
          Return true if this table is connected to a datasource
 java.lang.String getCatalog()
           
 Schema getDbSchema()
           
 Table getDbTable()
           
 java.lang.String getDefaultCatalog()
           
 java.lang.String getDefaultName()
           
 java.lang.String getDefaultSchema()
           
 java.lang.String getName()
           
 java.lang.String getSchema()
           
 java.lang.String getSpecifiedCatalog()
           
 java.lang.String getSpecifiedName()
           
 java.lang.String getSpecifiedSchema()
           
 boolean hasResolvedSchema()
          Return true if this table's schema can be resolved to a schema on the active connection
 boolean isResolved()
          Return true if this can be resolved to a table on the active connection
 void moveUniqueConstraint(int targetIndex, int sourceIndex)
          Move the unique constraint from the source index to the target index.
 void removeUniqueConstraint(int index)
          Remove unique constraint at the given index from the Table
 void removeUniqueConstraint(UniqueConstraint uniqueConstraint)
          Remove the unique constraint from the Table
 void setSpecifiedCatalog(java.lang.String value)
           
 void setSpecifiedName(java.lang.String value)
           
 void setSpecifiedSchema(java.lang.String value)
           
<T extends UniqueConstraint>
java.util.ListIterator<T>
uniqueConstraints()
          Return a list iterator of the unique constraints.
 int uniqueConstraintsSize()
          Return the number of unique constraints.
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getEntityMappings, getOrmPersistentType, getPersistenceUnit
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent, getResource
 
Methods inherited from interface org.eclipse.jpt.utility.model.Model
addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, removeTreeChangeListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Field Detail

DEFAULT_NAME_PROPERTY

static final java.lang.String DEFAULT_NAME_PROPERTY
See Also:
Constant Field Values

SPECIFIED_NAME_PROPERTY

static final java.lang.String SPECIFIED_NAME_PROPERTY
See Also:
Constant Field Values

DEFAULT_CATALOG_PROPERTY

static final java.lang.String DEFAULT_CATALOG_PROPERTY
See Also:
Constant Field Values

SPECIFIED_CATALOG_PROPERTY

static final java.lang.String SPECIFIED_CATALOG_PROPERTY
See Also:
Constant Field Values

DEFAULT_SCHEMA_PROPERTY

static final java.lang.String DEFAULT_SCHEMA_PROPERTY
See Also:
Constant Field Values

SPECIFIED_SCHEMA_PROPERTY

static final java.lang.String SPECIFIED_SCHEMA_PROPERTY
See Also:
Constant Field Values

UNIQUE_CONSTRAINTS_LIST

static final java.lang.String UNIQUE_CONSTRAINTS_LIST
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()

getDefaultName

java.lang.String getDefaultName()

getSpecifiedName

java.lang.String getSpecifiedName()

setSpecifiedName

void setSpecifiedName(java.lang.String value)

getCatalog

java.lang.String getCatalog()

getDefaultCatalog

java.lang.String getDefaultCatalog()

getSpecifiedCatalog

java.lang.String getSpecifiedCatalog()

setSpecifiedCatalog

void setSpecifiedCatalog(java.lang.String value)

getSchema

java.lang.String getSchema()

getDefaultSchema

java.lang.String getDefaultSchema()

getSpecifiedSchema

java.lang.String getSpecifiedSchema()

setSpecifiedSchema

void setSpecifiedSchema(java.lang.String value)

uniqueConstraints

<T extends UniqueConstraint> java.util.ListIterator<T> uniqueConstraints()
Return a list iterator of the unique constraints. This will not be null.


uniqueConstraintsSize

int uniqueConstraintsSize()
Return the number of unique constraints.


addUniqueConstraint

UniqueConstraint addUniqueConstraint(int index)
Add a unique constraint to the table and return the object representing it.


removeUniqueConstraint

void removeUniqueConstraint(int index)
Remove unique constraint at the given index from the Table


removeUniqueConstraint

void removeUniqueConstraint(UniqueConstraint uniqueConstraint)
Remove the unique constraint from the Table


moveUniqueConstraint

void moveUniqueConstraint(int targetIndex,
                          int sourceIndex)
Move the unique constraint from the source index to the target index.


getDbTable

Table getDbTable()

getDbSchema

Schema getDbSchema()

connectionProfileIsActive

boolean connectionProfileIsActive()
Return true if this table is connected to a datasource


hasResolvedSchema

boolean hasResolvedSchema()
Return true if this table's schema can be resolved to a schema on the active connection


isResolved

boolean isResolved()
Return true if this can be resolved to a table on the active connection