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

All Superinterfaces:

Annotation, JavaResourceNode, Model, RelationshipMappingAnnotation

All Known Subinterfaces:

ManyToMany2_0Annotation, ManyToManyAnnotation, OneToMany2_0Annotation, OneToManyAnnotation, OneToOne2_0Annotation, OneToOneAnnotation

public interface OwnableRelationshipMappingAnnotation
extends RelationshipMappingAnnotation

Represents a relationship mapping annotation that may have the mappedBy element:

• javax.persistence.ManyToMany
• javax.persistence.OneToMany
• javax.persistence.OneToOne

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

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

MAPPED_BY_PROPERTY

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

CASCADE_ALL_PROPERTY, CASCADE_MERGE_PROPERTY, CASCADE_PERSIST_PROPERTY, CASCADE_REFRESH_PROPERTY, CASCADE_REMOVE_PROPERTY, FETCH_PROPERTY, TARGET_ENTITY_PROPERTY

Method Summary

java.lang.String	getMappedBy() Corresponds to the 'mappedBy' element of the annotation.
TextRange	getMappedByTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'mappedBy' element.
boolean	mappedByTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'mappedBy' element.
void	setMappedBy(java.lang.String mappedBy) Corresponds to the 'mappedBy' element of the annotation.

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

getCascadeTextRange, getFetch, getFetchTextRange, getFullyQualifiedTargetEntityClassName, getTargetEntity, getTargetEntityTextRange, isCascadeAll, isCascadeMerge, isCascadePersist, isCascadeRefresh, isCascadeRemove, setCascadeAll, setCascadeMerge, setCascadePersist, setCascadeRefresh, setCascadeRemove, setFetch, setTargetEntity

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

MAPPED_BY_PROPERTY

static final java.lang.String MAPPED_BY_PROPERTY

See Also:

Constant Field Values

Method Detail

getMappedBy

java.lang.String getMappedBy()

Corresponds to the 'mappedBy' element of the annotation. Return null if the element does not exist in Java.

setMappedBy

void setMappedBy(java.lang.String mappedBy)

Corresponds to the 'mappedBy' element of the annotation. Set to null to remove the element.

getMappedByTextRange

TextRange getMappedByTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return the TextRange for the 'mappedBy' element. If the element does not exist return the TextRange for the annotation.

mappedByTouches

boolean mappedByTouches(int pos,
                        org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return whether the specified position touches the 'mappedBy' element. Return false if the element does not exist.