Keel 2.1RC2

org.apache.excalibur.instrument.manager
Class InstrumentManagerClientLocalImpl

java.lang.Object
  extended byorg.apache.excalibur.instrument.manager.InstrumentManagerClientLocalImpl
All Implemented Interfaces:
InstrumentManagerClient, InstrumentManagerClientLocal

public class InstrumentManagerClientLocalImpl
extends java.lang.Object
implements InstrumentManagerClientLocal

Since:
4.1
Version:
CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:25 $
Author:

Field Summary
private  DefaultInstrumentManager m_manager
           
 
Fields inherited from interface org.apache.excalibur.instrument.manager.interfaces.InstrumentManagerClient
INSTRUMENT_SAMPLE_TYPE_COUNTER, INSTRUMENT_SAMPLE_TYPE_MAXIMUM, INSTRUMENT_SAMPLE_TYPE_MEAN, INSTRUMENT_SAMPLE_TYPE_MINIMUM, INSTRUMENT_TYPE_COUNTER, INSTRUMENT_TYPE_NONE, INSTRUMENT_TYPE_VALUE
 
Constructor Summary
InstrumentManagerClientLocalImpl(DefaultInstrumentManager manager)
           
 
Method Summary
 java.lang.String getDescription()
          Returns the description of this InstrumentManager.
 InstrumentableDescriptor getInstrumentableDescriptor(java.lang.String instrumentableName)
          Returns a InstrumentableDescriptor based on its name or the name of any of its children.
 InstrumentableDescriptorLocal getInstrumentableDescriptorLocal(java.lang.String instrumentableName)
          Returns a InstrumentableDescriptorLocal based on its name or the name of any of its children.
 InstrumentableDescriptorLocal[] getInstrumentableDescriptorLocals()
          Returns an array of Descriptors for the Instrumentables managed by this InstrumentManager.
 InstrumentableDescriptor[] getInstrumentableDescriptors()
          Returns an array of Descriptors for the Instrumentables managed by this InstrumentManager.
 java.lang.String getName()
          Returns the name used to identify this InstrumentManager.
 int getStateVersion()
          Returns the stateVersion of the instrument manager.
 void invokeGarbageCollection()
          Invokes garbage collection.
 InstrumentableDescriptor locateInstrumentableDescriptor(java.lang.String instrumentableName)
          Searches the entire instrument tree an instrumentable with the given name.
 InstrumentableDescriptorLocal locateInstrumentableDescriptorLocal(java.lang.String instrumentableName)
          Searches the entire instrument tree an instrumentable with the given name.
 InstrumentDescriptor locateInstrumentDescriptor(java.lang.String instrumentName)
          Searches the entire instrument tree an instrument with the given name.
 InstrumentDescriptorLocal locateInstrumentDescriptorLocal(java.lang.String instrumentName)
          Searches the entire instrument tree an instrument with the given name.
 InstrumentSampleDescriptor locateInstrumentSampleDescriptor(java.lang.String sampleName)
          Searches the entire instrument tree an instrument sample with the given name.
 InstrumentSampleDescriptorLocal locateInstrumentSampleDescriptorLocal(java.lang.String sampleName)
          Searches the entire instrument tree an instrument sample with the given name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_manager

private DefaultInstrumentManager m_manager
Constructor Detail

InstrumentManagerClientLocalImpl

public InstrumentManagerClientLocalImpl(DefaultInstrumentManager manager)
Method Detail

getName

public java.lang.String getName()
Returns the name used to identify this InstrumentManager.

Specified by:
getName in interface InstrumentManagerClient
Returns:
The name used to identify this InstrumentManager.

getDescription

public java.lang.String getDescription()
Returns the description of this InstrumentManager.

Specified by:
getDescription in interface InstrumentManagerClient
Returns:
The description of this InstrumentManager.

getInstrumentableDescriptor

public InstrumentableDescriptor getInstrumentableDescriptor(java.lang.String instrumentableName)
                                                     throws NoSuchInstrumentableException
Returns a InstrumentableDescriptor based on its name or the name of any of its children.

Specified by:
getInstrumentableDescriptor in interface InstrumentManagerClient
Parameters:
instrumentableName - Name of the Instrumentable being requested.
Returns:
A Descriptor of the requested Instrumentable.
Throws:
NoSuchInstrumentableException - If the specified Instrumentable does not exist.

getInstrumentableDescriptors

public InstrumentableDescriptor[] getInstrumentableDescriptors()
Returns an array of Descriptors for the Instrumentables managed by this InstrumentManager.

Specified by:
getInstrumentableDescriptors in interface InstrumentManagerClient
Returns:
An array of Descriptors for the Instrumentables managed by this InstrumentManager.

locateInstrumentableDescriptor

public InstrumentableDescriptor locateInstrumentableDescriptor(java.lang.String instrumentableName)
                                                        throws NoSuchInstrumentableException
Searches the entire instrument tree an instrumentable with the given name.

Specified by:
locateInstrumentableDescriptor in interface InstrumentManagerClient
Parameters:
instrumentableName - Name of the Instrumentable being requested.
Returns:
A Descriptor of the requested Instrumentable.
Throws:
NoSuchInstrumentableException - If the specified Instrumentable does not exist.

locateInstrumentDescriptor

public InstrumentDescriptor locateInstrumentDescriptor(java.lang.String instrumentName)
                                                throws NoSuchInstrumentException
Searches the entire instrument tree an instrument with the given name.

Specified by:
locateInstrumentDescriptor in interface InstrumentManagerClient
Parameters:
instrumentName - Name of the Instrument being requested.
Returns:
A Descriptor of the requested Instrument.
Throws:
NoSuchInstrumentException - If the specified Instrument does not exist.

locateInstrumentSampleDescriptor

public InstrumentSampleDescriptor locateInstrumentSampleDescriptor(java.lang.String sampleName)
                                                            throws NoSuchInstrumentSampleException
Searches the entire instrument tree an instrument sample with the given name.

Specified by:
locateInstrumentSampleDescriptor in interface InstrumentManagerClient
Parameters:
sampleName - Name of the Instrument Sample being requested.
Returns:
A Descriptor of the requested Instrument Sample.
Throws:
NoSuchInstrumentSampleException - If the specified Instrument Sample does not exist.

getStateVersion

public int getStateVersion()
Returns the stateVersion of the instrument manager. The state version will be incremented each time any of the configuration of the instrument manager 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.

Specified by:
getStateVersion in interface InstrumentManagerClient
Returns:
The state version of the instrument manager.

invokeGarbageCollection

public void invokeGarbageCollection()
Invokes garbage collection.

Specified by:
invokeGarbageCollection in interface InstrumentManagerClient

getInstrumentableDescriptorLocal

public InstrumentableDescriptorLocal getInstrumentableDescriptorLocal(java.lang.String instrumentableName)
                                                               throws NoSuchInstrumentableException
Returns a InstrumentableDescriptorLocal based on its name or the name of any of its children.

Specified by:
getInstrumentableDescriptorLocal in interface InstrumentManagerClientLocal
Parameters:
instrumentableName - Name of the Instrumentable being requested.
Returns:
A Descriptor of the requested Instrumentable.
Throws:
NoSuchInstrumentableException - If the specified Instrumentable does not exist.

getInstrumentableDescriptorLocals

public InstrumentableDescriptorLocal[] getInstrumentableDescriptorLocals()
Returns an array of Descriptors for the Instrumentables managed by this InstrumentManager.

Specified by:
getInstrumentableDescriptorLocals in interface InstrumentManagerClientLocal
Returns:
An array of Descriptors for the Instrumentables managed by this InstrumentManager.

locateInstrumentableDescriptorLocal

public InstrumentableDescriptorLocal locateInstrumentableDescriptorLocal(java.lang.String instrumentableName)
                                                                  throws NoSuchInstrumentableException
Searches the entire instrument tree an instrumentable with the given name.

Specified by:
locateInstrumentableDescriptorLocal in interface InstrumentManagerClientLocal
Parameters:
instrumentableName - Name of the Instrumentable being requested.
Returns:
A Descriptor of the requested Instrumentable.
Throws:
NoSuchInstrumentableException - If the specified Instrumentable does not exist.

locateInstrumentDescriptorLocal

public InstrumentDescriptorLocal locateInstrumentDescriptorLocal(java.lang.String instrumentName)
                                                          throws NoSuchInstrumentException
Searches the entire instrument tree an instrument with the given name.

Specified by:
locateInstrumentDescriptorLocal in interface InstrumentManagerClientLocal
Parameters:
instrumentName - Name of the Instrument being requested.
Returns:
A Descriptor of the requested Instrument.
Throws:
NoSuchInstrumentException - If the specified Instrument does not exist.

locateInstrumentSampleDescriptorLocal

public InstrumentSampleDescriptorLocal locateInstrumentSampleDescriptorLocal(java.lang.String sampleName)
                                                                      throws NoSuchInstrumentSampleException
Searches the entire instrument tree an instrument sample with the given name.

Specified by:
locateInstrumentSampleDescriptorLocal in interface InstrumentManagerClientLocal
Parameters:
sampleName - Name of the Instrument Sample being requested.
Returns:
A Descriptor of the requested Instrument Sample.
Throws:
NoSuchInstrumentSampleException - If the specified Instrument Sample does not exist.

Keel 2.1RC2

Please see keelframework.org for information about new Keel releases.