Dali Provisional API
Release 3.2

org.eclipse.jpt.jpa.core.context.orm
Interface OrmSpecifiedReferenceTable

All Superinterfaces:
IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, OrmSpecifiedTable, ReferenceTable, SpecifiedReferenceTable, SpecifiedTable, Table
All Known Subinterfaces:
OrmCollectionTable2_0, OrmSpecifiedJoinTable

public interface OrmSpecifiedReferenceTable
extends SpecifiedReferenceTable, OrmSpecifiedTable

orm.xml join table or collection 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.

Since:
2.3

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.Table
Table.DbTableTransformer, Table.NameTransformer, Table.ParentAdapter<P extends JpaContextModel>
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel
JpaModel.JpaVersionIsCompatibleWith
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer
 
Field Summary
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.ReferenceTable
DEFAULT_JOIN_COLUMN_PROPERTY, SPECIFIED_JOIN_COLUMNS_LIST
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.Table
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
TRANSFORMER
 
Method Summary
 OrmSpecifiedJoinColumn addSpecifiedJoinColumn()
          Add and return a specified join column to the reference table.
 OrmSpecifiedJoinColumn addSpecifiedJoinColumn(int index)
          Add and return a specified join column to the reference table.
 OrmSpecifiedJoinColumn getDefaultJoinColumn()
          Return the default join column or null.
 org.eclipse.jpt.common.utility.iterable.ListIterable<OrmSpecifiedJoinColumn> getJoinColumns()
          Return the reference table's join columns, whether specified or default.
 OrmSpecifiedJoinColumn getSpecifiedJoinColumn(int index)
          Return the specified join column at the specified index.
 org.eclipse.jpt.common.utility.iterable.ListIterable<OrmSpecifiedJoinColumn> getSpecifiedJoinColumns()
          Return the reference table's specified join columns.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.SpecifiedReferenceTable
clearSpecifiedJoinColumns, convertDefaultJoinColumnToSpecified, moveSpecifiedJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.ReferenceTable
getJoinColumnsSize, getPersistentAttribute, getSpecifiedJoinColumnsSize, hasSpecifiedJoinColumns
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmSpecifiedTable
addUniqueConstraint, addUniqueConstraint, getUniqueConstraint, getUniqueConstraints
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.SpecifiedTable
isSpecifiedInResource, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.Table
catalogIsResolved, getCatalog, getCatalogValidationTextRange, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getNameValidationTextRange, getSchema, getSchemaValidationTextRange, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, getUniqueConstraintsSize, isResolved, schemaIsResolved, validatesAgainstDatabase
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextModel
getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate
 
Methods inherited from interface org.eclipse.jpt.jpa.core.JpaModel
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
 

Method Detail

getJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<OrmSpecifiedJoinColumn> getJoinColumns()
Description copied from interface: ReferenceTable
Return the reference table's join columns, whether specified or default.

Specified by:
getJoinColumns in interface ReferenceTable
Specified by:
getJoinColumns in interface SpecifiedReferenceTable

getSpecifiedJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<OrmSpecifiedJoinColumn> getSpecifiedJoinColumns()
Description copied from interface: ReferenceTable
Return the reference table's specified join columns.

Specified by:
getSpecifiedJoinColumns in interface ReferenceTable
Specified by:
getSpecifiedJoinColumns in interface SpecifiedReferenceTable

getSpecifiedJoinColumn

OrmSpecifiedJoinColumn getSpecifiedJoinColumn(int index)
Description copied from interface: ReferenceTable
Return the specified join column at the specified index.

Specified by:
getSpecifiedJoinColumn in interface ReferenceTable
Specified by:
getSpecifiedJoinColumn in interface SpecifiedReferenceTable

addSpecifiedJoinColumn

OrmSpecifiedJoinColumn addSpecifiedJoinColumn()
Description copied from interface: SpecifiedReferenceTable
Add and return a specified join column to the reference table.

Specified by:
addSpecifiedJoinColumn in interface SpecifiedReferenceTable

addSpecifiedJoinColumn

OrmSpecifiedJoinColumn addSpecifiedJoinColumn(int index)
Description copied from interface: SpecifiedReferenceTable
Add and return a specified join column to the reference table.

Specified by:
addSpecifiedJoinColumn in interface SpecifiedReferenceTable

getDefaultJoinColumn

OrmSpecifiedJoinColumn getDefaultJoinColumn()
Description copied from interface: ReferenceTable
Return the default join column or null. A default join column only exists if there are no specified join columns.

Specified by:
getDefaultJoinColumn in interface ReferenceTable
Specified by:
getDefaultJoinColumn in interface SpecifiedReferenceTable

Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.