Eclipse GMF Guide (Galileo) - ChildReference (Eclipse GMF Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Generation Framework

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.gmf.mappings
Interface ChildReference

All Superinterfaces:: org.eclipse.emf.ecore.EObject, NeedsContainment, NodeReference, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:: ChildReferenceImpl

public interface ChildReference
extends NodeReference
extends NodeReference

A representation of the model object ' Child Reference '.

The following features are supported:

See Also:: GMFMapPackage.getChildReference()
** Generated **
Model:: annotation="https://www.eclipse.org/gmf/2005/constraints ocl='not (ownedChild.oclIsUndefined() and referencedChild.oclIsUndefined())' description='Either \'ownedChild\' or \'referencedChild\' NodeMapping must be set'" annotation="https://www.eclipse.org/gmf/2005/constraints ocl='not childrenFeature.oclIsUndefined() implies childrenFeature.eContainingClass.isSuperTypeOf(parentNode.domainMetaElement)' description='\'Children Feature\' must be owned by \'Domain Meta Element\' or its super type of this reference parent Node Mapping'" annotation="https://www.eclipse.org/gmf/2005/constraints ocl='not containmentFeature.oclIsUndefined() implies containmentFeature.eContainingClass.isSuperTypeOf(parentNode.domainMetaElement)' description='\'Containment Feature\' must be owned by \'Domain Meta Element\' or its super type of this reference parent Node Mapping'" annotation="https://www.eclipse.org/gmf/2005/constraints ocl='not child.getDomainContext().oclIsUndefined() implies not containmentFeature.oclIsUndefined()' description='ChildReference to NodeMapping with domainElement should define \'containmentFeature\''" annotation="https://www.eclipse.org/gmf/2005/constraints ocl='let child:NodeMapping=(if ownedChild.oclIsUndefined() then referencedChild else ownedChild endif) in (((child.labelMappings->size() = 1) and child.labelMappings->forAll( soleLabel: LabelMapping | soleLabel.diagramLabel = child.diagramNode)) implies (child.diagramNode.affixedParentSide = gmfgraph::Direction::NONE))' description='Side-affixed children can not be pure labels'" annotation="https://www.eclipse.org/gmf/2005/constraints ocl='let child:NodeMapping=(if ownedChild.oclIsUndefined() then referencedChild else ownedChild endif) in ((not compartment.oclIsUndefined()) implies (child.diagramNode.affixedParentSide = gmfgraph::Direction::NONE))' description='Side-affixed children can not be placed in compartments'"

Method Summary

CompartmentMapping getCompartment ()
          Returns the value of the ' Compartment ' reference.

NodeMapping getOwnedChild ()
          Returns the value of the ' Owned Child ' containment reference

NodeMapping getParentNode ()
          Returns the value of the ' Parent Node ' container reference.

NodeMapping getReferencedChild ()
          Returns the value of the ' Referenced Child ' reference

void setCompartment ( CompartmentMapping value)
          Sets the value of the ' Compartment' reference

void setOwnedChild ( NodeMapping value)
          Sets the value of the ' Owned Child' containment reference

void setParentNode ( NodeMapping value)
          Sets the value of the ' Parent Node' container reference

void setReferencedChild ( NodeMapping value)
          Sets the value of the ' Referenced Child' reference

Methods inherited from interface org.eclipse.gmf.mappings. NodeReference

getChild, getChildrenFeature, isSetChild, setChildrenFeature

Methods inherited from interface org.eclipse.gmf.mappings. NeedsContainment

getContainmentFeature, setContainmentFeature

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

getParentNode


NodeMapping getParentNode()

Returns the value of the ' Parent Node ' container reference. It is bidirectional and its opposite is ' Children'.

If the meaning of the 'Parent Node' container reference isn't clear, there really should be more of a description here...

Returns:: the value of the 'Parent Node' container reference.
See Also:: setParentNode(NodeMapping), GMFMapPackage.getChildReference_ParentNode(), NodeMapping.getChildren()
** Generated **
Model:: opposite="children" required="true" transient="false"

setParentNode

void setParentNode(
NodeMapping value)

Sets the value of the ' Parent Node' container reference.

Parameters:: value - the new value of the 'Parent Node' container reference.
See Also:: getParentNode()
** Generated **

getCompartment


CompartmentMapping getCompartment()

Returns the value of the ' Compartment ' reference. It is bidirectional and its opposite is ' Children'.

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

Returns:: the value of the 'Compartment' reference.
See Also:: setCompartment(CompartmentMapping), GMFMapPackage.getChildReference_Compartment(), CompartmentMapping.getChildren()
** Generated **
Model:: opposite="children"

setCompartment

void setCompartment(
CompartmentMapping value)

Sets the value of the ' Compartment' reference.

Parameters:: value - the new value of the 'Compartment' reference.
See Also:: getCompartment()
** Generated **

getOwnedChild


NodeMapping getOwnedChild()

Returns the value of the ' Owned Child ' containment reference.

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

Returns:: the value of the 'Owned Child' containment reference.
See Also:: setOwnedChild(NodeMapping), GMFMapPackage.getChildReference_OwnedChild()
** Generated **
Model:: containment="true"

setOwnedChild

void setOwnedChild(
NodeMapping value)

Sets the value of the ' Owned Child' containment reference.

Parameters:: value - the new value of the 'Owned Child' containment reference.
See Also:: getOwnedChild()
** Generated **

getReferencedChild


NodeMapping getReferencedChild()

Returns the value of the ' Referenced Child ' reference.

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

Returns:: the value of the 'Referenced Child' reference.
See Also:: setReferencedChild(NodeMapping), GMFMapPackage.getChildReference_ReferencedChild()
** Generated **
Model:

setReferencedChild

void setReferencedChild(
NodeMapping value)

Sets the value of the ' Referenced Child' reference.

Parameters:: value - the new value of the 'Referenced Child' reference.
See Also:: getReferencedChild()
** Generated **