Revision: 14556
http://gate.svn.sourceforge.net/gate/?rev=14556&view=rev
Author: valyt
Date: 2011-11-16 16:01:16 +0000 (Wed, 16 Nov 2011)
Log Message:
-----------
Better comments.
Modified Paths:
--------------
mimir/trunk/mimir-core/src/gate/mimir/search/QueryRunner.java
Modified: mimir/trunk/mimir-core/src/gate/mimir/search/QueryRunner.java
===================================================================
--- mimir/trunk/mimir-core/src/gate/mimir/search/QueryRunner.java
2011-11-16 02:18:18 UTC (rev 14555)
+++ mimir/trunk/mimir-core/src/gate/mimir/search/QueryRunner.java
2011-11-16 16:01:16 UTC (rev 14556)
@@ -14,8 +14,6 @@
*/
package gate.mimir.search;
-
-
import gate.mimir.DocumentMetadataHelper;
import gate.mimir.index.IndexException;
import gate.mimir.search.query.Binding;
@@ -27,8 +25,6 @@
import java.util.Map;
import java.util.Set;
-
-
/**
* A QueryRunner object can be used to execute a query in a separate thread.
The
* query execution will be performed in stages, each being limited to a given
@@ -37,6 +33,14 @@
* each document. The hits already collected can be accessed in a random
* fashion.
*
+ * N.B. Documents are referred to in two different manners:
+ * <ul>
+ * <li>by documentId: the ID associated with the document at indexing time,
+ * which never changes</li>
+ * <li>by index: the index in the list of documents found to contain
hits.</li>
+ * </ul>
+ * You can tell which addressing scheme is used based on the of the parameter.
+ *
* Implementations of this interface must be thread-safe!
*/
public interface QueryRunner {
@@ -60,11 +64,14 @@
*
* If the query execution is currently in progress (i.e. a previous search
* stage has not yet finished), this call will have no effect. If a previous
- * query execution has completed, this call will cause it to restart,
- * accumulating more hits.
+ * query execution stage has ended, this call will cause the search to
+ * restart, accumulating more hits. If the search had finished, this call
+ * will have no effect.
*
* @see #setMaxHits(int)
* @see #setTimeout(int)
+ * @see #isActive()
+ * @see #isComplete()
*
* @throws IOException
*/
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure
contains a definitive record of customers, application performance,
security threats, fraudulent activity, and more. Splunk takes this
data and makes sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-novd2d
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
