Module org.apache.lucene.spatial3d
Package org.apache.lucene.spatial3d.geom

Class GeoBaseAreaShape

java.lang.Object
org.apache.lucene.spatial3d.geom.BasePlanetObject
org.apache.lucene.spatial3d.geom.GeoBaseBounds
org.apache.lucene.spatial3d.geom.GeoBaseShape
org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
All Implemented Interfaces:
Bounded, GeoArea, GeoAreaShape, GeoBounds, GeoMembershipShape, GeoOutsideDistance, GeoShape, Membership, PlanetObject, SerializableObject
Direct Known Subclasses:
GeoBaseBBox, GeoBaseDistanceShape, GeoBasePolygon
abstract class GeoBaseAreaShape extends GeoBaseMembershipShape implements GeoAreaShape
Base extended areaShape object.

  • Field Details

    • ALL_INSIDE

      protected static final int ALL_INSIDE
      All edgepoints inside shape
      See Also:

    • SOME_INSIDE

      protected static final int SOME_INSIDE
      Some edgepoints inside shape
      See Also:

    • NONE_INSIDE

      protected static final int NONE_INSIDE
      No edgepoints inside shape
      See Also:

  • Constructor Details

    • GeoBaseAreaShape

      public GeoBaseAreaShape(PlanetModel planetModel)
      Constructor.
      Parameters:
      planetModel - is the planet model to use.

  • Method Details

    • isShapeInsideGeoAreaShape

      protected int isShapeInsideGeoAreaShape(GeoShape geoShape)
      Determine the relationship between the GeoAreShape and the shape's edgepoints.
      Parameters:
      geoShape - is the shape.
      Returns:
      the relationship.

    • isGeoAreaShapeInsideShape

      protected int isGeoAreaShapeInsideShape(GeoShape geoshape)
      Determine the relationship between the GeoAreaShape's edgepoints and the provided shape.
      Parameters:
      geoshape - is the shape.
      Returns:
      the relationship.

    • getRelationship

      public int getRelationship(GeoShape geoShape)
      Description copied from interface: GeoArea
      Find the spatial relationship between a shape and the current geo area. Note: return value is how the GeoShape relates to the GeoArea, not the other way around. For example, if this GeoArea is entirely within the shape, then CONTAINS should be returned. If the shape is entirely enclosed by this GeoArea, then WITHIN should be returned.

      It is permissible to return OVERLAPS instead of WITHIN if the shape intersects with the area at even a single point. So, a circle inscribed in a rectangle could return either OVERLAPS or WITHIN, depending on implementation. It is not permissible to return CONTAINS or DISJOINT in this circumstance, however.

      Similarly, it is permissible to return OVERLAPS instead of CONTAINS under conditions where the shape consists of multiple independent overlapping subshapes, and the area overlaps one of the subshapes. It is not permissible to return WITHIN or DISJOINT in this circumstance, however.

      Specified by:
      getRelationship in interface GeoArea
      Parameters:
      geoShape - is the shape to consider.
      Returns:
      the relationship, from the perspective of the shape.