Package de.dlr.proseo.geotools.rest

Class GeotoolsUtil

java.lang.Object

de.dlr.proseo.geotools.rest.GeotoolsUtil

@Component
public class GeotoolsUtil
extends Object

A utility class for working with geospatial data. It provides methods for checking if a point or polygon is inside or overlaps with certain regions defined by shape files (provided in application.yml).

Field Summary

Fields

Modifier and Type	Field	Description
(package private) GeotoolsConfiguration	geotoolsConfig	Geotools configuration

Constructor Summary

Constructors

Constructor	Description
GeotoolsUtil()

Method Summary

Modifier and Type	Method	Description
String	getInfo()	Retrieves information about the loaded shapes
Boolean	isPointInside(Double latitude, Double longitude, ShpFile shpFile)	Checks whether the geographical point defined by latitude and longitude is contained in the region described by the provided shpFile
Boolean	isPointInside(Double latitude, Double longitude, String[] types)	Checks whether the geographical point defined by latitude and longitude is inside of at least one of the provided regions
Boolean	isPolyInside(RestPolygon poly, String[] types)	Checks whether the geographical area defined by the RestPolygon is contained in one or more of the region types.
Boolean	isPolyOverlap(RestPolygon poly, String[] types)	Check whether the geographical area defined by the RestPolygon overlaps one or more of the region types.

Methods inherited from class java.lang.Object

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

Field Details

geotoolsConfig

@Autowired
GeotoolsConfiguration geotoolsConfig

Geotools configuration

Constructor Details

GeotoolsUtil

public GeotoolsUtil()

Method Details

getInfo

public String getInfo()
               throws UnsupportedOperationException,
IllegalArgumentException,
IOException

Retrieves information about the loaded shapes

Returns:

information about the loaded shapes

Throws:

UnsupportedOperationException - if a valid, but not yet handled file type was given

IllegalArgumentException - if an invalid file type was given

IOException - if the shape file could not be opened created successfully

isPointInside

public Boolean isPointInside(Double latitude,
 Double longitude,
 String[] types)
                      throws UnsupportedOperationException,
IllegalArgumentException,
IOException

Checks whether the geographical point defined by latitude and longitude is inside of at least one of the provided regions

Parameters:

latitude - a Double describing the latitude of the coordinate

longitude - a Double describing the longitude of the coordinate

types - the types parameter is used to determine which region types to check if a given point is inside. If the types parameter is null or empty, it will consider all available region types stored in the shapeMap. Otherwise, it will only check the specified region types.

Returns:

true if the coordinate is contained in at least one of the provided regions (or all known regions if none were provided)

Throws:

UnsupportedOperationException - if a valid, but not yet handled file type was given

IllegalArgumentException - if an invalid file type was given

IOException - if the shape file could not be opened created successfully

isPointInside

public Boolean isPointInside(Double latitude,
 Double longitude,
 ShpFile shpFile)
                      throws UnsupportedOperationException,
IllegalArgumentException,
IOException

Checks whether the geographical point defined by latitude and longitude is contained in the region described by the provided shpFile

Parameters:

latitude - a Double describing the latitude of the coordinate

longitude - a Double describing the longitude of the coordinate

shpFile - the shape file against which to compare the coordinate

Returns:

true if the geographical point defined by latitude and longitude is contained in the region described by the provided shpFile

Throws:

UnsupportedOperationException - if a valid, but not yet handled file type was given

IllegalArgumentException - if an invalid file type was given or either input is missing

IOException - if the shape file could not be opened created successfully

isPolyInside

public Boolean isPolyInside(RestPolygon poly,
 String[] types)
                     throws UnsupportedOperationException,
IllegalArgumentException,
IOException

Checks whether the geographical area defined by the RestPolygon is contained in one or more of the region types. All available region types will be checked if none were specified.

Parameters:

poly - a RestPolygon

types - the types parameter is used to determine which region types to check if a given point is inside. If the types parameter is null or empty, it will consider all available region types stored in the shapeMap. Otherwise, it will only check the specified region types.

Returns:

true if poly is inside

Throws:

UnsupportedOperationException - if a valid, but not yet handled file type was given

IllegalArgumentException - if an invalid file type was given

IOException - if the shape file could not be opened created successfully

isPolyOverlap

public Boolean isPolyOverlap(RestPolygon poly,
 String[] types)
                      throws UnsupportedOperationException,
IllegalArgumentException,
IOException

Check whether the geographical area defined by the RestPolygon overlaps one or more of the region types. All available region types will be checked if none were specified.

Parameters:

poly - a RestPolygon

types - the types parameter is used to determine which region types to check if a given point is inside. If the types parameter is null or empty, it will consider all available region types stored in the shapeMap. Otherwise, it will only check the specified region types.

Returns:

true if poly overlaps one or more of the regions, false otherwise

Throws:

UnsupportedOperationException - if a valid, but not yet handled file type was given

IllegalArgumentException - if an invalid file type was given

IOException - if the shape file could not be opened created successfully