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

All Superinterfaces:

IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, Model, ReadOnlySecondaryTable, ReadOnlyTable, Table

All Known Subinterfaces:

JavaSecondaryTable, OrmSecondaryTable

public interface SecondaryTable
extends Table, ReadOnlySecondaryTable

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.

Since:

2.0

Nested Class Summary

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

ReadOnlyTable.DbTableTransformer, ReadOnlyTable.NameTransformer, ReadOnlyTable.Owner

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

JptResourceTypeReference.ResourceTypeTransformer

Field Summary

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

DEFAULT_PRIMARY_KEY_JOIN_COLUMN, SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST

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

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

RESOURCE_TYPE_TRANSFORMER

Method Summary

PrimaryKeyJoinColumn	addSpecifiedPrimaryKeyJoinColumn() Add a specified primary key join column to the secondary table.
PrimaryKeyJoinColumn	addSpecifiedPrimaryKeyJoinColumn(int index) Add a specified primary key join column to the secondary table.
void	clearSpecifiedPrimaryKeyJoinColumns() Remove all the specified primary key join columns.
void	convertDefaultPrimaryKeyJoinColumnsToSpecified() Add specified primary key join column for each default join column with the same name and referenced column name.
PrimaryKeyJoinColumn	getDefaultPrimaryKeyJoinColumn() Return the default primary key join column or null.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends PrimaryKeyJoinColumn>	getPrimaryKeyJoinColumns() Return the secondary table's primary key join columns, whether specified or default.
PrimaryKeyJoinColumn	getSpecifiedPrimaryKeyJoinColumn(int index)
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends PrimaryKeyJoinColumn>	getSpecifiedPrimaryKeyJoinColumns() Return the specified primary key join columns.
void	moveSpecifiedPrimaryKeyJoinColumn(int targetIndex, int sourceIndex) Move the specified primary key join column from the specified source index to the specified target index.
void	removeSpecifiedPrimaryKeyJoinColumn(int index) Remove the specified primary key join column at the specified index from the secondary table.
void	removeSpecifiedPrimaryKeyJoinColumn(PrimaryKeyJoinColumn pkJoinColumn) Remove the specified primary key join column from the secondary table.

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

addUniqueConstraint, addUniqueConstraint, getUniqueConstraint, getUniqueConstraints, isSpecifiedInResource, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema

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

getParent, getPrimaryKeyJoinColumnsSize, getSpecifiedPrimaryKeyJoinColumnsSize, isVirtual

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

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

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

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

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

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

Method Detail

getPrimaryKeyJoinColumns

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

Description copied from interface: ReadOnlySecondaryTable

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

Specified by:

getPrimaryKeyJoinColumns in interface ReadOnlySecondaryTable

getSpecifiedPrimaryKeyJoinColumns

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

Description copied from interface: ReadOnlySecondaryTable

Return the specified primary key join columns.

Specified by:

getSpecifiedPrimaryKeyJoinColumns in interface ReadOnlySecondaryTable

getDefaultPrimaryKeyJoinColumn

PrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()

Description copied from interface: ReadOnlySecondaryTable

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.

Specified by:

getDefaultPrimaryKeyJoinColumn in interface ReadOnlySecondaryTable

getSpecifiedPrimaryKeyJoinColumn

PrimaryKeyJoinColumn getSpecifiedPrimaryKeyJoinColumn(int index)

addSpecifiedPrimaryKeyJoinColumn

PrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn()

Add a specified primary key join column to the secondary table. Return the newly-created primary key join column.

addSpecifiedPrimaryKeyJoinColumn

PrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)

Add a specified primary key join column to the secondary table. Return the newly-created primary key join column.

removeSpecifiedPrimaryKeyJoinColumn

void removeSpecifiedPrimaryKeyJoinColumn(int index)

Remove the specified primary key join column at the specified index from the secondary table.

removeSpecifiedPrimaryKeyJoinColumn

void removeSpecifiedPrimaryKeyJoinColumn(PrimaryKeyJoinColumn pkJoinColumn)

Remove the specified primary key join column from the secondary table.

moveSpecifiedPrimaryKeyJoinColumn

void moveSpecifiedPrimaryKeyJoinColumn(int targetIndex,
                                       int sourceIndex)

Move the specified primary key join column from the specified source index to the specified target index.

convertDefaultPrimaryKeyJoinColumnsToSpecified

void convertDefaultPrimaryKeyJoinColumnsToSpecified()

Add specified primary key join column for each default join column with the same name and referenced column name. As a side-effect in the update, the default primary key join columns will be recalculated.

clearSpecifiedPrimaryKeyJoinColumns

void clearSpecifiedPrimaryKeyJoinColumns()

Remove all the specified primary key join columns. As a side-effect in the update, the default primary key join columns will be recalculated.