com.hp.hpl.sparta

Class Parser

java.lang.Object

com.hp.hpl.sparta.Parser

public class Parser
extends Object

Provides a simple interface to the XML parser. This is an example of the Facade design pattern. There are two types of parse methods: DOM methods which parse into a DOM tree and SAX methods in which the parser calls a client-provided hander. The XML can be proved either as characters (in a String, character array, or Reader) or as bytes (in a File, byte array, or InputStream). In the latter case the Unicode encoding is first guessed by looking at the first few characters and then possibly confirmed by reading an encoding declaration on the first line of the XML. In some cases the declared encoding may be different to the guessed encoding and the parser will have to re-start reading the bytes.

Copyright (C) 2002 Hewlett-Packard Company. This file is part of Sparta, an XML Parser, DOM, and XPath library. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Version:

$Date: 2003/11/01 05:40:15 $ $Revision: 1.5 $

Author:

Eamonn O'Brien-Strain, Sergio Marti

See Also:

GNU Lesser General Public License

Constructor Summary

Constructors

Constructor and Description
Parser()

Method Summary

Methods

Modifier and Type	Method and Description
static Document	parse(byte[] xml) Parse XML to DOM, figuring out the encoding using the first few characters and possibly an encoding declaration on the first line of the XML.
static void	parse(byte[] xml, ParseHandler ph) SAX parsing of XML encoded in a byte array.
static Document	parse(char[] xml) DOM parsing of XML in a character array (this is the fastest parse method).
static void	parse(char[] xml, ParseHandler ph) SAX parsing of XML in a character array.
static Document	parse(String xml) DOM parsing of XML in a String.
static Document	parse(String systemId, InputStream istream) DOM parsing of XML encoded in a byte stream, using a default log.
static void	parse(String systemId, InputStream istream, ParseHandler ph) SAX parsing of XML encoded in a byte stream.
static Document	parse(String systemId, InputStream istream, ParseLog log) DOM parsing of XML encoded in a byte stream.
static void	parse(String systemId, InputStream istream, ParseLog log, ParseHandler ph) SAX parsing of XML encoded in a byte stream, using default log.
static Document	parse(String systemId, InputStream istream, ParseLog log, String guessedEncoding) DOM parsing of XML encoded in a character stream, specifying the Unicode encoding.
static void	parse(String systemId, InputStream istream, ParseLog log, String guessedEncoding, ParseHandler ph) SAX parsing of XML encoded in a byte stream, specifying the Unicode encoding.
static void	parse(String xml, ParseHandler ph) SAX parsing of XML in a string.
static Document	parse(String systemId, Reader reader) DOM parsing of XML in a character stream, using a default log.
static void	parse(String systemId, Reader reader, ParseHandler ph) SAX parsing of XML in character stream, using default log.
static Document	parse(String systemId, Reader reader, ParseLog log) DOM parsing of XML in a character stream.
static void	parse(String systemId, Reader reader, ParseLog log, ParseHandler ph) SAX parsing of XML in character stream.
static Document	parse(String systemId, Reader reader, ParseLog log, String encoding) DOM parsing of XML in a character stream, specifying the Unicode encoding.
static void	parse(String systemId, Reader reader, ParseLog log, String encoding, ParseHandler ph) SAX parsing of XML encoded in a character stream, specifying the Unicode encoding.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parser

public Parser()

Method Detail

parse

public static Document parse(String systemId,
             Reader reader)
                      throws ParseException,
                             IOException

DOM parsing of XML in a character stream, using a default log.

Throws:

ParseException

IOException

parse

public static Document parse(String systemId,
             Reader reader,
             ParseLog log)
                      throws ParseException,
                             IOException

DOM parsing of XML in a character stream.

Throws:

ParseException

IOException

parse

public static Document parse(String xml)
                      throws ParseException,
                             IOException

DOM parsing of XML in a String.

Throws:

ParseException

IOException

parse

public static Document parse(char[] xml)
                      throws ParseException,
                             IOException

DOM parsing of XML in a character array (this is the fastest parse method).

Throws:

ParseException

IOException

parse

public static Document parse(byte[] xml)
                      throws ParseException,
                             IOException

Parse XML to DOM, figuring out the encoding using the first few characters and possibly an encoding declaration on the first line of the XML.

Parameters:

xml - stored in an array of bytes in some Unicode encoding.

Returns:

the DOM Document resulting from the parsing

Throws:

ParseException - on parse error

IOException

parse

public static Document parse(String systemId,
             Reader reader,
             ParseLog log,
             String encoding)
                      throws ParseException,
                             EncodingMismatchException,
                             IOException

DOM parsing of XML in a character stream, specifying the Unicode encoding.

Throws:

ParseException

EncodingMismatchException

IOException

parse

public static Document parse(String systemId,
             InputStream istream,
             ParseLog log)
                      throws ParseException,
                             IOException

DOM parsing of XML encoded in a byte stream.

Throws:

ParseException

IOException

parse

public static Document parse(String systemId,
             InputStream istream)
                      throws ParseException,
                             IOException

DOM parsing of XML encoded in a byte stream, using a default log.

Throws:

ParseException

IOException

parse

public static Document parse(String systemId,
             InputStream istream,
             ParseLog log,
             String guessedEncoding)
                      throws ParseException,
                             IOException

DOM parsing of XML encoded in a character stream, specifying the Unicode encoding.

Throws:

ParseException

IOException

parse

public static void parse(String systemId,
         Reader reader,
         ParseHandler ph)
                  throws ParseException,
                         IOException

SAX parsing of XML in character stream, using default log.

Throws:

ParseException

IOException

parse

public static void parse(String systemId,
         Reader reader,
         ParseLog log,
         ParseHandler ph)
                  throws ParseException,
                         IOException

SAX parsing of XML in character stream.

Throws:

ParseException

IOException

parse

public static void parse(String xml,
         ParseHandler ph)
                  throws ParseException,
                         IOException

SAX parsing of XML in a string.

Throws:

ParseException

IOException

parse

public static void parse(char[] xml,
         ParseHandler ph)
                  throws ParseException,
                         IOException

SAX parsing of XML in a character array.

Throws:

ParseException

IOException

parse

public static void parse(byte[] xml,
         ParseHandler ph)
                  throws ParseException,
                         IOException

SAX parsing of XML encoded in a byte array.

Throws:

ParseException

IOException

parse

public static void parse(String systemId,
         InputStream istream,
         ParseLog log,
         ParseHandler ph)
                  throws ParseException,
                         IOException

SAX parsing of XML encoded in a byte stream, using default log.

Throws:

ParseException

IOException

parse

public static void parse(String systemId,
         InputStream istream,
         ParseHandler ph)
                  throws ParseException,
                         IOException

SAX parsing of XML encoded in a byte stream.

Throws:

ParseException

IOException

parse

public static void parse(String systemId,
         InputStream istream,
         ParseLog log,
         String guessedEncoding,
         ParseHandler ph)
                  throws ParseException,
                         IOException

SAX parsing of XML encoded in a byte stream, specifying the Unicode encoding.

Throws:

ParseException

IOException

parse

public static void parse(String systemId,
         Reader reader,
         ParseLog log,
         String encoding,
         ParseHandler ph)
                  throws ParseException,
                         EncodingMismatchException,
                         IOException

SAX parsing of XML encoded in a character stream, specifying the Unicode encoding.

Throws:

ParseException

EncodingMismatchException

IOException