com.mapquest.MQObjectCollection

	Property	Defined by
		CLASS_NAME : String = "MQObject" [static]	MQObject

	Property	Defined by
		itemXpath : String = "Item" Value to represent the xpath of items in this collections	MQObjectCollection
		m_items : Array Value to represent collection	MQObjectCollection
		objectVersion : Number = 0 Value to represent the version of this object	MQObject
		xml : XML = null	MQObject
		xpath : String	MQObject

Public Methods

	Method		Defined by
		MQObjectCollection(max:int) Constructs a new MQObjectCollection object.	MQObjectCollection
		add(obj:MQObject):int Adds this object to the array if it has not reached the maximum size.	MQObjectCollection
		addInteger(integer:int):int Adds this integer to the array if it has not reached the maximum size.	MQObjectCollection
		addString(str:String):int Adds this string to the array if it has not reached the maximum size.	MQObjectCollection
		append(collection:MQObjectCollection):void Append a collection to this one	MQObjectCollection
		contains(item:MQObject):Boolean Check if the array contains a specific object	MQObjectCollection
		get(i:Number):* Get the item at postion i	MQObjectCollection
		getAt(i:Number):*	MQObjectCollection
		getById(strId:String):MQObject Return the object, if it exists, with the id strId	MQObjectCollection
		getClassName():String Returns the text name of this class.	MQObjectCollection
		getItemXpath():String Returns the m_itemXpath string.	MQObjectCollection
		getObjectVersion():Number Returns the version of this class.	MQObject
		getProperty(path:String):String Gets values from xml.	MQObject
		getSize():int Get the maximum size.	MQObjectCollection
		getValidClassName():String Accessor method for ValidClassName	MQObjectCollection
		internalCopy(obj:MQObject):MQObject Create a copy of this object.	MQObject
		internalCopyXML(obj:MQObject):XML	MQObject
		internalCopyXMLx(obj:MQObject):String	MQObject
		isValidObject(obj:Object):Boolean Is this object a valid object for this collection.	MQObjectCollection
		loadXml(xml:XML):void New XML Handler	MQObject
		readExternal(input:IDataInput):void	MQObject
		remove(iIndex:int):* Remove the item at postion iIndex	MQObjectCollection
		removeAll():void Remove all the items in the array	MQObjectCollection
		removeItem(item:MQObject):void Remove an item by it's pointer.	MQObjectCollection
		saveXml():XML New XML Handler	MQObject
		set(i:Number, newO:MQObject):MQObject Replace an object at position i and return the old object.	MQObjectCollection
		setItemXpath(itemXpath:String):void Sets the m_itemXpath string.	MQObjectCollection
		setProperty(path:String, value:Object):String Sets values in xml.	MQObject
		setValidClassName(className:String):void Accessor method for ValidClassName	MQObjectCollection
		setXpath(xpath:String):void Sets the m_xpath object.	MQObject
		writeExternal(output:IDataOutput):void	MQObject

	Method	Defined by
		getItems():Array Accessor method for m_items	MQObjectCollection
		getXML():XML Returns the m_xmlDoc object.	MQObject
		getXpath():String Returns the xpath string.	MQObject
		setXML(xml:XML):void Sets the m_xmlDoc object.	MQObject

Property detail

itemXpath

property

protected var itemXpath:String = "Item"

Value to represent the xpath of items in this collections

m_items

property

protected var m_items:Array

Value to represent collection

Constructor detail

MQObjectCollection

()

constructor

public function MQObjectCollection(max:int)

Constructs a new MQObjectCollection object.

Parameters

max:int

Method detail

add

()

method

public function add(obj:MQObject):int

Adds this object to the array if it has not reached the maximum size. Type Checking is left to the descendent class.

Parameters

obj:MQObject

Returns

int — The new number of items in the array or nothing if it is unsuccessful

addInteger

()

method

public function addInteger(integer:int):int

Adds this integer to the array if it has not reached the maximum size. Type Checking is left to the descendent class.

Parameters

integer:int

Returns

int — The new number of items in the array or nothing if it is unsuccessful

addString

()

method

public function addString(str:String):int

Adds this string to the array if it has not reached the maximum size. Type Checking is left to the descendent class.

Parameters

str:String

Returns

int — The new number of items in the array or nothing if it is unsuccessful

append

()

method

public function append(collection:MQObjectCollection):void

Append a collection to this one

Parameters

collection:MQObjectCollection — collection The collection to append to this one

contains

()

method

public function contains(item:MQObject):Boolean

Check if the array contains a specific object

Parameters

item:MQObject — item The object to search for

Returns

Boolean — True if the object is in the collection, false otherwise

get

()

method

public function get(i:Number):*

Get the item at postion i

Parameters

i:Number — i The position in the array from which to pull the object

Returns

* — The object

getAt

()

method

public function getAt(i:Number):*Parameters

i:Number

Returns

*

getById

()

method

public function getById(strId:String):MQObject

Return the object, if it exists, with the id strId

Parameters

strId:String — strId The id to check for.

Returns

MQObject — The object if it exists.

getClassName

()

method

public override function getClassName():String

Returns the text name of this class.

Returns

String — The text name of this class.

getItems

()

method

protected function getItems():Array

Accessor method for m_items

Returns

Array — The Array of m_items

getItemXpath

()

method

public function getItemXpath():String

Returns the m_itemXpath string.

Returns

String — The m_itemXpath string.

getSize

()

method

public function getSize():int

Get the maximum size.

Returns

int — The size of the array

getValidClassName

()

method

public function getValidClassName():String

Accessor method for ValidClassName

Returns

String — Value of ValidClassName

isValidObject

()

method

public function isValidObject(obj:Object):Boolean

Is this object a valid object for this collection.

Parameters

obj:Object

Returns

Boolean — True if valid, false otherwise

remove

()

method

public function remove(iIndex:int):*

Remove the item at postion iIndex

Parameters

iIndex:int — iIndex The position in the array from which to pull the object

Returns

* — The object to be removed

removeAll

()

method

public function removeAll():void

Remove all the items in the array

removeItem

()

method

public function removeItem(item:MQObject):void

Remove an item by it's pointer.

Parameters

item:MQObject — item pointer to the item to remove.

set

()

method

public function set(i:Number, newO:MQObject):MQObject

Replace an object at position i and return the old object.

Parameters

	`i:Number`

	`newO:MQObject`

Returns

MQObject — True if valid, false otherwise

setItemXpath

()

method

public function setItemXpath(itemXpath:String):void

Sets the m_itemXpath string.

Parameters

itemXpath:String — itemXpath the String m_xpath is set to.

setValidClassName

()

method

public function setValidClassName(className:String):void

Accessor method for ValidClassName

Parameters

className:String — className Value of ValidClassName

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class MQObjectCollection	Properties \| Methods

Package	com.mapquest
Class	public class MQObjectCollection
Inheritance	MQObjectCollection MQObject
Subclasses	CoverageStyle, DBLayerQueryCollection, FeatureCollection, FeatureSpecifierCollection, GeocodeOptionsCollection, IntCollection, LatLngCollection, LocationCollection, LocationCollectionCollection, ManeuverCollection, MQSession, PointCollection, PrimitiveCollection, SignCollection, StrColCollection, StringCollection, TrekRouteCollection