org.eclipse.jpt.core.context
Interface Table

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, 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)
           
 java.lang.String getCatalog()
          Return the specified catalog if present, otherwise return the default catalog.
 Catalog getDbCatalog()
           
 Schema getDbSchema()
           
 SchemaContainer getDbSchemaContainer()
           
 Table getDbTable()
           
 java.lang.String getDefaultCatalog()
           
 java.lang.String getDefaultName()
           
 java.lang.String getDefaultSchema()
           
 java.lang.String getName()
          Return the specified name if present, otherwise return the default name.
 java.lang.String getSchema()
          Return the specified schema if present, otherwise return the default schema.
 java.lang.String getSpecifiedCatalog()
           
 java.lang.String getSpecifiedName()
           
 java.lang.String getSpecifiedSchema()
           
 boolean hasResolvedCatalog()
          Return whether the table has a catalog and it can be resolved to a catalog on the database.
 boolean hasResolvedSchema()
          Return whether the table's schema can be resolved to a schema on the database.
 boolean isResolved()
          Return whether the table can be resolved to a table on the database.
 void moveUniqueConstraint(int targetIndex, int sourceIndex)
           
 void removeUniqueConstraint(int index)
           
 void removeUniqueConstraint(UniqueConstraint uniqueConstraint)
           
 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()
           
 int uniqueConstraintsSize()
           
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent
 
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
 
Methods inherited from interface org.eclipse.jpt.core.IResourcePart
getResource
 

Field Detail

SPECIFIED_NAME_PROPERTY

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

DEFAULT_NAME_PROPERTY

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

SPECIFIED_SCHEMA_PROPERTY

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

DEFAULT_SCHEMA_PROPERTY

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

SPECIFIED_CATALOG_PROPERTY

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

DEFAULT_CATALOG_PROPERTY

static final java.lang.String DEFAULT_CATALOG_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()
Return the specified name if present, otherwise return the default name.


getSpecifiedName

java.lang.String getSpecifiedName()

setSpecifiedName

void setSpecifiedName(java.lang.String value)

getDefaultName

java.lang.String getDefaultName()

getSchema

java.lang.String getSchema()
Return the specified schema if present, otherwise return the default schema.


getSpecifiedSchema

java.lang.String getSpecifiedSchema()

setSpecifiedSchema

void setSpecifiedSchema(java.lang.String value)

getDefaultSchema

java.lang.String getDefaultSchema()

getCatalog

java.lang.String getCatalog()
Return the specified catalog if present, otherwise return the default catalog.


getSpecifiedCatalog

java.lang.String getSpecifiedCatalog()

setSpecifiedCatalog

void setSpecifiedCatalog(java.lang.String value)

getDefaultCatalog

java.lang.String getDefaultCatalog()

uniqueConstraints

<T extends UniqueConstraint> java.util.ListIterator<T> uniqueConstraints()

uniqueConstraintsSize

int uniqueConstraintsSize()

addUniqueConstraint

UniqueConstraint addUniqueConstraint(int index)

removeUniqueConstraint

void removeUniqueConstraint(int index)

removeUniqueConstraint

void removeUniqueConstraint(UniqueConstraint uniqueConstraint)

moveUniqueConstraint

void moveUniqueConstraint(int targetIndex,
                          int sourceIndex)

getDbTable

Table getDbTable()

getDbSchema

Schema getDbSchema()

getDbCatalog

Catalog getDbCatalog()

getDbSchemaContainer

SchemaContainer getDbSchemaContainer()

isResolved

boolean isResolved()
Return whether the table can be resolved to a table on the database.


hasResolvedSchema

boolean hasResolvedSchema()
Return whether the table's schema can be resolved to a schema on the database.


hasResolvedCatalog

boolean hasResolvedCatalog()
Return whether the table has a catalog and it can be resolved to a catalog on the database.