com.esri.arcgis.trackinganalyst
Class TxMaps

java.lang.Object
  com.esri.arcgis.trackinganalyst.TxMaps

All Implemented Interfaces:

IMaps, com.esri.arcgis.interop.RemoteObjRef, IArray, Serializable

public class TxMaps
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMaps, IArray

TxMaps is a container class that holds a list or array of objects implementing IMap.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:

Serialized Form

Constructor Summary

TxMaps()
Constructs a TxMaps using ArcGIS Engine.

TxMaps(Object obj)
Construct a TxMaps using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	add(IMap map) Adds a map to the collection.
void	add(Object unk) Adds an object to the array.
IMap	create() Creates a new map.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCount() Number of maps.
Object	getElement(int index) Searches for the object in the array.
IMap	getItem(int index) The map at the given index.
int	hashCode() the hashcode for this object
void	insert(int index, Object unk) Adds an object to the array at the specified index.
void	remove(IMap map) Removes a map from the collection.
void	remove(int index) Removes an object from the array.
void	removeAll() Removes all objects from the array.
void	removeAt(int index) Removes a map at the specified index.
void	reset() Removes all maps from the collection.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

TxMaps

public TxMaps()
       throws IOException,
              UnknownHostException

Constructs a TxMaps using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TxMaps

public TxMaps(Object obj)
       throws IOException

Construct a TxMaps using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TxMaps.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems TxMaps theTxMaps = (TxMaps) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getCount

public int getCount()
             throws IOException,
                    AutomationException

Number of maps.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IMaps

Specified by:

getCount in interface IArray

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItem

public IMap getItem(int index)
             throws IOException,
                    AutomationException

The map at the given index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getItem in interface IMaps

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

create

public IMap create()
            throws IOException,
                   AutomationException

Creates a new map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

create in interface IMaps

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(IMap map)
            throws IOException,
                   AutomationException

Removes a map from the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IMaps

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(IMap map)
         throws IOException,
                AutomationException

Adds a map to the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IMaps

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAt

public void removeAt(int index)
              throws IOException,
                     AutomationException

Removes a map at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAt in interface IMaps

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Removes all maps from the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IMaps

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

public Object getElement(int index)
                  throws IOException,
                         AutomationException

Searches for the object in the array.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getElement in interface IArray

Parameters:

index - The index (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(Object unk)
         throws IOException,
                AutomationException

Adds an object to the array.

Description

Adds the element to the end of the array.

Remarks

When adding an object to an Array, you are merely adding a new reference to the object not copying it. The reference is released when the Array is destroyed or the object is removed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IArray

Parameters:

unk - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   Object unk)
            throws IOException,
                   AutomationException

Adds an object to the array at the specified index.

Description

Adds the element to the array at the specified index. The element at the beginning or the array has an index of 0, and the element at the end of the array has in index of Count - 1.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

insert in interface IArray

Parameters:

index - The index (in)

unk - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws IOException,
                   AutomationException

Removes an object from the array.

Description

Removes the element at the specified index from the array. The element at the beginning or the array has an index of 0, and the element at the end of the array has in index of Count - 1.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IArray

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Removes all objects from the array.

Description

Removes all of the elements from the array.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAll in interface IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.