org.vertexium.type

Class GeoCollection

java.lang.Object

org.vertexium.type.GeoShapeBase

org.vertexium.type.GeoCollection

All Implemented Interfaces:

Serializable, GeoShape

public class GeoCollection
extends GeoShapeBase

See Also:

Serialized Form

Field Summary

Fields inherited from class org.vertexium.type.GeoShapeBase

EARTH_CIRCUMFERENCE, EARTH_RADIUS, MAX_LAT, MAX_LON, MIN_LAT, MIN_LON

Constructor Summary

Constructors

Constructor and Description
GeoCollection()
GeoCollection(List<GeoShape> geoShapes)
GeoCollection(List<GeoShape> geoShapes, String description)
GeoCollection(String description)

Method Summary

Modifier and Type	Method and Description
GeoCollection	addShape(GeoShape geoShape)
GeoCollection	addShapes(List<GeoShape> geoShapes)
boolean	equals(Object obj)
List<GeoShape>	getGeoShapes()
int	hashCode()
boolean	intersects(GeoShape geoShape) Calculate whether the given GeoShape intersects with the geometry of this object.
void	validate() Throw a VertexiumException if the requirements for this shape are not met.
boolean	within(GeoShape geoShape) Calculate whether the given GeoShape is completely within the geometry of this object.

Methods inherited from class org.vertexium.type.GeoShapeBase

distanceBetween, getDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoCollection

public GeoCollection()

GeoCollection

public GeoCollection(String description)

GeoCollection

public GeoCollection(List<GeoShape> geoShapes)

GeoCollection

public GeoCollection(List<GeoShape> geoShapes,
                     String description)

Method Detail

intersects

public boolean intersects(GeoShape geoShape)

Description copied from interface: GeoShape

Calculate whether the given GeoShape intersects with the geometry of this object.

Parameters:

geoShape - The other shape

Returns:

True if any points of the provided shape are within the geometry of this shape or vice-versa.

within

public boolean within(GeoShape geoShape)

Description copied from interface: GeoShape

Calculate whether the given GeoShape is completely within the geometry of this object.

Parameters:

geoShape - The other shape

Returns:

True if the provided shape is completely within the geometry of this shape.

addShape

public GeoCollection addShape(GeoShape geoShape)

addShapes

public GeoCollection addShapes(List<GeoShape> geoShapes)

getGeoShapes

public List<GeoShape> getGeoShapes()

validate

public void validate()

Description copied from interface: GeoShape

Throw a VertexiumException if the requirements for this shape are not met.

Specified by:

validate in interface GeoShape

Overrides:

validate in class GeoShapeBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object