KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > instrument > manager > InstrumentManagerClientLocalImpl


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6  
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11  
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14  
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18  
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24  
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29  
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33  
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48  
49 */
50 package org.apache.excalibur.instrument.manager;
51
52 import org.apache.excalibur.instrument.manager.interfaces.InstrumentDescriptor;
53 import org.apache.excalibur.instrument.manager.interfaces.InstrumentSampleDescriptor;
54 import org.apache.excalibur.instrument.manager.interfaces.InstrumentableDescriptor;
55 import org.apache.excalibur.instrument.manager.interfaces.NoSuchInstrumentException;
56 import org.apache.excalibur.instrument.manager.interfaces.NoSuchInstrumentSampleException;
57 import org.apache.excalibur.instrument.manager.interfaces.NoSuchInstrumentableException;
58
59 /**
60  *
61  * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a>
62  * @version CVS $Revision: 1.5 $ $Date: 2003/02/25 16:28:16 $
63  * @since 4.1
64  */
65 public class InstrumentManagerClientLocalImpl
66     implements InstrumentManagerClientLocal
67 {
68     private DefaultInstrumentManager m_manager;
69     
70     /*---------------------------------------------------------------
71      * Constructors
72      *-------------------------------------------------------------*/
73     public InstrumentManagerClientLocalImpl( DefaultInstrumentManager manager )
74     {
75         m_manager = manager;
76     }
77     
78     /*---------------------------------------------------------------
79      * InstrumentManagerClient Methods
80      *-------------------------------------------------------------*/
81     /**
82      * Returns the name used to identify this InstrumentManager.
83      *
84      * @return The name used to identify this InstrumentManager.
85      */
86     public String JavaDoc getName()
87     {
88         return m_manager.getName();
89     }
90     
91     /**
92      * Returns the description of this InstrumentManager.
93      *
94      * @return The description of this InstrumentManager.
95      */
96     public String JavaDoc getDescription()
97     {
98         return m_manager.getDescription();
99     }
100     
101     /**
102      * Returns a InstrumentableDescriptor based on its name or the name of any
103      * of its children.
104      *
105      * @param instrumentableName Name of the Instrumentable being requested.
106      *
107      * @return A Descriptor of the requested Instrumentable.
108      *
109      * @throws NoSuchInstrumentableException If the specified Instrumentable does
110      * not exist.
111      */
112     public InstrumentableDescriptor getInstrumentableDescriptor( String JavaDoc instrumentableName )
113         throws NoSuchInstrumentableException
114     {
115         return getInstrumentableDescriptorLocal( instrumentableName );
116     }
117
118     /**
119      * Returns an array of Descriptors for the Instrumentables managed by this
120      * InstrumentManager.
121      *
122      * @return An array of Descriptors for the Instrumentables managed by this
123      * InstrumentManager.
124      */
125     public InstrumentableDescriptor[] getInstrumentableDescriptors()
126     {
127         return getInstrumentableDescriptorLocals();
128     }
129     
130     /**
131      * Searches the entire instrument tree an instrumentable with the given
132      * name.
133      *
134      * @param instrumentableName Name of the Instrumentable being requested.
135      *
136      * @return A Descriptor of the requested Instrumentable.
137      *
138      * @throws NoSuchInstrumentableException If the specified Instrumentable does
139      * not exist.
140      */
141     public InstrumentableDescriptor locateInstrumentableDescriptor( String JavaDoc instrumentableName )
142         throws NoSuchInstrumentableException
143     {
144         return locateInstrumentableDescriptorLocal( instrumentableName );
145     }
146     
147     /**
148      * Searches the entire instrument tree an instrument with the given name.
149      *
150      * @param instrumentName Name of the Instrument being requested.
151      *
152      * @return A Descriptor of the requested Instrument.
153      *
154      * @throws NoSuchInstrumentException If the specified Instrument does
155      * not exist.
156      */
157     public InstrumentDescriptor locateInstrumentDescriptor( String JavaDoc instrumentName )
158         throws NoSuchInstrumentException
159     {
160         return locateInstrumentDescriptorLocal( instrumentName );
161     }
162
163     /**
164      * Searches the entire instrument tree an instrument sample with the given
165      * name.
166      *
167      * @param sampleName Name of the Instrument Sample being requested.
168      *
169      * @return A Descriptor of the requested Instrument Sample.
170      *
171      * @throws NoSuchInstrumentSampleException If the specified Instrument
172      * Sample does not exist.
173      */
174     public InstrumentSampleDescriptor locateInstrumentSampleDescriptor( String JavaDoc sampleName )
175         throws NoSuchInstrumentSampleException
176     {
177         return locateInstrumentSampleDescriptorLocal( sampleName );
178     }
179     
180     /**
181      * Returns the stateVersion of the instrument manager. The state version
182      * will be incremented each time any of the configuration of the
183      * instrument manager or any of its children is modified.
184      * Clients can use this value to tell whether or not anything has
185      * changed without having to do an exhaustive comparison.
186      *
187      * @return The state version of the instrument manager.
188      */
189     public int getStateVersion()
190     {
191         return m_manager.getStateVersion();
192     }
193     
194     /**
195      * Invokes garbage collection.
196      */
197     public void invokeGarbageCollection()
198     {
199         m_manager.invokeGarbageCollection();
200     }
201     
202     /*---------------------------------------------------------------
203      * InstrumentManagerClientLocal Methods
204      *-------------------------------------------------------------*/
205     /**
206      * Returns a InstrumentableDescriptorLocal based on its name or the name
207      * of any of its children.
208      *
209      * @param instrumentableName Name of the Instrumentable being requested.
210      *
211      * @return A Descriptor of the requested Instrumentable.
212      *
213      * @throws NoSuchInstrumentableException If the specified Instrumentable does
214      * not exist.
215      */
216     public InstrumentableDescriptorLocal getInstrumentableDescriptorLocal(
217                                                     String JavaDoc instrumentableName )
218         throws NoSuchInstrumentableException
219     {
220         return m_manager.getInstrumentableDescriptor( instrumentableName );
221     }
222
223     /**
224      * Returns an array of Descriptors for the Instrumentables managed by this
225      * InstrumentManager.
226      *
227      * @return An array of Descriptors for the Instrumentables managed by this
228      * InstrumentManager.
229      */
230     public InstrumentableDescriptorLocal[] getInstrumentableDescriptorLocals()
231     {
232         return m_manager.getInstrumentableDescriptors();
233     }
234     
235     /**
236      * Searches the entire instrument tree an instrumentable with the given
237      * name.
238      *
239      * @param instrumentableName Name of the Instrumentable being requested.
240      *
241      * @return A Descriptor of the requested Instrumentable.
242      *
243      * @throws NoSuchInstrumentableException If the specified Instrumentable does
244      * not exist.
245      */
246     public InstrumentableDescriptorLocal locateInstrumentableDescriptorLocal(
247                                                 String JavaDoc instrumentableName )
248         throws NoSuchInstrumentableException
249     {
250         return m_manager.locateInstrumentableDescriptor( instrumentableName );
251     }
252     
253     /**
254      * Searches the entire instrument tree an instrument with the given name.
255      *
256      * @param instrumentName Name of the Instrument being requested.
257      *
258      * @return A Descriptor of the requested Instrument.
259      *
260      * @throws NoSuchInstrumentException If the specified Instrument does
261      * not exist.
262      */
263     public InstrumentDescriptorLocal locateInstrumentDescriptorLocal( String JavaDoc instrumentName )
264         throws NoSuchInstrumentException
265     {
266         return m_manager.locateInstrumentDescriptor( instrumentName );
267     }
268
269     /**
270      * Searches the entire instrument tree an instrument sample with the given
271      * name.
272      *
273      * @param sampleName Name of the Instrument Sample being requested.
274      *
275      * @return A Descriptor of the requested Instrument Sample.
276      *
277      * @throws NoSuchInstrumentSampleException If the specified Instrument
278      * Sample does not exist.
279      */
280     public InstrumentSampleDescriptorLocal locateInstrumentSampleDescriptorLocal(
281                                                 String JavaDoc sampleName )
282         throws NoSuchInstrumentSampleException
283     {
284         return m_manager.locateInstrumentSampleDescriptor( sampleName );
285     }
286 }
287
288
Popular Tags