metricsOverlay.model.metrics
Class Metric

java.lang.Object
  extended by metricsOverlay.model.metrics.Metric
All Implemented Interfaces:
java.lang.Comparable<Metric>, IEditable, INameable
Direct Known Subclasses:
ActualMetric, DerivedMetric

public abstract class Metric
extends java.lang.Object
implements java.lang.Comparable<Metric>, INameable, IEditable

This abstract class Metric represents a metric in the overlay form. It has two subclasses, one, ActualMetric, that holds metric data and the other, DerivedMetric, that acts as a proxy to allow the same metric data to be displayed with different ranges.

Version:
15/8/2009
Author:
Matthew Harward

Constructor Summary
Metric()
           
 
Method Summary
 int compareTo(Metric o)
           
abstract  java.util.Set<MetricSection> getMetricSections()
           
 java.lang.String getName()
           
 Range getRange()
           
 void setName(java.lang.String name)
          This method sets the name of a nameable object.
 void setRange(Range range)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface metricsOverlay.model.IEditable
canChangeEditableStatus, canEdit, setEditable
 

Constructor Detail

Metric

public Metric()
Method Detail

setRange

public void setRange(Range range)
Parameters:
range - the range to set

getRange

public Range getRange()
Returns:
the range

setName

public void setName(java.lang.String name)
Description copied from interface: INameable
This method sets the name of a nameable object. This name should be unique among objects of this type.

Specified by:
setName in interface INameable
Parameters:
name - the name to set

getName

public java.lang.String getName()
Specified by:
getName in interface INameable
Returns:
the name

getMetricSections

public abstract java.util.Set<MetricSection> getMetricSections()
Returns:
the metric sections associated with this metric.

compareTo

public int compareTo(Metric o)
Specified by:
compareTo in interface java.lang.Comparable<Metric>