Package ch.tocco.nice2.optional.geolocation.api.util

Class PersistUtil

java.lang.Object

ch.tocco.nice2.optional.geolocation.api.util.PersistUtil

public abstract class PersistUtil
extends Object

Utility class for setting and getting position values from entities.

Please consider the methods in here for setting and getting Positions from entities.

Method Summary

Modifier and Type	Method	Description
static Position	getPosition(Entity entity, String field)	Reads a Position from the specified entity assuming the fieldnames for latitude and longitude are field + "_lat" and field + "_lng", respectively.
static Position	getPosition(Entity entity, String latField, String lngField)	Gets a position from the specified entity by reading the values of its longitude and latitude fields.
static void	setBoundingBoxParameter(Query q, String paramUllat, String paramUllng, String paramLrlat, String paramLrlng, Position[] box)
static void	setDistanceParameters(Query q, String paramLat, String paramLng, Position pos, String paramDst, Distance dst)
static void	setPosition(Entity entity, Position position)	Finds two fields of type latitude and longitude of the specified entity and sets the given position into the entity.
static void	setPosition(Entity entity, String field, Position pos)	Sets the position value into the entity assuming field names for latitude and longitude to be field + "_lat" and field + _lng, respecitvely.
static void	setPosition(Entity entity, String latField, String lngField, Position pos)	Sets the specified position into the specified entity by setting the latitude and longitude values into the specified fields.

Methods inherited from class java.lang.Object

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

Method Details

setDistanceParameters

public static void setDistanceParameters(Query q,
 String paramLat,
 String paramLng,
 Position pos,
 String paramDst,
 Distance dst)
                                  throws PersistException

Throws:

PersistException

setBoundingBoxParameter

public static void setBoundingBoxParameter(Query q,
 String paramUllat,
 String paramUllng,
 String paramLrlat,
 String paramLrlng,
 Position[] box)
                                    throws PersistException

Throws:

PersistException

getPosition

public static Position getPosition(Entity entity,
 String latField,
 String lngField)
                            throws PersistException

Gets a position from the specified entity by reading the values of its longitude and latitude fields.

Parameters:

entity - the entity to read from

latField - the latitude field name of 'entity'

lngField - the longitude field name of 'entity'

Returns:

a Position consisting of the latitude and longitude as specified

Throws:

PersistException

setPosition

public static void setPosition(Entity entity,
 String latField,
 String lngField,
 Position pos)
                        throws PersistException,
InterruptedException

Sets the specified position into the specified entity by setting the latitude and longitude values into the specified fields.

Parameters:

entity - the entity to write to

latField - the latitude field name of 'entity'

lngField - the longitude field name of 'entity'

pos - the Position object to set

Throws:

PersistException

InterruptedException

setPosition

public static void setPosition(Entity entity,
 Position position)
                        throws PersistException,
InterruptedException,
IllegalArgumentException

Finds two fields of type latitude and longitude of the specified entity and sets the given position into the entity. The entity must have exactly one field of type latitude (resp. longitude) for one position, otherwise an exception is thrown. If you know the fieldnames upfront (which is the case most of the time, I guess), consider setPosition(ch.tocco.nice2.persist.core.api.entity.Entity, String, String, Position) as this runs faster.

Throws:

IllegalArgumentException - if no or more than one lat/lng field is found in the entity

PersistException

InterruptedException

setPosition

public static void setPosition(Entity entity,
 String field,
 Position pos)
                        throws PersistException,
InterruptedException

Sets the position value into the entity assuming field names for latitude and longitude to be field + "_lat" and field + _lng, respecitvely.

Throws:

PersistException

InterruptedException

getPosition

public static Position getPosition(Entity entity,
 String field)
                            throws PersistException

Reads a Position from the specified entity assuming the fieldnames for latitude and longitude are field + "_lat" and field + "_lng", respectively.

Throws:

PersistException