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

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model, ReadOnlyReferenceTable, ReadOnlyTable
All Known Subinterfaces:
JavaJoinTable, JavaVirtualJoinTable, JoinTable, OrmJoinTable, OrmVirtualJoinTable, VirtualJoinTable

public interface ReadOnlyJoinTable
extends ReadOnlyReferenceTable

Used by association overrides.

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_INVERSE_JOIN_COLUMN
           
static java.lang.String SPECIFIED_INVERSE_JOIN_COLUMNS_LIST
           
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.ReadOnlyReferenceTable
DEFAULT_JOIN_COLUMN_PROPERTY, SPECIFIED_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
 ReadOnlyJoinColumn getDefaultInverseJoinColumn()
          Return the default inverse join column or null.
 ReadOnlyJoinTableRelationshipStrategy getParent()
          Return the JPA node's parent.
 RelationshipMapping getRelationshipMapping()
           
 ReadOnlyJoinColumn getSpecifiedInverseJoinColumn(int index)
          Return the specified inverse join column at the specified index.
 boolean hasSpecifiedInverseJoinColumns()
          Return whether the join table has specified inverse join columns.
 java.util.ListIterator<? extends ReadOnlyJoinColumn> inverseJoinColumns()
          Return the join table's inverse join columns, whether specified or default.
 int inverseJoinColumnsSize()
          Return the number of inverse join columns, whether specified or default.
 java.util.ListIterator<? extends ReadOnlyJoinColumn> specifiedInverseJoinColumns()
          Return the specified inverse join columns.
 int specifiedInverseJoinColumnsSize()
          Return the number of specified inverse join columns.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.ReadOnlyReferenceTable
getDefaultJoinColumn, getPersistentAttribute, getSpecifiedJoinColumn, hasSpecifiedJoinColumns, joinColumns, joinColumnsSize, specifiedJoinColumns, specifiedJoinColumnsSize
 
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_INVERSE_JOIN_COLUMNS_LIST

static final java.lang.String SPECIFIED_INVERSE_JOIN_COLUMNS_LIST
See Also:
Constant Field Values

DEFAULT_INVERSE_JOIN_COLUMN

static final java.lang.String DEFAULT_INVERSE_JOIN_COLUMN
See Also:
Constant Field Values
Method Detail

getParent

ReadOnlyJoinTableRelationshipStrategy 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

getRelationshipMapping

RelationshipMapping getRelationshipMapping()

inverseJoinColumns

java.util.ListIterator<? extends ReadOnlyJoinColumn> inverseJoinColumns()
Return the join table's inverse join columns, whether specified or default.


inverseJoinColumnsSize

int inverseJoinColumnsSize()
Return the number of inverse join columns, whether specified or default.


specifiedInverseJoinColumns

java.util.ListIterator<? extends ReadOnlyJoinColumn> specifiedInverseJoinColumns()
Return the specified inverse join columns.


specifiedInverseJoinColumnsSize

int specifiedInverseJoinColumnsSize()
Return the number of specified inverse join columns.


hasSpecifiedInverseJoinColumns

boolean hasSpecifiedInverseJoinColumns()
Return whether the join table has specified inverse join columns.


getSpecifiedInverseJoinColumn

ReadOnlyJoinColumn getSpecifiedInverseJoinColumn(int index)
Return the specified inverse join column at the specified index.


getDefaultInverseJoinColumn

ReadOnlyJoinColumn getDefaultInverseJoinColumn()
Return the default inverse join column or null. A default inverse join column only exists if there are no specified inverse join columns.