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

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model, ReadOnlyTable
All Known Subinterfaces:
CollectionTable2_0, JavaCollectionTable2_0, JavaJoinTable, JavaReferenceTable, JavaVirtualJoinTable, JoinTable, OrmCollectionTable2_0, OrmJoinTable, OrmReferenceTable, OrmVirtualJoinTable, ReadOnlyJoinTable, ReferenceTable, VirtualJoinTable, VirtualReferenceTable

public interface ReadOnlyReferenceTable
extends ReadOnlyTable

Read-only reference table (i.e. a table that joins with one other table, as opposed to a "join table" that joins with two other tables)

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_JOIN_COLUMN_PROPERTY
           
static java.lang.String 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 getDefaultJoinColumn()
          Return the default join column or null.
 PersistentAttribute getPersistentAttribute()
           
 ReadOnlyJoinColumn getSpecifiedJoinColumn(int index)
          Return the specified join column at the specified index.
 boolean hasSpecifiedJoinColumns()
          Return whether the reference table has specified join columns.
 java.util.ListIterator<? extends ReadOnlyJoinColumn> joinColumns()
          Return the reference table's join columns, whether specified or default.
 int joinColumnsSize()
          Return the number of join columns, whether specified or default.
 java.util.ListIterator<? extends ReadOnlyJoinColumn> specifiedJoinColumns()
          Return the reference table's specified join columns.
 int specifiedJoinColumnsSize()
          Return the number of specified 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, getParent, 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_JOIN_COLUMNS_LIST

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

DEFAULT_JOIN_COLUMN_PROPERTY

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

getPersistentAttribute

PersistentAttribute getPersistentAttribute()

joinColumns

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


joinColumnsSize

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


specifiedJoinColumns

java.util.ListIterator<? extends ReadOnlyJoinColumn> specifiedJoinColumns()
Return the reference table's specified join columns.


specifiedJoinColumnsSize

int specifiedJoinColumnsSize()
Return the number of specified join columns.


hasSpecifiedJoinColumns

boolean hasSpecifiedJoinColumns()
Return whether the reference table has specified join columns.


getSpecifiedJoinColumn

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


getDefaultJoinColumn

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