org.apache.slide.search.basic
Interface ComparableResourcesPool

All Known Implementing Classes:
ComparableResourcesPoolImpl

public interface ComparableResourcesPool

Represents the pool of all resources out of which the query result is computed. This may be the complete scope of the query or a subset, when the server the maximum depth of a query.

Version:
$Revision: 1.3 $

Method Summary
 java.util.Set getPool()
          Method getPool
 QueryScope getScope()
          Returns the scope of this ResourcePool.
 boolean partialResult()
          Indicates if the server truncated the result set.
 java.util.Iterator resourceIterator()
          Method resourceIterator
 

Method Detail

resourceIterator

public java.util.Iterator resourceIterator()
Method resourceIterator

Returns:
an Iterator over RequestedResource objects

getPool

public java.util.Set getPool()
                      throws BadQueryException
Method getPool

Returns:
the pool as Set of RequestedResource objects.
Throws:
BadQueryException

partialResult

public boolean partialResult()
Indicates if the server truncated the result set.

Returns:
a boolean

getScope

public QueryScope getScope()
Returns the scope of this ResourcePool.

Returns:
the scope of this ResourcePool.