org.eclipse.jpt.core.resource.orm
Interface XmlRelationshipMapping

All Superinterfaces:
org.eclipse.emf.ecore.EObject, JpaEObject, org.eclipse.emf.common.notify.Notifier, XmlAttributeMapping
All Known Subinterfaces:
XmlManyToMany, XmlManyToOne, XmlMultiRelationshipMapping, XmlOneToMany, XmlOneToOne, XmlSingleRelationshipMapping
All Known Implementing Classes:
XmlManyToManyImpl, XmlManyToOneImpl, XmlOneToManyImpl, XmlOneToOneImpl

public interface XmlRelationshipMapping
extends XmlAttributeMapping

A representation of the model object 'Relationship Mapping'. 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.

The following features are supported:

See Also:
OrmPackage.getXmlRelationshipMapping()

Method Summary
 CascadeType getCascade()
          Returns the value of the 'Cascade' containment reference.
 FetchType getFetch()
          Returns the value of the 'Fetch' attribute.
 XmlJoinTable getJoinTable()
          Returns the value of the 'Join Table' containment reference.
 java.lang.String getTargetEntity()
          Returns the value of the 'Target Entity' attribute.
 void setCascade(CascadeType value)
          Sets the value of the 'Cascade' containment reference.
 void setFetch(FetchType value)
          Sets the value of the 'Fetch' attribute.
 void setJoinTable(XmlJoinTable value)
          Sets the value of the 'Join Table' containment reference.
 void setTargetEntity(java.lang.String value)
          Sets the value of the 'Target Entity' attribute.
 
Methods inherited from interface org.eclipse.jpt.core.resource.orm.XmlAttributeMapping
getName, getNameTextRange, setName
 
Methods inherited from interface org.eclipse.jpt.core.resource.common.JpaEObject
containsOffset, getPlatformResource, getResource, getRoot, getSelectionTextRange, getValidationTextRange, isAllFeaturesUnset
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getTargetEntity

java.lang.String getTargetEntity()
Returns the value of the 'Target Entity' attribute.

If the meaning of the 'Target Entity' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Target Entity' attribute.
See Also:
setTargetEntity(String), OrmPackage.getXmlRelationshipMapping_TargetEntity()

setTargetEntity

void setTargetEntity(java.lang.String value)
Sets the value of the 'Target Entity' attribute.

Parameters:
value - the new value of the 'Target Entity' attribute.
See Also:
getTargetEntity()

getFetch

FetchType getFetch()
Returns the value of the 'Fetch' attribute. The default value is "LAZY". The literals are from the enumeration FetchType.

If the meaning of the 'Fetch' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Fetch' attribute.
See Also:
FetchType, setFetch(FetchType), OrmPackage.getXmlRelationshipMapping_Fetch()

setFetch

void setFetch(FetchType value)
Sets the value of the 'Fetch' attribute.

Parameters:
value - the new value of the 'Fetch' attribute.
See Also:
FetchType, getFetch()

getCascade

CascadeType getCascade()
Returns the value of the 'Cascade' containment reference.

If the meaning of the 'Cascade' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Cascade' containment reference.
See Also:
setCascade(CascadeType), OrmPackage.getXmlRelationshipMapping_Cascade()

setCascade

void setCascade(CascadeType value)
Sets the value of the 'Cascade' containment reference.

Parameters:
value - the new value of the 'Cascade' containment reference.
See Also:
getCascade()

getJoinTable

XmlJoinTable getJoinTable()
Returns the value of the 'Join Table' containment reference.

If the meaning of the 'Join Table' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Join Table' containment reference.
See Also:
setJoinTable(XmlJoinTable), OrmPackage.getXmlRelationshipMapping_JoinTable()

setJoinTable

void setJoinTable(XmlJoinTable value)
Sets the value of the 'Join Table' containment reference.

Parameters:
value - the new value of the 'Join Table' containment reference.
See Also:
getJoinTable()