de.gerdiproject.json.datacite

Class GeoLocation

java.lang.Object

de.gerdiproject.json.datacite.GeoLocation

All Implemented Interfaces:

ICleanable

public class GeoLocation
extends Object
implements ICleanable

Spatial region or named place where the data was gathered or about which the data is focused. This schema deviates from the DataCite schema, mapping the geo coordinates to GeoJson objects that can be read by ElasticSearch. Source: https://schema.datacite.org/meta/kernel-4.1/doc/DataCite-MetadataKernel_v4.1.pdf

Author:

Mathis Neumann, Robin Weiss

Constructor Summary

Constructors

Constructor and Description
GeoLocation()
GeoLocation(String place) Constructor that sets the name of the location.

Method Summary

Modifier and Type	Method and Description
void	addPolygons(Collection<com.vividsolutions.jts.geom.Geometry> geoList) Adds a Collection of Geometry objects to the List of Polygons.
protected boolean	canEqual(Object other)
boolean	clean() Cleans each GeoJson attached to the location.
boolean	equals(Object o)
com.vividsolutions.jts.geom.Polygon	getBox() Retrieves the spatial limits of a box.
String	getPlace() Retrieves the free text description of the geographic location.
com.vividsolutions.jts.geom.Point	getPoint() Retrieves the point location in space.
Set<com.vividsolutions.jts.geom.Polygon>	getPolygons() Retrieves a list of drawn polygon areas, defined by sets of points and lines connecting the points in closed chains.
int	hashCode()
boolean	isValid() Returns true if the GeoLocation has any geographical data or at least a textual description.
void	setBox(double westBoundLongitude, double eastBoundLongitude, double southBoundLatitude, double northBoundLatitude) Changes the spatial limits of a box, defining its shape.
void	setBox(com.vividsolutions.jts.geom.Geometry geometry) Changes the spatial limits of a box, defining its shape.
void	setPlace(String place) Sets the free text description of the geographic location.
void	setPoint(double longitude, double latitude) Changes the point location in space.
void	setPoint(com.vividsolutions.jts.geom.Point point) Sets the point location in space.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoLocation

public GeoLocation(String place)

Constructor that sets the name of the location.

Parameters:

place - free text description of the geographic location

GeoLocation

public GeoLocation()

Method Detail

setBox

public void setBox(double westBoundLongitude,
                   double eastBoundLongitude,
                   double southBoundLatitude,
                   double northBoundLatitude)

Changes the spatial limits of a box, defining its shape.

Parameters:

westBoundLongitude - western longitudinal dimension of the box

eastBoundLongitude - eastern longitudinal dimension of the box

southBoundLatitude - southern latitudinal dimension of the box

northBoundLatitude - northern latitudinal dimension of the box

setBox

public void setBox(com.vividsolutions.jts.geom.Geometry geometry)

Changes the spatial limits of a box, defining its shape.

Parameters:

geometry - a GeoJson object, the bounding box of which becomes the box

setPoint

public void setPoint(double longitude,
                     double latitude)

Changes the point location in space.

Parameters:

longitude - a geographic coordinate that specifies the east-west position of a point on the Earth's surface

latitude - a geographic coordinate that specifies the north–south position of a point on the Earth's surface

addPolygons

public void addPolygons(Collection<com.vividsolutions.jts.geom.Geometry> geoList)

Adds a Collection of Geometry objects to the List of Polygons. MultiPolygons are split up into Polygons in order to be DataCite compliant.

Parameters:

geoList - a collection of Polygons and MultiPolygons

clean

public boolean clean()

Cleans each GeoJson attached to the location. Each invalid GeoJsons will become null.

Specified by:

clean in interface ICleanable

Returns:

true if the clean up was successful and the object is now valid

isValid

public boolean isValid()

Returns true if the GeoLocation has any geographical data or at least a textual description.

Returns:

true, if the GeoLocation has any data

getPlace

public String getPlace()

Retrieves the free text description of the geographic location.

Returns:

the free text description of the geographic location

getPoint

public com.vividsolutions.jts.geom.Point getPoint()

Retrieves the point location in space.

Returns:

the point location in space

getBox

public com.vividsolutions.jts.geom.Polygon getBox()

Retrieves the spatial limits of a box.

Returns:

the spatial limits of a box

getPolygons

public Set<com.vividsolutions.jts.geom.Polygon> getPolygons()

Retrieves a list of drawn polygon areas, defined by sets of points and lines connecting the points in closed chains.

Returns:

the list of drawn polygon areas

setPlace

public void setPlace(String place)

Sets the free text description of the geographic location.

Parameters:

place - the free text description of the geographic location

setPoint

public void setPoint(com.vividsolutions.jts.geom.Point point)

Sets the point location in space.

Parameters:

point - a point location in space

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object