Java docs

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
harshavamsi · Jun 11, 2024 · 2068f43 · 2068f43
1 parent cdd1a0f
commit 2068f43
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/search/approximate/ApproximatePointRangeQuery.java b/server/src/main/java/org/opensearch/search/approximate/ApproximatePointRangeQuery.java
@@ -15,6 +15,7 @@
 import org.apache.lucene.search.ConstantScoreWeight;
 import org.apache.lucene.search.DocIdSetIterator;
 import org.apache.lucene.search.IndexSearcher;
+import org.apache.lucene.search.PointRangeQuery;
 import org.apache.lucene.search.Query;
 import org.apache.lucene.search.QueryVisitor;
 import org.apache.lucene.search.ScoreMode;
@@ -33,6 +34,10 @@
 
 import static org.apache.lucene.search.PointRangeQuery.checkArgs;
 
+/**
+ * An approximate-able version of {@link PointRangeQuery}. It creates an instance of {@link PointRangeQuery} but short-circuits the intersect logic
+ * after {@code size} is hit
+ */
 public abstract class ApproximatePointRangeQuery extends Query {
     final String field;
     final int numDims;