metricsOverlay.model.metrics
Class ActualMetric

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

public class ActualMetric
extends Metric

This class represents and holds actual metrics data.

Version:
15/8/2009
Author:
Matthew Harward

Constructor Summary
ActualMetric(java.lang.String name)
          A reduced constructor.
ActualMetric(java.lang.String mname, Range mrange)
          Main constructor.
 
Method Summary
 void addMetricSection(MetricSection ms)
           
 boolean canChangeEditableStatus()
           
 boolean canEdit()
           
 java.util.Set<MetricSection> getMetricSections()
           
 int numSections()
           
 void removeMetricSection(MetricSection ms)
           
 void setEditable(boolean editable)
          If allowed, this sets the new editable status.
 void setMetricSections(java.util.Set<MetricSection> mSections)
           
 java.lang.String toString()
           
 
Methods inherited from class metricsOverlay.model.metrics.Metric
compareTo, getName, getRange, setName, setRange
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ActualMetric

public ActualMetric(java.lang.String name)
A reduced constructor. Sets up a default IntegerRange.

Parameters:
name - the unique name of the metric.

ActualMetric

public ActualMetric(java.lang.String mname,
                    Range mrange)
Main constructor.

Parameters:
mname - the unique name of the metric.
mrange - the range of the metric.
Method Detail

setMetricSections

public void setMetricSections(java.util.Set<MetricSection> mSections)
Parameters:
mSections - Replace all of the current metric sections with this set

addMetricSection

public void addMetricSection(MetricSection ms)
Parameters:
ms - The metric section to be added.

removeMetricSection

public void removeMetricSection(MetricSection ms)
Parameters:
ms - The metric section to be removed

getMetricSections

public java.util.Set<MetricSection> getMetricSections()
Specified by:
getMetricSections in class Metric
Returns:
An unmodifiable set of MetricSections

numSections

public int numSections()
Returns:
The number of MetricSections associated with this mapping

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

canChangeEditableStatus

public boolean canChangeEditableStatus()
Returns:
A value to determine if the editable status may be changed.

canEdit

public boolean canEdit()
Returns:
A boolean value that determines if you are allowed to edit this class.

setEditable

public void setEditable(boolean editable)
Description copied from interface: IEditable
If allowed, this sets the new editable status.

Parameters:
editable - the new status.