cyvis.core.metrics.sources
Class FileMetricSource

java.lang.Object
  cyvis.core.metrics.sources.MetricSource
      cyvis.core.metrics.sources.FileMetricSource

Direct Known Subclasses:

ClassFileMetricSource, JarFileMetricSource, TextFileMetricSource

public abstract class FileMetricSource
extends MetricSource

A file from which metrics can be extracted.

Nested Class Summary

Nested classes/interfaces inherited from class cyvis.core.metrics.sources.MetricSource

MetricSource.ProgressNotifier, MetricSource.UnreadableMetricSourceException, MetricSource.UnsupportedMetricSourceException

Field Summary

protected File

file The file from which metrics are to be extracted.

Constructor Summary

FileMetricSource(File file)

Method Summary

static FileMetricSource

get(File fileName) Factory method for constructing the appropriate FileMetricSource for a given filename.

Methods inherited from class cyvis.core.metrics.sources.MetricSource

collect, collect

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

file

protected final File file

The file from which metrics are to be extracted.

Constructor Detail

FileMetricSource

public FileMetricSource(File file)

Method Detail

get

public static FileMetricSource get(File fileName)
                            throws RuntimeException

Factory method for constructing the appropriate FileMetricSource for a given filename.

Returns:

an instance of a FileMetricSource subclass which can be used to extract metrics from the given filename

Throws:

UnreadableMetricSourceException - if the file cannot be read

UnsupportedMetricSourceException - if the file extension is not recognised

RuntimeException