org.eclipse.jpt.jpa.core.resource.java
Interface ReferenceTableAnnotation

All Superinterfaces:
Annotation, BaseTableAnnotation, JavaResourceNode, Model
All Known Subinterfaces:
CollectionTable2_0Annotation, JoinTableAnnotation

public interface ReferenceTableAnnotation
extends BaseTableAnnotation

Corresponds to the JPA annotations:

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
Version:
2.3

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.resource.java.JavaResourceNode
JavaResourceNode.Root
 
Field Summary
static java.lang.String JOIN_COLUMNS_LIST
           
 
Fields inherited from interface org.eclipse.jpt.jpa.core.resource.java.BaseTableAnnotation
CATALOG_PROPERTY, NAME_PROPERTY, SCHEMA_PROPERTY, UNIQUE_CONSTRAINTS_LIST
 
Method Summary
 JoinColumnAnnotation addJoinColumn(int index)
          Corresponds to the 'joinColumns' element of the JoinTable annotation.
 int indexOfJoinColumn(JoinColumnAnnotation joinColumn)
          Corresponds to the 'joinColumns' element of the JoinTable annotation.
 JoinColumnAnnotation joinColumnAt(int index)
          Corresponds to the 'joinColumns' element of the JoinTable annotation.
 java.util.ListIterator<JoinColumnAnnotation> joinColumns()
          Corresponds to the 'joinColumns' element of the JoinTable annotation.
 int joinColumnsSize()
          Corresponds to the 'joinColumns' element of the JoinTable annotation.
 void moveJoinColumn(int targetIndex, int sourceIndex)
          Corresponds to the 'joinColumns' element of the JoinTable annotation.
 void removeJoinColumn(int index)
          Corresponds to the 'joinColumns' element of the JoinTable annotation.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.BaseTableAnnotation
addUniqueConstraint, catalogTouches, getCatalog, getCatalogTextRange, getName, getNameTextRange, getSchema, getSchemaTextRange, indexOfUniqueConstraint, isSpecified, moveUniqueConstraint, nameTouches, removeUniqueConstraint, schemaTouches, setCatalog, setName, setSchema, uniqueConstraintAt, uniqueConstraints, uniqueConstraintsSize
 
Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.Annotation
getAnnotationName, getAstAnnotation, isUnset, newAnnotation, removeAnnotation, restoreFrom, storeOn
 
Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.JavaResourceNode
getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange, initialize, synchronizeWith
 
Methods inherited from interface org.eclipse.jpt.common.utility.model.Model
addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener
 

Field Detail

JOIN_COLUMNS_LIST

static final java.lang.String JOIN_COLUMNS_LIST
See Also:
Constant Field Values
Method Detail

joinColumns

java.util.ListIterator<JoinColumnAnnotation> joinColumns()
Corresponds to the 'joinColumns' element of the JoinTable annotation. Return an empty iterator if the element does not exist in Java.


joinColumnsSize

int joinColumnsSize()
Corresponds to the 'joinColumns' element of the JoinTable annotation.


joinColumnAt

JoinColumnAnnotation joinColumnAt(int index)
Corresponds to the 'joinColumns' element of the JoinTable annotation.


indexOfJoinColumn

int indexOfJoinColumn(JoinColumnAnnotation joinColumn)
Corresponds to the 'joinColumns' element of the JoinTable annotation.


addJoinColumn

JoinColumnAnnotation addJoinColumn(int index)
Corresponds to the 'joinColumns' element of the JoinTable annotation.


moveJoinColumn

void moveJoinColumn(int targetIndex,
                    int sourceIndex)
Corresponds to the 'joinColumns' element of the JoinTable annotation.


removeJoinColumn

void removeJoinColumn(int index)
Corresponds to the 'joinColumns' element of the JoinTable annotation.