com.sdmetrics.metrics

Class MetricEntry

java.lang.Object

com.sdmetrics.metrics.MetricEntry

Direct Known Subclasses:

Glossary, Matrix, Metric, Reference, Rule, Set

public abstract class MetricEntry
extends java.lang.Object

Base class for entries in the metric definition file (metrics, sets, rules, or matrices). An entry has a name, a brief informal description, a full description, a location (line number), and a calculation procedure that defines the entry.

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcedureAttributes	attributes Attributes of the calculation procedure for the entry.
protected com.sdmetrics.metrics.Description	description Description of the entry.
protected int	id Entry ID number (array index for efficient storage).
protected int	location Line number of the entry in the metric definition file.
protected java.lang.String	name Name of the entry in the metric definition file.
protected java.lang.String	procedureName Name of the calculation procedure for the entry.

Constructor Summary

Constructors

Constructor and Description
MetricEntry(java.lang.String name) Constructor.

Method Summary

Modifier and Type	Method and Description
ProcedureAttributes	getAttributes() Gets the calculation procedure attributes for this entry.
java.lang.String	getBriefDescription() Gets the brief description for this entry.
java.lang.String	getFullDescription() Gets the full description for this entry.
int	getLocation() Gets the line number of this entry in the metric definition file.
java.lang.String	getName() Retrieves the name of the entry.
java.lang.String	getProcedureName() Gets the name of the calculation procedure.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

Name of the entry in the metric definition file.

id

protected int id

Entry ID number (array index for efficient storage).

description

protected com.sdmetrics.metrics.Description description

Description of the entry.

procedureName

protected java.lang.String procedureName

Name of the calculation procedure for the entry.

attributes

protected ProcedureAttributes attributes

Attributes of the calculation procedure for the entry.

location

protected int location

Line number of the entry in the metric definition file.

Constructor Detail

MetricEntry

public MetricEntry(java.lang.String name)

Constructor.

Parameters:

name - Name of the entry.

Method Detail

getName

public java.lang.String getName()

Retrieves the name of the entry.

Returns:

name of the entry

getBriefDescription

public java.lang.String getBriefDescription()

Gets the brief description for this entry.

Returns:

One-liner informally describing the entry.

getFullDescription

public java.lang.String getFullDescription()

Gets the full description for this entry.

Returns:

Full, detailed description for the entry.

getAttributes

public ProcedureAttributes getAttributes()

Gets the calculation procedure attributes for this entry.

Returns:

Calculation procedure attributes for this entry

getProcedureName

public java.lang.String getProcedureName()

Gets the name of the calculation procedure.

Returns:

Name of the calculation procedure (projection, compoundmetric, etc)

getLocation

public int getLocation()

Gets the line number of this entry in the metric definition file.

Returns:

Line number of the entry, or 0 if the location is not known.