Dali Provisional API
Release 3.2

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

All Superinterfaces:
IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, OrmSpecifiedTable, SecondaryTable, SpecifiedSecondaryTable, SpecifiedTable, Table

public interface OrmSpecifiedSecondaryTable
extends SpecifiedSecondaryTable, OrmSpecifiedTable

orm.xml 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
static interface OrmSpecifiedSecondaryTable.ParentAdapter
           
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.Table
Table.DbTableTransformer, Table.NameTransformer
 
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.SecondaryTable
DEFAULT_PRIMARY_KEY_JOIN_COLUMN, SPECIFIED_PRIMARY_KEY_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
 OrmSpecifiedPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn()
          Add a specified primary key join column to the secondary table.
 OrmSpecifiedPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)
          Add a specified primary key join column to the secondary table.
 OrmSpecifiedPrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()
          Return the default primary key join column or null.
 OrmEntity getParent()
          Return the JPA node's parent.
 org.eclipse.jpt.common.utility.iterable.ListIterable<OrmSpecifiedPrimaryKeyJoinColumn> getPrimaryKeyJoinColumns()
          Return the secondary table's primary key join columns, whether specified or default.
 org.eclipse.jpt.common.utility.iterable.ListIterable<OrmSpecifiedPrimaryKeyJoinColumn> getSpecifiedPrimaryKeyJoinColumns()
          Return the specified primary key join columns.
 org.eclipse.jpt.jpa.core.resource.orm.XmlSecondaryTable getXmlTable()
           
 void initializeFrom(OrmVirtualSecondaryTable oldTable)
           
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.SpecifiedSecondaryTable
clearSpecifiedPrimaryKeyJoinColumns, convertDefaultPrimaryKeyJoinColumnsToSpecified, getSpecifiedPrimaryKeyJoinColumn, moveSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.SecondaryTable
getPrimaryKeyJoinColumnsSize, getSpecifiedPrimaryKeyJoinColumnsSize, isVirtual
 
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, 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

getParent

OrmEntity getParent()
Description copied from interface: JpaModel
Return the JPA node's parent. The JPA project will not have a parent.

Specified by:
getParent in interface JpaContextModel
Specified by:
getParent in interface JpaModel
Specified by:
getParent in interface SecondaryTable

initializeFrom

void initializeFrom(OrmVirtualSecondaryTable oldTable)
See Also:
OrmEntity.setSecondaryTablesAreDefinedInXml(boolean)

getXmlTable

org.eclipse.jpt.jpa.core.resource.orm.XmlSecondaryTable getXmlTable()

getPrimaryKeyJoinColumns

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

Specified by:
getPrimaryKeyJoinColumns in interface SecondaryTable
Specified by:
getPrimaryKeyJoinColumns in interface SpecifiedSecondaryTable

getSpecifiedPrimaryKeyJoinColumns

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

Specified by:
getSpecifiedPrimaryKeyJoinColumns in interface SecondaryTable
Specified by:
getSpecifiedPrimaryKeyJoinColumns in interface SpecifiedSecondaryTable

addSpecifiedPrimaryKeyJoinColumn

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

Specified by:
addSpecifiedPrimaryKeyJoinColumn in interface SpecifiedSecondaryTable

addSpecifiedPrimaryKeyJoinColumn

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

Specified by:
addSpecifiedPrimaryKeyJoinColumn in interface SpecifiedSecondaryTable

getDefaultPrimaryKeyJoinColumn

OrmSpecifiedPrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()
Description copied from interface: SecondaryTable
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 SecondaryTable
Specified by:
getDefaultPrimaryKeyJoinColumn in interface SpecifiedSecondaryTable

Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.