com.esri.arcgis.catalogUI
Class IMetadataHelperProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.catalogUI.IMetadataHelperProxy

All Implemented Interfaces:

IMetadataHelper, Externalizable, Serializable

public class IMetadataHelperProxy
extends com.esri.arcgis.interop.Dispatch
implements IMetadataHelper, Serializable

Provides access to members that change the Catalog's metadata settings.

Description

The IMetadataHelper Interface is implemented through the MetadataExtension CoClass.

When To Use

Use the IMetadataHelper interface is used to access metadata properties and settings such as the default style sheet, the metadata editor, and the metadata synchronization options create and update.

Many of the same properties can be set through the graphical user interface. They are available at the Tools > Options > Metadata Tab. The IMetadataHelper simply offers the opportunity to get and/or set these properties programmatically.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IMetadataHelperProxy()
	IMetadataHelperProxy(Object obj)
protected	IMetadataHelperProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getDefaultStylesheet() Name of the default stylesheet.
IUID	getEditor() CLSID of the currently selected editor.
String	getStylesheet() Name of the currently selected stylesheet.
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.
String	getWebPagePath() Path to the HTML directory.
void	refresh(IGxObject ipObject) Refreshes the currently selected object in the Catalog.
void	removeListener(String iidStr, Object theListener)
void	setDefaultStylesheet(String name) Name of the default stylesheet.
void	setEditor(IUID editor) CLSID of the currently selected editor.
void	setStylesheet(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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IMetadataHelperProxy

public IMetadataHelperProxy()

IMetadataHelperProxy

public IMetadataHelperProxy(Object obj)
                     throws IOException

Throws:

IOException

IMetadataHelperProxy

protected IMetadataHelperProxy(Object obj,
                               String iid)
                        throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

refresh

public void refresh(IGxObject ipObject)
             throws IOException,
                    AutomationException

Refreshes the currently selected object in the Catalog.

Description

The ipObject parameter must be of data type IGxObject.

Remarks

Refreshes the currently selected object in the Catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IMetadataHelper

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEditor

public void setEditor(IUID editor)
               throws IOException,
                      AutomationException

CLSID of the currently selected editor.

Remarks

The Editor property is no longer used in ArcGIS 10. The pages that are included when you edit an item’s metadata in ArcGIS are determined by the current ArcGIS metadata style.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setEditor in interface IMetadataHelper

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

UID, IUID

getEditor

public IUID getEditor()
               throws IOException,
                      AutomationException

CLSID of the currently selected editor.

Description

This property is used to check and/or change the Metadata Editor used in ArcCatalog.

The value to get or set the property must be of data type IUID.

Remarks

The Editor property is no longer used in ArcGIS 10. The pages that are included when you edit an item’s metadata in ArcGIS are determined by the current ArcGIS metadata style.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getEditor in interface IMetadataHelper

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

UID, IUID

setStylesheet

public void setStylesheet(String name)
                   throws IOException,
                          AutomationException

Name of the currently selected stylesheet.

Remarks

The Stylesheet property is no longer used in ArcGIS 10. The stylesheet that is used to display an ArcGIS item’s metadata is determined by the current ArcGIS metadata style.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setStylesheet in interface IMetadataHelper

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStylesheet

public String getStylesheet()
                     throws IOException,
                            AutomationException

Name of the currently selected stylesheet.

Remarks

The Stylesheet property is no longer used in ArcGIS 10. The stylesheet that is used to display an ArcGIS item’s metadata is determined by the current ArcGIS metadata style.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getStylesheet in interface IMetadataHelper

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultStylesheet

public void setDefaultStylesheet(String name)
                          throws IOException,
                                 AutomationException

Name of the default stylesheet.

Remarks

The DefaultStylesheet property is no longer used in ArcGIS 10. The stylesheet that is used to display an ArcGIS item’s metadata is determined by the current ArcGIS metadata style.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDefaultStylesheet in interface IMetadataHelper

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultStylesheet

public String getDefaultStylesheet()
                            throws IOException,
                                   AutomationException

Name of the default stylesheet.

Remarks

The DefaultStylesheet property is no longer used in ArcGIS 10. The stylesheet that is used to display an ArcGIS item’s metadata is determined by the current ArcGIS metadata style.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDefaultStylesheet in interface IMetadataHelper

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStylesheetPath

public String getStylesheetPath()
                         throws IOException,
                                AutomationException

Path to the Stylesheets directory.

Remarks

The StylesheetPath property is no longer used in ArcGIS 10. The stylesheet that is used to display an ArcGIS item’s metadata is clearly identified in the current ArcGIS metadata style by providing a file path that originates from the ArcGIS for Desktop install location.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getStylesheetPath in interface IMetadataHelper

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWebPagePath

public String getWebPagePath()
                      throws IOException,
                             AutomationException

Path to the HTML directory.

Remarks

The WebPagePath property is no longer used in ArcGIS 10. The messages that are displayed if an ArcGIS item does not support metadata or if the item’s metadata is not well-formed, for example, are generated by the metadata editor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getWebPagePath in interface IMetadataHelper

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSynchronizationOption

public void setSynchronizationOption(int option)
                              throws IOException,
                                     AutomationException

When the Catalog creates and updates metadata automatically.

Remarks

The SynchronizationOption property is set for all items in ArcGIS, not individual documents. Synchronization cannot be disabled for individual documents in ArcGIS 10. By default the property is set to esriSyncAccessed, where metadata is always created and always updated. This property only determines if synchronization occurs when the metadata is viewed. It does not affect if metadata is updated programmatically or if synchronization occurs in connection with other operations.

The SynchronizationOption property can also be controlled through the user interface. A check box is available in the ArcGIS application’s Options dialog box that determines if metadata will be updated automatically when you view metadata. When the box is checked synchronization will always occur, and if metadata has not already been created it will be created. The SynchronizationOption property is set to esriSyncAccessed.

When unchecked, synchronization will never occur when you view the item’s metadata. The SynchronizationOption property is set to esriSyncNever. Other actions will update the metadata automatically even when this box is unchecked including using geoprocessing tools on the item, importing metadata, and so on.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSynchronizationOption in interface IMetadataHelper

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSynchronizationOption

public int getSynchronizationOption()
                             throws IOException,
                                    AutomationException

When the Catalog creates and updates metadata automatically.

Description

This SynchronizationOption property allows for control of how metadata is created and updated automatically using ArcCatalog.

Remarks

The SynchronizationOption property is set for all items in ArcGIS, not individual documents. Synchronization cannot be disabled for individual documents in ArcGIS 10. By default the property is set to esriSyncAccessed, where metadata is always created and always updated. This property only determines if synchronization occurs when the metadata is viewed. It does not affect if metadata is updated programmatically or if synchronization occurs in connection with other operations.

The SynchronizationOption property can also be controlled through the user interface. A check box is available in the ArcGIS application’s Options dialog box that determines if metadata will be updated automatically when you view metadata. When the box is checked synchronization will always occur, and if metadata has not already been created it will be created. The SynchronizationOption property is set to esriSyncAccessed.

When unchecked, synchronization will never occur when you view the item’s metadata. The SynchronizationOption property is set to esriSyncNever. Other actions will update the metadata automatically even when this box is unchecked including using geoprocessing tools on the item, importing metadata, and so on.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSynchronizationOption in interface IMetadataHelper

Returns:

A com.esri.arcgis.catalog.esriSynchronizationOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSynchronizationInterval

public void setSynchronizationInterval(int interval)
                                throws IOException,
                                       AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSynchronizationInterval in interface IMetadataHelper

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSynchronizationInterval

public int getSynchronizationInterval()
                               throws IOException,
                                      AutomationException

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

Description

The SynchronizationInterval property allows metadata updates and creation to occur at regular intervals.

The value of the SynchronizationInterval property is measured in seconds.

Remarks

Depending how Updating metadata and Creating metadata (available from the SynchronizationOption property) are set up, by default, metadata is updated or created every time the selected item is viewed through the Metadata Tab (GxDocumentationView).

By default the SynchronizationInterval is 0 seconds, thus creating or updating metadata every time an item is viewed in the Metadata Tab. As long as the current time is 1 second past the values in the SyncDate & SyncTime, metadata will be updated.

Rather than continually updating or creating metadata, the SynchronizationInterval property allows the user to control when and how regularly metadata is updated or created. For instance if multiple people were accessing a feature class, one editing features and the other viewing metadata, with the default setting, the changes in the metadata would reflect those new edits in the feature class the first time the metadata was accessed through the Metadata Tab after the edits were committed. Changing the SynchronizationInterval property can postpone when changes are viewed.

This property was originally put in place to help deal with system load so that metadata is not having to be constantly created. But since the system load is rarely affected by the creation of metadata, it is a good idea to keep the defaults and always have the most accurate metadata.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSynchronizationInterval in interface IMetadataHelper

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.