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()

Method Summary

Modifier and Type	Method and Description
void	clean() Cleans each GeoJson attached to the location.
GeoJson	getBox() Returns the spatial limits of a box.
String	getPlace() Returns the description of the geographic location.
GeoJson	getPoint() Returns a point location in space.
List<GeoJson>	getPolygons() Returns a list of drawn polygon areas, defined by sets of points and lines connecting the points in closed chains.
boolean	isValid() Returns true if the GeoLocation has any geographical data.
void	setBox(double westBoundLongitude, double eastBoundLongitude, double southBoundLatitude, double northBoundLatitude) Changes the spatial limits of a box, defining its shape.
void	setPlace(String place) Changes the description of the geographic location.
void	setPoint(GeoJson point) Changes the point location.
void	setPolygons(List<GeoJson> polygons) Changes the list of drawn polygon areas, defined by sets of points and lines connecting the points in closed chains.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoLocation

public GeoLocation()

Method Detail

getPlace

public String getPlace()

Returns the description of the geographic location.

Returns:

a free text description of the location

setPlace

public void setPlace(String place)

Changes the description of the geographic location.

Parameters:

place - a free text description of the location

getPoint

public GeoJson getPoint()

Returns a point location in space.

Returns:

a point location

setPoint

public void setPoint(GeoJson point)

Changes the point location.

Parameters:

point - a point location

getPolygons

public List<GeoJson> getPolygons()

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

Returns:

a list of drawn polygon areas

setPolygons

public void setPolygons(List<GeoJson> polygons)

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

Parameters:

polygons - a list of drawn polygon areas

getBox

public GeoJson getBox()

Returns the spatial limits of a box.

Returns:

the spatial limits of a box

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

clean

public void clean()

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

Specified by:

clean in interface ICleanable

isValid

public boolean isValid()

Returns true if the GeoLocation has any geographical data.

Returns:

true, if the GeoLocation has any geographical data