You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by kr...@apache.org on 2017/01/06 21:47:24 UTC
[04/25] lucene-solr:jira/solr-8593: SOLR-8530: Fixed javadoc
SOLR-8530: Fixed javadoc
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/390a01b0
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/390a01b0
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/390a01b0
Branch: refs/heads/jira/solr-8593
Commit: 390a01b0fea0dda8d231d165a929ff937d7a8928
Parents: 5bbd4d6
Author: Joel Bernstein <jb...@apache.org>
Authored: Tue Jan 3 14:52:30 2017 -0500
Committer: Joel Bernstein <jb...@apache.org>
Committed: Tue Jan 3 15:06:14 2017 -0500
----------------------------------------------------------------------
.../client/solrj/io/ops/BooleanOperation.java | 6 ++++--
.../client/solrj/io/stream/HavingStream.java | 21 ++------------------
2 files changed, 6 insertions(+), 21 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/390a01b0/solr/solrj/src/java/org/apache/solr/client/solrj/io/ops/BooleanOperation.java
----------------------------------------------------------------------
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/io/ops/BooleanOperation.java b/solr/solrj/src/java/org/apache/solr/client/solrj/io/ops/BooleanOperation.java
index 609e4e1..d455999 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/io/ops/BooleanOperation.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/io/ops/BooleanOperation.java
@@ -16,8 +16,10 @@
*/
package org.apache.solr.client.solrj.io.ops;
-import org.apache.solr.client.solrj.io.Tuple;
-
+/**
+ * A BooleanOperation returns true or false for each tuple that it evaluates. The HavingStream applies a BooleanOperation to
+ * determine which tuples to emit.
+ */
public interface BooleanOperation extends StreamOperation {
public abstract boolean evaluate();
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/390a01b0/solr/solrj/src/java/org/apache/solr/client/solrj/io/stream/HavingStream.java
----------------------------------------------------------------------
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/io/stream/HavingStream.java b/solr/solrj/src/java/org/apache/solr/client/solrj/io/stream/HavingStream.java
index 36ca113..38c1a6b 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/io/stream/HavingStream.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/io/stream/HavingStream.java
@@ -22,12 +22,7 @@ import java.util.List;
import java.util.Locale;
import org.apache.solr.client.solrj.io.Tuple;
-import org.apache.solr.client.solrj.io.comp.FieldComparator;
-import org.apache.solr.client.solrj.io.comp.MultipleFieldComparator;
import org.apache.solr.client.solrj.io.comp.StreamComparator;
-import org.apache.solr.client.solrj.io.eq.FieldEqualitor;
-import org.apache.solr.client.solrj.io.eq.MultipleFieldEqualitor;
-import org.apache.solr.client.solrj.io.eq.StreamEqualitor;
import org.apache.solr.client.solrj.io.ops.BooleanOperation;
import org.apache.solr.client.solrj.io.ops.StreamOperation;
import org.apache.solr.client.solrj.io.stream.expr.Explanation;
@@ -35,23 +30,11 @@ import org.apache.solr.client.solrj.io.stream.expr.Explanation.ExpressionType;
import org.apache.solr.client.solrj.io.stream.expr.Expressible;
import org.apache.solr.client.solrj.io.stream.expr.StreamExplanation;
import org.apache.solr.client.solrj.io.stream.expr.StreamExpression;
-import org.apache.solr.client.solrj.io.stream.expr.StreamExpressionNamedParameter;
-import org.apache.solr.client.solrj.io.stream.expr.StreamExpressionValue;
import org.apache.solr.client.solrj.io.stream.expr.StreamFactory;
/**
- * Iterates over a TupleStream and buffers Tuples that are equal based on a comparator.
- * This allows tuples to be grouped by common field(s).
- *
- * The read() method emits one tuple per group. The fields of the emitted Tuple reflect the first tuple
- * encountered in the group.
- *
- * Use the Tuple.getMaps() method to return all the Tuples in the group. This method returns
- * a list of maps (including the group head), which hold the data for each Tuple in the group.
- *
- * Note: The ReducerStream requires that it's underlying stream be sorted and partitioned by the same
- * fields as it's comparator.
- *
+ * The HavingStream iterates over an internal stream and applies a BooleanOperation to each tuple. If the BooleanOperation
+ * evaluates to true then the HavingStream emits the tuple, if it returns false the tuple is not emitted.
**/
public class HavingStream extends TupleStream implements Expressible {