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.excalibur.source.Source;
20: import org.apache.excalibur.source.SourceException;
21:
22: /**
23: * A source, which can be a directory or collection of sources.
24: *
25: * @deprecated use the one from excalibur sourceresolve instead
26: * @author <a href="mailto:stephan@apache.org">Stephan Michels</a>
27: * @version CVS $Id: TraversableSource.java 433543 2006-08-22 06:22:54Z crossley $
28: */
29: public interface TraversableSource extends Source {
30:
31: /**
32: * If the source a directory or a collection
33: */
34: public boolean isSourceCollection() throws SourceException;
35:
36: /**
37: * Returns the count of child sources.
38: */
39: public int getChildSourceCount() throws SourceException;
40:
41: /**
42: * Return the system id of a child source.
43: *
44: * @param index Index of the child
45: */
46: public String getChildSource(int index) throws SourceException;
47:
48: /**
49: * Return the system id of the parent source. The method should return
50: * null if the source has no parent.
51: */
52: public String getParentSource();
53: }
|