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

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

public class XMLSchemaValidator
extends AbstractGPTool

Uses the .NET 3.5 Framework's XML software to validate an ArcGIS item's metadata or any XML file. The XML is checked to see if it follows the structure and content rules outlined by an XML schema. Schemas written using the DTD or W3C XML Schema languages may be used with this tool. The XML Schema Validation 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
XMLSchemaValidator()
          Creates the XML Schema Validation tool with defaults.
XMLSchemaValidator(Object source, String schemaurl)
          Creates the XML Schema Validation tool with the required parameters.
 
Method Summary
 String getNsuri()
          Returns the Namespace URI parameter of this tool .
 Object getOutput()
          Returns the Output Metadata parameter of this tool (Read only).
 String getSchemaurl()
          Returns the Schema URL 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 setNsuri(String nsuri)
          Sets the Namespace URI parameter of this tool .
 void setSchemaurl(String schemaurl)
          Sets the Schema URL 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

XMLSchemaValidator

public XMLSchemaValidator()
Creates the XML Schema Validation tool with defaults.

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


XMLSchemaValidator

public XMLSchemaValidator(Object source,
                          String schemaurl)
Creates the XML Schema Validation 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 validated, or a stand-alone XML file that will be validated.
schemaurl - the XML Schema or XML DTD that describes the structure and content of a valid XML document.
Method Detail

getSource

public Object getSource()
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

setSource

public void setSource(Object source)
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:
source - the item whose metadata will be validated, or a stand-alone XML file that will be validated.

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. 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. This is a required parameter.

Parameters:
schemaurl - the XML Schema or XML DTD that describes the structure and content of a valid XML document.

getNsuri

public String getNsuri()
Returns the Namespace URI parameter of this tool . This parameter is the XML namespace that will be validated. if Schema URL identifies a DTD this value won't be used. This is an optional parameter.

Returns:
the Namespace URI

setNsuri

public void setNsuri(String nsuri)
Sets the Namespace URI parameter of this tool . This parameter is the XML namespace that will be validated. if Schema URL identifies a DTD this value won't be used. This is an optional parameter.

Parameters:
nsuri - the XML namespace that will be validated. if Schema URL identifies a DTD this value won't be used.

getOutput

public Object getOutput()
Returns the Output Metadata parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output 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