org.eclipse.jpt.jpa.core.context.orm
Interface OrmSecondaryTable

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model, OrmTable, ReadOnlySecondaryTable, ReadOnlyTable, SecondaryTable, Table, XmlContextNode

public interface OrmSecondaryTable
extends SecondaryTable, OrmTable

orm.xml 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

Version:

2.1

Nested Class Summary

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

Table.Owner

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

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

Method Summary

OrmPrimaryKeyJoinColumn	addSpecifiedPrimaryKeyJoinColumn() Add a specified primary key join column to the secondary table.
OrmPrimaryKeyJoinColumn	addSpecifiedPrimaryKeyJoinColumn(int index) Add a specified primary key join column to the secondary table.
OrmPrimaryKeyJoinColumn	getDefaultPrimaryKeyJoinColumn() Return the default primary key join column or null.
OrmEntity	getParent() Return the JPA node's parent.
XmlSecondaryTable	getXmlTable()
void	initializeFrom(ReadOnlySecondaryTable oldSecondaryTable)
java.util.ListIterator<OrmPrimaryKeyJoinColumn>	primaryKeyJoinColumns() Return the secondary table's primary key join columns, whether specified or default.
java.util.ListIterator<OrmPrimaryKeyJoinColumn>	specifiedPrimaryKeyJoinColumns() Return the specified primary key join columns.

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

moveSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn

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

isVirtual, primaryKeyJoinColumnsSize, specifiedPrimaryKeyJoinColumnsSize

Methods inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmTable

addUniqueConstraint, addUniqueConstraint, getCatalogTextRange, getNameTextRange, getSchemaTextRange, getUniqueConstraint, uniqueConstraints

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

catalogIsResolved, isResolved, isSpecifiedInResource, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, schemaIsResolved, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema, validatesAgainstDatabase

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

getCatalog, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getSchema, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, uniqueConstraintsSize

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

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

getJpaProject, stateChanged

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

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

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

getAdapter

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

getResource

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

getValidationTextRange, validate

Method Detail

getParent

OrmEntity getParent()

Description copied from interface: JpaNode

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

Specified by:

getParent in interface JpaNode

Specified by:

getParent in interface ReadOnlySecondaryTable

initializeFrom

void initializeFrom(ReadOnlySecondaryTable oldSecondaryTable)

getXmlTable

XmlSecondaryTable getXmlTable()

primaryKeyJoinColumns

java.util.ListIterator<OrmPrimaryKeyJoinColumn> primaryKeyJoinColumns()

Description copied from interface: ReadOnlySecondaryTable

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

Specified by:

primaryKeyJoinColumns in interface ReadOnlySecondaryTable

Specified by:

primaryKeyJoinColumns in interface SecondaryTable

specifiedPrimaryKeyJoinColumns

java.util.ListIterator<OrmPrimaryKeyJoinColumn> specifiedPrimaryKeyJoinColumns()

Description copied from interface: ReadOnlySecondaryTable

Return the specified primary key join columns.

Specified by:

specifiedPrimaryKeyJoinColumns in interface ReadOnlySecondaryTable

Specified by:

specifiedPrimaryKeyJoinColumns in interface SecondaryTable

addSpecifiedPrimaryKeyJoinColumn

OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn()

Description copied from interface: SecondaryTable

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

Specified by:

addSpecifiedPrimaryKeyJoinColumn in interface SecondaryTable

addSpecifiedPrimaryKeyJoinColumn

OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)

Description copied from interface: SecondaryTable

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

Specified by:

addSpecifiedPrimaryKeyJoinColumn in interface SecondaryTable

getDefaultPrimaryKeyJoinColumn

OrmPrimaryKeyJoinColumn 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

Specified by:

getDefaultPrimaryKeyJoinColumn in interface SecondaryTable