Class MQObjectCollection

Object
   |
   +--MQObject
         |
         +--MQObjectCollection

Direct Known Subclasses:

MQStringCollection, MQIntCollection, MQLocationCollection, MQSession, MQDBLayerQueryCollection, MQFeatureSpecifierCollection, MQLatLngCollection, MQLocationCollectionCollection, MQGeocodeOptionsCollection, MQTrekRouteCollection, MQPointCollection, MQPrimitiveCollection, MQSignCollection, MQStrColCollection, MQFeatureCollection, MQManeuverCollection, MQCoverageStyle

class MQObjectCollection

extends MQObject

Base class for collections. Takes care of basic functionality
Defined in mqcommon.js

Field Detail

m_items

<private> Array m_items

Value to represent collection

m_itemXpath

<private> String m_itemXpath

Value to represent the xpath of items in this collections

m_maxItems

<private> int m_maxItems

Value to represent maximum number of items

validClassName

<private> String validClassName

Value to represent className to check for

MQObjectCollection

MQObjectCollection(<int> max)

Constructs a new MQObjectCollection object.

Parameters:
max - The initial size of the collection array
strMQObjectType - The type of MQObject descedent to check for

add

int add(obj)

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

Returns:
The new number of items in the array or nothing if it is unsuccessful

append

void append(<MQObjectCollection> collection)

Append a collection to this one

Parameters:
collection - The collection to append to this one

contains

Boolean contains(<MQObject> item)

Check if the array contains a specific object

Parameters:
item - The object to search for

Returns:
True if the object is in the collection, false otherwise

get

Object get(<int> i)

Get the item at postion i

Parameters:
i - The position in the array from which to pull the object

Returns:
The object

getAt

Object getAt(<int> i)

Wraps the get(i) method

Parameters:
i - The position in the array from which to pull the object

Returns:
The object

getById

Object getById(<String> strId)

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

Parameters:
strId - The id to check for.

Returns:
The object if it exists.

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getM_Items

Array getM_Items()

Accessor method for m_items

Returns:
The Array of m_items

getM_itemXpath

String getM_itemXpath()

Returns the m_itemXpath string.

Returns:
The m_itemXpath string.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

getSize

int getSize()

Get the maximum size.

Returns:
The size of the array

getValidClassName

String getValidClassName()

Accessor method for ValidClassName

Returns:
Value of ValidClassName

isValidObject

MQObject isValidObject(obj)

Is this object a valid object for this collection.

Returns:
True if valid, false otherwise

remove

MQObject remove(<int> iIndex)

Remove the item at postion iIndex

Parameters:
iIndex - The position in the array from which to pull the object

Returns:
The object to be removed

removeAll

void removeAll()

Remove all the items in the array

removeItem

void removeItem(<Object> item)

Remove an item by it's pointer.

Parameters:
item - pointer to the item to remove.

set

MQObject set(i, newO)

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

Returns:
True if valid, false otherwise

setM_itemXpath

void setM_itemXpath(<String> itemXpath)

Sets the m_itemXpath string.

Parameters:
itemXpath - the String m_xpath is set to.

setValidClassName

void setValidClassName(<String> className)

Accessor method for ValidClassName

Parameters:
className - Value of ValidClassName