org.eclipse.modisco.omg.smm
Interface Measure

All Superinterfaces:
AbstractMeasureElement, SmmElement
All Known Subinterfaces:
BinaryMeasure, CollectiveMeasure, Counting, DimensionalMeasure, DirectMeasure, NamedMeasure, Ranking, RatioMeasure, RescaledMeasure

public interface Measure
extends AbstractMeasureElement

A representation of the model object 'Measure'.

The following features are supported:

See Also:
SmmPackage.getMeasure()
Generated:
Model:
abstract="true"

Method Summary
  getAllArguments()
           
  getArguments()
           
  getCategory()
          Returns the value of the 'Category' reference list.
 Operation getDefaultQuery()
          Returns the value of the 'Default Query' reference.
  getEquivalentFrom()
          Returns the value of the 'Equivalent From' reference list.
  getEquivalentTo()
          Returns the value of the 'Equivalent To' reference list.
 java.lang.String getMeasureLabelFormat()
          Returns the value of the 'Measure Label Format' attribute.
 java.lang.String getMeasurementLabelFormat()
          Returns the value of the 'Measurement Label Format' attribute.
  getMeasureRelationships()
          Returns the value of the 'Measure Relationships' containment reference list.
 RecursiveMeasureRelationship getRecursiveFrom()
          Returns the value of the 'Recursive From' reference.
 RecursiveMeasureRelationship getRecursiveTo()
          Returns the value of the 'Recursive To' reference.
  getRefinementFrom()
          Returns the value of the 'Refinement From' reference list.
  getRefinementTo()
          Returns the value of the 'Refinement To' reference list.
 Scope getScope()
          Returns the value of the 'Scope' reference.
 Characteristic getTrait()
          Returns the value of the 'Trait' reference.
 boolean isVisible()
          Returns the value of the 'Visible' attribute.
 void setDefaultQuery(Operation value)
          Sets the value of the 'Default Query' reference.
 void setMeasureLabelFormat(java.lang.String value)
          Sets the value of the 'Measure Label Format' attribute.
 void setMeasurementLabelFormat(java.lang.String value)
          Sets the value of the 'Measurement Label Format' attribute.
 void setRecursiveFrom(RecursiveMeasureRelationship value)
          Sets the value of the 'Recursive From' reference.
 void setRecursiveTo(RecursiveMeasureRelationship value)
          Sets the value of the 'Recursive To' reference.
 void setScope(Scope value)
          Sets the value of the 'Scope' reference.
 void setTrait(Characteristic value)
          Sets the value of the 'Trait' reference.
 void setVisible(boolean value)
          Sets the value of the 'Visible' attribute.
 
Methods inherited from interface org.eclipse.modisco.omg.smm.AbstractMeasureElement
getInCategory
 
Methods inherited from interface org.eclipse.modisco.omg.smm.SmmElement
getAnnotation, getAttribute, getDescription, getInbound, getName, getOutbound, getRequestedObservations, getShortDescription, setDescription, setName, setShortDescription
 

Method Detail

getCategory

 getCategory()
Returns the value of the 'Category' reference list. The list contents are of type MeasureCategory. It is bidirectional and its opposite is 'Category Measure'.

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

Returns:
the value of the 'Category' reference list.
See Also:
SmmPackage.getMeasure_Category(), MeasureCategory.getCategoryMeasure()
Generated:
Model:
opposite="categoryMeasure"

getTrait

Characteristic getTrait()
Returns the value of the 'Trait' reference.

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

Returns:
the value of the 'Trait' reference.
See Also:
setTrait(Characteristic), SmmPackage.getMeasure_Trait()
Generated:
Model:
required="true"

setTrait

void setTrait(Characteristic value)
Sets the value of the 'Trait' reference.

Parameters:
value - the new value of the 'Trait' reference.
See Also:
getTrait()
Generated:

getScope

Scope getScope()
Returns the value of the 'Scope' reference.

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

Returns:
the value of the 'Scope' reference.
See Also:
setScope(Scope), SmmPackage.getMeasure_Scope()
Generated:
Model:
required="true"

setScope

void setScope(Scope value)
Sets the value of the 'Scope' reference.

Parameters:
value - the new value of the 'Scope' reference.
See Also:
getScope()
Generated:

getMeasureLabelFormat

java.lang.String getMeasureLabelFormat()
Returns the value of the 'Measure Label Format' attribute.

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

Returns:
the value of the 'Measure Label Format' attribute.
See Also:
setMeasureLabelFormat(String), SmmPackage.getMeasure_MeasureLabelFormat()
Generated:
Model:

setMeasureLabelFormat

void setMeasureLabelFormat(java.lang.String value)
Sets the value of the 'Measure Label Format' attribute.

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

getRefinementTo

 getRefinementTo()
Returns the value of the 'Refinement To' reference list. The list contents are of type RefinementMeasureRelationship. It is bidirectional and its opposite is 'From'.

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

Returns:
the value of the 'Refinement To' reference list.
See Also:
SmmPackage.getMeasure_RefinementTo(), RefinementMeasureRelationship.getFrom()
Generated:
Model:
opposite="from"

getRefinementFrom

 getRefinementFrom()
Returns the value of the 'Refinement From' reference list. The list contents are of type RefinementMeasureRelationship. It is bidirectional and its opposite is 'To'.

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

Returns:
the value of the 'Refinement From' reference list.
See Also:
SmmPackage.getMeasure_RefinementFrom(), RefinementMeasureRelationship.getTo()
Generated:
Model:
opposite="to"

getEquivalentTo

 getEquivalentTo()
Returns the value of the 'Equivalent To' reference list. The list contents are of type EquivalentMeasureRelationship. It is bidirectional and its opposite is 'From'.

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

Returns:
the value of the 'Equivalent To' reference list.
See Also:
SmmPackage.getMeasure_EquivalentTo(), EquivalentMeasureRelationship.getFrom()
Generated:
Model:
opposite="from"

getEquivalentFrom

 getEquivalentFrom()
Returns the value of the 'Equivalent From' reference list. The list contents are of type EquivalentMeasureRelationship. It is bidirectional and its opposite is 'To'.

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

Returns:
the value of the 'Equivalent From' reference list.
See Also:
SmmPackage.getMeasure_EquivalentFrom(), EquivalentMeasureRelationship.getTo()
Generated:
Model:
opposite="to"

getRecursiveTo

RecursiveMeasureRelationship getRecursiveTo()
Returns the value of the 'Recursive To' reference. It is bidirectional and its opposite is 'From'.

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

Returns:
the value of the 'Recursive To' reference.
See Also:
setRecursiveTo(RecursiveMeasureRelationship), SmmPackage.getMeasure_RecursiveTo(), RecursiveMeasureRelationship.getFrom()
Generated:
Model:
opposite="from"

setRecursiveTo

void setRecursiveTo(RecursiveMeasureRelationship value)
Sets the value of the 'Recursive To' reference.

Parameters:
value - the new value of the 'Recursive To' reference.
See Also:
getRecursiveTo()
Generated:

getRecursiveFrom

RecursiveMeasureRelationship getRecursiveFrom()
Returns the value of the 'Recursive From' reference. It is bidirectional and its opposite is 'To'.

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

Returns:
the value of the 'Recursive From' reference.
See Also:
setRecursiveFrom(RecursiveMeasureRelationship), SmmPackage.getMeasure_RecursiveFrom(), RecursiveMeasureRelationship.getTo()
Generated:
Model:
opposite="to"

setRecursiveFrom

void setRecursiveFrom(RecursiveMeasureRelationship value)
Sets the value of the 'Recursive From' reference.

Parameters:
value - the new value of the 'Recursive From' reference.
See Also:
getRecursiveFrom()
Generated:

getMeasurementLabelFormat

java.lang.String getMeasurementLabelFormat()
Returns the value of the 'Measurement Label Format' attribute.

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

Returns:
the value of the 'Measurement Label Format' attribute.
See Also:
setMeasurementLabelFormat(String), SmmPackage.getMeasure_MeasurementLabelFormat()
Generated:
Model:

setMeasurementLabelFormat

void setMeasurementLabelFormat(java.lang.String value)
Sets the value of the 'Measurement Label Format' attribute.

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

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:
setVisible(boolean), SmmPackage.getMeasure_Visible()
Generated:
Model:
default="true"

setVisible

void setVisible(boolean value)
Sets the value of the 'Visible' attribute.

Parameters:
value - the new value of the 'Visible' attribute.
See Also:
isVisible()
Generated:

getMeasureRelationships

 getMeasureRelationships()
Returns the value of the 'Measure Relationships' containment reference list. The list contents are of type MeasureRelationship.

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

Returns:
the value of the 'Measure Relationships' containment reference list.
See Also:
SmmPackage.getMeasure_MeasureRelationships()
Generated:
Model:
containment="true"

getDefaultQuery

Operation getDefaultQuery()
Returns the value of the 'Default Query' reference.

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

Returns:
the value of the 'Default Query' reference.
See Also:
setDefaultQuery(Operation), SmmPackage.getMeasure_DefaultQuery()
Generated:
Model:

setDefaultQuery

void setDefaultQuery(Operation value)
Sets the value of the 'Default Query' reference.

Parameters:
value - the new value of the 'Default Query' reference.
See Also:
getDefaultQuery()
Generated:

getArguments

 getArguments()

Generated:
Model:
kind="operation"

getAllArguments

 getAllArguments()

Generated:
Model:
kind="operation"