net.sf.ant4eclipse.lang.xquery

Class XQueryHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

net.sf.ant4eclipse.lang.xquery.XQueryHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class XQueryHandler
extends org.xml.sax.helpers.DefaultHandler

A SAX handler allowing to collect XML related data using simple queries (similar to XPath but currently not providing it's complete functionality).

Constructor Summary

Constructors

Constructor and Description
XQueryHandler() Initialises this handler.

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
XQuery	createQuery(java.lang.String query) Creates a XQuery instance for the supplied query string.
void	endElement(java.lang.String uri, java.lang.String localname, java.lang.String qname)
static void	queryFile(java.io.File xmlfile, XQueryHandler handler) Runs the queries against the supplied XML file.
static void	queryInputStream(java.io.InputStream inputStream, XQueryHandler handler) Runs the queries against the supplied XML inputstream.
void	startDocument()
void	startElement(java.lang.String uri, java.lang.String localname, java.lang.String qname, org.xml.sax.Attributes attributes)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

XQueryHandler

public XQueryHandler()

Initialises this handler.

Method Detail

createQuery

public XQuery createQuery(java.lang.String query)
                   throws XQueryException

Creates a XQuery instance for the supplied query string.

Parameters:

query - A XPath like query string.

Returns:

A query instance allowing to retrieve the results.

Throws:

XQueryException - The supplied query is invalid.

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                java.lang.String localname,
                java.lang.String qname,
                org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
              java.lang.String localname,
              java.lang.String qname)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
              int start,
              int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

queryFile

public static void queryFile(java.io.File xmlfile,
             XQueryHandler handler)
                      throws XQueryException

Runs the queries against the supplied XML file.

Parameters:

xmlfile - The XML file that shall be queried.

handler - The handler which provides all queries.

Throws:

XQueryException - Parsing failed for some reason.

queryInputStream

public static void queryInputStream(java.io.InputStream inputStream,
                    XQueryHandler handler)
                             throws XQueryException

Runs the queries against the supplied XML inputstream.

Parameters:

inputStream - The XML inputstream that shall be queried.

handler - The handler which provides all queries.

Throws:

XQueryException - Parsing failed for some reason.