KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > components > source > TraversableSource


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.components.source;
17
18 import org.apache.excalibur.source.Source;
19 import org.apache.excalibur.source.SourceException;
20
21 /**
22  * A source, which can be a directory or collection of sources.
23  *
24  * @deprecated use the one from excalibur sourceresolve instead
25  * @author <a HREF="mailto:stephan@apache.org">Stephan Michels</a>
26  * @version CVS $Id: TraversableSource.java 30932 2004-07-29 17:35:38Z vgritsenko $
27  */
28 public interface TraversableSource extends Source {
29
30     /**
31      * If the source a directory or a collection
32      */
33     public boolean isSourceCollection() throws SourceException;
34
35     /**
36      * Returns the count of child sources.
37      */
38     public int getChildSourceCount() throws SourceException;
39
40     /**
41      * Return the system id of a child source.
42      *
43      * @param index Index of the child
44      */
45     public String JavaDoc getChildSource(int index) throws SourceException;
46
47     /**
48      * Return the system id of the parent source. The method should return
49      * null if the source has no parent.
50      */
51     public String JavaDoc getParentSource();
52 }
53
54
Popular Tags