com.esri.arcgis.catalog
Class GxMetadata

java.lang.Object
  extended by com.esri.arcgis.catalog.GxMetadata
All Implemented Interfaces:
IGxFile, IGxObject, IGxObjectEdit, IGxObjectInternalName, IGxObjectProperties, IGxObjectUI, IMetadata, IMetadataEdit, INativeTypeInfo, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GxMetadata
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxFile, IGxObject, IGxObjectEdit, IMetadata, IMetadataEdit, IGxObjectInternalName, INativeTypeInfo, IGxObjectProperties, IGxObjectUI

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

Description 'GxObject that represents an XML 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.IGxFile
IID, IIDbdbbb3f2_d0b2_11d1_aed9_080009ec734b, 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.IGxObjectEdit
IID, IIDbdbbb3fc_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.catalog.IGxObjectProperties
IID, IIDd342626e_f9da_11d3_a68d_0008c7d3ae8d, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectUI
IID, IID7273aa57_e6f9_11d2_9f30_00c04f6bc69e, xxDummy
 
Constructor Summary
GxMetadata()
          Constructs a GxMetadata using ArcGIS Engine.
GxMetadata(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxMetadata theGxMetadata = (GxMetadata) obj;
 
Method Summary
 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 canRename()
          Indicates if the object can be renamed.
 void close(boolean saveChanges)
          Closes the file, optionally saving changes.
 void delete()
          Deletes the object.
 void detach()
          Instructs the object to detach itself from its parent and 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.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void esri_new()
          Creates a new file.
 java.lang.String getBaseName()
          The base name of the object (i.e.
 java.lang.String getCategory()
          The category of the object.
 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.
 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.
 int getLargeImage()
          The large image that represents the object.
 int getLargeSelectedImage()
          The large image that represents the object when it is selected.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 java.lang.String getName()
          The short name of the object.
 INativeType getNativeType()
          The native type.
 IUID getNewMenu()
          The class ID of the New menu for this object.
 IGxObject getParent()
          The parent of the object.
 java.lang.String getPath()
          The full path for the file.
 void getPropByIndex(int index, java.lang.String[] name, java.lang.Object[] value)
          The name and value of the indexed property in the GxObject.
 java.lang.Object getProperty(java.lang.String name)
          The value of the named property in the GxObject.
 int getPropertyCount()
          The number of properties in the GxObject.
 int getSmallImage()
          The small image that represents the object.
 int getSmallSelectedImage()
          The small image that represents the object when it is selected.
 int hashCode()
          the hashcode for this object
 boolean isCanEditMetadata()
          Indicates if metadata can be edited.
 boolean isValid()
          Indicates if the object is still valid.
 void open()
          Opens the file.
 void refresh()
          Updates the object and any children of the object.
 void release()
          Release a GxMetadata.
 void rename(java.lang.String newShortName)
          Renames the object.
 void save()
          Saves changes without closing the file.
 void setInternalObjectNameByRef(IName internalObjectName)
          The Name for the internal object that this GxObject represents.
 void setMetadata(IPropertySet propertySet)
          The PropertySet containing metadata.
 void setPath(java.lang.String path)
          The full path for the file.
 void setProperty(java.lang.String name, java.lang.Object value)
          Set the value of the named property in the GxObject.
 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

GxMetadata

public GxMetadata()
           throws java.io.IOException,
                  java.net.UnknownHostException
Constructs a GxMetadata using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GxMetadata

public GxMetadata(java.lang.Object obj)
           throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxMetadata theGxMetadata = (GxMetadata) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

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.

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.

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.

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.

getPropertyCount

public int getPropertyCount()
                     throws java.io.IOException,
                            AutomationException
The number of properties in the GxObject.

Specified by:
getPropertyCount in interface IGxObjectProperties
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropByIndex

public void getPropByIndex(int index,
                           java.lang.String[] name,
                           java.lang.Object[] value)
                    throws java.io.IOException,
                           AutomationException
The name and value of the indexed property in the GxObject.

Specified by:
getPropByIndex in interface IGxObjectProperties
Parameters:
index - The index (in)
name - The name (in/out: use single element array)
value - A Variant (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException
The value of the named property in the GxObject.

Specified by:
getProperty in interface IGxObjectProperties
Parameters:
name - The name (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws java.io.IOException,
                        AutomationException
Set the value of the named property in the GxObject.

Specified by:
setProperty in interface IGxObjectProperties
Parameters:
name - The name (in)
value - A Variant (in)
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.