org.elasticsearch.common.geo.builders

Class MultiPolygonBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.common.geo.builders.ShapeBuilder

org.elasticsearch.common.geo.builders.MultiPolygonBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent

public class MultiPolygonBuilder
extends ShapeBuilder

Nested Class Summary

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

ShapeBuilder.CoordinateNode, ShapeBuilder.Edge, ShapeBuilder.GeoShapeType, ShapeBuilder.Orientation

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

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

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static ShapeBuilder.GeoShapeType	TYPE

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

AUTO_INDEX_JTS_GEOMETRY, AUTO_VALIDATE_JTS_GEOMETRY, DATELINE, FACTORY, FIELD_COORDINATES, FIELD_GEOMETRIES, FIELD_ORIENTATION, FIELD_TYPE, 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 and Description
MultiPolygonBuilder() Build a MultiPolygonBuilder with RIGHT orientation.
MultiPolygonBuilder(ShapeBuilder.Orientation orientation) Build a MultiPolygonBuilder with an arbitrary orientation.
MultiPolygonBuilder(StreamInput in) Read from a stream.

Method Summary

Modifier and Type	Method and Description
org.locationtech.spatial4j.shape.Shape	build() Create a new Shape from this builder.
boolean	equals(java.lang.Object obj)
int	hashCode()
ShapeBuilder.Orientation	orientation()
MultiPolygonBuilder	polygon(PolygonBuilder polygon) Add a shallow copy of the polygon to the multipolygon.
java.util.List<PolygonBuilder>	polygons() get the list of polygons
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ShapeBuilder.GeoShapeType	type() get the shapes type
void	writeTo(StreamOutput out) Write this into the StreamOutput.

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

debugEnabled, getWriteableName, intersection, intersections, jtsGeometry, parse, parse, readFromStream, shift, toXContent, writeCoordinateTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString, toString

Methods inherited from class java.lang.Object

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

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

isFragment

Field Detail

TYPE

public static final ShapeBuilder.GeoShapeType TYPE

Constructor Detail

MultiPolygonBuilder

public MultiPolygonBuilder()

Build a MultiPolygonBuilder with RIGHT orientation.

MultiPolygonBuilder

public MultiPolygonBuilder(ShapeBuilder.Orientation orientation)

Build a MultiPolygonBuilder with an arbitrary orientation.

MultiPolygonBuilder

public MultiPolygonBuilder(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.

Throws:

java.io.IOException

orientation

public ShapeBuilder.Orientation orientation()

polygon

public MultiPolygonBuilder polygon(PolygonBuilder polygon)

Add a shallow copy of the polygon to the multipolygon. This will apply the orientation of the MultiPolygonBuilder to the polygon if polygon has different orientation.

polygons

public java.util.List<PolygonBuilder> polygons()

get the list of polygons

toXContent

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

Throws:

java.io.IOException

type

public ShapeBuilder.GeoShapeType type()

Description copied from class: ShapeBuilder

get the shapes type

Specified by:

type in class ShapeBuilder

Returns:

type of the shape

build

public org.locationtech.spatial4j.shape.Shape 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

Returns:

new Shape defined by the builder

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object