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

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model, ReadOnlyTable

All Known Subinterfaces:

JavaSecondaryTable, OrmSecondaryTable, OrmVirtualSecondaryTable, SecondaryTable, VirtualSecondaryTable

public interface ReadOnlySecondaryTable
extends ReadOnlyTable

Read-only 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.

Field Summary

static java.lang.String	DEFAULT_PRIMARY_KEY_JOIN_COLUMN
static java.lang.String	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

ReadOnlyPrimaryKeyJoinColumn	getDefaultPrimaryKeyJoinColumn() Return the default primary key join column or null.
Entity	getParent() Return the JPA node's parent.
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).
java.util.ListIterator<? extends ReadOnlyPrimaryKeyJoinColumn>	primaryKeyJoinColumns() Return the secondary table's primary key join columns, whether specified or default.
int	primaryKeyJoinColumnsSize() Return the number of primary key join columns, whether specified or default.
java.util.ListIterator<? extends ReadOnlyPrimaryKeyJoinColumn>	specifiedPrimaryKeyJoinColumns() Return the specified primary key join columns.
int	specifiedPrimaryKeyJoinColumnsSize() Return the number of specified primary key join columns.

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

getCatalog, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getSchema, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, getUniqueConstraint, uniqueConstraints, 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

Field Detail

SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST

static final java.lang.String SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST

See Also:

Constant Field Values

DEFAULT_PRIMARY_KEY_JOIN_COLUMN

static final java.lang.String DEFAULT_PRIMARY_KEY_JOIN_COLUMN

See Also:

Constant Field Values

Method Detail

getParent

Entity 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

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).

primaryKeyJoinColumns

java.util.ListIterator<? extends ReadOnlyPrimaryKeyJoinColumn> primaryKeyJoinColumns()

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

primaryKeyJoinColumnsSize

int primaryKeyJoinColumnsSize()

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

specifiedPrimaryKeyJoinColumns

java.util.ListIterator<? extends ReadOnlyPrimaryKeyJoinColumn> specifiedPrimaryKeyJoinColumns()

Return the specified primary key join columns.

specifiedPrimaryKeyJoinColumnsSize

int specifiedPrimaryKeyJoinColumnsSize()

Return the number of specified primary key join columns.

getDefaultPrimaryKeyJoinColumn

ReadOnlyPrimaryKeyJoinColumn 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.