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

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

All Implemented Interfaces:

GPTool

public class UpgradeMetadata
extends AbstractGPTool

Updates an ArcGIS item's metadata or a stand-alone XML file to the current ArcGIS metadata format. The Upgrade Metadata tool is contained in the Conversion Tools tool box.

Usage tips:

• When you view an ArcGIS item's metadata or a stand-alone metadata XML file in the Description tab, an Upgrade button may be available that will run this tool. If you have many items or metadata XML files you want to upgrade, run this tool as a to upgrade all your metadata at once.
• 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 Source 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

UpgradeMetadata()
Creates the Upgrade Metadata tool with defaults.

UpgradeMetadata(Object sourceMetadata, String upgradeType)
Creates the Upgrade Metadata tool with the required parameters.

Method Summary

Object	getOutputMetadata() Returns the Output Metadata parameter of this tool (Read only).
Object	getSourceMetadata() Returns the Source 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.
String	getUpgradeType() Returns the Upgrade Type parameter of this tool .
void	setSourceMetadata(Object sourceMetadata) Sets the Source Metadata parameter of this tool .
void	setUpgradeType(String upgradeType) Sets the Upgrade Type 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

UpgradeMetadata

public UpgradeMetadata()

Creates the Upgrade Metadata tool with defaults.

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

UpgradeMetadata

public UpgradeMetadata(Object sourceMetadata,
                       String upgradeType)

Creates the Upgrade Metadata 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:

sourceMetadata - the item whose metadata will be upgraded, or a stand-alone XML file that will be upgraded.

upgradeType - the type of conversion that will take place. an upgrade type must be specified; otherwise, no conversion will be performed.

Method Detail

getSourceMetadata

public Object getSourceMetadata()

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

Returns:

the Source Metadata

setSourceMetadata

public void setSourceMetadata(Object sourceMetadata)

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

Parameters:

sourceMetadata - the item whose metadata will be upgraded, or a stand-alone XML file that will be upgraded.

getUpgradeType

public String getUpgradeType()

Returns the Upgrade Type parameter of this tool . This parameter is the type of conversion that will take place. an upgrade type must be specified; otherwise, no conversion will be performed. This is a required parameter.

Returns:

the Upgrade Type

setUpgradeType

public void setUpgradeType(String upgradeType)

Sets the Upgrade Type parameter of this tool . This parameter is the type of conversion that will take place. an upgrade type must be specified; otherwise, no conversion will be performed. This is a required parameter.

Parameters:

upgradeType - the type of conversion that will take place. an upgrade type must be specified; otherwise, no conversion will be performed.

getOutputMetadata

public Object getOutputMetadata()

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