com.esri.arcgis.catalogUI
Class MetadataExtension

java.lang.Object
  com.esri.arcgis.catalogUI.MetadataExtension

All Implemented Interfaces:

IMetadataHelper, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IExtension, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class MetadataExtension
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IExtension, IMetadataHelper, IPersistStream, IConnectionPointContainer, java.io.Externalizable

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

Description 'Provides access to metadata extension.' 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.system.IExtension

IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.IMetadataHelper

IID, IID055b2b9a_f2c9_11d2_9fc1_00c04f8ed211, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

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

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Constructor Summary

MetadataExtension(java.lang.Object obj)
Construct a MetadataExtension using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addIMetadataEventsListener(IMetadataEvents theListener) addIMetadataEventsListener.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
java.lang.String	getDefaultStylesheet() Name of the default stylesheet.
IUID	getEditor() CLSID of the currently selected editor.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the extension.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getStylesheet() Name of the currently selected stylesheet.
java.lang.String	getStylesheetPath() Path to the Stylesheets directory.
int	getSynchronizationInterval() The interval in seconds from the last update which must elapse before the Catalog will again update the metadata.
int	getSynchronizationOption() When the Catalog creates and updates metadata automatically.
java.lang.String	getWebPagePath() Path to the HTML directory.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	refresh(IGxObject ipObject) Refreshes the currently selected object in the Catalog.
void	release() Release a MetadataExtension.
void	removeIMetadataEventsListener(IMetadataEvents theListener) removeIMetadataEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	setDefaultStylesheet(java.lang.String name) Name of the default stylesheet.
void	setEditor(IUID editor) CLSID of the currently selected editor.
void	setStylesheet(java.lang.String name) Name of the currently selected stylesheet.
void	setSynchronizationInterval(int interval) The interval in seconds from the last update which must elapse before the Catalog will again update the metadata.
void	setSynchronizationOption(int option) When the Catalog creates and updates metadata automatically.
void	shutdown() Shuts down the extension.
void	startup(java.lang.Object initializationData) Starts up the extension with the given initialization data.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

MetadataExtension

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

Construct a MetadataExtension using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MetadataExtension.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
MetadataExtension o = (MetadataExtension)obj; // will not work

MetadataExtension o = new MetadataExtension(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems MetadataExtension theMetadataExtension = (MetadataExtension) obj;

Method Detail

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

addIMetadataEventsListener

public void addIMetadataEventsListener(IMetadataEvents theListener)
                                throws java.io.IOException

addIMetadataEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalogUI.IMetadataEvents interface.

Throws:

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

removeIMetadataEventsListener

public void removeIMetadataEventsListener(IMetadataEvents theListener)
                                   throws java.io.IOException

removeIMetadataEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalogUI.IMetadataEvents interface.

Throws:

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

release

public void release()

Release a MetadataExtension.

Specified by:

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

getName

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

The name of the extension.

Specified by:

getName in interface IExtension

Returns:

The extensionName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startup

public void startup(java.lang.Object initializationData)
             throws java.io.IOException,
                    AutomationException

Starts up the extension with the given initialization data.

Specified by:

startup in interface IExtension

Parameters:

initializationData - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

shutdown

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

Shuts down the extension.

Specified by:

shutdown in interface IExtension

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

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

Refreshes the currently selected object in the Catalog.

Specified by:

refresh in interface IMetadataHelper

Parameters:

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

setEditor

public void setEditor(IUID editor)
               throws java.io.IOException,
                      AutomationException

CLSID of the currently selected editor.

Specified by:

setEditor in interface IMetadataHelper

Parameters:

editor - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEditor

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

CLSID of the currently selected editor.

Specified by:

getEditor in interface IMetadataHelper

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.

setStylesheet

public void setStylesheet(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

Name of the currently selected stylesheet.

Specified by:

setStylesheet in interface IMetadataHelper

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStylesheet

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

Name of the currently selected stylesheet.

Specified by:

getStylesheet in interface IMetadataHelper

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultStylesheet

public void setDefaultStylesheet(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

Name of the default stylesheet.

Specified by:

setDefaultStylesheet in interface IMetadataHelper

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultStylesheet

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

Name of the default stylesheet.

Specified by:

getDefaultStylesheet in interface IMetadataHelper

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStylesheetPath

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

Path to the Stylesheets directory.

Specified by:

getStylesheetPath in interface IMetadataHelper

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWebPagePath

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

Path to the HTML directory.

Specified by:

getWebPagePath in interface IMetadataHelper

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSynchronizationOption

public void setSynchronizationOption(int option)
                              throws java.io.IOException,
                                     AutomationException

When the Catalog creates and updates metadata automatically.

Specified by:

setSynchronizationOption in interface IMetadataHelper

Parameters:

option - A com.esri.arcgis.catalog.esriSynchronizationOption constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSynchronizationOption

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

When the Catalog creates and updates metadata automatically.

Specified by:

getSynchronizationOption in interface IMetadataHelper

Returns:

A com.esri.arcgis.catalog.esriSynchronizationOption constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSynchronizationInterval

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

The interval in seconds from the last update which must elapse before the Catalog will again update the metadata.

Specified by:

setSynchronizationInterval in interface IMetadataHelper

Parameters:

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSynchronizationInterval

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

The interval in seconds from the last update which must elapse before the Catalog will again update the metadata.

Specified by:

getSynchronizationInterval in interface IMetadataHelper

Returns:

The interval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

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.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException