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

All Superinterfaces:

Annotation, BaseTableAnnotation, JavaResourceNode, Model

All Known Subinterfaces:

NestableSecondaryTableAnnotation

public interface SecondaryTableAnnotation
extends BaseTableAnnotation

Corresponds to the JPA annotation javax.persistence.SecondaryTable

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.2

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	PK_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

PrimaryKeyJoinColumnAnnotation	addPkJoinColumn(int index) Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.
int	indexOfPkJoinColumn(PrimaryKeyJoinColumnAnnotation pkJoinColumn) Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.
void	movePkJoinColumn(int targetIndex, int sourceIndex) Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.
PrimaryKeyJoinColumnAnnotation	pkJoinColumnAt(int index) Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.
java.util.ListIterator<PrimaryKeyJoinColumnAnnotation>	pkJoinColumns() Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.
int	pkJoinColumnsSize() Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.
void	removePkJoinColumn(int index) Corresponds to the 'pkJoinColumns' element of the SecondaryTable 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

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

PK_JOIN_COLUMNS_LIST

static final java.lang.String PK_JOIN_COLUMNS_LIST

See Also:

Constant Field Values

Method Detail

pkJoinColumns

java.util.ListIterator<PrimaryKeyJoinColumnAnnotation> pkJoinColumns()

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

pkJoinColumnsSize

int pkJoinColumnsSize()

Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.

pkJoinColumnAt

PrimaryKeyJoinColumnAnnotation pkJoinColumnAt(int index)

Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.

indexOfPkJoinColumn

int indexOfPkJoinColumn(PrimaryKeyJoinColumnAnnotation pkJoinColumn)

Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.

addPkJoinColumn

PrimaryKeyJoinColumnAnnotation addPkJoinColumn(int index)

Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.

removePkJoinColumn

void removePkJoinColumn(int index)

Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.

movePkJoinColumn

void movePkJoinColumn(int targetIndex,
                      int sourceIndex)

Corresponds to the 'pkJoinColumns' element of the SecondaryTable annotation.