Eclipse GMF Guide (Galileo) - GenMetricRule (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.codegen.gmfgen
Interface GenMetricRule

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

All Known Implementing Classes:: GenMetricRuleImpl

public interface GenMetricRule
extends GenRuleBase
extends GenRuleBase

A representation of the model object ' Gen Metric Rule '.

The following features are supported:

See Also:: GMFGenPackage.getGenMetricRule()
** Generated **
Model:: annotation="https://www.eclipse.org/gmf/2005/constraints ocl='not lowLimit.oclIsUndefined() and not highLimit.oclIsUndefined() implies lowLimit < highLimit' description='Metric value \'lowLimit\' must be smaller then \'highLimit\''"

Method Summary

GenMetricContainer getContainer ()
          Returns the value of the ' Container ' container reference.

java.lang.Double getHighLimit ()
          Returns the value of the ' High Limit ' attribute

java.lang.String getKey ()
          Returns the value of the ' Key ' attribute

java.lang.Double getLowLimit ()
          Returns the value of the ' Low Limit ' attribute

ValueExpression getRule ()
          Returns the value of the ' Rule ' reference

GenMeasurable getTarget ()
          Returns the value of the ' Target ' containment reference

void setContainer ( GenMetricContainer value)
          Sets the value of the ' Container' container reference

void setHighLimit (java.lang.Double value)
          Sets the value of the ' High Limit' attribute

void setKey (java.lang.String value)
          Sets the value of the ' Key' attribute

void setLowLimit (java.lang.Double value)
          Sets the value of the ' Low Limit' attribute

void setRule ( ValueExpression value)
          Sets the value of the ' Rule' reference

void setTarget ( GenMeasurable value)
          Sets the value of the ' Target' containment reference

Methods inherited from interface org.eclipse.gmf.codegen.gmfgen. GenRuleBase

getDescription, getName, setDescription, setName

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

getKey

java.lang.String getKey()

Returns the value of the ' Key ' attribute. Unique key identifying this metric an abbreviation for this metric

Returns:: the value of the 'Key' attribute.
See Also:: setKey(String), GMFGenPackage.getGenMetricRule_Key()
** Generated **
Model:: required="true" annotation="https://www.eclipse.org/gmf/2005/constraints ocl='not key.oclIsUndefined() implies container.metrics->one(i | i.key = self.key)' description='Metric rule with the same \'key\' already exists'"

setKey

void setKey(java.lang.String value)

Sets the value of the ' Key' attribute.

Parameters:: value - the new value of the 'Key' attribute.
See Also:: getKey()
** Generated **

getRule


ValueExpression getRule()

Returns the value of the ' Rule ' reference. Expression that calculates the value of this metric which is of EDataType that encapsulates java.lang.Number subclasses or their primitives

Returns:: the value of the 'Rule' reference.
See Also:: setRule(ValueExpression), GMFGenPackage.getGenMetricRule_Rule()
** Generated **
Model:: required="true" annotation="https://www.eclipse.org/gmf/2005/constraints/meta def='context' ocl='target.getContext()'" annotation="https://www.eclipse.org/gmf/2005/constraints/meta def='type' ocl='\'ecore::EDoubleObject\''"

setRule

void setRule(
ValueExpression value)

Sets the value of the ' Rule' reference.

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

getTarget


GenMeasurable getTarget()

Returns the value of the ' Target ' containment reference. The target representing the context this metric is evaluated in

Returns:: the value of the 'Target' containment reference.
See Also:: setTarget(GenMeasurable), GMFGenPackage.getGenMetricRule_Target()
** Generated **
Model:: containment="true" required="true"

setTarget

void setTarget(
GenMeasurable value)

Sets the value of the ' Target' containment reference.

Parameters:: value - the new value of the 'Target' containment reference.
See Also:: getTarget()
** Generated **

getContainer


GenMetricContainer getContainer()

Returns the value of the ' Container ' container reference. It is bidirectional and its opposite is ' Metrics'. The containing metric container of this metric rule

Returns:: the value of the 'Container' container reference.
See Also:: setContainer(GenMetricContainer), GMFGenPackage.getGenMetricRule_Container(), GenMetricContainer.getMetrics()
** Generated **
Model:: opposite="metrics" required="true" transient="false"

setContainer

void setContainer(
GenMetricContainer value)

Sets the value of the ' Container' container reference.

Parameters:: value - the new value of the 'Container' container reference.
See Also:: getContainer()
** Generated **

getLowLimit

java.lang.Double getLowLimit()

Returns the value of the ' Low Limit ' attribute.

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

Returns:: the value of the 'Low Limit' attribute.
See Also:: setLowLimit(Double), GMFGenPackage.getGenMetricRule_LowLimit()
** Generated **
Model:

setLowLimit

void setLowLimit(java.lang.Double value)

Sets the value of the ' Low Limit' attribute.

Parameters:: value - the new value of the 'Low Limit' attribute.
See Also:: getLowLimit()
** Generated **

getHighLimit

java.lang.Double getHighLimit()

Returns the value of the ' High Limit ' attribute.

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

Returns:: the value of the 'High Limit' attribute.
See Also:: setHighLimit(Double), GMFGenPackage.getGenMetricRule_HighLimit()
** Generated **
Model:

setHighLimit

void setHighLimit(java.lang.Double value)

Sets the value of the ' High Limit' attribute.

Parameters:: value - the new value of the 'High Limit' attribute.
See Also:: getHighLimit()
** Generated **