Dali Provisional API
Release 3.2

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

All Superinterfaces:
IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, Model, ReadOnlyTable
All Known Subinterfaces:
CollectionTable2_0, JavaCollectionTable2_0, JavaJoinTable, JavaReferenceTable, JoinTable, OrmCollectionTable2_0, OrmJoinTable, OrmReferenceTable, 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.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.ReadOnlyTable
ReadOnlyTable.DbTableTransformer, ReadOnlyTable.NameTransformer, ReadOnlyTable.Owner
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
JptResourceTypeReference.ResourceTypeTransformer
 
Field Summary
static String DEFAULT_JOIN_COLUMN_PROPERTY
           
static String SPECIFIED_JOIN_COLUMNS_LIST
           
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.ReadOnlyTable
DB_TABLE_TRANSFORMER, DEFAULT_CATALOG_PROPERTY, DEFAULT_NAME_PROPERTY, DEFAULT_SCHEMA_PROPERTY, NAME_TRANSFORMER, SPECIFIED_CATALOG_PROPERTY, SPECIFIED_NAME_PROPERTY, SPECIFIED_SCHEMA_PROPERTY, UNIQUE_CONSTRAINTS_LIST
 
Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
RESOURCE_TYPE_TRANSFORMER
 
Method Summary
 ReadOnlyJoinColumn getDefaultJoinColumn()
          Return the default join column or null.
 org.eclipse.jpt.common.utility.iterable.ListIterable<? extends ReadOnlyJoinColumn> getJoinColumns()
          Return the reference table's join columns, whether specified or default.
 int getJoinColumnsSize()
          Return the number of join columns, whether specified or default.
 PersistentAttribute getPersistentAttribute()
           
 ReadOnlyJoinColumn getSpecifiedJoinColumn(int index)
          Return the specified join column at the specified index.
 org.eclipse.jpt.common.utility.iterable.ListIterable<? extends ReadOnlyJoinColumn> getSpecifiedJoinColumns()
          Return the reference table's specified join columns.
 int getSpecifiedJoinColumnsSize()
          Return the number of specified join columns.
 boolean hasSpecifiedJoinColumns()
          Return whether the reference table has specified join columns.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.ReadOnlyTable
catalogIsResolved, getCatalog, getCatalogValidationTextRange, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getNameValidationTextRange, getSchema, getSchemaValidationTextRange, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, getUniqueConstraint, getUniqueConstraints, getUniqueConstraintsSize, isResolved, schemaIsResolved, validatesAgainstDatabase
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextNode
getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate
 
Methods inherited from interface org.eclipse.jpt.jpa.core.JpaNode
getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged
 
Methods inherited from interface org.eclipse.jpt.common.utility.model.Model
addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
getResourceType
 

Field Detail

SPECIFIED_JOIN_COLUMNS_LIST

static final String SPECIFIED_JOIN_COLUMNS_LIST
See Also:
Constant Field Values

DEFAULT_JOIN_COLUMN_PROPERTY

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

getPersistentAttribute

PersistentAttribute getPersistentAttribute()

getJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends ReadOnlyJoinColumn> getJoinColumns()
Return the reference table's join columns, whether specified or default.


getJoinColumnsSize

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


getSpecifiedJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends ReadOnlyJoinColumn> getSpecifiedJoinColumns()
Return the reference table's specified join columns.


getSpecifiedJoinColumnsSize

int getSpecifiedJoinColumnsSize()
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.


Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.