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:

• javax.persistence.JoinTable
• javax.persistence.CollectionTable

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.common.core.resource.java.JavaResourceNode

JavaResourceNode.FileTransformer, JavaResourceNode.Root

Field Summary

static 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

Fields inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceNode

FILE_TRANSFORMER

Method Summary

JoinColumnAnnotation	addJoinColumn(int index) Corresponds to the 'joinColumns' element of the JoinTable annotation.
org.eclipse.jpt.common.utility.iterable.ListIterable<JoinColumnAnnotation>	getJoinColumns() Corresponds to the 'joinColumns' element of the JoinTable annotation.
int	getJoinColumnsSize() Corresponds to the 'joinColumns' element of the JoinTable annotation.
JoinColumnAnnotation	joinColumnAt(int index) 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, catalogValidationTouches, getCatalog, getCatalogTextRange, getCatalogValidationTextRange, getName, getNameTextRange, getNameValidationTextRange, getSchema, getSchemaTextRange, getSchemaValidationTextRange, getUniqueConstraints, getUniqueConstraintsSize, isSpecified, moveUniqueConstraint, nameTouches, nameValidationTouches, removeUniqueConstraint, schemaTouches, schemaValidationTouches, setCatalog, setName, setSchema, uniqueConstraintAt

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.Annotation

getAnnotationName, getAstAnnotation, initialize, initialize, isUnset, newAnnotation, removeAnnotation, synchronizeWith, synchronizeWith

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceNode

getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Field Detail

JOIN_COLUMNS_LIST

static final String JOIN_COLUMNS_LIST

See Also:

Constant Field Values

Method Detail

getJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<JoinColumnAnnotation> getJoinColumns()

Corresponds to the 'joinColumns' element of the JoinTable annotation. Return an empty iterator if the element does not exist in Java.

getJoinColumnsSize

int getJoinColumnsSize()

Corresponds to the 'joinColumns' element of the JoinTable annotation.

joinColumnAt

JoinColumnAnnotation joinColumnAt(int index)

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.