com.esri.arcgis.catalog
Class GxCatalog

java.lang.Object
  com.esri.arcgis.catalog.GxCatalog

All Implemented Interfaces:

IGxCatalog, IGxCatalogDefaultDatabase, IGxCatalogWorkspace, IGxDataElement, IGxDataElementHelper, IGxFile, IGxObject, IGxObjectContainer, IGxObjectEdit, IGxObjectFactories, IGxObjectSort, IGxObjectUI, IGxPasteTarget, IGxPasteTargetHelper, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IComPropertySheetEvents, java.io.Serializable, java.util.EventListener

public class GxCatalog
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxCatalog, IGxCatalogWorkspace, IGxCatalogDefaultDatabase, IGxObject, IGxObjectUI, IGxObjectContainer, IGxObjectEdit, IGxPasteTarget, IGxFile, IComPropertySheetEvents, IConnectionPointContainer, IGxObjectFactories, IGxPasteTargetHelper, IGxDataElement, IGxDataElementHelper, IGxObjectSort

COM Class 'GxCatalog'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description 'GxObject that represents the 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.catalog.IGxCatalog

IID, IIDbdbbb3ee_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxCatalogWorkspace

IID, IID9585bc1b_3477_48f7_9f28_c1ed484ad498, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxCatalogDefaultDatabase

IID, IIDf154fd7b_c485_47d2_810a_2792e41f225d, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObject

IID, IIDbdbbb3eb_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectUI

IID, IID7273aa57_e6f9_11d2_9f30_00c04f6bc69e, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectContainer

IID, IID7273aa58_e6f9_11d2_9f30_00c04f6bc69e, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectEdit

IID, IIDbdbbb3fc_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxPasteTarget

IID, IIDbdbbb403_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxFile

IID, IIDbdbbb3f2_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.systemUI.IComPropertySheetEvents

IID, IID6b7b57f8_5765_11d0_92d9_00805f7c28b0, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectFactories

IID, IID6eec9a26_e824_45d7_9536_fe28393ba9c1, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxPasteTargetHelper

IID, IIDc8b779c7_9ce0_45f9_bb53_c09898688c25, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxDataElement

IID, IID611c22e5_dab3_4ac6_9c98_665d0f89aacd, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxDataElementHelper

IID, IID880af9da_a704_4546_9ff3_bd2fa8ab9e82, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectSort

IID, IID4b7eb42e_d500_11d3_a6f3_0008c7d3ae50, xxDummy

Constructor Summary

GxCatalog()
Constructs a GxCatalog using ArcGIS Engine.

GxCatalog(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxCatalog theGxCatalog = (GxCatalog) obj;

Method Summary

IGxObject	addChild(IGxObject child) Adds a new child and returns a reference to it.
void	addIGxCatalogEventsDispListener(IGxCatalogEventsDisp theListener) addIGxCatalogEventsDispListener.
void	addIGxCatalogEventsListener(IGxCatalogEvents theListener) addIGxCatalogEventsListener.
void	attach(IGxObject parent, IGxCatalog pCatalog) Attaches the object to its parent and the catalog.
boolean	canCopy() Indicates if the object can be copied.
boolean	canDelete() Indicates if the object can be deleted.
boolean	canPaste(IEnumName names, boolean[] moveOperation) Indicates if the specified names may be pasted into this object.
boolean	canPaste(IName name, IGxObject target, boolean[] moveOperation) Indicates if the specified name object may be pasted into the given target.
boolean	canRename() Indicates if the object can be renamed.
void	close() Closes the catalog object.
void	close(boolean saveChanges) Closes the file, optionally saving changes.
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	delete() Deletes the object.
void	deleteChild(IGxObject child) Deletes the specified child object.
void	detach() Instructs the object to detach itself from its parent and the catalog.
void	disconnectFolder(java.lang.String folderPath) Removes a folder connection from the catalog.
void	edit() Opens an editor to modify the file.
void	editProperties(int hParent) Presents a modal dialog to allow editing the object's properties.
void	enableGxObjectFactory(int index, boolean enabled) Enables or disables a GxObject factory.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	esri_new() Creates a new file.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
java.lang.String	getBaseName() The base name of the object (i.e.
java.lang.String	getCategory() The category of the object.
IEnumGxObject	getChildren() An enumeration of the child objects.
IUID	getClassID() The class ID of this object.
static java.lang.String	getClsid() getClsid.
IUID	getContextMenu() The class ID of the context menu for this object.
int	getCount() The number of registered GxObject factories.
IDataElement	getDataElement(IDEBrowseOptions browseOptions) Get the GxObject's data element.
IWorkspaceName	getDefaultDatabaseName() The default geodatabase.
IWorkspaceName	getDefaultDatabaseNameNoValidate() The default geodatabase.
IEnumGxObjectFactory	getEnabledGxObjectFactories() The enabled GxObject factories (sorted by priority).
IGxFileFilter	getFileFilter() The file filter.
java.lang.String	getFullName() The full name of the object.
IGxObjectFactory	getGxObjectFactory(int index) The specified GxObject factory.
IUID	getGxObjectFactoryCLSID(int index) The class ID of the specified GxObject factory.
IName	getInternalObjectName() The Name for the internal object that this GxObject represents.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLargeImage() The large image that represents the object.
int	getLargeSelectedImage() The large image that represents the object when it is selected.
java.lang.String	getName() The short name of the object.
IUID	getNewMenu() The class ID of the New menu for this object.
java.lang.Object	getObjectFromFullName(java.lang.String fullName, int[] numFound) Finds an object in the catalog tree given its full name.
IGxObject	getParent() The parent of the object.
java.lang.String	getPath() The full path for the file.
IGxObject	getSelectedObject() The first selected object, or the location if no objects are selected.
IGxSelection	getSelection() The selection.
int	getSmallImage() The small image that represents the object.
int	getSmallSelectedImage() The small image that represents the object when it is selected.
java.lang.String	getWorkspaceFolderPath() The workspace path.
int	hashCode() the hashcode for this object
boolean	isAreChildrenViewable() Indicates if the objects children are available for viewing in the tree-view.
boolean	isEnabled(int index) Indicates if a specific GxObject factory is enabled.
boolean	isHasChildren() Indicates if the object has any children.
boolean	isSortEnabled() Indicates if sorting is enabled for this GxObject.
boolean	isUseWorkspaceFolder() Indicates if the catalog uses a workspace folder as a home folder.
boolean	isValid() Indicates if the object is still valid.
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	onApply(IComPropertySheetEventsOnApplyEvent theEvent) Occurs when changes are applied.
void	open() Opens the file.
void	openWorkspaceFolder(java.lang.String workspaceFolderPath) Opens the document catalog.
boolean	paste(IEnumName names, boolean[] moveOperation) Pastes the specified names into this object.
boolean	paste(IName name, IGxObject target, boolean[] moveOperation) Pastes the specified name object into the given target.
void	refresh() Updates the object and any children of the object.
void	release() Release a GxCatalog.
void	removeIGxCatalogEventsDispListener(IGxCatalogEventsDisp theListener) removeIGxCatalogEventsDispListener.
void	removeIGxCatalogEventsListener(IGxCatalogEvents theListener) removeIGxCatalogEventsListener.
void	rename(java.lang.String newShortName) Renames the object.
void	retrieveDEBaseProperties(IDataElement[] dataElement) Retrieve the GxObject's light-weight properties.
void	retrieveDEFullProperties(IDataElement[] dataElement) Retrieve the GxObject's heavy-weight properties.
void	save() Saves changes without closing the file.
void	setDefaultDatabaseName(IWorkspaceName ppWorkspaceName) The default geodatabase.
void	setDefaultDatabaseNameNoValidate(IWorkspaceName ppWorkspaceName) The default geodatabase.
void	setLocation(java.lang.String rhs1) The location to the specified path.
void	setPath(java.lang.String path) The full path for the file.
void	setSortEnabled(boolean path) Indicates if sorting is enabled for this GxObject.
void	setUseWorkspaceFolder(boolean bUseWorkspaceFolder) Indicates if the catalog uses a workspace folder as a home folder.

Methods inherited from class java.lang.Object

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

Constructor Detail

GxCatalog

public GxCatalog()
          throws java.io.IOException,
                 java.net.UnknownHostException

Constructs a GxCatalog using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxCatalog

public GxCatalog(java.lang.Object obj)
          throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxCatalog theGxCatalog = (GxCatalog) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIGxCatalogEventsDispListener

public void addIGxCatalogEventsDispListener(IGxCatalogEventsDisp theListener)
                                     throws java.io.IOException

addIGxCatalogEventsDispListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalog.IGxCatalogEventsDisp interface.

Throws:

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

removeIGxCatalogEventsDispListener

public void removeIGxCatalogEventsDispListener(IGxCatalogEventsDisp theListener)
                                        throws java.io.IOException

removeIGxCatalogEventsDispListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalog.IGxCatalogEventsDisp interface.

Throws:

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

addIGxCatalogEventsListener

public void addIGxCatalogEventsListener(IGxCatalogEvents theListener)
                                 throws java.io.IOException

addIGxCatalogEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalog.IGxCatalogEvents interface.

Throws:

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

removeIGxCatalogEventsListener

public void removeIGxCatalogEventsListener(IGxCatalogEvents theListener)
                                    throws java.io.IOException

removeIGxCatalogEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalog.IGxCatalogEvents interface.

Throws:

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

release

public void release()

Release a GxCatalog.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

close

public 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.

Specified by:

close in interface IGxCatalog

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelection

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

The selection.

Specified by:

getSelection in interface IGxCatalog

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

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

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

Specified by:

getSelectedObject in interface IGxCatalog

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

public 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.

Specified by:

setLocation in interface IGxCatalog

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileFilter

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

The file filter.

Specified by:

getFileFilter in interface IGxCatalog

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

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

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

Specified by:

connectFolder in interface IGxCatalog

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

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

Removes a folder connection from the catalog.

Specified by:

disconnectFolder in interface IGxCatalog

Parameters:

folderPath - The folderPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

objectAdded

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

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

Specified by:

objectAdded in interface IGxCatalog

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

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

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

Specified by:

objectDeleted in interface IGxCatalog

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

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

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

Specified by:

objectChanged in interface IGxCatalog

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

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

Called when an existing object has been refreshed.

Specified by:

objectRefreshed in interface IGxCatalog

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

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

Constructs the full name for an object.

Specified by:

constructFullName in interface IGxCatalog

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

public 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.

Specified by:

getObjectFromFullName in interface IGxCatalog

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.

isUseWorkspaceFolder

public boolean isUseWorkspaceFolder()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the catalog uses a workspace folder as a home folder.

Specified by:

isUseWorkspaceFolder in interface IGxCatalogWorkspace

Returns:

The bUseWorkspaceFolder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseWorkspaceFolder

public void setUseWorkspaceFolder(boolean bUseWorkspaceFolder)
                           throws java.io.IOException,
                                  AutomationException

Indicates if the catalog uses a workspace folder as a home folder.

Specified by:

setUseWorkspaceFolder in interface IGxCatalogWorkspace

Parameters:

bUseWorkspaceFolder - The bUseWorkspaceFolder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFolderPath

public java.lang.String getWorkspaceFolderPath()
                                        throws java.io.IOException,
                                               AutomationException

The workspace path.

Specified by:

getWorkspaceFolderPath in interface IGxCatalogWorkspace

Returns:

The workspaceFolderPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openWorkspaceFolder

public void openWorkspaceFolder(java.lang.String workspaceFolderPath)
                         throws java.io.IOException,
                                AutomationException

Opens the document catalog.

Specified by:

openWorkspaceFolder in interface IGxCatalogWorkspace

Parameters:

workspaceFolderPath - The workspaceFolderPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultDatabaseName

public IWorkspaceName getDefaultDatabaseName()
                                      throws java.io.IOException,
                                             AutomationException

The default geodatabase.

Specified by:

getDefaultDatabaseName in interface IGxCatalogDefaultDatabase

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultDatabaseName

public void setDefaultDatabaseName(IWorkspaceName ppWorkspaceName)
                            throws java.io.IOException,
                                   AutomationException

The default geodatabase.

Specified by:

setDefaultDatabaseName in interface IGxCatalogDefaultDatabase

Parameters:

ppWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultDatabaseNameNoValidate

public IWorkspaceName getDefaultDatabaseNameNoValidate()
                                                throws java.io.IOException,
                                                       AutomationException

The default geodatabase. Does not perform validation on the geodatabase.

Specified by:

getDefaultDatabaseNameNoValidate in interface IGxCatalogDefaultDatabase

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultDatabaseNameNoValidate

public void setDefaultDatabaseNameNoValidate(IWorkspaceName ppWorkspaceName)
                                      throws java.io.IOException,
                                             AutomationException

The default geodatabase. Does not perform validation on the geodatabase.

Specified by:

setDefaultDatabaseNameNoValidate in interface IGxCatalogDefaultDatabase

Parameters:

ppWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The short name of the object.

Specified by:

getName in interface IGxObject

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

public java.lang.String getFullName()
                             throws java.io.IOException,
                                    AutomationException

The full name of the object.

Specified by:

getFullName in interface IGxObject

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBaseName

public java.lang.String getBaseName()
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

getBaseName in interface IGxObject

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException

The category of the object.

Specified by:

getCategory in interface IGxObject

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParent

public IGxObject getParent()
                    throws java.io.IOException,
                           AutomationException

The parent of the object.

Specified by:

getParent in interface IGxObject

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.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException

The class ID of this object.

Specified by:

getClassID in interface IGxObject

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInternalObjectName

public IName getInternalObjectName()
                            throws java.io.IOException,
                                   AutomationException

The Name for the internal object that this GxObject represents.

Specified by:

getInternalObjectName in interface IGxObject

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException

Indicates if the object is still valid.

Specified by:

isValid in interface IGxObject

Returns:

The isValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

attach

public void attach(IGxObject parent,
                   IGxCatalog pCatalog)
            throws java.io.IOException,
                   AutomationException

Attaches the object to its parent and the catalog.

Specified by:

attach in interface IGxObject

Parameters:

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

pCatalog - A reference to a com.esri.arcgis.catalog.IGxCatalog (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws java.io.IOException,
                   AutomationException

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

Specified by:

detach in interface IGxObject

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws java.io.IOException,
                    AutomationException

Updates the object and any children of the object.

Specified by:

refresh in interface IGxObject

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws java.io.IOException,
                         AutomationException

The small image that represents the object.

Specified by:

getSmallImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws java.io.IOException,
                                 AutomationException

The small image that represents the object when it is selected.

Specified by:

getSmallSelectedImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws java.io.IOException,
                         AutomationException

The large image that represents the object.

Specified by:

getLargeImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws java.io.IOException,
                                 AutomationException

The large image that represents the object when it is selected.

Specified by:

getLargeSelectedImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContextMenu

public IUID getContextMenu()
                    throws java.io.IOException,
                           AutomationException

The class ID of the context menu for this object.

Specified by:

getContextMenu in interface IGxObjectUI

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNewMenu

public IUID getNewMenu()
                throws java.io.IOException,
                       AutomationException

The class ID of the New menu for this object.

Specified by:

getNewMenu in interface IGxObjectUI

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasChildren

public boolean isHasChildren()
                      throws java.io.IOException,
                             AutomationException

Indicates if the object has any children.

Specified by:

isHasChildren in interface IGxObjectContainer

Returns:

The hasChildren

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren()
                          throws java.io.IOException,
                                 AutomationException

An enumeration of the child objects.

Specified by:

getChildren in interface IGxObjectContainer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAreChildrenViewable

public boolean isAreChildrenViewable()
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:

isAreChildrenViewable in interface IGxObjectContainer

Returns:

The areViewable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addChild

public IGxObject addChild(IGxObject child)
                   throws java.io.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.

Specified by:

addChild in interface IGxObjectContainer

Parameters:

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

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.

deleteChild

public void deleteChild(IGxObject child)
                 throws java.io.IOException,
                        AutomationException

Deletes the specified child object.

Specified by:

deleteChild in interface IGxObjectContainer

Parameters:

child - 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.

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException

Indicates if the object can be renamed.

Specified by:

canRename in interface IGxObjectEdit

Returns:

The canRename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String newShortName)
            throws java.io.IOException,
                   AutomationException

Renames the object.

Specified by:

rename in interface IGxObjectEdit

Parameters:

newShortName - The newShortName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException

Indicates if the object can be deleted.

Specified by:

canDelete in interface IGxObjectEdit

Returns:

The canDelete

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException

Deletes the object.

Specified by:

delete in interface IGxObjectEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

editProperties

public void editProperties(int hParent)
                    throws java.io.IOException,
                           AutomationException

Presents a modal dialog to allow editing the object's properties.

Specified by:

editProperties in interface IGxObjectEdit

Parameters:

hParent - The hParent (A COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException

Indicates if the object can be copied.

Specified by:

canCopy in interface IGxObjectEdit

Returns:

The canCopy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canPaste

public boolean canPaste(IEnumName names,
                        boolean[] moveOperation)
                 throws java.io.IOException,
                        AutomationException

Indicates if the specified names may be pasted into this object. On output, moveOperation indicates if a subsequent paste operation would represent a move, or merely a copy, operation.

Specified by:

canPaste in interface IGxPasteTarget

Parameters:

names - A reference to a com.esri.arcgis.system.IEnumName (in)

moveOperation - The moveOperation (in/out: use single element array)

Returns:

The canPaste

Throws:

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

AutomationException - If the ArcObject component throws an exception.

paste

public boolean paste(IEnumName names,
                     boolean[] moveOperation)
              throws java.io.IOException,
                     AutomationException

Pastes the specified names into this object. On input, moveOperation indicates if this is a move operation. On output, it indicates if the objects have been moved, or merely copied.

Specified by:

paste in interface IGxPasteTarget

Parameters:

names - A reference to a com.esri.arcgis.system.IEnumName (in)

moveOperation - The moveOperation (in/out: use single element array)

Returns:

The successfulPaste

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(java.lang.String path)
             throws java.io.IOException,
                    AutomationException

The full path for the file.

Specified by:

setPath in interface IGxFile

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPath

public java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException

The full path for the file.

Specified by:

getPath in interface IGxFile

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_new

public void esri_new()
              throws java.io.IOException,
                     AutomationException

Creates a new file.

Specified by:

esri_new in interface IGxFile

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

public void open()
          throws java.io.IOException,
                 AutomationException

Opens the file.

Specified by:

open in interface IGxFile

Throws:

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

AutomationException - If the ArcObject component throws an exception.

close

public void close(boolean saveChanges)
           throws java.io.IOException,
                  AutomationException

Closes the file, optionally saving changes.

Specified by:

close in interface IGxFile

Parameters:

saveChanges - The saveChanges (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

edit

public void edit()
          throws java.io.IOException,
                 AutomationException

Opens an editor to modify the file.

Specified by:

edit in interface IGxFile

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save()
          throws java.io.IOException,
                 AutomationException

Saves changes without closing the file.

Specified by:

save in interface IGxFile

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onApply

public void onApply(IComPropertySheetEventsOnApplyEvent theEvent)
             throws java.io.IOException,
                    AutomationException

Occurs when changes are applied.

Specified by:

onApply in interface IComPropertySheetEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException

The number of registered GxObject factories.

Specified by:

getCount in interface IGxObjectFactories

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(int index)
                  throws java.io.IOException,
                         AutomationException

Indicates if a specific GxObject factory is enabled.

Specified by:

isEnabled in interface IGxObjectFactories

Parameters:

index - The index (in)

Returns:

The isEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enableGxObjectFactory

public void enableGxObjectFactory(int index,
                                  boolean enabled)
                           throws java.io.IOException,
                                  AutomationException

Enables or disables a GxObject factory.

Specified by:

enableGxObjectFactory in interface IGxObjectFactories

Parameters:

index - The index (in)

enabled - The enabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGxObjectFactoryCLSID

public IUID getGxObjectFactoryCLSID(int index)
                             throws java.io.IOException,
                                    AutomationException

The class ID of the specified GxObject factory.

Specified by:

getGxObjectFactoryCLSID in interface IGxObjectFactories

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGxObjectFactory

public IGxObjectFactory getGxObjectFactory(int index)
                                    throws java.io.IOException,
                                           AutomationException

The specified GxObject factory.

Specified by:

getGxObjectFactory in interface IGxObjectFactories

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEnabledGxObjectFactories

public IEnumGxObjectFactory getEnabledGxObjectFactories()
                                                 throws java.io.IOException,
                                                        AutomationException

The enabled GxObject factories (sorted by priority).

Specified by:

getEnabledGxObjectFactories in interface IGxObjectFactories

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canPaste

public boolean canPaste(IName name,
                        IGxObject target,
                        boolean[] moveOperation)
                 throws java.io.IOException,
                        AutomationException

Indicates if the specified name object may be pasted into the given target. On output, moveOperation indicates if a subsequent paste operation would represent a move, or merely a copy, operation.

Specified by:

canPaste in interface IGxPasteTargetHelper

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

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

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

Returns:

The canPaste

Throws:

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

AutomationException - If the ArcObject component throws an exception.

paste

public boolean paste(IName name,
                     IGxObject target,
                     boolean[] moveOperation)
              throws java.io.IOException,
                     AutomationException

Pastes the specified name object into the given target. On input, moveOperation indicates if this is a move operation. On output, it indicates if the objects have been moved, or merely copied.

Specified by:

paste in interface IGxPasteTargetHelper

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

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

moveOperation - The moveOperation (in/out: use single element array)

Returns:

The successfulPaste

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataElement

public IDataElement getDataElement(IDEBrowseOptions browseOptions)
                            throws java.io.IOException,
                                   AutomationException

Get the GxObject's data element.

Specified by:

getDataElement in interface IGxDataElement

Parameters:

browseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IDataElement

Throws:

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

AutomationException - If the ArcObject component throws an exception.

retrieveDEFullProperties

public void retrieveDEFullProperties(IDataElement[] dataElement)
                              throws java.io.IOException,
                                     AutomationException

Retrieve the GxObject's heavy-weight properties.

Specified by:

retrieveDEFullProperties in interface IGxDataElementHelper

Parameters:

dataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

retrieveDEBaseProperties

public void retrieveDEBaseProperties(IDataElement[] dataElement)
                              throws java.io.IOException,
                                     AutomationException

Retrieve the GxObject's light-weight properties.

Specified by:

retrieveDEBaseProperties in interface IGxDataElementHelper

Parameters:

dataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSortEnabled

public void setSortEnabled(boolean path)
                    throws java.io.IOException,
                           AutomationException

Indicates if sorting is enabled for this GxObject.

Specified by:

setSortEnabled in interface IGxObjectSort

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSortEnabled

public boolean isSortEnabled()
                      throws java.io.IOException,
                             AutomationException

Indicates if sorting is enabled for this GxObject.

Specified by:

isSortEnabled in interface IGxObjectSort

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.