com.inrix.sdk

Class AreaLimitedManager

java.lang.Object

com.inrix.sdk.AreaLimitedManager

Direct Known Subclasses:

CameraManager, GasStationManager, ParkingManager

public abstract class AreaLimitedManager
extends Object

An abstract representation of a Manager which needs to enforce restrictions on the geographical area of certain queries, for example search queries restricted to a rectangular (box) or a circular (point and radius) region.

Constructor Summary

Constructors

Constructor and Description
AreaLimitedManager()

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	getAllowedArea(UserPreferences.Unit units) Get the maximum allowed area to query in the given units.
boolean	isQueryAreaWithinLimits(double radius, UserPreferences.Unit units) Check if the area of the circle is within allowed limits.
boolean	isQueryAreaWithinLimits(GeoPoint corner1, GeoPoint corner2) Check if the area of the box is within allowed limits.

Methods inherited from class java.lang.Object

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

Constructor Detail

AreaLimitedManager

public AreaLimitedManager()

Method Detail

isQueryAreaWithinLimits

public boolean isQueryAreaWithinLimits(GeoPoint corner1,
                              GeoPoint corner2)

Check if the area of the box is within allowed limits.

Parameters:

corner1 - First corner, can be specified in any order but must be diagonally opposite to corner2

corner2 - Second corner, can be specified in any order but must be diagonally opposite to corner1

Returns:

true if the area is within allowed limits, false otherwise

isQueryAreaWithinLimits

public boolean isQueryAreaWithinLimits(double radius,
                              UserPreferences.Unit units)

Check if the area of the circle is within allowed limits.

Parameters:

radius - - radius of the circle

units - - units of measure see UserPreferences.Unit

Returns:

true if the area is within the limit, false otherwise

getAllowedArea

public abstract double getAllowedArea(UserPreferences.Unit units)

Get the maximum allowed area to query in the given units.

Parameters:

units - units to express the area in

Returns:

area, in the given units