metricsprovider
Class MetricsGenerator

java.lang.Object
  extended by java.util.Observable
      extended by metricsprovider.MetricsGenerator
Direct Known Subclasses:
EclipseMetricsGenerator, LineLengthGenerator, LOCGenerator

public abstract class MetricsGenerator
extends java.util.Observable

This abstract class provides basic functionality for adding metrics information to the overlay.

Version:
9/8/2009
Author:
Matthew Harward

Method Summary
abstract  void generateMetrics(UpdatedEditor upEditor)
          This method is the main metric generation path.
static MetricsGenerator getInstance()
          Default singleton method, should be overriden.
 
Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static MetricsGenerator getInstance()
Default singleton method, should be overriden.


generateMetrics

public abstract void generateMetrics(UpdatedEditor upEditor)
This method is the main metric generation path. Subclasses should override this method and make sure it sets the observer as being changed and notifies the observer with a either a MetricFile or an UpdatedEditor if XML is provided.

Parameters:
upEditor - the editor information for the current update.