diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/Geo3dShape.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/Geo3dShape.java index e80e5b67eae..5f40130e414 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/Geo3dShape.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/Geo3dShape.java @@ -29,7 +29,11 @@ import org.apache.lucene.spatial.spatial4j.geo3d.GeoAreaFactory; import org.apache.lucene.spatial.spatial4j.geo3d.GeoPoint; import org.apache.lucene.spatial.spatial4j.geo3d.GeoShape; -/** A 3D planar geometry based Spatial4j Shape implementation. */ +/** + * A 3D planar geometry based Spatial4j Shape implementation. + * + * @lucene.experimental + */ public class Geo3dShape implements Shape { public final SpatialContext ctx; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Bounds.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Bounds.java index 75b91c3ec58..cee58aefc65 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Bounds.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Bounds.java @@ -27,6 +27,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * (3) No lower latitude bound possible * When any of these have been applied, further application of * points cannot override that decision. + * + * @lucene.experimental */ public class Bounds { protected boolean noLongitudeBound = false; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoArea.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoArea.java index 4412e8b0eca..0fef21beaca 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoArea.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoArea.java @@ -22,6 +22,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * be bounded in latitude, or bounded in both latitude and longitude, or not * bounded at all. The purpose of the interface is to describe bounding shapes used for * computation of geo hashes. + * + * @lucene.experimental */ public interface GeoArea extends Membership { // Since we don't know what each GeoArea's constraints are, diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoAreaFactory.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoAreaFactory.java index 3597691ca2d..ab49cad3587 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoAreaFactory.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoAreaFactory.java @@ -17,7 +17,11 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * limitations under the License. */ -/** Factory for {@link org.apache.lucene.spatial.spatial4j.geo3d.GeoArea}. */ +/** + * Factory for {@link org.apache.lucene.spatial.spatial4j.geo3d.GeoArea}. + * + * @lucene.experimental + */ public class GeoAreaFactory { private GeoAreaFactory() { } diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBox.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBox.java index 5ff8739bc75..37b47ae1496 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBox.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBox.java @@ -21,6 +21,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * All bounding box shapes have this interface in common. * This describes methods that bounding boxes have above and beyond * GeoMembershipShape's. + * + * @lucene.experimental */ public interface GeoBBox extends GeoMembershipShape, GeoSizeable, GeoArea { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBoxBase.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBoxBase.java index 44c01555750..4dd7a3a9f4e 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBoxBase.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBoxBase.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * All bounding box shapes can derive from this base class, which furnishes * some common code + * + * @lucene.external */ public abstract class GeoBBoxBase implements GeoBBox { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBoxFactory.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBoxFactory.java index eed8f242d01..c8de3167482 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBoxFactory.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBBoxFactory.java @@ -17,7 +17,11 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * limitations under the License. */ -/** Factory for {@link org.apache.lucene.spatial.spatial4j.geo3d.GeoBBox}. */ +/** + * Factory for {@link org.apache.lucene.spatial.spatial4j.geo3d.GeoBBox}. + * + * @lucene.experimental + */ public class GeoBBoxFactory { private GeoBBoxFactory() { } diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBaseExtendedShape.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBaseExtendedShape.java index 020794b5cce..a9e7843fbb6 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBaseExtendedShape.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoBaseExtendedShape.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Base extended shape object. + * + * @lucene.experimental */ public abstract class GeoBaseExtendedShape implements GeoShape { protected final static GeoPoint NORTH_POLE = new GeoPoint(0.0, 0.0, 1.0); diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoCircle.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoCircle.java index 3803e833791..b04d0faa4c4 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoCircle.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoCircle.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Circular area with a center and radius. + * + * @lucene.experimental */ public class GeoCircle extends GeoBaseExtendedShape implements GeoDistanceShape, GeoSizeable { public final GeoPoint center; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoCompositeMembershipShape.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoCompositeMembershipShape.java index 7201b86b433..5a192f5e37e 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoCompositeMembershipShape.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoCompositeMembershipShape.java @@ -22,6 +22,8 @@ import java.util.List; /** * GeoComposite is a set of GeoMembershipShape's, treated as a unit. + * + * @lucene.experimental */ public class GeoCompositeMembershipShape implements GeoMembershipShape { protected final List shapes = new ArrayList(); diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoConvexPolygon.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoConvexPolygon.java index 8c4b8ed5fa9..cf9a1d7611f 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoConvexPolygon.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoConvexPolygon.java @@ -26,6 +26,8 @@ import java.util.List; * The only restrictions on these objects are: (1) they must be convex; (2) they must have * a maximum extent no larger than PI. Violating either one of these limits will * cause the logic to fail. + * + * @lucene.experimental */ public class GeoConvexPolygon extends GeoBaseExtendedShape implements GeoMembershipShape { protected final List points; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateHorizontalLine.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateHorizontalLine.java index a12cb8a6c3e..14a7396b4da 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateHorizontalLine.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateHorizontalLine.java @@ -21,6 +21,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * Degenerate bounding box limited on two sides (left lon, right lon). * The left-right maximum extent for this shape is PI; for anything larger, use * GeoWideDegenerateHorizontalLine. + * + * @lucene.internal */ public class GeoDegenerateHorizontalLine extends GeoBBoxBase { public final double latitude; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateLatitudeZone.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateLatitudeZone.java index fddfa0f2353..982f8f593b6 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateLatitudeZone.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateLatitudeZone.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * This GeoBBox represents an area rectangle of one specific latitude with * no longitude bounds. + * + * @lucene.internal */ public class GeoDegenerateLatitudeZone extends GeoBBoxBase { public final double latitude; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateLongitudeSlice.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateLongitudeSlice.java index 393f0f16565..69c703b862e 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateLongitudeSlice.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateLongitudeSlice.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Degenerate longitude slice. + * + * @lucene.internal */ public class GeoDegenerateLongitudeSlice extends GeoBBoxBase { public final double longitude; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegeneratePoint.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegeneratePoint.java index 9e96adbf818..f7c0775a8ec 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegeneratePoint.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegeneratePoint.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * This class represents a degenerate point bounding box. * It is not a simple GeoPoint because we must have the latitude and longitude. + * + * @lucene.internal */ public class GeoDegeneratePoint extends GeoPoint implements GeoBBox { public final double latitude; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateVerticalLine.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateVerticalLine.java index 4b2bb13163b..dd0306b01ee 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateVerticalLine.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDegenerateVerticalLine.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Degenerate bounding box limited on two sides (top lat, bottom lat). + * + * @lucene.internal */ public class GeoDegenerateVerticalLine extends GeoBBoxBase { public final double topLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDistance.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDistance.java index c7ef1ba5670..e061a95550d 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDistance.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDistance.java @@ -22,6 +22,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * of this interface is capable of computing the described "distance" values, * which are meant to provide both actual distance values, as well as * distance estimates that can be computed more cheaply. + * + * @lucene.experimental */ public interface GeoDistance extends Membership { /** diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDistanceShape.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDistanceShape.java index 0e41c8e9992..003dc3b7b96 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDistanceShape.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoDistanceShape.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Distance shapes have capabilities of both geohashing and distance * computation (which also includes point membership determination). + * + * @lucene.experimental */ public interface GeoDistanceShape extends GeoMembershipShape, GeoDistance { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoLatitudeZone.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoLatitudeZone.java index 28eadac7a2a..132893c62cc 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoLatitudeZone.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoLatitudeZone.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * This GeoBBox represents an area rectangle limited only in latitude. + * + * @lucene.internal */ public class GeoLatitudeZone extends GeoBBoxBase { public final double topLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoLongitudeSlice.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoLongitudeSlice.java index cbb31e63135..adf1fe3f123 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoLongitudeSlice.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoLongitudeSlice.java @@ -21,6 +21,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * Bounding box limited on left and right. * The left-right maximum extent for this shape is PI; for anything larger, use * GeoWideLongitudeSlice. + * + * @lucene.internal */ public class GeoLongitudeSlice extends GeoBBoxBase { public final double leftLon; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoMembershipShape.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoMembershipShape.java index e31e7114007..f055a84e4a8 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoMembershipShape.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoMembershipShape.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Membership shapes have capabilities of both geohashing and membership * determination. + * + * @lucene.experimental */ public interface GeoMembershipShape extends GeoShape, Membership { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoNorthLatitudeZone.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoNorthLatitudeZone.java index 42c7cbd7d49..4a03be2fd74 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoNorthLatitudeZone.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoNorthLatitudeZone.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * This GeoBBox represents an area rectangle limited only in south latitude. + * + * @lucene.internal */ public class GeoNorthLatitudeZone extends GeoBBoxBase { public final double bottomLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoNorthRectangle.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoNorthRectangle.java index deec4e21581..be0c1cbcec2 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoNorthRectangle.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoNorthRectangle.java @@ -22,6 +22,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * the north pole. * The left-right maximum extent for this shape is PI; for anything larger, use * GeoWideNorthRectangle. + * + * @lucene.internal */ public class GeoNorthRectangle extends GeoBBoxBase { public final double bottomLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPath.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPath.java index ca8f582be9a..2ff08b05f0a 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPath.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPath.java @@ -25,6 +25,8 @@ import java.util.List; * with a specified half-width. Path is described by a series of points. * Distances are measured from the starting point along the path, and then at right * angles to the path. + * + * @lucene.experimental */ public class GeoPath extends GeoBaseExtendedShape implements GeoDistanceShape { public final double cutoffAngle; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPoint.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPoint.java index 4aa98679d25..93c0c847775 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPoint.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPoint.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * This class represents a point on the surface of a unit sphere. + * + * @lucene.experimental */ public class GeoPoint extends Vector { public GeoPoint(final double sinLat, final double sinLon, final double cosLat, final double cosLon) { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPolygonFactory.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPolygonFactory.java index 4b14e2d24f1..b630dc0deb6 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPolygonFactory.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoPolygonFactory.java @@ -23,6 +23,8 @@ import java.util.List; /** * Class which constructs a GeoMembershipShape representing an arbitrary polygon. + * + * @lucene.experimental */ public class GeoPolygonFactory { private GeoPolygonFactory() { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoRectangle.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoRectangle.java index 219f78196a5..459203641ac 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoRectangle.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoRectangle.java @@ -21,6 +21,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * Bounding box limited on four sides (top lat, bottom lat, left lon, right lon). * The left-right maximum extent for this shape is PI; for anything larger, use * GeoWideRectangle. + * + * @lucene.internal */ public class GeoRectangle extends GeoBBoxBase { public final double topLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoShape.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoShape.java index 44eadcf90e6..ceb303e63ea 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoShape.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoShape.java @@ -21,6 +21,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * Generic shape. This describes methods that help GeoAreas figure out * how they interact with a shape, for the purposes of coming up with a * set of geo hash values. + * + * @lucene.experimental */ public interface GeoShape extends Membership { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSizeable.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSizeable.java index 4380cd3f308..4c57b8037a3 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSizeable.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSizeable.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Some shapes can compute radii of a geocircle in which they are inscribed. + * + * @lucene.experimental */ public interface GeoSizeable { /** diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSouthLatitudeZone.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSouthLatitudeZone.java index 0cb3a824af3..8bff3acca78 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSouthLatitudeZone.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSouthLatitudeZone.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * This GeoBBox represents an area rectangle limited only in north latitude. + * + * @lucene.internal */ public class GeoSouthLatitudeZone extends GeoBBoxBase { public final double topLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSouthRectangle.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSouthRectangle.java index 9ce3dc027c2..1b79367dc5b 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSouthRectangle.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoSouthRectangle.java @@ -22,6 +22,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; * other corner is the south pole. * The left-right maximum extent for this shape is PI; for anything larger, use * GeoWideSouthRectangle. + * + * @lucene.internal */ public class GeoSouthRectangle extends GeoBBoxBase { public final double topLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideDegenerateHorizontalLine.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideDegenerateHorizontalLine.java index 9a7991a31ae..a22d6f43990 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideDegenerateHorizontalLine.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideDegenerateHorizontalLine.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Degenerate bounding box wider than PI and limited on two sides (left lon, right lon). + * + * @lucene.internal */ public class GeoWideDegenerateHorizontalLine extends GeoBBoxBase { public final double latitude; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideLongitudeSlice.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideLongitudeSlice.java index 73857ed7a73..4ebae4df52d 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideLongitudeSlice.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideLongitudeSlice.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Bounding box wider than PI but limited on left and right sides ( * left lon, right lon). + * + * @lucene.internal */ public class GeoWideLongitudeSlice extends GeoBBoxBase { public final double leftLon; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideNorthRectangle.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideNorthRectangle.java index e1a4f1bcd41..c46abcff378 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideNorthRectangle.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideNorthRectangle.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Bounding box wider than PI but limited on three sides ( * bottom lat, left lon, right lon). + * + * @lucene.internal */ public class GeoWideNorthRectangle extends GeoBBoxBase { public final double bottomLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideRectangle.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideRectangle.java index 352a8482ffc..2f46404345b 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideRectangle.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideRectangle.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Bounding box wider than PI but limited on four sides (top lat, * bottom lat, left lon, right lon). + * + * @lucene.internal */ public class GeoWideRectangle extends GeoBBoxBase { public final double topLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideSouthRectangle.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideSouthRectangle.java index 8bf8f0f06a5..97568cddf56 100644 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideSouthRectangle.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWideSouthRectangle.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Bounding box wider than PI but limited on three sides (top lat, * left lon, right lon). + * + * @lucene.internal */ public class GeoWideSouthRectangle extends GeoBBoxBase { public final double topLat; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWorld.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWorld.java index a4ebb6bf0d3..dac957adf5d 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWorld.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/GeoWorld.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Bounding box including the entire world. + * + * @lucene.internal */ public class GeoWorld extends GeoBBoxBase { protected final static GeoPoint originPoint = new GeoPoint(1.0, 0.0, 0.0); diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Membership.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Membership.java index 2a70342e886..d21e544cf92 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Membership.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Membership.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Interface describing 3d shape membership methods. + * + * @lucene.experimental */ public interface Membership { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Plane.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Plane.java index a1b41353fad..1481e2300c5 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Plane.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Plane.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * We know about three kinds of planes. First kind: general plain through two points and origin * Second kind: horizontal plane at specified height. Third kind: vertical plane with specified x and y value, through origin. + * + * @lucene.experimental */ public class Plane extends Vector { protected final static GeoPoint[] NO_POINTS = new GeoPoint[0]; @@ -112,7 +114,7 @@ public class Plane extends Vector { /** * Evaluate the plane equation for a given point, as represented * by a vector. - * + * * @return true if the result is on the plane. */ public boolean evaluateIsZero(final double x, final double y, final double z) { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/SidedPlane.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/SidedPlane.java index 389d669baea..6c0f49d741f 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/SidedPlane.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/SidedPlane.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Combination of a plane, and a sign value indicating what evaluation values are on the correct * side of the plane. + * + * @lucene.experimental */ public class SidedPlane extends Plane implements Membership { public final double sigNum; diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Tools.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Tools.java index 7528de87cfc..5e33b28ecc3 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Tools.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Tools.java @@ -19,6 +19,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * Static methods globally useful for 3d geometric work. + * + * @lucene.experimental */ public class Tools { private Tools() { diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Vector.java b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Vector.java index f7c4e4e0ce1..69fd2bdf10b 100755 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Vector.java +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/spatial4j/geo3d/Vector.java @@ -20,6 +20,8 @@ package org.apache.lucene.spatial.spatial4j.geo3d; /** * A 3d vector in space, not necessarily * going through the origin. + * + * @lucene.experimental */ public class Vector { /**