org.eclipse.jpt.core.context.orm
Interface OrmJoinColumnJoiningStrategy

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JoinColumnJoiningStrategy, JoiningStrategy, JpaContextNode, JpaNode, Model, OrmJoiningStrategy, XmlContextNode
All Known Subinterfaces:
OrmJoinColumnInAssociationOverrideJoiningStrategy

public interface OrmJoinColumnJoiningStrategy
extends OrmJoiningStrategy, JoinColumnJoiningStrategy

The orm.xml representation of a JoinColumnJoiningStrategy 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.2
Version:
2.2

Field Summary
 
Fields inherited from interface org.eclipse.jpt.core.context.JoinColumnJoiningStrategy
DEFAULT_JOIN_COLUMN_PROPERTY, SPECIFIED_JOIN_COLUMNS_LIST
 
Method Summary
 OrmJoinColumn addSpecifiedJoinColumn(int index)
          Add a specified join column to the join table return the object representing it.
 OrmJoinColumn getDefaultJoinColumn()
          Return the default join column or null.
 java.util.ListIterator<OrmJoinColumn> joinColumns()
          Return a list iterator of the join columns whether specified or default.
 java.util.ListIterator<OrmJoinColumn> specifiedJoinColumns()
          Return a list iterator of the specified join columns.
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmJoiningStrategy
update
 
Methods inherited from interface org.eclipse.jpt.core.context.XmlContextNode
getValidationTextRange, validate
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, postUpdate
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent
 
Methods inherited from interface org.eclipse.jpt.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.core.IResourcePart
getResource
 
Methods inherited from interface org.eclipse.jpt.core.context.JoiningStrategy
addStrategy, getColumnTableNotValidDescription, getDbTable, getRelationshipReference, getTableName, isOverridableAssociation, removeStrategy, tableNameIsInvalid
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, postUpdate
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent
 
Methods inherited from interface org.eclipse.jpt.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.core.IResourcePart
getResource
 
Methods inherited from interface org.eclipse.jpt.core.context.JoinColumnJoiningStrategy
getRelationshipSource, getRelationshipTarget, hasSpecifiedJoinColumns, initializeFrom, isTargetForeignKeyRelationship, joinColumnsSize, moveSpecifiedJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn, specifiedJoinColumnsSize
 
Methods inherited from interface org.eclipse.jpt.core.context.JoiningStrategy
addStrategy, getColumnTableNotValidDescription, getDbTable, getRelationshipReference, getTableName, isOverridableAssociation, removeStrategy, tableNameIsInvalid
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, postUpdate
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent
 
Methods inherited from interface org.eclipse.jpt.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.core.IResourcePart
getResource
 

Method Detail

joinColumns

java.util.ListIterator<OrmJoinColumn> joinColumns()
Description copied from interface: JoinColumnJoiningStrategy
Return a list iterator of the join columns whether specified or default. This will not be null.

Specified by:
joinColumns in interface JoinColumnJoiningStrategy

getDefaultJoinColumn

OrmJoinColumn getDefaultJoinColumn()
Description copied from interface: JoinColumnJoiningStrategy
Return the default join column or null. If there are specified join columns, then there will be no default join column (though there are times that there may be no default join column even if there are no specified join columns.)

Specified by:
getDefaultJoinColumn in interface JoinColumnJoiningStrategy

specifiedJoinColumns

java.util.ListIterator<OrmJoinColumn> specifiedJoinColumns()
Description copied from interface: JoinColumnJoiningStrategy
Return a list iterator of the specified join columns. This will not be null.

Specified by:
specifiedJoinColumns in interface JoinColumnJoiningStrategy

addSpecifiedJoinColumn

OrmJoinColumn addSpecifiedJoinColumn(int index)
Description copied from interface: JoinColumnJoiningStrategy
Add a specified join column to the join table return the object representing it.

Specified by:
addSpecifiedJoinColumn in interface JoinColumnJoiningStrategy