dnaber 2004/12/14 11:00:01
Modified: src/java/org/apache/lucene/search Searcher.java
Searchable.java
Log:
document that TooManyClauses is thrown by several methods
Revision Changes Path
1.13 +10 -2
jakarta-lucene/src/java/org/apache/lucene/search/Searcher.java
Index: Searcher.java
===================================================================
RCS file:
/home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/Searcher.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- Searcher.java 29 Mar 2004 22:48:04 -0000 1.12
+++ Searcher.java 14 Dec 2004 19:00:01 -0000 1.13
@@ -22,19 +22,25 @@
* Implements some common utility methods.
*/
public abstract class Searcher implements Searchable {
- /** Returns the documents matching <code>query</code>. */
+
+ /** Returns the documents matching <code>query</code>.
+ * @throws BooleanQuery.TooManyClauses
+ */
public final Hits search(Query query) throws IOException {
return search(query, (Filter)null);
}
/** Returns the documents matching <code>query</code> and
- <code>filter</code>. */
+ * <code>filter</code>.
+ * @throws BooleanQuery.TooManyClauses
+ */
public Hits search(Query query, Filter filter) throws IOException {
return new Hits(this, query, filter);
}
/** Returns documents matching <code>query</code> sorted by
* <code>sort</code>.
+ * @throws BooleanQuery.TooManyClauses
*/
public Hits search(Query query, Sort sort)
throws IOException {
@@ -43,6 +49,7 @@
/** Returns documents matching <code>query</code> and <code>filter</code>,
* sorted by <code>sort</code>.
+ * @throws BooleanQuery.TooManyClauses
*/
public Hits search(Query query, Filter filter, Sort sort)
throws IOException {
@@ -61,6 +68,7 @@
* <p>Note: The <code>score</code> passed to this method is a raw score.
* In other words, the score will not necessarily be a float whose value is
* between 0 and 1.
+ * @throws BooleanQuery.TooManyClauses
*/
public void search(Query query, HitCollector results)
throws IOException {
1.13 +7 -1
jakarta-lucene/src/java/org/apache/lucene/search/Searchable.java
Index: Searchable.java
===================================================================
RCS file:
/home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/Searchable.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- Searchable.java 6 Aug 2004 20:09:19 -0000 1.12
+++ Searchable.java 14 Dec 2004 19:00:01 -0000 1.13
@@ -41,6 +41,7 @@
* @param query to match documents
* @param filter if non-null, a bitset used to eliminate some documents
* @param results to receive hits
+ * @throws BooleanQuery.TooManyClauses
*/
void search(Query query, Filter filter, HitCollector results)
throws IOException;
@@ -70,6 +71,7 @@
*
* <p>Applications should usually call [EMAIL PROTECTED]
Searcher#search(Query)} or
* [EMAIL PROTECTED] Searcher#search(Query,Filter)} instead.
+ * @throws BooleanQuery.TooManyClauses
*/
TopDocs search(Query query, Filter filter, int n) throws IOException;
@@ -79,7 +81,9 @@
*/
Document doc(int i) throws IOException;
- /** Expert: called to re-write queries into primitive queries. */
+ /** Expert: called to re-write queries into primitive queries.
+ * @throws BooleanQuery.TooManyClauses
+ */
Query rewrite(Query query) throws IOException;
/** Returns an Explanation that describes how <code>doc</code> scored
against
@@ -89,6 +93,7 @@
* and, for good performance, should not be displayed with every hit.
* Computing an explanation is as expensive as executing the query over the
* entire index.
+ * @throws BooleanQuery.TooManyClauses
*/
Explanation explain(Query query, int doc) throws IOException;
@@ -99,6 +104,7 @@
*
* <p>Applications should usually call [EMAIL PROTECTED]
* Searcher#search(Query,Filter,Sort)} instead.
+ * @throws BooleanQuery.TooManyClauses
*/
TopFieldDocs search(Query query, Filter filter, int n, Sort sort)
throws IOException;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
