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

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

All Implemented Interfaces:

GPTool

public class ExportMetadataMultiple
extends AbstractGPTool

Exports metadata for many ArcGIS items to a designated folder. This tool is a model that uses Export Metadata to export metadata for many ArcGIS items. The Export Metadata Multiple tool is contained in the Conversion Tools tool box.

Usage tips:

• The output XML files are named by appending _export.xml to the item's name and are stored in the specified folder.

Field Summary

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

vals

Constructor Summary

ExportMetadataMultiple()
Creates the Export Metadata Multiple tool with defaults.

ExportMetadataMultiple(Object sourceMetadata, Object translator, Object outputFolder)
Creates the Export Metadata Multiple tool with the required parameters.

Method Summary

Object	getOutputFiles() Returns the Output Files parameter of this tool (Read only).
Object	getOutputFolder() Returns the Output Folder 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	setOutputFolder(Object outputFolder) Sets the Output Folder 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

ExportMetadataMultiple

public ExportMetadataMultiple()

Creates the Export Metadata Multiple tool with defaults.

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

ExportMetadataMultiple

public ExportMetadataMultiple(Object sourceMetadata,
                              Object translator,
                              Object outputFolder)

Creates the Export Metadata Multiple 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 set of items whose metadata will be converted, or the set of stand-alone XML files 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.

outputFolder - an existing folder where the output XML files containing the converted metadata will be stored.

Method Detail

getSourceMetadata

public Object getSourceMetadata()

Returns the Source Metadata parameter of this tool . This parameter is the set of items whose metadata will be converted, or the set of stand-alone XML files 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 set of items whose metadata will be converted, or the set of stand-alone XML files that will be converted. This is a required parameter.

Parameters:

sourceMetadata - the set of items whose metadata will be converted, or the set of stand-alone XML files 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.

getOutputFolder

public Object getOutputFolder()

Returns the Output Folder parameter of this tool . This parameter is an existing folder where the output XML files containing the converted metadata will be stored. This is a required parameter.

Returns:

the Output Folder

setOutputFolder

public void setOutputFolder(Object outputFolder)

Sets the Output Folder parameter of this tool . This parameter is an existing folder where the output XML files containing the converted metadata will be stored. This is a required parameter.

Parameters:

outputFolder - an existing folder where the output XML files containing the converted metadata will be stored.

getOutputFiles

public Object getOutputFiles()

Returns the Output Files parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Files

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