Make the visitor of the spatial triangle tree a public interface (#92349)

Author: iverase

x-pack/plugin/spatial/src/main/java/org/elasticsearch/xpack/spatial/index/fielddata/Component2DRelationVisitor.java

@@ -17,7 +17,7 @@
  * This class supports checking {@link Component2D} relations against a serialized triangle tree.
  * It does not support bounding boxes crossing the dateline.
  */
-class Component2DRelationVisitor extends TriangleTreeReader.DecodedVisitor {
+class Component2DRelationVisitor extends TriangleTreeVisitor.TriangleTreeDecodedVisitor {
 
     private GeoRelation relation;
     private Component2D component2D;
@@ -39,7 +39,7 @@ public GeoRelation relation() {
     }
 
     @Override
-    void visitDecodedPoint(double x, double y) {
+    protected void visitDecodedPoint(double x, double y) {
         if (component2D.contains(x, y)) {
             if (canBeContained()) {
                 relation = GeoRelation.QUERY_CONTAINS;
@@ -54,7 +54,7 @@ void visitDecodedPoint(double x, double y) {
     }
 
     @Override
-    void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
+    protected void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
         if (component2D.intersectsLine(aX, aY, bX, bY)) {
             final boolean ab = (metadata & 1 << 4) == 1 << 4;
             if (canBeContained() && component2D.containsLine(aX, aY, bX, bY)) {
@@ -70,7 +70,7 @@ void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata)
     }
 
     @Override
-    void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
+    protected void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
         if (component2D.intersectsTriangle(aX, aY, bX, bY, cX, cY)) {
             final boolean ab = (metadata & 1 << 4) == 1 << 4;
             final boolean bc = (metadata & 1 << 5) == 1 << 5;

x-pack/plugin/spatial/src/main/java/org/elasticsearch/xpack/spatial/index/fielddata/Component2DVisitor.java

@@ -12,10 +12,10 @@
 import org.apache.lucene.index.PointValues;
 
 /**
- * A {@link TriangleTreeReader.Visitor} implementation for {@link Component2D} geometries.
+ * A {@link TriangleTreeVisitor.TriangleTreeDecodedVisitor} implementation for {@link Component2D} geometries.
  * It can solve spatial relationships against a serialize triangle tree.
  */
-public abstract class Component2DVisitor extends TriangleTreeReader.DecodedVisitor {
+public abstract class Component2DVisitor extends TriangleTreeVisitor.TriangleTreeDecodedVisitor {
 
     protected final Component2D component2D;
 
@@ -31,23 +31,23 @@ private Component2DVisitor(Component2D component2D, CoordinateEncoder encoder) {
     public abstract void reset();
 
     @Override
-    public boolean pushDecodedX(double minX) {
+    protected boolean pushDecodedX(double minX) {
         return component2D.getMaxX() >= minX;
     }
 
     @Override
-    public boolean pushDecodedY(double minY) {
+    protected boolean pushDecodedY(double minY) {
         return component2D.getMaxY() >= minY;
     }
 
     @Override
-    public boolean pushDecoded(double maxX, double maxY) {
+    protected boolean pushDecoded(double maxX, double maxY) {
         return component2D.getMinX() <= maxX && component2D.getMinY() <= maxY;
 
     }
 
     @Override
-    public boolean pushDecoded(double minX, double minY, double maxX, double maxY) {
+    protected boolean pushDecoded(double minX, double minY, double maxX, double maxY) {
         return pushDecoded(component2D.relate(minX, maxX, minY, maxY));
     }
 
@@ -56,7 +56,7 @@ public boolean pushDecoded(double minX, double minY, double maxX, double maxY) {
      *
      * @return if true, the visitor keeps traversing the tree, else it stops.
      * */
-    abstract boolean pushDecoded(PointValues.Relation relation);
+    protected abstract boolean pushDecoded(PointValues.Relation relation);
 
     /**
      * Creates a visitor from the provided Component2D and spatial relationship. Visitors are re-usable by
@@ -95,17 +95,17 @@ public void reset() {
         }
 
         @Override
-        void visitDecodedPoint(double x, double y) {
+        protected void visitDecodedPoint(double x, double y) {
             intersects = component2D.contains(x, y);
         }
 
         @Override
-        void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
+        protected void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
             intersects = component2D.intersectsLine(aX, aY, bX, bY);
         }
 
         @Override
-        void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
+        protected void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
             intersects = component2D.intersectsTriangle(aX, aY, bX, bY, cX, cY);
         }
 
@@ -116,7 +116,7 @@ public boolean push() {
         }
 
         @Override
-        boolean pushDecoded(PointValues.Relation relation) {
+        protected boolean pushDecoded(PointValues.Relation relation) {
             if (relation == PointValues.Relation.CELL_OUTSIDE_QUERY) {
                 // shapes are disjoint, stop traversing the tree.
                 return false;
@@ -156,17 +156,17 @@ public void reset() {
         }
 
         @Override
-        void visitDecodedPoint(double x, double y) {
+        protected void visitDecodedPoint(double x, double y) {
             disjoint = component2D.contains(x, y) == false;
         }
 
         @Override
-        void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
+        protected void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
             disjoint = component2D.intersectsLine(aX, aY, bX, bY) == false;
         }
 
         @Override
-        void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
+        protected void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
             disjoint = component2D.intersectsTriangle(aX, aY, bX, bY, cX, cY) == false;
         }
 
@@ -177,7 +177,7 @@ public boolean push() {
         }
 
         @Override
-        boolean pushDecoded(PointValues.Relation relation) {
+        protected boolean pushDecoded(PointValues.Relation relation) {
             if (relation == PointValues.Relation.CELL_OUTSIDE_QUERY) {
                 // shapes are disjoint, stop traversing the tree.
                 return false;
@@ -217,17 +217,17 @@ public void reset() {
         }
 
         @Override
-        void visitDecodedPoint(double x, double y) {
+        protected void visitDecodedPoint(double x, double y) {
             within = component2D.contains(x, y);
         }
 
         @Override
-        void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
+        protected void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
             within = component2D.containsLine(aX, aY, bX, bY);
         }
 
         @Override
-        void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
+        protected void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
             within = component2D.containsTriangle(aX, aY, bX, bY, cX, cY);
         }
 
@@ -238,31 +238,31 @@ public boolean push() {
         }
 
         @Override
-        public boolean pushX(int minX) {
+        protected boolean pushDecodedX(double minX) {
             // if any part of the tree is skipped, then the doc value is not within the shape,
             // stop traversing the tree
-            within = super.pushX(minX);
+            within = super.pushDecodedX(minX);
             return within;
         }
 
         @Override
-        public boolean pushY(int minY) {
+        protected boolean pushDecodedY(double minY) {
             // if any part of the tree is skipped, then the doc value is not within the shape,
             // stop traversing the tree
-            within = super.pushY(minY);
+            within = super.pushDecodedY(minY);
             return within;
         }
 
         @Override
-        public boolean push(int maxX, int maxY) {
+        protected boolean pushDecoded(double maxX, double maxY) {
             // if any part of the tree is skipped, then the doc value is not within the shape,
             // stop traversing the tree
-            within = super.push(maxX, maxY);
+            within = super.pushDecoded(maxX, maxY);
             return within;
         }
 
         @Override
-        boolean pushDecoded(PointValues.Relation relation) {
+        protected boolean pushDecoded(PointValues.Relation relation) {
             if (relation == PointValues.Relation.CELL_OUTSIDE_QUERY) {
                 // shapes are disjoint, stop traversing the tree.
                 within = false;
@@ -297,7 +297,7 @@ public void reset() {
         }
 
         @Override
-        void visitDecodedPoint(double x, double y) {
+        protected void visitDecodedPoint(double x, double y) {
             final Component2D.WithinRelation rel = component2D.withinPoint(x, y);
             if (rel != Component2D.WithinRelation.DISJOINT) {
                 // Only override relationship if different to DISJOINT
@@ -306,7 +306,7 @@ void visitDecodedPoint(double x, double y) {
         }
 
         @Override
-        void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
+        protected void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
             final boolean ab = (metadata & 1 << 4) == 1 << 4;
             final Component2D.WithinRelation rel = component2D.withinLine(aX, aY, ab, bX, bY);
             if (rel != Component2D.WithinRelation.DISJOINT) {
@@ -316,7 +316,7 @@ void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata)
         }
 
         @Override
-        void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
+        protected void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
             final boolean ab = (metadata & 1 << 4) == 1 << 4;
             final boolean bc = (metadata & 1 << 5) == 1 << 5;
             final boolean ca = (metadata & 1 << 6) == 1 << 6;
@@ -334,7 +334,7 @@ public boolean push() {
         }
 
         @Override
-        boolean pushDecoded(PointValues.Relation relation) {
+        protected boolean pushDecoded(PointValues.Relation relation) {
             // Only traverse the tree if the shapes intersects.
             return relation == PointValues.Relation.CELL_CROSSES_QUERY;
         }

x-pack/plugin/spatial/src/main/java/org/elasticsearch/xpack/spatial/index/fielddata/GeoShapeValues.java

@@ -80,7 +80,7 @@ protected Component2D centroidAsComponent2D() throws IOException {
          */
         public GeoRelation relate(int minX, int maxX, int minY, int maxY) throws IOException {
             tile2DVisitor.reset(minX, minY, maxX, maxY);
-            reader.visit(tile2DVisitor);
+            visit(tile2DVisitor);
             return tile2DVisitor.relation();
         }
 

x-pack/plugin/spatial/src/main/java/org/elasticsearch/xpack/spatial/index/fielddata/GeometryDocValueReader.java

@@ -98,7 +98,7 @@ protected double getSumCentroidWeight() throws IOException {
     /**
      * Visit the triangle tree with the provided visitor
      */
-    public void visit(TriangleTreeReader.Visitor visitor) throws IOException {
+    public void visit(TriangleTreeVisitor visitor) throws IOException {
         Extent geometryExtent = getExtent();
         int thisMaxX = geometryExtent.maxX();
         int thisMinX = geometryExtent.minX();

x-pack/plugin/spatial/src/main/java/org/elasticsearch/xpack/spatial/index/fielddata/LabelPositionVisitor.java

@@ -17,41 +17,41 @@
  *
  * TODO: We could instead choose the point closer to the centroid which improves unbalanced trees
  */
-public class LabelPositionVisitor extends TriangleTreeReader.DecodedVisitor {
+class LabelPositionVisitor extends TriangleTreeVisitor.TriangleTreeDecodedVisitor {
 
     private SpatialPoint labelPosition;
     private final BiFunction<Double, Double, SpatialPoint> pointMaker;
 
-    public LabelPositionVisitor(CoordinateEncoder encoder, BiFunction<Double, Double, SpatialPoint> pointMaker) {
+    LabelPositionVisitor(CoordinateEncoder encoder, BiFunction<Double, Double, SpatialPoint> pointMaker) {
         super(encoder);
         this.pointMaker = pointMaker;
     }
 
     @Override
-    void visitDecodedPoint(double x, double y) {
+    protected void visitDecodedPoint(double x, double y) {
         assert labelPosition == null;
         labelPosition = pointMaker.apply(x, y);
     }
 
     @Override
-    public void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
+    protected void visitDecodedLine(double aX, double aY, double bX, double bY, byte metadata) {
         assert labelPosition == null;
         labelPosition = pointMaker.apply((aX + bX) / 2.0, (aY + bY) / 2.0);
     }
 
     @Override
-    public void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
+    protected void visitDecodedTriangle(double aX, double aY, double bX, double bY, double cX, double cY, byte metadata) {
         assert labelPosition == null;
         labelPosition = pointMaker.apply((aX + bX + cX) / 3.0, (aY + bY + cY) / 3.0);
     }
 
     @Override
-    boolean pushDecodedX(double minX) {
+    protected boolean pushDecodedX(double minX) {
         return labelPosition == null;
     }
 
     @Override
-    boolean pushDecodedY(double minX) {
+    protected boolean pushDecodedY(double minX) {
         return labelPosition == null;
     }
 
@@ -62,18 +62,12 @@ public boolean push() {
     }
 
     @Override
-    boolean pushDecoded(double maxX, double maxY) {
+    protected boolean pushDecoded(double maxX, double maxY) {
         return labelPosition == null;
     }
 
     @Override
-    public boolean push(int minX, int minY, int maxX, int maxY) {
-        // Always start the traversal
-        return labelPosition == null;
-    }
-
-    @Override
-    boolean pushDecoded(double minX, double minY, double maxX, double maxY) {
+    protected boolean pushDecoded(double minX, double minY, double maxX, double maxY) {
         return labelPosition == null;
     }
 

x-pack/plugin/spatial/src/main/java/org/elasticsearch/xpack/spatial/index/fielddata/ShapeValues.java

@@ -91,9 +91,9 @@ public T missing(String missing) {
      * the provided decoder (could be geo or cartesian)
      */
     protected abstract static class ShapeValue implements ToXContentFragment {
-        protected final GeometryDocValueReader reader;
+        private final GeometryDocValueReader reader;
         private final BoundingBox boundingBox;
-        protected final CoordinateEncoder encoder;
+        private final CoordinateEncoder encoder;
         private final BiFunction<Double, Double, SpatialPoint> pointMaker;
         private final Component2DRelationVisitor component2DRelationVisitor;
 
@@ -117,6 +117,13 @@ public BoundingBox boundingBox() {
             return boundingBox;
         }
 
+        /**
+         * Visit the underlying tree structure using the provided {@link TriangleTreeVisitor}
+         */
+        public void visit(TriangleTreeVisitor visitor) throws IOException {
+            reader.visit(visitor);
+        }
+
         protected abstract Component2D centroidAsComponent2D() throws IOException;
 
         private boolean centroidWithinShape() throws IOException {
@@ -139,7 +146,7 @@ public SpatialPoint labelPosition() throws IOException {
             }
             // For all other cases, use the first triangle (or line or point) in the tree which will always intersect the shape
             LabelPositionVisitor visitor = new LabelPositionVisitor(this.encoder, pointMaker);
-            reader.visit(visitor);
+            visit(visitor);
             return visitor.labelPosition();
         }
 

x-pack/plugin/spatial/src/main/java/org/elasticsearch/xpack/spatial/index/fielddata/Tile2DVisitor.java

@@ -16,7 +16,7 @@
  * This class supports checking bounding box relations against a serialized triangle tree.
  *
  */
-class Tile2DVisitor implements TriangleTreeReader.Visitor {
+class Tile2DVisitor implements TriangleTreeVisitor {
 
     private GeoRelation relation;
     private int minX;