com.compomics.util.pride.validation

Class PrideXmlValidator

java.lang.Object

com.compomics.util.pride.validation.PrideXmlValidator

public class PrideXmlValidator
extends java.lang.Object

PRIDE XML schema validation.

Author:

Phil Jones, Florian Reisinger, Harald Barsnes

Field Summary

Fields

Modifier and Type	Field and Description
static org.iso_relax.verifier.VerifierFactory	VERIFIER_FACTORY The verifier factory.

Constructor Summary

Constructors

Constructor and Description
PrideXmlValidator() Set up a PrideXmlValidator using the default schema.
PrideXmlValidator(java.net.URL schemaUrl) Set up a PrideXmlValidator using the provided schema.

Method Summary

Methods

Modifier and Type	Method and Description
XMLValidationErrorHandler	getErrors() Returns the XML validation error object.
java.lang.String	getErrorsAsString() Returns the errors formatted as s single string.
void	setSchema(java.net.URL schemaUrl) Set the schema.
boolean	validate(java.io.File prideXmlFile) Returns true of the given PRIDE XML file is valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERIFIER_FACTORY

public static final org.iso_relax.verifier.VerifierFactory VERIFIER_FACTORY

The verifier factory.

Constructor Detail

PrideXmlValidator

public PrideXmlValidator()
                  throws java.io.IOException,
                         org.iso_relax.verifier.VerifierConfigurationException,
                         org.xml.sax.SAXException

Set up a PrideXmlValidator using the default schema.

Throws:

java.io.IOException

org.iso_relax.verifier.VerifierConfigurationException

org.xml.sax.SAXException

PrideXmlValidator

public PrideXmlValidator(java.net.URL schemaUrl)
                  throws java.io.IOException,
                         org.iso_relax.verifier.VerifierConfigurationException,
                         org.xml.sax.SAXException

Set up a PrideXmlValidator using the provided schema.

Parameters:

schemaUrl - the URL to the schema

Throws:

java.io.IOException

org.iso_relax.verifier.VerifierConfigurationException

org.xml.sax.SAXException

Method Detail

setSchema

public void setSchema(java.net.URL schemaUrl)
               throws java.io.IOException,
                      org.iso_relax.verifier.VerifierConfigurationException,
                      org.xml.sax.SAXException

Set the schema.

Parameters:

schemaUrl - the schema to set

Throws:

java.io.IOException

org.iso_relax.verifier.VerifierConfigurationException

org.xml.sax.SAXException

validate

public boolean validate(java.io.File prideXmlFile)
                 throws java.io.FileNotFoundException,
                        java.io.IOException,
                        org.iso_relax.verifier.VerifierConfigurationException,
                        org.xml.sax.SAXException

Returns true of the given PRIDE XML file is valid.

Parameters:

prideXmlFile - the PRIDE XML file to test

Returns:

true of the given PRIDE XML file is valid

Throws:

java.io.FileNotFoundException

java.io.IOException

org.iso_relax.verifier.VerifierConfigurationException

org.xml.sax.SAXException

getErrorsAsString

public java.lang.String getErrorsAsString()

Returns the errors formatted as s single string. Returns null if the file has not been validated.

Returns:

the errors formatted as s single string, null if the file has not yet been validated

getErrors

public XMLValidationErrorHandler getErrors()

Returns the XML validation error object. Returns null if the file has not been validated.

Returns:

the XML validation error object, null if the file has not yet been validated