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

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

All Implemented Interfaces:

GPTool

public class USGSMPTranslator
extends AbstractGPTool

This tool requires the Microsoft .NET Framework 2.0. These tools are installed with the .NET Support install option. Uses mp to export or validate metadata content created using the The USGS MP Metadata Translator tool is contained in the Conversion Tools tool box.

Software restrictions: none

Usage tips:

• Documentation for the mp utility can be found on the USGS web site
• An mp configuration file can be used to specify an extension file that will recognize metadata elements that are defined in FGDC CSDGM profiles. Extension and configuration files that will recognize ESRI-defined metadata elements and ESRI-ISO metadata elements can be found at ESRI's metadata web page.
• When metadata is edited using ArcCatalog, the XML elements will not be in the correct order as specified by the FGDC CSDGM rules. As a result, mp will record warnings in the error file.
• MP is also used by some of the metadata importers and exporters that are available in ArcCatalog. The following Metadata Importers use mp: FGDC CSDGM (TXT) and FGDC CSDGM (SGML). The following Metadata Exporters use mp: FGDC CSDGM (HTML), FGDC CSDGM (FAQ), FGDC CSDGM (SGML) and FGDC CSDGM (TXT). These importers and exporters will not report any validation errors and warnings that were found in the conversion process, and don't let you specify a configuration file.

Field Summary

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

vals

Constructor Summary

USGSMPTranslator()
Creates the USGS MP Metadata Translator tool with defaults.

USGSMPTranslator(Object source)
Creates the USGS MP Metadata Translator tool with the required parameters.

Method Summary

Object	getConfig() Returns the Configuration File parameter of this tool .
String	getConversion() Returns the Conversion Type parameter of this tool .
Object	getErrors() Returns the Log File parameter of this tool .
Object	getOutput() Returns the Output File parameter of this tool .
Object	getSource() 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.
void	setConfig(Object config) Sets the Configuration File parameter of this tool .
void	setConversion(String conversion) Sets the Conversion Type parameter of this tool .
void	setErrors(Object errors) Sets the Log File parameter of this tool .
void	setOutput(Object output) Sets the Output File parameter of this tool .
void	setSource(Object source) Sets the Source 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

USGSMPTranslator

public USGSMPTranslator()

Creates the USGS MP Metadata Translator tool with defaults.

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

USGSMPTranslator

public USGSMPTranslator(Object source)

Creates the USGS MP Metadata Translator 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 converted, or a stand-alone XML file that will be converted.

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 converted, or a stand-alone XML file that will be converted. 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 converted, or a stand-alone XML file that will be converted. This is a required parameter.

Parameters:

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

getConfig

public Object getConfig()

Returns the Configuration File parameter of this tool . This parameter is File, a file that defines custom parameters that mp will consider when parsing the source object's metadata. This is an optional parameter.

Returns:

the Configuration File

setConfig

public void setConfig(Object config)

Sets the Configuration File parameter of this tool . This parameter is File, a file that defines custom parameters that mp will consider when parsing the source object's metadata. This is an optional parameter.

Parameters:

config - File, a file that defines custom parameters that mp will consider when parsing the source object's metadata.

getConversion

public String getConversion()

Returns the Conversion Type parameter of this tool . This parameter is String, for all conversion types, the source metadata will be validated according to the FGDC CSDGM rules and any warnings or errors regarding the metadata content will be reported in the log file. If the "none" conversion is specified, the log file will be created with validation information but no additional output will be generated. This is an optional parameter.

Returns:

the Conversion Type

setConversion

public void setConversion(String conversion)

Sets the Conversion Type parameter of this tool . This parameter is String, for all conversion types, the source metadata will be validated according to the FGDC CSDGM rules and any warnings or errors regarding the metadata content will be reported in the log file. If the "none" conversion is specified, the log file will be created with validation information but no additional output will be generated. This is an optional parameter.

Parameters:

conversion - String, for all conversion types, the source metadata will be validated according to the FGDC CSDGM rules and any warnings or errors regarding the metadata content will be reported in the log file. If the "none" conversion is specified, the log file will be created with validation information but no additional output will be generated.

getOutput

public Object getOutput()

Returns the Output File parameter of this tool . This parameter is File, the output file, as defined by the conversion type. This is an optional parameter.

Returns:

the Output File

setOutput

public void setOutput(Object output)

Sets the Output File parameter of this tool . This parameter is File, the output file, as defined by the conversion type. This is an optional parameter.

Parameters:

output - File, the output file, as defined by the conversion type.

getErrors

public Object getErrors()

Returns the Log File parameter of this tool . This parameter is File, a text file listing the warnings and errors that occurred during the conversion process. This is an optional parameter.

Returns:

the Log File

setErrors

public void setErrors(Object errors)

Sets the Log File parameter of this tool . This parameter is File, a text file listing the warnings and errors that occurred during the conversion process. This is an optional parameter.

Parameters:

errors - File, a text file listing the warnings and errors that occurred during the conversion process.

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