org.eclipse.ocl.examples.emf.validation.validity
Interface AbstractNode

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
ConstrainingNode, LeafConstrainingNode, ResultConstrainingNode, ResultValidatableNode, RootConstrainingNode, RootValidatableNode, ValidatableNode
All Known Implementing Classes:
AbstractNodeImpl, ConstrainingNodeImpl, LeafConstrainingNodeImpl, ResultConstrainingNodeImpl, ResultValidatableNodeImpl, RootConstrainingNodeImpl, RootValidatableNodeImpl, ValidatableNodeImpl

public interface AbstractNode
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'AbstractNode'.

The following features are supported:

See Also:
ValidityPackage.getAbstractNode()
Generated
Model
abstract="true"

Method Summary
 int countVisibleChildren()
          Return the number of visible children in this node and its descendants.
 org.eclipse.emf.common.util.EList<? extends AbstractNode> getChildren()
           
 void getGrayedElements(java.util.List<AbstractNode> grayedNodes)
          Fill grayedNodes with all grayed nodes in this node and its descendants.
 java.lang.String getLabel()
          Returns the value of the 'Label' attribute.
 AbstractNode getParent()
           
 AbstractNode[] getVisibleChildren()
          Return the fraction of getChildren() that are visible in an array to suit access by a ContentProvider.
 Result getWorstResult()
          Returns the value of the 'Worst Result' reference.
 boolean isEnabled()
          Returns the value of the 'Enabled' attribute.
 boolean isGrayed()
          Returns the value of the 'Grayed' attribute.
 boolean isVisible()
          Returns the value of the 'Visible' attribute.
 int refreshGrayed()
          Update the grayed status of this node and all its descendants, returning >0 if this node and its children are consistently enabled, <0 is consistently disbaled and 0 otherwise.
 boolean refreshVisibleChildren(java.lang.Iterable<IVisibilityFilter> visibilityFilters)
          Update the visible status of this node and all its descendants by comuting the AND of the visibilityFilters at each node.
 void setEnabled(boolean value)
          Sets the value of the 'Enabled' attribute.
 void setLabel(java.lang.String value)
          Sets the value of the 'Label' attribute.
 void setWorstResult(Result value)
          Sets the value of the 'Worst Result' reference.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

isEnabled

boolean isEnabled()
Returns the value of the 'Enabled' attribute. The default value is "true".

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

Returns:
the value of the 'Enabled' attribute.
See Also:
setEnabled(boolean), ValidityPackage.getAbstractNode_Enabled()
Generated
Model
default="true" required="true"

setEnabled

void setEnabled(boolean value)
Sets the value of the 'Enabled' attribute.

Parameters:
value - the new value of the 'Enabled' attribute.
See Also:
isEnabled()
Generated

isGrayed

boolean isGrayed()
Returns the value of the 'Grayed' attribute. The default value is "false".

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

Returns:
the value of the 'Grayed' attribute.
See Also:
ValidityPackage.getAbstractNode_Grayed()
Generated
Model
default="false" required="true" changeable="false"

isVisible

boolean isVisible()
Returns the value of the 'Visible' attribute. The default value is "true".

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

Returns:
the value of the 'Visible' attribute.
See Also:
ValidityPackage.getAbstractNode_Visible()
Generated
Model
default="true" required="true" changeable="false"

getLabel

java.lang.String getLabel()
Returns the value of the 'Label' attribute. The default value is "".

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

Returns:
the value of the 'Label' attribute.
See Also:
setLabel(String), ValidityPackage.getAbstractNode_Label()
Generated
Model
default="" required="true"

setLabel

void setLabel(java.lang.String value)
Sets the value of the 'Label' attribute.

Parameters:
value - the new value of the 'Label' attribute.
See Also:
getLabel()
Generated

getWorstResult

@Nullable
Result getWorstResult()
Returns the value of the 'Worst Result' reference.

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

Returns:
the value of the 'Worst Result' reference.
See Also:
setWorstResult(Result), ValidityPackage.getAbstractNode_WorstResult()
Generated
Model
resolveProxies="false" transient="true" derived="true"

setWorstResult

void setWorstResult(Result value)
Sets the value of the 'Worst Result' reference.

Parameters:
value - the new value of the 'Worst Result' reference.
See Also:
getWorstResult()
Generated

getParent

@Nullable
AbstractNode getParent()

Generated
Model
kind="operation"

getChildren

@NonNull
org.eclipse.emf.common.util.EList<? extends AbstractNode> getChildren()

Generated
NOT
Model
kind="operation"

countVisibleChildren

int countVisibleChildren()
Return the number of visible children in this node and its descendants.


getGrayedElements

void getGrayedElements(@NonNull
                       java.util.List<AbstractNode> grayedNodes)
Fill grayedNodes with all grayed nodes in this node and its descendants.


getVisibleChildren

@NonNull
AbstractNode[] getVisibleChildren()
Return the fraction of getChildren() that are visible in an array to suit access by a ContentProvider.


refreshGrayed

int refreshGrayed()
Update the grayed status of this node and all its descendants, returning >0 if this node and its children are consistently enabled, <0 is consistently disbaled and 0 otherwise.


refreshVisibleChildren

boolean refreshVisibleChildren(@NonNull
                               java.lang.Iterable<IVisibilityFilter> visibilityFilters)
Update the visible status of this node and all its descendants by comuting the AND of the visibilityFilters at each node. Return strue if this node visible.