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

All Superinterfaces:

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

public interface OrmSecondaryTable
extends SecondaryTable, XmlContextNode

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

Fields inherited from interface org.eclipse.jpt.core.context.SecondaryTable

DEFAULT_PRIMARY_KEY_JOIN_COLUMN, SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST

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

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(int index) Add a specified primary key join column to the secondary table return the object representing it.
OrmUniqueConstraint	addUniqueConstraint(int index)
OrmPrimaryKeyJoinColumn	getDefaultPrimaryKeyJoinColumn() Return the default primary key join column or null.
OrmEntity	getParent() Return the JPA node's parent.
void	initializeFrom(SecondaryTable oldSecondaryTable)
java.util.ListIterator<OrmPrimaryKeyJoinColumn>	primaryKeyJoinColumns() Return a list iterator of the primary key join columns whether specified or default.
java.util.ListIterator<OrmPrimaryKeyJoinColumn>	specifiedPrimaryKeyJoinColumns() Return a list iterator of the specified primary key join columns.
java.util.ListIterator<OrmUniqueConstraint>	uniqueConstraints()
void	update(XmlSecondaryTable secondaryTable) Update the OrmSecondaryTable context model object to match the XmlSecondaryTable resource model object.

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

isVirtual, moveSpecifiedPrimaryKeyJoinColumn, primaryKeyJoinColumnsSize, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn, specifiedPrimaryKeyJoinColumnsSize

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

getCatalog, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getSchema, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, hasResolvedCatalog, hasResolvedSchema, isResolved, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema, 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

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

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

getEResource, getValidationTextRange, validate

Method Detail

update

void update(XmlSecondaryTable secondaryTable)

Update the OrmSecondaryTable context model object to match the XmlSecondaryTable resource model object. see JpaProject.update()

initializeFrom

void initializeFrom(SecondaryTable oldSecondaryTable)

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 SecondaryTable

primaryKeyJoinColumns

java.util.ListIterator<OrmPrimaryKeyJoinColumn> primaryKeyJoinColumns()

Description copied from interface: SecondaryTable

Return a list iterator of the primary key join columns whether specified or default. This will not be null.

Specified by:

primaryKeyJoinColumns in interface SecondaryTable

getDefaultPrimaryKeyJoinColumn

OrmPrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()

Description copied from interface: SecondaryTable

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 SecondaryTable

specifiedPrimaryKeyJoinColumns

java.util.ListIterator<OrmPrimaryKeyJoinColumn> specifiedPrimaryKeyJoinColumns()

Description copied from interface: SecondaryTable

Return a list iterator of the specified primary key join columns. This will not be null.

Specified by:

specifiedPrimaryKeyJoinColumns 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 object representing it.

Specified by:

addSpecifiedPrimaryKeyJoinColumn in interface SecondaryTable

uniqueConstraints

java.util.ListIterator<OrmUniqueConstraint> uniqueConstraints()

Specified by:

uniqueConstraints in interface Table

addUniqueConstraint

OrmUniqueConstraint addUniqueConstraint(int index)

Specified by:

addUniqueConstraint in interface Table