01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.components.profiler;
18:
19: import org.apache.avalon.framework.component.Component;
20:
21: import java.util.Collection;
22:
23: /**
24: * Profiler component interface.
25: *
26: * @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
27: * @author <a href="mailto:stephan@apache.org">Stephan Michels</a>
28: * @version CVS $Id: Profiler.java 433543 2006-08-22 06:22:54Z crossley $
29: */
30: public interface Profiler extends Component {
31: String ROLE = Profiler.class.getName();
32:
33: /**
34: * Clear the results.
35: */
36: void clearResults();
37:
38: /**
39: * Remove a specified result.
40: *
41: * @param key Key of the result.
42: */
43: void clearResult(Object key);
44:
45: /**
46: * Add a result for a request.
47: *
48: * @param uri URI of the request
49: * @param data Result of the profiling
50: */
51: void addResult(String uri, ProfilerData data);
52:
53: /**
54: * Returns a collection of all keys
55: *
56: * @return Keys of all results.
57: */
58: Collection getResultKeys();
59:
60: /**
61: * Returns a collection of the results.
62: *
63: * @return Collection of results.
64: */
65: Collection getResults();
66:
67: /**
68: * Returns a result of a specifed key.
69: *
70: * @param key Key of the result.
71: * @return Result.
72: */
73: ProfilerResult getResult(Object key);
74: }
|