org.apache.excalibur.instrument.manager
Interface InstrumentableDescriptor

All Known Implementing Classes:

InstrumentableDescriptorImpl

public interface InstrumentableDescriptor

Describes a Instrumentable and acts as a Proxy to protect the original Instrumentable.

Author:

Avalon Development Team

Method Summary

InstrumentableDescriptor	getChildInstrumentableDescriptor(java.lang.String childInstrumentableName) Returns a child InstrumentableDescriptor based on its name or the name of any of its children.
InstrumentableDescriptor[]	getChildInstrumentableDescriptors() Returns an array of Descriptors for the child Instrumentables registered by this Instrumentable.
java.lang.String	getDescription() Gets the description of the Instrumentable.
InstrumentDescriptor	getInstrumentDescriptor(java.lang.String instrumentName) Returns a InstrumentDescriptor based on its name.
InstrumentDescriptor[]	getInstrumentDescriptors() Returns an array of Descriptors for the Instruments registered by this Instrumentable.
java.lang.String	getName() Gets the name for the Instrumentable.
InstrumentableDescriptor	getParentInstrumentableDescriptor() Returns the parent InstrumentableDescriptor or null if this is a top level instrumentable.
int	getStateVersion() Returns the stateVersion of the instrumentable.
boolean	isConfigured() Returns true if the Instrumentable was configured in the instrumentables section of the configuration.
boolean	isRegistered() Returns true if the Instrumentable was registered with the Instrument Manager.

Method Detail

isConfigured

public boolean isConfigured()

Returns true if the Instrumentable was configured in the instrumentables section of the configuration.

Returns:

True if configured.

isRegistered

public boolean isRegistered()

Returns true if the Instrumentable was registered with the Instrument Manager.

Returns:

True if registered.

getName

public java.lang.String getName()

Gets the name for the Instrumentable. The Instrumentable Name is used to uniquely identify the Instrumentable during its configuration and to gain access to a InstrumentableDescriptor through a DefaultInstrumentManager.

Returns:

The name used to identify a Instrumentable.

getDescription

public java.lang.String getDescription()

Gets the description of the Instrumentable.

Returns:

The description of the Instrumentable.

getParentInstrumentableDescriptor

public InstrumentableDescriptor getParentInstrumentableDescriptor()

Returns the parent InstrumentableDescriptor or null if this is a top level instrumentable.

Returns:

The parent InstrumentableDescriptor or null.

getChildInstrumentableDescriptor

public InstrumentableDescriptor getChildInstrumentableDescriptor(java.lang.String childInstrumentableName)
                                                          throws NoSuchInstrumentableException

Returns a child InstrumentableDescriptor based on its name or the name of any of its children.

Parameters:

childInstrumentableName - Name of the child Instrumentable being requested.

Returns:

A descriptor of the requested child Instrumentable.

Throws:

NoSuchInstrumentableException - If the specified Instrumentable does not exist.

getChildInstrumentableDescriptors

public InstrumentableDescriptor[] getChildInstrumentableDescriptors()

Returns an array of Descriptors for the child Instrumentables registered by this Instrumentable.

Returns:

An array of Descriptors for the child Instrumentables registered by this Instrumentable.

getInstrumentDescriptor

public InstrumentDescriptor getInstrumentDescriptor(java.lang.String instrumentName)
                                             throws NoSuchInstrumentException

Returns a InstrumentDescriptor based on its name.

Parameters:

instrumentName - Name of the Instrument being requested.

Returns:

A Descriptor of the requested Instrument.

Throws:

NoSuchInstrumentException - If the specified Instrument does not exist.

getInstrumentDescriptors

public InstrumentDescriptor[] getInstrumentDescriptors()

Returns an array of Descriptors for the Instruments registered by this Instrumentable.

Returns:

An array of Descriptors for the Instruments registered by this Instrumentable.

getStateVersion

public int getStateVersion()

Returns the stateVersion of the instrumentable. The state version will be incremented each time any of the configuration of the instrumentable or any of its children is modified. Clients can use this value to tell whether or not anything has changed without having to do an exhaustive comparison.

Returns:

The state version of the instrumentable.