com.esri.arcgis.catalog
Interface IMetadataExport

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMetadataExportProxy

public interface IMetadataExport
extends Serializable

Provides access to members that define a metadata exporter.

Remarks

The IMetadataExport interface is available to custom CoClasses that implement the MetadataExport abstract class. For example, a custom CoClass might be written to support exporting metadata from an ArcGIS item to a custom document format. Example code illustrating how to use this object is available in the ArcGIS 9.3.1 Developer Help system.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	export(IMetadata source, String destination) Exports metadata to the specified location.
String	getDefaultFilename() Default filename (including the file extension) to create on export.
String	getName() Name of the metadata exporter.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the metadata exporter.

Remarks

Returns the name of the MetadataExport subclass as a string.

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.

getDefaultFilename

String getDefaultFilename()
                          throws IOException,
                                 AutomationException

Default filename (including the file extension) to create on export.

Remarks

The DefaultFilename is determined by the MetadataExport subclass. Typically the name �metadata� with an appropriate file extension for the export format is built into the MetadataExport subclass. For example, if a subclass exports content to an HTML file the default filename might be �metadata.html�.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

export

void export(IMetadata source,
            String destination)
            throws IOException,
                   AutomationException

Exports metadata to the specified location.

Remarks

The Export method creates metadata for the specified source ArcGIS item and exports it to a determined location. Although MetadataExporters create metadata documents in a specific format, it is still necessary to explicitly state the file format when supplying the destination parameter, for example, �c:\metadata\parcels.html�.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

source - A reference to a com.esri.arcgis.geodatabase.IMetadata (in)

destination - The destination (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.