org.thales.punch.libraries.punchlang.operator

Class GeoOperator

java.lang.Object

org.thales.punch.libraries.punchlang.operator.GeoOperator

public class GeoOperator
extends Object

The GeoOperator exposes all the standard the cartographic and geographical functions .

Here are some examples:

 // compute the distance between two points
 [distance] = geo().distance([source], [dest]);

 // compute the area of a geoshape
 [area] = geo().area([surface]);
 

For this to work, your tuple must contain valid geo-json data. You can explicitly check your tuples are geo-tuple using :

 [surface] = [input].asGeoShape();
 

This will throw a PunchRuntimeException should your input data be invalid.

Author:

J.J, dimi

Constructor Summary

Constructors

Constructor and Description
GeoOperator()

Method Summary

Modifier and Type	Method and Description
boolean	contains(Tuple t1, Tuple t2) Return if the geoFeatureTuple T1 geometry contains geoFeatureTuple T2
Double	distance(Tuple t1, Tuple t2) Return a distance between two tuples.
double	getArea(Tuple t) Get Area of Geometry of GeoFeatureTuple
Boolean	intersect(Tuple t1, Tuple t2) Return if the geometries of T1 geoFeatureTuple have a least one pint in common with Geometry of T2 geoFeatureTuple

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoOperator

public GeoOperator()

Method Detail

distance

public Double distance(Tuple t1,
                       Tuple t2)

Return a distance between two tuples. This assumes the tuples are Geo-tuples.

Parameters:

t1 - first tuple

t2 - second tuple

Returns:

the distance or null if one of the two tuple is not a geo tuple.

contains

public boolean contains(Tuple t1,
                        Tuple t2)

Return if the geoFeatureTuple T1 geometry contains geoFeatureTuple T2

Parameters:

t1 - : the first geoFeatureTuple t1

t2 - : the first geoFeatureTuple t2

Returns:

true if t1 contains t2

getArea

public double getArea(Tuple t)

Get Area of Geometry of GeoFeatureTuple

Parameters:

t - : GeoFeature tuple

Returns:

the Area of GeoFeatureTuple

intersect

public Boolean intersect(Tuple t1,
                         Tuple t2)

Return if the geometries of T1 geoFeatureTuple have a least one pint in common with Geometry of T2 geoFeatureTuple

Parameters:

t1 - : the first geoFeatureTuple t1

t2 - : the first geoFeatureTuple t2

Returns:

boolean Return if the geometries of T1 geoFeatureTuple have a least one pint in common with Geometry of T2 geoFeatureTuple