Class MQCorridorSearchCriteria

Object
   |
   +--MQObject
         |
         +--MQSearchCriteria
               |
               +--MQPolySearchCriteria
                     |
                     +--MQCorridorSearchCriteria

class MQCorridorSearchCriteria

extends MQPolySearchCriteria

Defines the criteria for a Corridor search. The corridor to be searched is defined by the latitude/longitude collection
See:

- MQDistanceUnits
- MQSearchCriteria

Constructor Detail

MQCorridorSearchCriteria

MQCorridorSearchCriteria()

Constructs a new MQCorridorSearchCriteria object.

See:
- MQDistanceUnits
- MQSearchCriteria

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getCorrExactLinks

Boolean getCorrExactLinks()

Returns the exactLinks-whether to use generalization in determining corridor

Returns:
The exactLinks-whether to use generalization in determining corridor

getCorridorBufferWidth

Double getCorridorBufferWidth(<MQDistanceUnits> lUnits)

Returns the width of the corridor buffer which defines the extent of the generalization.

Parameters:
lUnits - DistanceUnits Miles or KiloMeters

Returns:
The width of the corridor buffer which defines the extent of the generalization.

getCorridorWidth

Double getCorridorWidth(<MQDistanceUnits> lUnits)

Returns the width of the corridor which defines the extent of the search area.

Parameters:
lUnits - The DistanceUnits Miles or KiloMeters

Returns:
The width of the corridor which defines the extent of the search area.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

setCorrExactLinks

void setCorrExactLinks(<Boolean> bExactLinks)

Sets exactLinks-whether to use generalization in determining corridor

Parameters:
bExactLinks - Enables/disables generalization in the server.

setCorridorBufferWidth

void setCorridorBufferWidth(<Double> dBufferWidth, <MQDistanceUnits> lUnits)

Sets the buffer width which defines the amount to generalize. Returns the width it was set to.

Parameters:
dBufferWidth - The corridor buffer that this object is to be set to.
lUnits - The DistanceUnits Miles or KiloMeters.

setCorridorWidth

void setCorridorWidth(<Double> dCorrWidth, <MQDistanceUnits> lUnits)

Sets the Corridor width (miles) which defines the extent of the search area. Returns the width it was set to.

Parameters:
dCorrWidth - The corridor width that this object is to be set to.
lUnits - DistanceUnits Miles or KiloMeters.