com.esri.arcgis.trackinganalyst
Class TxCatalog

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, ITxCatalog, ITxCatalogObject, ITxObjectContainer, ITxObjectProperties, ITxObjectPropertiesGEN, Serializable

public class TxCatalog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITxCatalog, ITxObjectContainer, ITxCatalogObject, ITxObjectProperties, ITxObjectPropertiesGEN, ISupportErrorInfo

This class provides a GUI less catalog of structured objects that allow the navigation of a system to discover GIS data sources.

Description

This object is a general purpose wrapper object around ESRI name objects. This class provides a GUI-less catalog of structured objects that allow the navigation of a system to discover GIS data sources.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TxCatalog()
Constructs a TxCatalog using ArcGIS Engine.

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

Method Summary

ITxCatalogObject	addChild(ITxCatalogObject child) Adds a new child and returns a reference to it.
void	attach(ITxCatalogObject parent, ITxCatalog pCatalog) Attaches the object to its parent and the catalog.
void	close() Close the Open Catalog and save its state to the current path.
ITxCatalogObject	connectFolder(String bstrFolderPath) Connect a folder to the root level of the Catalog.
void	deleteChild(ITxCatalogObject child) Deletes the specified child object.
void	detach() Instructs the object to detach itself from its parent and the catalog.
void	disconnectFolder(String bstrFolderPath) Disconnect a folder from the root level of the Catalog.
void	empty() Empty the container.
boolean	equals(Object o) Compare this object with another
void	esri_new() Creates a Default Catalog Removing any customized folders or root objects added.
String	getBaseName() The base name of the object (i.e.
String	getCategory() The category of the object.
IEnumTxObject	getChildren() An enumeration of the child objects.
IUID	getClassID() The class ID of this object.
static String	getClsid() getClsid.
int	getCount() The number of Objects in the container.
String	getFullName() The full name of the object.
IName	getInternalObjectName() The Name for the internal object that this GxObject represents.
int	getLargeImage() The large image that represents the object.
String	getName() The short name of the object.
ITxCatalogObject	getParent() The parent of the object.
String	getPath() The current path of the Catalogs configuration file.
int	getSmallImage() The small image that represents the object.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAreChildrenViewable() Indicates if the objects children are available for viewing in the tree-view.
boolean	isHasChildren() Indicates if the catalog object have any children.
boolean	isValid() Indicates if the object is still valid.
void	open(String bstrCatalogPath) Opens a Catalog Configuration File at the specified path.
void	refresh() Updates the object and any children of the object.
void	save(String bstrPath) Save the catalogs state to a configurations file at the Path specified.

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

TxCatalog

public TxCatalog()
          throws IOException,
                 UnknownHostException

Constructs a TxCatalog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TxCatalog

public TxCatalog(Object obj)
          throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems TxCatalog theTxCatalog = (TxCatalog) 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

connectFolder

public ITxCatalogObject connectFolder(String bstrFolderPath)
                               throws IOException,
                                      AutomationException

Connect a folder to the root level of the Catalog.

Product Availability

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

Specified by:

connectFolder in interface ITxCatalog

Parameters:

bstrFolderPath - The bstrFolderPath (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnectFolder

public void disconnectFolder(String bstrFolderPath)
                      throws IOException,
                             AutomationException

Disconnect a folder from the root level of the Catalog.

Product Availability

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

Specified by:

disconnectFolder in interface ITxCatalog

Parameters:

bstrFolderPath - The bstrFolderPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

public void close()
           throws IOException,
                  AutomationException

Close the Open Catalog and save its state to the current path.

Product Availability

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

Specified by:

close in interface ITxCatalog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException

The current path of the Catalogs configuration file.

Product Availability

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

Specified by:

getPath in interface ITxCatalog

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_new

public void esri_new()
              throws IOException,
                     AutomationException

Creates a Default Catalog Removing any customized folders or root objects added.

Product Availability

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

Specified by:

esri_new in interface ITxCatalog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public void open(String bstrCatalogPath)
          throws IOException,
                 AutomationException

Opens a Catalog Configuration File at the specified path.

Product Availability

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

Specified by:

open in interface ITxCatalog

Parameters:

bstrCatalogPath - The bstrCatalogPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(String bstrPath)
          throws IOException,
                 AutomationException

Save the catalogs state to a configurations file at the Path specified.

Product Availability

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

Specified by:

save in interface ITxCatalog

Parameters:

bstrPath - The bstrPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasChildren

public boolean isHasChildren()
                      throws IOException,
                             AutomationException

Indicates if the catalog object have any children.

Product Availability

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

Specified by:

isHasChildren in interface ITxObjectContainer

Returns:

The hasChildren

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumTxObject getChildren()
                          throws IOException,
                                 AutomationException

An enumeration of the child objects.

Product Availability

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

Specified by:

getChildren in interface ITxObjectContainer

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IEnumTxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAreChildrenViewable

public boolean isAreChildrenViewable()
                              throws IOException,
                                     AutomationException

Indicates if the objects children are available for viewing in the tree-view.

Product Availability

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

Specified by:

isAreChildrenViewable in interface ITxObjectContainer

Returns:

The areViewable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addChild

public ITxCatalogObject addChild(ITxCatalogObject child)
                          throws IOException,
                                 AutomationException

Adds a new child and returns a reference to it. However, if a duplicate already exists, the function returns the existing child instead.

Product Availability

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

Specified by:

addChild in interface ITxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteChild

public void deleteChild(ITxCatalogObject child)
                 throws IOException,
                        AutomationException

Deletes the specified child object.

Product Availability

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

Specified by:

deleteChild in interface ITxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The number of Objects in the container.

Product Availability

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

Specified by:

getCount in interface ITxObjectContainer

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Empty the container.

Description

This method empties the container.

Product Availability

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

Specified by:

empty in interface ITxObjectContainer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The short name of the object.

Product Availability

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

Specified by:

getName in interface ITxCatalogObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public String getFullName()
                   throws IOException,
                          AutomationException

The full name of the object.

Product Availability

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

Specified by:

getFullName in interface ITxCatalogObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

public String getBaseName()
                   throws IOException,
                          AutomationException

The base name of the object (i.e. no extension).

Product Availability

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

Specified by:

getBaseName in interface ITxCatalogObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the object.

Description

This property indicates the category of the object (e.g., Shapefile Feature Class).

Product Availability

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

Specified by:

getCategory in interface ITxCatalogObject

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

public ITxCatalogObject getParent()
                           throws IOException,
                                  AutomationException

The parent of the object.

Product Availability

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

Specified by:

getParent in interface ITxCatalogObject

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of this object.

Product Availability

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

Specified by:

getClassID in interface ITxCatalogObject

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalObjectName

public IName getInternalObjectName()
                            throws IOException,
                                   AutomationException

The Name for the internal object that this GxObject represents.

Product Availability

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

Specified by:

getInternalObjectName in interface ITxCatalogObject

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the object is still valid.

Product Availability

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

Specified by:

isValid in interface ITxCatalogObject

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attach

public void attach(ITxCatalogObject parent,
                   ITxCatalog pCatalog)
            throws IOException,
                   AutomationException

Attaches the object to its parent and the catalog.

Product Availability

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

Specified by:

attach in interface ITxCatalogObject

Parameters:

parent - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject (in)

pCatalog - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws IOException,
                   AutomationException

Instructs the object to detach itself from its parent and the catalog.

Product Availability

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

Specified by:

detach in interface ITxCatalogObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Updates the object and any children of the object.

Product Availability

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

Specified by:

refresh in interface ITxCatalogObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException

The small image that represents the object.

Product Availability

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

Specified by:

getSmallImage in interface ITxObjectProperties

Specified by:

getSmallImage in interface ITxObjectPropertiesGEN

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException

The large image that represents the object.

Product Availability

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

Specified by:

getLargeImage in interface ITxObjectProperties

Specified by:

getLargeImage in interface ITxObjectPropertiesGEN

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.