org.xml.sax
Class SAXParseException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--org.xml.sax.SAXException
                    |
                    +--org.xml.sax.SAXParseException

public class SAXParseException

extends SAXException

Encapsulate an XML parse error or warning.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This is ARP specific documentation, for the general SAX documentation try the Xerces copy.

This exception will include information for locating the error in the original XML document. Note that although the application will receive a SAXParseException as the argument to the handlers in the ErrorHandler interface, the application is not actually required to throw the exception; instead, it can simply read the information in it and take a different action.

Since this exception is a subclass of SAXException, it inherits the ability to wrap another exception.

Within ARP, any instance of this class that is not also an instance of the subclass ParseException is an XML related error, originating in SAXException, ErrorHandler, Serialized Form

Constructor Summary

SAXParseException(java.lang.String message, org.xml.sax.Locator locator)
Create a new SAXParseException from a message and a Locator.

SAXParseException(java.lang.String message, org.xml.sax.Locator locator, java.lang.Exception e)
Wrap an existing exception in a SAXParseException.

SAXParseException(java.lang.String message, java.lang.String publicId, java.lang.String systemId, int lineNumber, int columnNumber)
Create a new SAXParseException.

SAXParseException(java.lang.String message, java.lang.String publicId, java.lang.String systemId, int lineNumber, int columnNumber, java.lang.Exception e)
Create a new SAXParseException with an embedded exception.

Method Summary

int	getColumnNumber() The column number of the end of the text where the exception occurred.
int	getLineNumber() The line number of the end of the text where the exception occurred.
java.lang.String	getPublicId() Get the public identifier of the entity where the exception occurred.
java.lang.String	getSystemId() Get the system identifier of the entity where the exception occurred.

Methods inherited from class org.xml.sax.SAXException

getException, getMessage, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SAXParseException

public SAXParseException(java.lang.String message,
                         org.xml.sax.Locator locator)

Create a new SAXParseException from a message and a Locator.

This constructor is not very useful within ARP.

Parameters:

message - The error or warning message.

locator - The locator object for the error or warning (may be null).

SAXParseException

public SAXParseException(java.lang.String message,
                         org.xml.sax.Locator locator,
                         java.lang.Exception e)

Wrap an existing exception in a SAXParseException.

This constructor is not very useful within ARP}.

Parameters:

message - The error or warning message, or null to use the message from the embedded exception.

locator - The locator object for the error or warning (may be null).

e - Any exception.

SAXParseException

public SAXParseException(java.lang.String message,
                         java.lang.String publicId,
                         java.lang.String systemId,
                         int lineNumber,
                         int columnNumber)

Create a new SAXParseException.

Parameters:

message - The error or warning message.

publicId - The public identifer of the entity that generated the error or warning.

systemId - The system identifer of the entity that generated the error or warning.

lineNumber - The line number of the end of the text that caused the error or warning.

columnNumber - The column number of the end of the text that cause the error or warning.

SAXParseException

public SAXParseException(java.lang.String message,
                         java.lang.String publicId,
                         java.lang.String systemId,
                         int lineNumber,
                         int columnNumber,
                         java.lang.Exception e)

Create a new SAXParseException with an embedded exception.

Parameters:

message - The error or warning message, or null to use the message from the embedded exception.

publicId - The public identifer of the entity that generated the error or warning.

systemId - The system identifer of the entity that generated the error or warning.

lineNumber - The line number of the end of the text that caused the error or warning.

columnNumber - The column number of the end of the text that cause the error or warning.

e - Another exception to embed in this one.

Method Detail

getPublicId

public java.lang.String getPublicId()

Get the public identifier of the entity where the exception occurred. Within ARP this is usually null.

Returns:

A string containing the public identifier, or null if none is available.

getSystemId

public java.lang.String getSystemId()

Get the system identifier of the entity where the exception occurred.

If the system identifier is a URL, it will be resolved fully.

Returns:

A string containing the system identifier, or null if none is available.

getLineNumber

public int getLineNumber()

The line number of the end of the text where the exception occurred.

For an RDF error related to an XML attribute or an element tag qname this method returns the location of the end of the XML start element tag.

e.g.

<unqualifiedElement rdf:unknownAttribute="value"
rdf:about="http://example.org/"
rdf:type="http://example.org/#OKType
xmlns=""
>

Will generate errors which give their location as being where the ">" is, not on the line of the "<" where they occur.

Returns:

An integer representing the line number, or -1 if none is available.

getColumnNumber

public int getColumnNumber()

The column number of the end of the text where the exception occurred.

The first column in a line is position 1.

Note the details given under getLineNumber concerning locating RDF errors in ARP.

Returns:

An integer representing the column number, or -1 if none is available.