com.esri.arcgis.catalog
Class GxExcelFile

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

All Implemented Interfaces:

IGxCachedObjects, IGxExcelFile, IGxObject, IGxObjectContainer, IGxObjectInternalName, IGxObjectWizard, IMetadata, IMetadataEdit, INativeTypeInfo, IWorkspaceEvents, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class GxExcelFile
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxExcelFile, IGxObject, IGxObjectContainer, IGxObjectWizard, IGxCachedObjects, IMetadata, IMetadataEdit, IGxObjectInternalName, INativeTypeInfo, IWorkspaceEvents

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

Description 'GxObject that represents a excel file.' 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.IGxExcelFile

IID, IIDe1c64112_201d_4b1f_9cfd_28c77e63c798, 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.IGxObjectContainer

IID, IID7273aa58_e6f9_11d2_9f30_00c04f6bc69e, xxDummy

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

IID, IIDc6df682d_a28c_476a_924c_44d1194cf78d, xxDummy

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

IID, IIDbdbbb404_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata

IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IMetadataEdit

IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy

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

IID, IIDd3cc0862_a328_4b51_a05a_540bf20cef25, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.INativeTypeInfo

IID, IID906db24a_f0ad_4ca5_871b_5466e54fab80, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceEvents

IID, IIDda10c1c4_09a3_11d4_9faa_00c04f6bdf0c, xxDummy

Constructor Summary

GxExcelFile()
Constructs a GxExcelFile using ArcGIS Engine.

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

Method Summary

IGxObject	addChild(IGxObject child) Adds a new child and returns a reference to it.
void	attach(IGxObject parent, IGxCatalog pCatalog) Attaches the object to its parent and the catalog.
void	deleteChild(IGxObject child) Deletes the specified child object.
void	detach() Instructs the object to detach itself from its parent and the catalog.
boolean	equals(java.lang.Object o) Compare this object with another
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.
java.lang.String	getFullName() The full name of the object.
IName	getInternalObjectName() The Name for the internal object that this GxObject represents.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IPropertySet	getMetadata() The PropertySet containing metadata.
java.lang.String	getName() The short name of the object.
INativeType	getNativeType() The native type.
IGxObject	getParent() The parent of the object.
IWorkspace	getWorkspace() The associated workspace.
IWorkspaceName	getWorkspaceName() The workspace name.
int	hashCode() the hashcode for this object
boolean	isAreChildrenViewable() Indicates if the objects children are available for viewing in the tree-view.
boolean	isCanEditMetadata() Indicates if metadata can be edited.
boolean	isHasChildren() Indicates if the object has any children.
boolean	isValid() Indicates if the object is still valid.
void	loadCachedObjects() Loads any objects that should be cached for efficiency.
void	onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent) This event is fired when a dataset is created.
void	onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent) This event is fired when a dataset is deleted.
void	onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent) This event is fired when a dataset is renamed.
void	refresh() Updates the object and any children of the object.
void	release() Release a GxExcelFile.
void	releaseCachedObjects() Releases any objects that have been cached for efficiency.
void	setInternalObjectNameByRef(IName internalObjectName) The Name for the internal object that this GxObject represents.
void	setMetadata(IPropertySet propertySet) The PropertySet containing metadata.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The workspace name.
void	synchronize(int action, int interval) Updates metadata with the current properties; may create metadata if it doesn't already exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

GxExcelFile

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

Constructs a GxExcelFile using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxExcelFile

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

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

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

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

release

public void release()

Release a GxExcelFile.

Specified by:

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

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws java.io.IOException,
                                  AutomationException

The workspace name.

Specified by:

setWorkspaceNameByRef in interface IGxExcelFile

Parameters:

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

getWorkspaceName

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

The workspace name.

Specified by:

getWorkspaceName in interface IGxExcelFile

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.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

The associated workspace.

Specified by:

getWorkspace in interface IGxExcelFile

Returns:

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

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

Specified by:

getInternalObjectName in interface IGxObjectInternalName

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.

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.

loadCachedObjects

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

Loads any objects that should be cached for efficiency.

Specified by:

loadCachedObjects in interface IGxCachedObjects

Throws:

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

AutomationException - If the ArcObject component throws an exception.

releaseCachedObjects

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

Releases any objects that have been cached for efficiency.

Specified by:

releaseCachedObjects in interface IGxCachedObjects

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException

The PropertySet containing metadata.

Specified by:

getMetadata in interface IMetadata

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException

The PropertySet containing metadata.

Specified by:

setMetadata in interface IMetadata

Parameters:

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:

synchronize in interface IMetadata

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

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

Indicates if metadata can be edited.

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInternalObjectNameByRef

public void setInternalObjectNameByRef(IName internalObjectName)
                                throws java.io.IOException,
                                       AutomationException

The Name for the internal object that this GxObject represents.

Specified by:

setInternalObjectNameByRef in interface IGxObjectInternalName

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType()
                          throws java.io.IOException,
                                 AutomationException

The native type.

Specified by:

getNativeType in interface INativeTypeInfo

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onCreateDataset

public void onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

This event is fired when a dataset is created.

Specified by:

onCreateDataset in interface IWorkspaceEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onRenameDataset

public void onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

This event is fired when a dataset is renamed.

Specified by:

onRenameDataset in interface IWorkspaceEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onDeleteDataset

public void onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

This event is fired when a dataset is deleted.

Specified by:

onDeleteDataset in interface IWorkspaceEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.