com.esri.arcgis.catalog
Interface IGxCatalog

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GxCatalog, IGxCatalogProxy

public interface IGxCatalog
extends java.io.Serializable

COM Interface 'IGxCatalog'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description: 'Provides access to members that manages a GX catalog.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDbdbbb3ee_d0b2_11d1_aed9_080009ec734b
static int	xxDummy Deprecated. Internal use only

Method Summary

void	close() Closes the catalog object.
IGxFolder	connectFolder(java.lang.String folderPath) Adds a folder connection to the catalog and returns the folder object.
java.lang.String	constructFullName(IGxObject gxObject) Constructs the full name for an object.
void	disconnectFolder(java.lang.String folderPath) Removes a folder connection from the catalog.
IGxFileFilter	getFileFilter() The file filter.
java.lang.Object	getObjectFromFullName(java.lang.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(java.lang.String rhs1) The location to the specified path.

Field Detail

IIDbdbbb3ee_d0b2_11d1_aed9_080009ec734b

static final int IIDbdbbb3ee_d0b2_11d1_aed9_080009ec734b

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

close

void close()
           throws java.io.IOException,
                  AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelection

IGxSelection getSelection()
                          throws java.io.IOException,
                                 AutomationException

The selection.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedObject

IGxObject getSelectedObject()
                            throws java.io.IOException,
                                   AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocation

void setLocation(java.lang.String rhs1)
                 throws java.io.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.

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileFilter

IGxFileFilter getFileFilter()
                            throws java.io.IOException,
                                   AutomationException

The file filter.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connectFolder

IGxFolder connectFolder(java.lang.String folderPath)
                        throws java.io.IOException,
                               AutomationException

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

Parameters:

folderPath - The folderPath (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnectFolder

void disconnectFolder(java.lang.String folderPath)
                      throws java.io.IOException,
                             AutomationException

Removes a folder connection from the catalog.

Parameters:

folderPath - The folderPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

objectAdded

void objectAdded(IGxObject gxObject)
                 throws java.io.IOException,
                        AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

objectDeleted

void objectDeleted(IGxObject gxObject)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

objectChanged

void objectChanged(IGxObject gxObject)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

objectRefreshed

void objectRefreshed(IGxObject gxObject)
                     throws java.io.IOException,
                            AutomationException

Called when an existing object has been refreshed.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

constructFullName

java.lang.String constructFullName(IGxObject gxObject)
                                   throws java.io.IOException,
                                          AutomationException

Constructs the full name for an object.

Parameters:

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

Returns:

The fullName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectFromFullName

java.lang.Object getObjectFromFullName(java.lang.String fullName,
                                       int[] numFound)
                                       throws java.io.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.

Parameters:

fullName - The fullName (in)

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

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.