oracle.jdeveloper.audit.analyzer

Class Metric

java.lang.Object

oracle.jdeveloper.audit.extension.ExtensionBean

oracle.jdeveloper.audit.analyzer.Metric

Direct Known Subclasses:

CountColumn, SeverityColumn

public class Metric
extends ExtensionBean

A metric of constructs of the Audit object model. A metric can be thought of as supplying data for one column of a table (or tree table) in which the rows are constructs from the Audit object model. Rows can also be violations, for which a metric can also (less commonly) supply data.

The configurable state of a metric is exposed through JavaBeans properties. Every metric has five default properties: id, type, enabled, category, and threshold. category, id, and enabled are inherited from ExtensionBean); category, id, and type are read-only. The name is used internally, primarily as a resource key. The type indicates the most-specific type common to the values of the attribute. The category is used to group attributes for presentation purposes. The threshold, if any, indicates the largest acceptable value of the attribute. An attribute can expose additional properties which the Audit framework will discover by introspection and add to the appropriate Audit preferences panel. Attributes are registered with the AuditManager at startup by IDE extensions.

For typical metrics, the values for all constructs are computed and and stored in an AuditModel during the traversal of the construct hierarchy. It is possible, however, to create a metric that computes the values for some or all constructs from values available from the AuditModel that contains it, or from external sources (e.g., a database or data file). To enable this, Audit will automatically add a metric which implements AuditModelListener as a listener to the AuditModel for which it is a column.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Comparator<java.lang.Object>	comparator
static java.lang.String	SHORT_LABEL_KEY The key for the short label of a bean.
protected java.lang.Object	threshold
protected java.lang.Class<?>	type

Fields inherited from class oracle.jdeveloper.audit.extension.ExtensionBean

DESCRIPTION_KEY, LABEL_KEY

Constructor Summary

Constructors

Constructor and Description
Metric() Creates a metric.

Method Summary

Methods

Modifier and Type	Method and Description
Category	category() Gets the category of this metric.
java.util.Comparator<java.lang.Object>	comparator() Gets a comparator for values of this attribute, or null if the values are not comparable.
protected void	copyInternalState(ExtensionBean copy, java.util.Map<java.lang.String,ExtensionBean> context) Copies internal subclass state as part of creating a copy of this bean.
MetricDefinition	definition() Gets the definition of this bean.
java.lang.Object	getThreshold() Gets the upper threshold of this metric, or null if none.
java.lang.Class<?>	getType() Gets the type of this attribute.
boolean	isEnabled() Gets whether this rule is enabled.
boolean	isOutOfBand(java.lang.Object value) Gets whether a value is out of band.
java.lang.String	representation(java.lang.Object value) Gets the text representation of a value.
void	setEnabled(boolean newValue) Sets whether this rule is enabled.
void	setThreshold(java.lang.Object newValue) Sets the upper threshold of this metric.
java.lang.String	shortLabel() Gets the localized short label of this metric, or null if none.
java.lang.String	toString()

Methods inherited from class oracle.jdeveloper.audit.extension.ExtensionBean

addPropertyChangeListener, addPropertyChangeListener, createCopy, description, equals, extensionId, extensionLine, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, formattedString, formattedString, formattedString, hashCode, id, key, label, labelOrId, logError, logError, logWarning, name, propertyDescription, propertyLabel, removePropertyChangeListener, removePropertyChangeListener, setters, string

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

protected java.lang.Class<?> type

threshold

protected java.lang.Object threshold

comparator

protected java.util.Comparator<java.lang.Object> comparator

SHORT_LABEL_KEY

public static final java.lang.String SHORT_LABEL_KEY

The key for the short label of a bean.

See Also:

shortLabel(), Constant Field Values

Constructor Detail

Metric

public Metric()

Creates a metric.

The Audit framework uses this constructor for metrics declared in an extension manifest, and then injects values for the ExtensionBean.id(), ExtensionBean.extensionId(), category, and type fields.

Method Detail

copyInternalState

protected void copyInternalState(ExtensionBean copy,
                     java.util.Map<java.lang.String,ExtensionBean> context)
                          throws java.lang.reflect.InvocationTargetException

Description copied from class: ExtensionBean

Copies internal subclass state as part of creating a copy of this bean.

Overrides:

copyInternalState in class ExtensionBean

Parameters:

copy - The partially initialized copy.

context - A map which allows subclasses to preserve object identity when copying a graph of extension beans.

Throws:

java.lang.reflect.InvocationTargetException

See Also:

ExtensionBean.createCopy(java.util.Map<java.lang.String, oracle.jdeveloper.audit.extension.ExtensionBean>)

definition

public MetricDefinition definition()

Gets the definition of this bean.

Overrides:

definition in class ExtensionBean

isEnabled

public boolean isEnabled()

Gets whether this rule is enabled.

setEnabled

public void setEnabled(boolean newValue)

Sets whether this rule is enabled.

category

public Category category()

Gets the category of this metric.

getType

public java.lang.Class<?> getType()

Gets the type of this attribute.

comparator

public java.util.Comparator<java.lang.Object> comparator()

Gets a comparator for values of this attribute, or null if the values are not comparable. The Metric implementation returns a default comparator if the attribute type is naturally ordered (i.e., implements Comparable) and returns null otherwise.

getThreshold

public java.lang.Object getThreshold()

Gets the upper threshold of this metric, or null if none.

setThreshold

public void setThreshold(java.lang.Object newValue)

Sets the upper threshold of this metric.

Parameters:

newValue - The value at which a measurement is considered out-of-band, or null if none.

isOutOfBand

public boolean isOutOfBand(java.lang.Object value)

Gets whether a value is out of band.

shortLabel

public java.lang.String shortLabel()

Gets the localized short label of this metric, or null if none.

See Also:

SHORT_LABEL_KEY

representation

public java.lang.String representation(java.lang.Object value)

Gets the text representation of a value.

The Metric implementation returns the result of String.valueOf(Object) applied to the value, or null if the value is null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object