Class CircleBuilder

    • Constructor Detail

      • CircleBuilder

        public CircleBuilder()
        Creates a circle centered at [0.0, 0.0]. Center can be changed by calling center(Coordinate) later.
      • CircleBuilder

        public CircleBuilder​(StreamInput in)
                      throws java.io.IOException
        Read from a stream.
        Throws:
        java.io.IOException
    • Method Detail

      • center

        public CircleBuilder center​(org.locationtech.jts.geom.Coordinate center)
        Set the center of the circle
        Parameters:
        center - coordinate of the circles center
        Returns:
        this
      • center

        public CircleBuilder center​(double lon,
                                    double lat)
        set the center of the circle
        Parameters:
        lon - longitude of the center
        lat - latitude of the center
        Returns:
        this
      • center

        public org.locationtech.jts.geom.Coordinate center()
        Get the center of the circle
      • radius

        public CircleBuilder radius​(java.lang.String radius)
        Set the radius of the circle. The String value will be parsed by DistanceUnit
        Parameters:
        radius - Value and unit of the circle combined in a string
        Returns:
        this
      • radius

        public CircleBuilder radius​(double radius,
                                    java.lang.String unit)
        Set the radius of the circle
        Parameters:
        radius - value of the circles radius
        unit - unit name of the radius value (see DistanceUnit)
        Returns:
        this
      • radius

        public CircleBuilder radius​(double radius,
                                    DistanceUnit unit)
        Set the radius of the circle
        Parameters:
        radius - value of the circles radius
        unit - unit of the radius value (see DistanceUnit)
        Returns:
        this
      • radius

        public double radius()
        Get the radius of the circle without unit
      • unit

        public DistanceUnit unit()
        Get the radius unit of the circle
      • buildS4J

        public org.locationtech.spatial4j.shape.Circle buildS4J()
        Description copied from class: ShapeBuilder
        Create a new Shape from this builder. Since calling this method could change the defined shape. (by inserting new coordinates or change the position of points) the builder looses its validity. So this method should only be called once on a builder
        Specified by:
        buildS4J in class ShapeBuilder<org.locationtech.spatial4j.shape.Circle,​Circle,​CircleBuilder>
        Returns:
        new Shape defined by the builder
      • buildGeometry

        public Circle buildGeometry()
        Description copied from class: ShapeBuilder
        build lucene geometry.
        Specified by:
        buildGeometry in class ShapeBuilder<org.locationtech.spatial4j.shape.Circle,​Circle,​CircleBuilder>
        Returns:
        GeoPoint, double[][], Line, Line[], Polygon, Polygon[], Rectangle, Object[]