com.esri.arcgis.trackinganalyst
Class TxFolderCatalogObject

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TxFolderCatalogObject
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ITxCatalogObject, ITxFolderObject, ITxObjectContainer, ITxObjectProperties, Serializable

public class TxFolderCatalogObject
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITxFolderObject, ITxCatalogObject, ITxObjectContainer, ITxObjectProperties

The TxFolderCatalogObject provides a container for CJMTK Catalog Objects much like a directory folder does to a filesystem.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TxFolderCatalogObject()
          Constructs a TxFolderCatalogObject using ArcGIS Engine.
TxFolderCatalogObject(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TxFolderCatalogObject theTxFolderCatalogObject = (TxFolderCatalogObject) obj;
 
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 deleteChild(ITxCatalogObject child)
          Deletes the specified child object.
 void detach()
          Instructs the object to detach itself from its parent and the catalog.
 void empty()
          Empty the container.
 boolean equals(Object o)
          Compare this object with another
 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()
          Folder objects path on disk.
 int getSmallImage()
          The small image that represents the object.
 int hashCode()
          the hashcode for this object
 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 refresh()
          Updates the object and any children of the object.
 void setPath(String pbstrCurrentPath)
          Folder objects path on disk.
 
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

TxFolderCatalogObject

public TxFolderCatalogObject()
                      throws IOException,
                             UnknownHostException
Constructs a TxFolderCatalogObject using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TxFolderCatalogObject

public TxFolderCatalogObject(Object obj)
                      throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TxFolderCatalogObject theTxFolderCatalogObject = (TxFolderCatalogObject) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
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

getPath

public String getPath()
               throws IOException,
                      AutomationException
Folder objects path on disk.

Product Availability

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

Specified by:
getPath in interface ITxFolderObject
Returns:
The pbstrCurrentPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(String pbstrCurrentPath)
             throws IOException,
                    AutomationException
Folder objects path on disk.

Product Availability

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

Specified by:
setPath in interface ITxFolderObject
Parameters:
pbstrCurrentPath - The pbstrCurrentPath (in)
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.

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.

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.

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.

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
Returns:
The hBitmap
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
Returns:
The hBitmap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.