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

Copies metadata from the source item to the target item. Metadata is retrieved from the source item and transferred to the target item without changing it. The source and target may be ArcGIS items or stand-alone metadata XML files. The Metadata Importer tool is contained in the Conversion Tools tool box.

Usage tips:

• Metadata may include unique identifiers that help to manage documents in a metadata catalog. This tool does not remove any unique identifiers in the source metadata before importing it. This is the desired behavior if you modify the source item's metadata as described above using an XSLT stylesheet, for example, to update contact information, and need to import the result back to the original item. In this case, you want the metadata to keep the same unique identifier it had before.However, if you want to import metadata created outside of ArcGIS or to copy information from one item to another, use instead; it removes unique identifiers from the imported information. Many items should not share the same unique identifier.
• After the source metadata is copied to the target, no changes are made to the target item's metadata. For example, the target item's metadata will not be synchronized to contain the item's current properties.
• Text or HTML files containing metadata can't be imported.
• This tool can import one source item to one target item. To import one source item to many target items or to import different source items to different target items, open the tool in batch mode and set the tool's parameters appropriately.
• The Source Metadata parameter has a complex data type. If you use this tool in a model, create a variable for the Source Metadata parameter in ModelBuilder by right-clicking the tool, pointing to Make VariableFrom ParameterSource Metadata.
• When using this tool in ModelBuilder, the Output Metadata parameter is derived from the Target Metadata parameter.
• If you do not have write access to the ArcGIS item or its metadata or the stand-alone metadata XML file that you are trying to modify, this tool will complete successfully but the item's original metadata will remain unchanged.

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 - the item whose metadata will be imported, or a stand-alone XML file that will be imported. if the source item is a stand-alone file it must contain well-formed XML data.

target - the item to which the metadata will be imported, or a stand-alone XML file that will be replaced.

Method Detail

getSource

public Object getSource()

Returns the Source Metadata parameter of this tool . This parameter is the item whose metadata will be imported, or a stand-alone XML file that will be imported. if the source item is a stand-alone file it must contain well-formed XML data. 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 the item whose metadata will be imported, or a stand-alone XML file that will be imported. if the source item is a stand-alone file it must contain well-formed XML data. This is a required parameter.

Parameters:

source - the item whose metadata will be imported, or a stand-alone XML file that will be imported. if the source item is a stand-alone file it must contain well-formed XML data.

getTarget

public Object getTarget()

Returns the Target Metadata parameter of this tool . This parameter is the item to which the metadata will be imported, or a stand-alone XML file that will be replaced. This is a required parameter.

Returns:

the Target Metadata

setTarget

public void setTarget(Object target)

Sets the Target Metadata parameter of this tool . This parameter is the item to which the metadata will be imported, or a stand-alone XML file that will be replaced. This is a required parameter.

Parameters:

target - the item to which the metadata will be imported, or a stand-alone XML file that will be replaced.

getOutput

public Object getOutput()

Returns the Output Metadata parameter of this tool (Read only). 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