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

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

All Implemented Interfaces:

GPTool

public class ExportMetadata
extends AbstractGPTool

Updates metadata to contain the most current properties of the ArcGIS item before processing the metadata and finally exporting it to an XML file that conforms to a standard metadata format. The Export Metadata tool is contained in the Conversion Tools tool box.

Usage tips:

• The output files produced by this tool can't be stored in a geodatabase. If the environment is set to a geodatabase the output files will be stored in a different location, as described below.
• 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.

Field Summary

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

vals

Constructor Summary

ExportMetadata()
Creates the Export Metadata tool with defaults.

ExportMetadata(Object sourceMetadata, Object translator)
Creates the Export Metadata tool with the required parameters.

Method Summary

Object	getOutputFile() Returns the Output File parameter of this tool .
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.
Object	getTranslator() Returns the Translator parameter of this tool .
void	setOutputFile(Object outputFile) Sets the Output File parameter of this tool .
void	setSourceMetadata(Object sourceMetadata) Sets the Source Metadata parameter of this tool .
void	setTranslator(Object translator) Sets the Translator 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

ExportMetadata

public ExportMetadata()

Creates the Export Metadata tool with defaults.

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

ExportMetadata

public ExportMetadata(Object sourceMetadata,
                      Object translator)

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

translator - an XML file that defines the conversion that will be performed. the translator files provided with ArcGIS Desktop can be found in the \Metadata\Translator folder. The following conversions are supported: the ArcGIS to ISO 19139 conversion will be used by default if another translator is not specified.

Method Detail

getSourceMetadata

public Object getSourceMetadata()

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

setSourceMetadata

public void setSourceMetadata(Object sourceMetadata)

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:

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

getTranslator

public Object getTranslator()

Returns the Translator parameter of this tool . This parameter is an XML file that defines the conversion that will be performed. the translator files provided with ArcGIS Desktop can be found in the \Metadata\Translator folder. The following conversions are supported: the ArcGIS to ISO 19139 conversion will be used by default if another translator is not specified. This is a required parameter.

Returns:

the Translator

setTranslator

public void setTranslator(Object translator)

Sets the Translator parameter of this tool . This parameter is an XML file that defines the conversion that will be performed. the translator files provided with ArcGIS Desktop can be found in the \Metadata\Translator folder. The following conversions are supported: the ArcGIS to ISO 19139 conversion will be used by default if another translator is not specified. This is a required parameter.

Parameters:

translator - an XML file that defines the conversion that will be performed. the translator files provided with ArcGIS Desktop can be found in the \Metadata\Translator folder. The following conversions are supported: the ArcGIS to ISO 19139 conversion will be used by default if another translator is not specified.

getOutputFile

public Object getOutputFile()

Returns the Output File parameter of this tool . This parameter is a stand-alone XML file that will be created containing the converted metadata. This is an optional parameter.

Returns:

the Output File

setOutputFile

public void setOutputFile(Object outputFile)

Sets the Output File parameter of this tool . This parameter is a stand-alone XML file that will be created containing the converted metadata. This is an optional parameter.

Parameters:

outputFile - a stand-alone XML file that will be created containing the converted 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