com.esri.arcgis.catalogUI
Interface IMetadataHelper

All Superinterfaces:
Serializable
All Known Implementing Classes:
IMetadataHelperProxy, MetadataExtension

public interface IMetadataHelper
extends 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.


Method Summary
 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 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.
 

Method Detail

refresh

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

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

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

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

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

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

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

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStylesheet

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

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultStylesheet

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

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultStylesheet

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

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStylesheetPath

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 Desktop install location.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWebPagePath

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

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSynchronizationOption

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

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

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

Returns:
A com.esri.arcgis.catalog.esriSynchronizationOption constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSynchronizationInterval

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

Parameters:
interval - The interval (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSynchronizationInterval

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

Returns:
The interval
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.