Package org.elasticsearch.common.geo.builders

Class CircleBuilder

java.lang.Object

org.elasticsearch.common.geo.builders.ShapeBuilder<org.locationtech.spatial4j.shape.Circle,CircleBuilder>

org.elasticsearch.common.geo.builders.CircleBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject

public class CircleBuilder
extends ShapeBuilder<org.locationtech.spatial4j.shape.Circle,CircleBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.common.geo.builders.ShapeBuilder

ShapeBuilder.Edge, ShapeBuilder.Orientation

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	FIELD_RADIUS
static GeoShapeType	TYPE

Fields inherited from class org.elasticsearch.common.geo.builders.ShapeBuilder

AUTO_INDEX_JTS_GEOMETRY, AUTO_VALIDATE_JTS_GEOMETRY, coordinates, DATELINE, FACTORY, INTERSECTION_ORDER, LOGGER, MULTI_POLYGON_MAY_OVERLAP, SPATIAL_CONTEXT, wrapdateline, ZERO_ZERO

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CircleBuilder()	Creates a circle centered at [0.0, 0.0].
CircleBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
org.locationtech.spatial4j.shape.Circle	build()	Create a new Shape from this builder.
org.locationtech.jts.geom.Coordinate	center()	Get the center of the circle
CircleBuilder	center(double lon, double lat)	set the center of the circle
CircleBuilder	center(org.locationtech.jts.geom.Coordinate center)	Set the center of the circle
boolean	equals(java.lang.Object obj)
int	hashCode()
int	numDimensions()	tracks number of dimensions for this shape
double	radius()	Get the radius of the circle without unit
CircleBuilder	radius(double radius, java.lang.String unit)	Set the radius of the circle
CircleBuilder	radius(double radius, DistanceUnit unit)	Set the radius of the circle
CircleBuilder	radius(java.lang.String radius)	Set the radius of the circle.
CircleBuilder	radius(DistanceUnit.Distance radius)	Set the radius of the circle
java.lang.String	toWKT()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
GeoShapeType	type()	get the shapes type
DistanceUnit	unit()	Get the radius unit of the circle
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.elasticsearch.common.geo.builders.ShapeBuilder

contentToWKT, coordinate, coordinate, coordinateListToWKT, coordinates, coordinates, coordinates, coordinatesToXcontent, debugEnabled, getWriteableName, intersection, intersections, jtsGeometry, parse, readFromStream, shift, toString, toXContent, writeCoordinateTo

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

FIELD_RADIUS

public static final ParseField FIELD_RADIUS

TYPE

public static final GeoShapeType TYPE

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

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ShapeBuilder<org.locationtech.spatial4j.shape.Circle,CircleBuilder>

Throws:

java.io.IOException

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(DistanceUnit.Distance radius)

Set the radius of the circle

Parameters:

radius - radius of the circle (see DistanceUnit.Distance)

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

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Throws:

java.io.IOException

build

public org.locationtech.spatial4j.shape.Circle build()

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:

build in class ShapeBuilder<org.locationtech.spatial4j.shape.Circle,CircleBuilder>

Returns:

new Shape defined by the builder

type

public GeoShapeType type()

Description copied from class: ShapeBuilder

get the shapes type

Specified by:

type in class ShapeBuilder<org.locationtech.spatial4j.shape.Circle,CircleBuilder>

Returns:

type of the shape

toWKT

public java.lang.String toWKT()

Overrides:

toWKT in class ShapeBuilder<org.locationtech.spatial4j.shape.Circle,CircleBuilder>

numDimensions

public int numDimensions()

Description copied from class: ShapeBuilder

tracks number of dimensions for this shape

Specified by:

numDimensions in class ShapeBuilder<org.locationtech.spatial4j.shape.Circle,CircleBuilder>

hashCode

public int hashCode()

Overrides:

hashCode in class ShapeBuilder<org.locationtech.spatial4j.shape.Circle,CircleBuilder>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ShapeBuilder<org.locationtech.spatial4j.shape.Circle,CircleBuilder>