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

All Superinterfaces:

Annotation, JavaResourceNode, Model, RelationshipMappingAnnotation

All Known Subinterfaces:

ManyToOne2_0Annotation, ManyToOneAnnotation, OneToOne2_0Annotation, OneToOneAnnotation

public interface SingleRelationshipMappingAnnotation
extends RelationshipMappingAnnotation

Common protocol among the following relationship mappings:

• javax.persistence.ManyToOne
• 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.

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

OPTIONAL_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.Boolean	getOptional() Corresponds to the optional element of a single relationship annotation.
TextRange	getOptionalTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the optional element.
void	setOptional(java.lang.Boolean optional) Corresponds to the optional element of a single relationship 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

OPTIONAL_PROPERTY

static final java.lang.String OPTIONAL_PROPERTY

See Also:

Constant Field Values

Method Detail

getOptional

java.lang.Boolean getOptional()

Corresponds to the optional element of a single relationship annotation. Returns null if the optional element does not exist in java.

setOptional

void setOptional(java.lang.Boolean optional)

Corresponds to the optional element of a single relationship annotation. Set to null to remove the optional element.

getOptionalTextRange

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

Return the TextRange for the optional element. If the optional element does not exist return the TextRange for the ManyToOne annotation.