com.esri.arcgis.catalog
Interface IGxCatalog

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxCatalog

public interface IGxCatalog
extends Serializable

Provides access to members that manages a GX catalog.

Description

The GxCatalog object implements the IGxCatalog interface. It lets you connect and disconnect folder objects. It also maintains the file filter associated with ArcCatalog.

The GxCatalog object represents your actual tree of data, as is shown in the tree view (the top-level object in the tree view). From the GxCatalog object, you can navigate to any of its descendants to access and manipulate them. The GxCatalog object is a type of GxObject and a type of GxObjectContainer because it is an item in the tree view and it contains additional GxObjects.

The GxCatalog object is also an event source, as it monitors the adding, deleting, and changing of the GxObjects within the Catalog through the IGxCatalogEvents interface.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	close() Closes the catalog object.
IGxFolder	connectFolder(String folderPath) Adds a folder connection to the catalog and returns the folder object.
String	constructFullName(IGxObject gxObject) Constructs the full name for an object.
void	disconnectFolder(String folderPath) Removes a folder connection from the catalog.
IGxFileFilter	getFileFilter() The file filter.
Object	getObjectFromFullName(String fullName, int[] numFound) Finds an object in the catalog tree given its full name.
IGxObject	getSelectedObject() The first selected object, or the location if no objects are selected.
IGxSelection	getSelection() The selection.
void	objectAdded(IGxObject gxObject) Called when a new object has been added to part of the catalog.
void	objectChanged(IGxObject gxObject) Called when an existing object from part of the catalog has been changed.
void	objectDeleted(IGxObject gxObject) Called when an existing object has been deleted from part of the catalog.
void	objectRefreshed(IGxObject gxObject) Called when an existing object has been refreshed.
void	setLocation(String rhs1) The location to the specified path.

Method Detail

close

void close()
           throws IOException,
                  AutomationException

Closes the catalog object. Clients that create a catalog object must call this method when they are finished using it.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelection

IGxSelection getSelection()
                          throws IOException,
                                 AutomationException

The selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.catalog.IGxSelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedObject

IGxObject getSelectedObject()
                            throws IOException,
                                   AutomationException

The first selected object, or the location if no objects are selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocation

void setLocation(String rhs1)
                 throws IOException,
                        AutomationException

The location to the specified path. If the path isn't yet part of the catalog, it is added as a folder connection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileFilter

IGxFileFilter getFileFilter()
                            throws IOException,
                                   AutomationException

The file filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.catalog.IGxFileFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connectFolder

IGxFolder connectFolder(String folderPath)
                        throws IOException,
                               AutomationException

Adds a folder connection to the catalog and returns the folder object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

folderPath - The folderPath (in)

Returns:

A reference to a com.esri.arcgis.catalog.IGxFolder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnectFolder

void disconnectFolder(String folderPath)
                      throws IOException,
                             AutomationException

Removes a folder connection from the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

folderPath - The folderPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

objectAdded

void objectAdded(IGxObject gxObject)
                 throws IOException,
                        AutomationException

Called when a new object has been added to part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Parameters:

gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

objectDeleted

void objectDeleted(IGxObject gxObject)
                   throws IOException,
                          AutomationException

Called when an existing object has been deleted from part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Parameters:

gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

objectChanged

void objectChanged(IGxObject gxObject)
                   throws IOException,
                          AutomationException

Called when an existing object from part of the catalog has been changed.

Product Availability

Available with ArcGIS Desktop.

Parameters:

gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

objectRefreshed

void objectRefreshed(IGxObject gxObject)
                     throws IOException,
                            AutomationException

Called when an existing object has been refreshed.

Product Availability

Available with ArcGIS Desktop.

Parameters:

gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

constructFullName

String constructFullName(IGxObject gxObject)
                         throws IOException,
                                AutomationException

Constructs the full name for an object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

The fullName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectFromFullName

Object getObjectFromFullName(String fullName,
                             int[] numFound)
                             throws IOException,
                                    AutomationException

Finds an object in the catalog tree given its full name. Returns a Variant containing an IGxObject or IEnumGxObject (if duplicate names were encountered), along with the number of objects found.

Remarks

An example of duplicate names (numFound > 1) is a CAD drawing. ArcCatalog represents a CAD drawing as two GxObjects - as a CAD drawing and as a CAD dataset.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

fullName - The fullName (in)

numFound - The numFound (out: use single element array)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.