org.eclipse.jpt.jpa.core.context
Interface Table

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

All Known Subinterfaces:

CollectionTable2_0, JavaCollectionTable2_0, JavaSpecifiedJoinTable, JavaSpecifiedReferenceTable, JavaSpecifiedSecondaryTable, JavaSpecifiedTable, JavaTable, JoinTable, OrmCollectionTable2_0, OrmSpecifiedJoinTable, OrmSpecifiedReferenceTable, OrmSpecifiedSecondaryTable, OrmSpecifiedTable, OrmTable, OrmVirtualSecondaryTable, ReferenceTable, SecondaryTable, SpecifiedJoinTable, SpecifiedReferenceTable, SpecifiedSecondaryTable, SpecifiedTable, VirtualJoinTable, VirtualReferenceTable, VirtualSecondaryTable, VirtualTable

public interface Table
extends JpaContextModel

• table
• secondary table
• join table
• collection 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.

Nested Class Summary

static class	Table.DbTableTransformer
static class	Table.NameTransformer
static interface	Table.ParentAdapter<P extends JpaContextModel> interface allowing columns to be used in multiple places (e.g. basic mappings and attribute overrides)

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static org.eclipse.jpt.common.utility.transformer.Transformer<Table,Table>	DB_TABLE_TRANSFORMER
static String	DEFAULT_CATALOG_PROPERTY
static String	DEFAULT_NAME_PROPERTY
static String	DEFAULT_SCHEMA_PROPERTY
static org.eclipse.jpt.common.utility.transformer.Transformer<Table,String>	NAME_TRANSFORMER
static String	SPECIFIED_CATALOG_PROPERTY
static String	SPECIFIED_NAME_PROPERTY
static String	SPECIFIED_SCHEMA_PROPERTY
static String	UNIQUE_CONSTRAINTS_LIST

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

boolean	catalogIsResolved() Return whether the table has a catalog and it can be resolved to a catalog on the database.
String	getCatalog() Return the specified catalog if present, otherwise return the default catalog.
TextRange	getCatalogValidationTextRange()
Catalog	getDbCatalog() Return the corresponding database catalog.
Schema	getDbSchema() Return the corresponding database schema.
SchemaContainer	getDbSchemaContainer() Return the corresponding database schema container (catalog or database).
Table	getDbTable() Return the corresponding database table.
String	getDefaultCatalog()
String	getDefaultName()
String	getDefaultSchema()
String	getName() Return the specified name if present, otherwise return the default name.
TextRange	getNameValidationTextRange()
String	getSchema() Return the specified schema if present, otherwise return the default schema.
TextRange	getSchemaValidationTextRange()
String	getSpecifiedCatalog()
String	getSpecifiedName()
String	getSpecifiedSchema()
UniqueConstraint	getUniqueConstraint(int index)
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends UniqueConstraint>	getUniqueConstraints()
int	getUniqueConstraintsSize()
boolean	isResolved() Return whether the table can be resolved to a table on the database.
boolean	schemaIsResolved() Return whether the table's schema can be resolved to a schema on the database.
boolean	validatesAgainstDatabase() Return whether the table is validated against a live database connection.

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextModel

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaModel

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Field Detail

NAME_TRANSFORMER

static final org.eclipse.jpt.common.utility.transformer.Transformer<Table,String> NAME_TRANSFORMER

SPECIFIED_NAME_PROPERTY

static final String SPECIFIED_NAME_PROPERTY

See Also:

Constant Field Values

DEFAULT_NAME_PROPERTY

static final String DEFAULT_NAME_PROPERTY

See Also:

Constant Field Values

DB_TABLE_TRANSFORMER

static final org.eclipse.jpt.common.utility.transformer.Transformer<Table,Table> DB_TABLE_TRANSFORMER

SPECIFIED_SCHEMA_PROPERTY

static final String SPECIFIED_SCHEMA_PROPERTY

See Also:

Constant Field Values

DEFAULT_SCHEMA_PROPERTY

static final String DEFAULT_SCHEMA_PROPERTY

See Also:

Constant Field Values

SPECIFIED_CATALOG_PROPERTY

static final String SPECIFIED_CATALOG_PROPERTY

See Also:

Constant Field Values

DEFAULT_CATALOG_PROPERTY

static final String DEFAULT_CATALOG_PROPERTY

See Also:

Constant Field Values

UNIQUE_CONSTRAINTS_LIST

static final String UNIQUE_CONSTRAINTS_LIST

See Also:

Constant Field Values

Method Detail

getName

String getName()

Return the specified name if present, otherwise return the default name.

getSpecifiedName

String getSpecifiedName()

getDefaultName

String getDefaultName()

getNameValidationTextRange

TextRange getNameValidationTextRange()

isResolved

boolean isResolved()

Return whether the table can be resolved to a table on the database.

getDbTable

Table getDbTable()

Return the corresponding database table.

getSchema

String getSchema()

Return the specified schema if present, otherwise return the default schema.

getSpecifiedSchema

String getSpecifiedSchema()

getDefaultSchema

String getDefaultSchema()

schemaIsResolved

boolean schemaIsResolved()

Return whether the table's schema can be resolved to a schema on the database.

getDbSchema

Schema getDbSchema()

Return the corresponding database schema.

getSchemaValidationTextRange

TextRange getSchemaValidationTextRange()

getCatalog

String getCatalog()

Return the specified catalog if present, otherwise return the default catalog.

getSpecifiedCatalog

String getSpecifiedCatalog()

getDefaultCatalog

String getDefaultCatalog()

catalogIsResolved

boolean catalogIsResolved()

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

getDbCatalog

Catalog getDbCatalog()

Return the corresponding database catalog.

getCatalogValidationTextRange

TextRange getCatalogValidationTextRange()

getUniqueConstraints

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends UniqueConstraint> getUniqueConstraints()

getUniqueConstraintsSize

int getUniqueConstraintsSize()

getUniqueConstraint

UniqueConstraint getUniqueConstraint(int index)

getDbSchemaContainer

SchemaContainer getDbSchemaContainer()

Return the corresponding database schema container (catalog or database).

validatesAgainstDatabase

boolean validatesAgainstDatabase()

Return whether the table is validated against a live database connection.