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

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, Table

All Known Subinterfaces:

JavaSpecifiedSecondaryTable, OrmSpecifiedSecondaryTable, OrmVirtualSecondaryTable, SpecifiedSecondaryTable, VirtualSecondaryTable

public interface SecondaryTable
extends Table

Entity secondary 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

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

Table.DbTableTransformer, Table.NameTransformer, Table.ParentAdapter<P extends JpaContextModel>

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 String	DEFAULT_PRIMARY_KEY_JOIN_COLUMN
static String	SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST

Fields inherited from interface org.eclipse.jpt.jpa.core.context.Table

DB_TABLE_TRANSFORMER, DEFAULT_CATALOG_PROPERTY, DEFAULT_NAME_PROPERTY, DEFAULT_SCHEMA_PROPERTY, NAME_TRANSFORMER, SPECIFIED_CATALOG_PROPERTY, SPECIFIED_NAME_PROPERTY, SPECIFIED_SCHEMA_PROPERTY, UNIQUE_CONSTRAINTS_LIST

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

TRANSFORMER

Method Summary

PrimaryKeyJoinColumn	getDefaultPrimaryKeyJoinColumn() Return the default primary key join column or null.
Entity	getParent() Return the JPA node's parent.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends PrimaryKeyJoinColumn>	getPrimaryKeyJoinColumns() Return the secondary table's primary key join columns, whether specified or default.
int	getPrimaryKeyJoinColumnsSize() Return the number of primary key join columns, whether specified or default.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends PrimaryKeyJoinColumn>	getSpecifiedPrimaryKeyJoinColumns() Return the specified primary key join columns.
int	getSpecifiedPrimaryKeyJoinColumnsSize() Return the number of specified primary key join columns.
boolean	isVirtual() Return whether the secondary table is part of an orm.xml entity but is specified only in the entity's Java annotations (as opposed to explicitly in the orm.xml).

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

catalogIsResolved, getCatalog, getCatalogValidationTextRange, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getNameValidationTextRange, getSchema, getSchemaValidationTextRange, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, getUniqueConstraint, getUniqueConstraints, getUniqueConstraintsSize, isResolved, schemaIsResolved, validatesAgainstDatabase

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, 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

SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST

static final String SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST

See Also:

Constant Field Values

DEFAULT_PRIMARY_KEY_JOIN_COLUMN

static final String DEFAULT_PRIMARY_KEY_JOIN_COLUMN

See Also:

Constant Field Values

Method Detail

getParent

Entity getParent()

Description copied from interface: JpaModel

Return the JPA node's parent. The JPA project will not have a parent.

Specified by:

getParent in interface JpaContextModel

Specified by:

getParent in interface JpaModel

isVirtual

boolean isVirtual()

Return whether the secondary table is part of an orm.xml entity but is specified only in the entity's Java annotations (as opposed to explicitly in the orm.xml).

getPrimaryKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends PrimaryKeyJoinColumn> getPrimaryKeyJoinColumns()

Return the secondary table's primary key join columns, whether specified or default.

getPrimaryKeyJoinColumnsSize

int getPrimaryKeyJoinColumnsSize()

Return the number of primary key join columns, whether specified or default.

getSpecifiedPrimaryKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends PrimaryKeyJoinColumn> getSpecifiedPrimaryKeyJoinColumns()

Return the specified primary key join columns.

getSpecifiedPrimaryKeyJoinColumnsSize

int getSpecifiedPrimaryKeyJoinColumnsSize()

Return the number of specified primary key join columns.

getDefaultPrimaryKeyJoinColumn

PrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()

Return the default primary key join column or null. A default primary key join column only exists if there are no specified primary key join columns.