com.esri.arcgis.geoprocessing.tools.conversiontools
Class MetadataImporter

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.MetadataImporter

All Implemented Interfaces:

GPTool

public class MetadataImporter
extends AbstractGPTool

This tool requires the Microsoft .NET Framework 2.0. These tools are installed with the .NET Support install option. Copies an XML metadata document as-is from the source item to the target item. The Metadata Importer tool retrieves the source item's metadata, then transfers a copy of this metadata document to the target item. If the source item is a stand-alone XML file, a copy of the file itself will be passed to the target item. The Metadata Importer tool is contained in the Conversion Tools tool box.

Software restrictions: none

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

MetadataImporter()
Creates the Metadata Importer tool with defaults.

MetadataImporter(Object source, Object target)
Creates the Metadata Importer tool with the required parameters.

Method Summary

Object	getOutput() Returns the Output Metadata parameter of this tool (Read only).
Object	getSource() Returns the Source Metadata parameter of this tool .
Object	getTarget() Returns the Target Metadata parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setSource(Object source) Sets the Source Metadata parameter of this tool .
void	setTarget(Object target) Sets the Target Metadata parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MetadataImporter

public MetadataImporter()

Creates the Metadata Importer tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

MetadataImporter

public MetadataImporter(Object source,
                        Object target)

Creates the Metadata Importer tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

source - Data Element, the item whose metadata will be imported, or a stand-alone XML file that will be imported.

target - null

Method Detail

getSource

public Object getSource()

Returns the Source Metadata parameter of this tool . This parameter is Data Element, the item whose metadata will be imported, or a stand-alone XML file that will be imported. This is a required parameter.

Returns:

the Source Metadata

setSource

public void setSource(Object source)

Sets the Source Metadata parameter of this tool . This parameter is Data Element, the item whose metadata will be imported, or a stand-alone XML file that will be imported. This is a required parameter.

Parameters:

source - Data Element, the item whose metadata will be imported, or a stand-alone XML file that will be imported.

getTarget

public Object getTarget()

Returns the Target Metadata parameter of this tool . This is a required parameter.

Returns:

the Target Metadata

setTarget

public void setTarget(Object target)

Sets the Target Metadata parameter of this tool . This is a required parameter.

Parameters:

target - null

getOutput

public Object getOutput()

Returns the Output Metadata parameter of this tool (Read only). This parameter is Data Element, the item to which the metadata will be imported. This is an derived parameter.

Returns:

the Output Metadata

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias