Packagecom.mapquest
Classpublic class CorridorSearchCriteria
InheritanceCorridorSearchCriteria Inheritance PolySearchCriteria Inheritance SearchCriteria Inheritance MQObject

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

See also

DistanceUnits
SearchCriteria


Public Properties
 PropertyDefined by
 InheritedCLASS_NAME : String = "MQObject"
[static]
MQObject
Protected Properties
 PropertyDefined by
 InheritedobjectVersion : Number = 0
Value to represent the version of this object
MQObject
 Inheritedxml : XML = null
MQObject
 Inheritedxpath : String
MQObject
Public Methods
 MethodDefined by
  
Constructs a new CorridorSearchCriteria object.
CorridorSearchCriteria
  
getClassName():String
Returns the text name of this class.
CorridorSearchCriteria
  
Returns the exactLinks-whether to use generalization in determining corridor
CorridorSearchCriteria
  
Returns the width of the corridor buffer which defines the extent of the generalization.
CorridorSearchCriteria
  
Returns the width of the corridor which defines the extent of the search area.
CorridorSearchCriteria
 Inherited
Gets the data member of this object which indicates the maximum number of matches that are to be returned by the search.
SearchCriteria
  
Returns the version of this class.
CorridorSearchCriteria
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
 Inherited
Returns the m_LatLngs object.
PolySearchCriteria
 Inherited
Create a copy of this object.
MQObject
 Inherited
MQObject
 Inherited
MQObject
 Inherited
loadXml(xmlPrm:XML):void
Assigns the xml that relates to this object.
PolySearchCriteria
 Inherited
readExternal(input:IDataInput):void
MQObject
 Inherited
saveXml():XML
Build xml that represents this object.
PolySearchCriteria
  
setCorrExactLinks(bExactLinks:Boolean):void
Sets exactLinks-whether to use generalization in determining corridor
CorridorSearchCriteria
  
setCorridorBufferWidth(dBufferWidth:Number, lUnits:DistanceUnits):void
Sets the buffer width which defines the amount to generalize.
CorridorSearchCriteria
  
setCorridorWidth(dCorrWidth:Number, lUnits:DistanceUnits):void
Sets the Corridor width (miles) which defines the extent of the search area.
CorridorSearchCriteria
 Inherited
setMaxMatches(nMax:int):void
Sets the data member of this object which indicates the maximum number of matches that are to be returned by the search.
SearchCriteria
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
 Inherited
Sets the m_LatLngs object.
PolySearchCriteria
 Inherited
setXpath(xpath:String):void
Sets the m_xpath object.
MQObject
 Inherited
writeExternal(output:IDataOutput):void
MQObject
Protected Methods
 MethodDefined by
 Inherited
getXML():XML
Returns the m_xmlDoc object.
MQObject
 Inherited
getXpath():String
Returns the xpath string.
MQObject
 Inherited
setXML(xml:XML):void
Sets the m_xmlDoc object.
MQObject
Constructor detail
CorridorSearchCriteria()constructor
public function CorridorSearchCriteria()

Constructs a new CorridorSearchCriteria object.

Method detail
getClassName()method
public override function getClassName():String

Returns the text name of this class.

Returns
String — The text name of this class.
getCorrExactLinks()method 
public function getCorrExactLinks():Boolean

Returns the exactLinks-whether to use generalization in determining corridor

Returns
Boolean — The exactLinks-whether to use generalization in determining corridor
getCorridorBufferWidth()method 
public function getCorridorBufferWidth(lUnits:DistanceUnits):Number

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

Parameters
lUnits:DistanceUnits — lUnits DistanceUnits Miles or KiloMeters

Returns
Number — The width of the corridor buffer which defines the extent of the generalization.
getCorridorWidth()method 
public function getCorridorWidth(lUnits:DistanceUnits):Number

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

Parameters
lUnits:DistanceUnits — lUnits The DistanceUnits Miles or KiloMeters

Returns
Number — The width of the corridor which defines the extent of the search area.
getObjectVersion()method 
public override function getObjectVersion():Number

Returns the version of this class.

Returns
Number — The version of this class.
setCorrExactLinks()method 
public function setCorrExactLinks(bExactLinks:Boolean):void

Sets exactLinks-whether to use generalization in determining corridor

Parameters
bExactLinks:Boolean — bExactLinks Enables/disables generalization in the server.
setCorridorBufferWidth()method 
public function setCorridorBufferWidth(dBufferWidth:Number, lUnits:DistanceUnits):void

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

Parameters
dBufferWidth:Number — dBufferWidth The corridor buffer that this object is to be set to.
 
lUnits:DistanceUnits — lUnits The DistanceUnits Miles or KiloMeters.
setCorridorWidth()method 
public function setCorridorWidth(dCorrWidth:Number, lUnits:DistanceUnits):void

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

Parameters
dCorrWidth:Number — {Double} dCorrWidth The corridor width that this object is to be set to.
 
lUnits:DistanceUnits — {DistanceUnits} lUnits DistanceUnits Miles or KiloMeters.