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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.conversiontools.USGSMPTranslator
All Implemented Interfaces:
GPTool

public class USGSMPTranslator
extends AbstractGPTool

Uses the USGS metadata parser utility, known as mp, to export or validate FGDC metadata content. The mp utility is created and maintained by the USGS for managing metadata that follows the FGDC The USGS MP Metadata Translator tool is contained in the Conversion Tools tool box.

Usage tips:


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

Parameters:
source - 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 a file that defines custom parameters that mp will consider when processing the metadata. to export metadata without using a configuration file, provide # instead of a file name. 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 a file that defines custom parameters that mp will consider when processing the metadata. to export metadata without using a configuration file, provide # instead of a file name. This is an optional parameter.

Parameters:
config - a file that defines custom parameters that mp will consider when processing the metadata. to export metadata without using a configuration file, provide # instead of a file name.

getConversion

public String getConversion()
Returns the Conversion Type parameter of this tool . This parameter is the type of conversion that will take place. by default, the "XML" conversion will be performed. 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 the type of conversion that will take place. by default, the "XML" conversion will be performed. This is an optional parameter.

Parameters:
conversion - the type of conversion that will take place. by default, the "XML" conversion will be performed.

getOutput

public Object getOutput()
Returns the Output File parameter of this tool . This parameter is a file that will be created containing the converted metadata. the type of file created is defined by the conversion type. to check for problems in the FGDC metadata using mp and not produce a output file, provide # instead of a file name. 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 a file that will be created containing the converted metadata. the type of file created is defined by the conversion type. to check for problems in the FGDC metadata using mp and not produce a output file, provide # instead of a file name. This is an optional parameter.

Parameters:
output - a file that will be created containing the converted metadata. the type of file created is defined by the conversion type. to check for problems in the FGDC metadata using mp and not produce a output file, provide # instead of a file name.

getErrors

public Object getErrors()
Returns the Log File parameter of this tool . This parameter is a text file that will be created listing the warnings and errors that occurred during the conversion process. to export metadata without producing a log file, provide # instead of a file name. 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 a text file that will be created listing the warnings and errors that occurred during the conversion process. to export metadata without producing a log file, provide # instead of a file name. This is an optional parameter.

Parameters:
errors - a text file that will be created listing the warnings and errors that occurred during the conversion process. to export metadata without producing a log file, provide # instead of a file name.

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