com.esri.arcgis.catalog
Class IMetadataExportProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.catalog.IMetadataExportProxy

All Implemented Interfaces:

IMetadataExport, Externalizable, Serializable

public class IMetadataExportProxy
extends com.esri.arcgis.interop.Dispatch
implements IMetadataExport, 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.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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.
void	removeListener(String iidStr, Object theListener)

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

IMetadataExportProxy

public IMetadataExportProxy()

IMetadataExportProxy

public IMetadataExportProxy(Object obj)
                     throws IOException

Throws:

IOException

IMetadataExportProxy

protected IMetadataExportProxy(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

getName

public 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

Specified by:

getName in interface IMetadataExport

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultFilename

public 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

Specified by:

getDefaultFilename in interface IMetadataExport

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

export

public 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

Specified by:

export in interface IMetadataExport

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.