net.sf.bloof.metrics
Interface Metric

All Known Implementing Classes:

SqlMetric

public interface Metric

Interface for every metric that can be used with Bloof

Version:

$Id: Metric.java,v 1.14 2003/10/13 15:52:31 pekacki Exp $

Author:

Lukasz Pekacki

Field Summary

static java.lang.String

XML_HEAD

Method Summary

java.lang.String	getDescription() Returns the description of the metric
java.lang.String	getName() Returns the Name of the metric
MetricParameter	getParameter() Returns the MetricParameter object of this metric
javax.swing.JComponent	getResultComponent() Returns the metric result as java component
net.n3.nanoxml.XMLElement	getResultXml() Returns the metric result as XML Document
void	runMetric(Database aDatabase) Runs the metric
void	setupMetric(MetricParameter aMetricParams) Initializes the metric with the specified parameter

Field Detail

XML_HEAD

public static final java.lang.String XML_HEAD

See Also:

Constant Field Values

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description of the metric

Returns:

String description

getName

public java.lang.String getName()

Returns the Name of the metric

Returns:

String

getParameter

public MetricParameter getParameter()

Returns the MetricParameter object of this metric

Returns:

MetricParameter object of this metric, null if none parameters exist

getResultComponent

public javax.swing.JComponent getResultComponent()

Returns the metric result as java component

Returns:

Component containing the results

getResultXml

public net.n3.nanoxml.XMLElement getResultXml()

Returns the metric result as XML Document

Returns:

XMLElement containing the results

runMetric

public void runMetric(Database aDatabase)
               throws java.sql.SQLException

Runs the metric

Parameters:

aDatabase - Database for running the metric

Throws:

java.sql.SQLException - on database connection error

setupMetric

public void setupMetric(MetricParameter aMetricParams)

Initializes the metric with the specified parameter

Parameters:

aMetricParams - parameter of the metrics