org.proteios.io.mzdata
Class MzDataImportTest

java.lang.Object
  org.proteios.io.mzdata.MzDataImportTest

public class MzDataImportTest
extends Object

This class supports tests of possible mzData input streams. An mzData file contains information on a mass spectrometry experiment. The XML input stream is checked for an initial mzData XML start tag. Validatation against an XML Schema Definition file is optional.

Version:

2.0

Author:

Olle

Last modified

$Date: 2006-09-26 14:44:16 +0200 (Wed, 20 Sep 2006) $

Constructor Summary

MzDataImportTest()
Default constructor.

MzDataImportTest(String xsdFilePath)
Constructor that takes an xml schema definition as parameter.

Method Summary

String	getXMLFilePath() Get mzData XML file path.
String	getXsdFilePath() Get XSD schema file to validate against.
boolean	importable(File file)
boolean	importable(InputStream iStream) Checks if XML input stream has mzData XML start tag.
boolean	importable(String xmlFilePath) Checks if XML file has mzData XML start tag.
void	processEndElement(javax.xml.stream.XMLStreamReader parser) Processes an EndElement event.
void	processEvent(int event, javax.xml.stream.XMLStreamReader parser) Processes an event.
void	processStartElement(javax.xml.stream.XMLStreamReader parser) Processes a StartElement event.
void	setXMLFilePath(String xmlFilePath) Set mzData XML file path.
void	setXsdFilePath(String xsdFilePath) Set XSD schema file to validate against.
boolean	valid(InputStream xmlInputStream) Validates mzData input stream against current mzData XSD file.
boolean	valid(String xmlFilePath) Validates mzData file against current mzData XSD file.

Methods inherited from class java.lang.Object

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

Constructor Detail

MzDataImportTest

public MzDataImportTest()

Default constructor.

MzDataImportTest

public MzDataImportTest(String xsdFilePath)

Constructor that takes an xml schema definition as parameter.

Parameters:

xsdFilePath - The XML Schema Definition to use.

Method Detail

getXsdFilePath

public String getXsdFilePath()

Get XSD schema file to validate against.

Returns:

xsdFilePath String with path for XSD schema file.

setXsdFilePath

public void setXsdFilePath(String xsdFilePath)

Set XSD schema file to validate against.

Parameters:

xsdFilePath - String with path for XSD schema file.

getXMLFilePath

public String getXMLFilePath()

Get mzData XML file path.

Returns:

xmlFilePath String with path for mzData XML file.

setXMLFilePath

public void setXMLFilePath(String xmlFilePath)

Set mzData XML file path.

Parameters:

xmlFilePath - String with path for mzData XML file.

valid

public boolean valid(String xmlFilePath)
              throws javax.xml.stream.XMLStreamException,
                     SAXException

Validates mzData file against current mzData XSD file.

Parameters:

xmlFilePath - String with path of XML file to validate.

Returns:

True if the file is valid, else false

Throws:

javax.xml.stream.XMLStreamException - If there is an XML Stream related error

SAXException

valid

public boolean valid(InputStream xmlInputStream)
              throws javax.xml.stream.XMLStreamException,
                     SAXException

Validates mzData input stream against current mzData XSD file.

Parameters:

xmlInputStream - XML input stream to validate.

Returns:

True if the XML input stream is valid, else false

Throws:

javax.xml.stream.XMLStreamException - If there is an XML Stream related error

SAXException

importable

public boolean importable(File file)
                   throws javax.xml.stream.XMLStreamException,
                          SAXException

Throws:

javax.xml.stream.XMLStreamException

SAXException

importable

public boolean importable(String xmlFilePath)

Checks if XML file has mzData XML start tag.

Parameters:

xmlFilePath - String with path of XML file to check.

importable

public boolean importable(InputStream iStream)

Checks if XML input stream has mzData XML start tag.

Parameters:

iStream - XML input stream to check.

processEvent

public void processEvent(int event,
                         javax.xml.stream.XMLStreamReader parser)
                  throws javax.xml.stream.XMLStreamException

Processes an event.

Parameters:

event - int current event.

parser - XMLStreamReader instance.

Throws:

javax.xml.stream.XMLStreamException - If there is an XML Stream related error

processStartElement

public void processStartElement(javax.xml.stream.XMLStreamReader parser)
                         throws javax.xml.stream.XMLStreamException

Processes a StartElement event.

Parameters:

parser - XMLStreamReader instance.

Throws:

javax.xml.stream.XMLStreamException - If there is an XML Stream related error

processEndElement

public void processEndElement(javax.xml.stream.XMLStreamReader parser)
                       throws javax.xml.stream.XMLStreamException

Processes an EndElement event.

Parameters:

parser - XMLStreamReader instance.

Throws:

javax.xml.stream.XMLStreamException - If there is an XML Stream related error