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

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

All Implemented Interfaces:

GPTool

public class ESRITranslator
extends AbstractGPTool

This tool requires the Microsoft .NET Framework 2.0. These tools are installed with the .NET Support install option. Uses the ArcGIS metadata translation engine to export metadata content from ArcCatalog to a standalone XML file. For example, the exported file might contain the same content but formatted to follow a different metadata standard such as The ESRI Metadata Translator tool is contained in the Conversion Tools tool box.

Software restrictions: none

Usage tips:

• To validate metadata using the ESRI Metadata Translator without producing an output file, run the tool from the command line and specify "#" as the output file name.
• If you look at the Translators provided with ArcGIS Desktop in a text or XML editor, you will see they have an attribute stopOnErrors. This attribute can have one of three values: yes, no, any. When including the ESRI Metadata Translator in a model, you may prefer to copy one of the default Translators and change the stopOnErrors value to produce the desired behavior.

Field Summary

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

vals

Constructor Summary

ESRITranslator()
Creates the ESRI Metadata Translator tool with defaults.

ESRITranslator(Object source, Object translator)
Creates the ESRI Metadata Translator tool with the required parameters.

Method Summary

Object	getLogfile() 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.
Object	getTranslator() Returns the Translation parameter of this tool .
void	setLogfile(Object logfile) 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 .
void	setTranslator(Object translator) Sets the Translation 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

ESRITranslator

public ESRITranslator()

Creates the ESRI Metadata Translator tool with defaults.

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

ESRITranslator

public ESRITranslator(Object source,
                      Object translator)

Creates the ESRI 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.

translator - File, when metadata is translated to ESRI-ISO format, the original document will be included in the output XML file as an enclosure.

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.

getTranslator

public Object getTranslator()

Returns the Translation parameter of this tool . This parameter is File, when metadata is translated to ESRI-ISO format, the original document will be included in the output XML file as an enclosure. This is a required parameter.

Returns:

the Translation

setTranslator

public void setTranslator(Object translator)

Sets the Translation parameter of this tool . This parameter is File, when metadata is translated to ESRI-ISO format, the original document will be included in the output XML file as an enclosure. This is a required parameter.

Parameters:

translator - File, when metadata is translated to ESRI-ISO format, the original document will be included in the output XML file as an enclosure.

getOutput

public Object getOutput()

Returns the Output File parameter of this tool . This parameter is File, a standalone XML file that will be created containing the transformed metadata. 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, a standalone XML file that will be created containing the transformed metadata. This is an optional parameter.

Parameters:

output - File, a standalone XML file that will be created containing the transformed metadata.

getLogfile

public Object getLogfile()

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

setLogfile

public void setLogfile(Object logfile)

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:

logfile - 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