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

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

All Implemented Interfaces:

GPTool

public class ValidateMetadata
extends AbstractGPTool

Exports metadata to a standard metadata format then validates the exported file. The Validate Metadata tool is contained in the Conversion Tools tool box.

Usage tips:

• Some XML Schemas require you to specify the XML namespace you want to validate, while others do not.
• Specify an output file if you want to keep the exported metadata file. For example, after checking that the exported file validated successfully you might publish it to a metadata catalog.
• 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.

Field Summary

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

vals

Constructor Summary

ValidateMetadata()
Creates the Validate Metadata tool with defaults.

ValidateMetadata(Object sourceMetadata, Object translator, String schemaURL, Object outputFile)
Creates the Validate Metadata tool with the required parameters.

Method Summary

String	getNamespaceURI() Returns the Namespace URI parameter of this tool .
Object	getOutputFile() Returns the Output File parameter of this tool .
String	getSchemaURL() Returns the Schema URL 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	setNamespaceURI(String namespaceURI) Sets the Namespace URI parameter of this tool .
void	setOutputFile(Object outputFile) Sets the Output File parameter of this tool .
void	setSchemaURL(String schemaURL) Sets the Schema URL 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

ValidateMetadata

public ValidateMetadata()

Creates the Validate Metadata tool with defaults.

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

ValidateMetadata

public ValidateMetadata(Object sourceMetadata,
                        Object translator,
                        String schemaURL,
                        Object outputFile)

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

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.

schemaURL - the XML Schema or XML DTD that describes the structure and content of a valid XML document. the XML Schema associated with ISO standard 19139, , will be used for validation if another URL is not specified.

outputFile - a stand-alone XML file that will be created containing the converted metadata.

Method Detail

getSourceMetadata

public Object getSourceMetadata()

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

Parameters:

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

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.

getSchemaURL

public String getSchemaURL()

Returns the Schema URL parameter of this tool . This parameter is the XML Schema or XML DTD that describes the structure and content of a valid XML document. the XML Schema associated with ISO standard 19139, , will be used for validation if another URL is not specified. This is a required parameter.

Returns:

the Schema URL

setSchemaURL

public void setSchemaURL(String schemaURL)

Sets the Schema URL parameter of this tool . This parameter is the XML Schema or XML DTD that describes the structure and content of a valid XML document. the XML Schema associated with ISO standard 19139, , will be used for validation if another URL is not specified. This is a required parameter.

Parameters:

schemaURL - the XML Schema or XML DTD that describes the structure and content of a valid XML document. the XML Schema associated with ISO standard 19139, , will be used for validation if another URL is not specified.

getNamespaceURI

public String getNamespaceURI()

Returns the Namespace URI parameter of this tool . This parameter is the XML namespace that will be validated. the Namespace URI associated with the ISO 19139 metadata standard will be used for validation if another XML Schema or DTD is not specified. if Schema URL identifies a DTD this value won't be used; provide # instead of a namespace URI. This is an optional parameter.

Returns:

the Namespace URI

setNamespaceURI

public void setNamespaceURI(String namespaceURI)

Sets the Namespace URI parameter of this tool . This parameter is the XML namespace that will be validated. the Namespace URI associated with the ISO 19139 metadata standard will be used for validation if another XML Schema or DTD is not specified. if Schema URL identifies a DTD this value won't be used; provide # instead of a namespace URI. This is an optional parameter.

Parameters:

namespaceURI - the XML namespace that will be validated. the Namespace URI associated with the ISO 19139 metadata standard will be used for validation if another XML Schema or DTD is not specified. if Schema URL identifies a DTD this value won't be used; provide # instead of a namespace URI.

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 a required 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 a required 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