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

All Superinterfaces:

Annotation, BaseTableAnnotation, JavaResourceNode, Model, ReferenceTableAnnotation

public interface JoinTableAnnotation
extends ReferenceTableAnnotation

Corresponds to the JPA annotation javax.persistence.JoinTable

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

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	ANNOTATION_NAME
static java.lang.String	INVERSE_JOIN_COLUMNS_LIST

Fields inherited from interface org.eclipse.jpt.jpa.core.resource.java.ReferenceTableAnnotation

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	addInverseJoinColumn(int index) Corresponds to the 'inverseJoinColumns' element of the JoinTable annotation.
int	indexOfInverseJoinColumn(JoinColumnAnnotation joinColumn) Corresponds to the 'inverseJoinColumns' element of the JoinTable annotation.
JoinColumnAnnotation	inverseJoinColumnAt(int index) Corresponds to the 'inverseJoinColumns' element of the JoinTable annotation.
java.util.ListIterator<JoinColumnAnnotation>	inverseJoinColumns() Corresponds to the 'inverseJoinColumns' element of the JoinTable annotation.
int	inverseJoinColumnsSize() Corresponds to the 'inverseJoinColumns' element of the JoinTable annotation.
void	moveInverseJoinColumn(int targetIndex, int sourceIndex) Corresponds to the 'inverseJoinColumns' element of the JoinTable annotation.
void	removeInverseJoinColumn(int index) Corresponds to the 'inverseJoinColumns' element of the JoinTable annotation.

Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.ReferenceTableAnnotation

addJoinColumn, indexOfJoinColumn, joinColumnAt, joinColumns, joinColumnsSize, moveJoinColumn, removeJoinColumn

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

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

INVERSE_JOIN_COLUMNS_LIST

static final java.lang.String INVERSE_JOIN_COLUMNS_LIST

See Also:

Constant Field Values

Method Detail

inverseJoinColumns

java.util.ListIterator<JoinColumnAnnotation> inverseJoinColumns()

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

inverseJoinColumnsSize

int inverseJoinColumnsSize()

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

inverseJoinColumnAt

JoinColumnAnnotation inverseJoinColumnAt(int index)

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

indexOfInverseJoinColumn

int indexOfInverseJoinColumn(JoinColumnAnnotation joinColumn)

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

addInverseJoinColumn

JoinColumnAnnotation addInverseJoinColumn(int index)

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

moveInverseJoinColumn

void moveInverseJoinColumn(int targetIndex,
                           int sourceIndex)

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

removeInverseJoinColumn

void removeInverseJoinColumn(int index)

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