www.sdmetrics.com

com.sdmetrics.metrics
Class Metric

java.lang.Object
  extended by com.sdmetrics.metrics.MetricEntry
      extended by com.sdmetrics.metrics.Metric

public class Metric
extends MetricEntry

Represents the definition of metric in the metric definition file.


Field Summary
 
Fields inherited from class com.sdmetrics.metrics.MetricEntry
attributes, description, id, location, name, procedureName
 
Constructor Summary
Metric(java.lang.String name, MetaModelElement type, java.lang.String category)
          Creates a new metric definition.
 
Method Summary
 java.lang.String getCategory()
          Gets the category (structural property) measured by the metric.
 MetaModelElement getType()
          Retrieves the type of elements for which the metric is defined.
 boolean isInternal()
          Tests if this metric is internal or externally visible in the output.
 java.lang.String toString()
          Returns a string representation of the metric.
 
Methods inherited from class com.sdmetrics.metrics.MetricEntry
getAttributes, getBriefDescription, getFullDescription, getLocation, getName, getProcedureName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Metric

public Metric(java.lang.String name,
              MetaModelElement type,
              java.lang.String category)
Creates a new metric definition.

Parameters:
name - Name of the metric.
type - Metamodel element type of the elements for which this metric is defined.
category - The structural property measured by the metric.
Method Detail

getType

public MetaModelElement getType()
Retrieves the type of elements for which the metric is defined.

Returns:
Element type of this metric.

getCategory

public java.lang.String getCategory()
Gets the category (structural property) measured by the metric.

Returns:
This metric's category.

isInternal

public boolean isInternal()
Tests if this metric is internal or externally visible in the output.

Returns:
true if the metric is internal.

toString

public java.lang.String toString()
Returns a string representation of the metric.

Overrides:
toString in class java.lang.Object
Returns:
String with the name of metric, its type, and the line number of the definition

www.sdmetrics.com