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.source;
18:
19: import org.apache.avalon.framework.component.Component;
20: import org.apache.cocoon.components.source.helpers.SourceProperty;
21: import org.apache.excalibur.source.Source;
22: import org.apache.excalibur.source.SourceException;
23: import org.apache.excalibur.source.SourceValidity;
24:
25: /**
26: * A source inspector exposes source properties.
27: *
28: * @author <a href="mailto:stephan@apache.org">Stephan Michels</a>
29: * @author <a href="mailto:unico@apache.org">Unico Hommes</a>
30: * @version CVS $Id: SourceInspector.java 433543 2006-08-22 06:22:54Z crossley $
31: */
32: public interface SourceInspector extends Component {
33:
34: public final static String ROLE = "org.apache.cocoon.components.source.SourceInspector";
35:
36: /**
37: * Gets the SourceProperty associated with the given Source identified
38: * by the requested namespace and name.
39: *
40: * @param source the source for which to compute the property
41: * @param namespace the namespace of the property
42: * @param name the name of the property
43: * @return the SourceProperty associated with the Source, <code>null</code>
44: * if the inspector does not provide this property.
45: * @throws SourceException
46: */
47: public SourceProperty getSourceProperty(Source source,
48: String namespace, String name) throws SourceException;
49:
50: /**
51: * Gets all the SourceProperties associated with the given Source.
52: *
53: * @param source the Source for wich to compute the property.
54: * @return the collection of all SourceProperties that could be computed
55: * by this SourceInspector.
56: * @throws SourceException
57: */
58: public SourceProperty[] getSourceProperties(Source source)
59: throws SourceException;
60:
61: /**
62: * Check if this inspector handles the property of the given type.
63: *
64: * @param namespace the namespace of the property
65: * @param name the name of the property
66: * @return <code>true</code> if this inspector handles properties of the given type
67: * else <code>false</code>.
68: */
69: public boolean handlesProperty(String namespace, String name);
70:
71: /**
72: * Get the validity object that describes the validity state
73: * of the properties belonging to the given source.
74: *
75: * @param source the Source for which to calculate the validity
76: * its properties, <code>null</code> if the source properties
77: * are not cacheable.
78: */
79: public SourceValidity getValidity(Source source);
80: }
|