Index: Searchable.java =================================================================== --- Searchable.java (revision 154651) +++ Searchable.java (working copy) @@ -24,14 +24,20 @@ /** The interface for search implementations. * - *

Implementations provide search over a single index, over multiple + *

Searchable is the abstract network protocol for searching. + * Implementations provide search over a single index, over multiple * indices, and over indices on remote servers. + * + *

Queries, filters and sort criteria are designed to be compact so that + * they may be efficiently passed to a remote index, with only the top-scoring + * hits being returned, rather than every non-zero scoring hit. */ public interface Searchable extends java.rmi.Remote { /** Lower-level search API. * *

{@link HitCollector#collect(int,float)} is called for every non-zero * scoring document. + *
HitCollector-based access to remote indexes is discouraged. * *

Applications should only use this if they need all of the * matching documents. The high-level search API ({@link Index: HitCollector.java =================================================================== --- HitCollector.java (revision 154651) +++ HitCollector.java (working copy) @@ -17,6 +17,8 @@ */ /** Lower-level search API. + *
HitCollectors are primarily meant to be used to implement queries, + * sorting and filtering. * @see Searcher#search(Query,HitCollector) * @version $Id$ */