KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > slide > search > basic > ComparableResourcesPool


1 /*
2  * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/search/basic/ComparableResourcesPool.java,v 1.3 2004/07/28 09:35:02 ib Exp $
3  * $Revision: 1.3 $
4  * $Date: 2004/07/28 09:35:02 $
5  *
6  * ====================================================================
7  *
8  * Copyright 1999-2002 The Apache Software Foundation
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License");
11  * you may not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS,
18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  *
22  */
23
24
25 package org.apache.slide.search.basic;
26 import org.apache.slide.search.*;
27
28 import java.util.Set JavaDoc;
29 import java.util.Iterator JavaDoc;
30
31 /**
32  * Represents the pool of all resources out of which the query result is
33  * computed. This may be the complete scope of the query or a subset, when
34  * the server the maximum depth of a query.
35  *
36  * @version $Revision: 1.3 $
37  */
38 public interface ComparableResourcesPool {
39     
40     /**
41      * Method resourceIterator
42      *
43      * @return an Iterator over RequestedResource objects
44      *
45      */
46     Iterator JavaDoc resourceIterator ();
47     
48     /**
49      * Method getPool
50      *
51      * @return the pool as Set of RequestedResource objects.
52      *
53      * @throws BadQueryException
54      *
55      */
56     Set JavaDoc getPool () throws BadQueryException ;
57     
58     
59     /**
60      * Indicates if the server truncated the result set.
61      *
62      * @return a boolean
63      *
64      */
65     boolean partialResult ();
66     
67     /**
68      * Returns the scope of this ResourcePool.
69      *
70      * @return the scope of this ResourcePool.
71      */
72     QueryScope getScope();
73 }
74
75
Popular Tags