Dali Provisional API
Release 3.2

org.eclipse.jpt.jpa.core.context.java
Interface JavaSecondaryTable

All Superinterfaces:
IAdaptable, JavaTable, JpaContextNode, JpaNode, JptResourceTypeReference, Model, ReadOnlySecondaryTable, ReadOnlyTable, SecondaryTable, Table

public interface JavaSecondaryTable
extends SecondaryTable, JavaTable

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

Since:
2.0

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
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.ReadOnlySecondaryTable
DEFAULT_PRIMARY_KEY_JOIN_COLUMN, SPECIFIED_PRIMARY_KEY_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
 JavaPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn()
          Add a specified primary key join column to the secondary table.
 JavaPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)
          Add a specified primary key join column to the secondary table.
 JavaPrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()
          Return the default primary key join column or null.
 JavaEntity getParent()
          Return the JPA node's parent.
 org.eclipse.jpt.common.utility.iterable.ListIterable<JavaPrimaryKeyJoinColumn> getPrimaryKeyJoinColumns()
          Return the secondary table's primary key join columns, whether specified or default.
 org.eclipse.jpt.common.utility.iterable.ListIterable<JavaPrimaryKeyJoinColumn> getSpecifiedPrimaryKeyJoinColumns()
          Return the specified primary key join columns.
 SecondaryTableAnnotation getTableAnnotation()
           
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.SecondaryTable
clearSpecifiedPrimaryKeyJoinColumns, convertDefaultPrimaryKeyJoinColumnsToSpecified, getSpecifiedPrimaryKeyJoinColumn, moveSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.ReadOnlySecondaryTable
getPrimaryKeyJoinColumnsSize, getSpecifiedPrimaryKeyJoinColumnsSize, isVirtual
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.java.JavaTable
addUniqueConstraint, addUniqueConstraint, getUniqueConstraint, getUniqueConstraints
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.Table
isSpecifiedInResource, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema
 
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, getUniqueConstraintsSize, isResolved, schemaIsResolved, validatesAgainstDatabase
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextNode
getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, 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
 

Method Detail

getParent

JavaEntity 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 JpaContextNode
Specified by:
getParent in interface JpaNode
Specified by:
getParent in interface ReadOnlySecondaryTable

getTableAnnotation

SecondaryTableAnnotation getTableAnnotation()
Specified by:
getTableAnnotation in interface JavaTable

getPrimaryKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<JavaPrimaryKeyJoinColumn> getPrimaryKeyJoinColumns()
Description copied from interface: ReadOnlySecondaryTable
Return the secondary table's primary key join columns, whether specified or default.

Specified by:
getPrimaryKeyJoinColumns in interface ReadOnlySecondaryTable
Specified by:
getPrimaryKeyJoinColumns in interface SecondaryTable

getSpecifiedPrimaryKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<JavaPrimaryKeyJoinColumn> getSpecifiedPrimaryKeyJoinColumns()
Description copied from interface: ReadOnlySecondaryTable
Return the specified primary key join columns.

Specified by:
getSpecifiedPrimaryKeyJoinColumns in interface ReadOnlySecondaryTable
Specified by:
getSpecifiedPrimaryKeyJoinColumns in interface SecondaryTable

addSpecifiedPrimaryKeyJoinColumn

JavaPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn()
Description copied from interface: SecondaryTable
Add a specified primary key join column to the secondary table. Return the newly-created primary key join column.

Specified by:
addSpecifiedPrimaryKeyJoinColumn in interface SecondaryTable

addSpecifiedPrimaryKeyJoinColumn

JavaPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)
Description copied from interface: SecondaryTable
Add a specified primary key join column to the secondary table. Return the newly-created primary key join column.

Specified by:
addSpecifiedPrimaryKeyJoinColumn in interface SecondaryTable

getDefaultPrimaryKeyJoinColumn

JavaPrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()
Description copied from interface: ReadOnlySecondaryTable
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.

Specified by:
getDefaultPrimaryKeyJoinColumn in interface ReadOnlySecondaryTable
Specified by:
getDefaultPrimaryKeyJoinColumn in interface SecondaryTable

Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.