oracle.dss.util.xml
Class BIParseException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--oracle.dss.util.BIBaseException
                    |
                    +--oracle.dss.util.xml.BIXMLException
                          |
                          +--oracle.dss.util.xml.BIParseException

All Implemented Interfaces:

BIException, java.io.Serializable

public class BIParseException

extends BIXMLException

Indicates a problem in parsing XML. The problem might be one of the following:

• A syntax error in the DTD
• A syntax error in the XML
• Invalid XML, which is XML that does not adhere to the structure that is specified in the DTD

See Also:

Serialized Form

Constructor Summary

BIParseException(java.lang.String msg, java.lang.String pubId, java.lang.String sysId, int line, int col, int type, java.lang.Exception ex)
Constructor.

Method Summary

int	getColumnNumber() Retrieves the column number where the exception occurred.
int	getLineNumber() Retrieves the line number where the exception occurred.
java.lang.String	getPublicId() Retrieves the ID of the public DTD that the XML document should adhere to.
java.lang.String	getSysId() Retrieves the ID of the private DTD that the XML document should adhere to.
int	getType() Retrieves the type of problem that the parser encountered.

Methods inherited from class oracle.dss.util.BIBaseException

elementAt, elements, findException, getBIRootCause, getPreviousException, size, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

BIParseException

public BIParseException(java.lang.String msg,
                        java.lang.String pubId,
                        java.lang.String sysId,
                        int line,
                        int col,
                        int type,
                        java.lang.Exception ex)

Constructor.

Parameters:

msg - The error message to display.

pubId - The identifier for a public DTD that the XML document should adhere to.

sysID - The identifier for a private DTD that the XML document should adhere to.

line - The line where the problem occurs.

col - The column where the problem occurs.

type - A constant that indicates the type of problem that the parser encountered. The constants are ERROR, FATAL_ERROR, WARNING.

ex - The exception that the underlying parser has thrown. If you are not passing along an underlying exception, then pass null in this parameter.

Method Detail

getPublicId

public java.lang.String getPublicId()

Retrieves the ID of the public DTD that the XML document should adhere to. This is the DTD specified in the PUBLIC variant of the DOCTYPE statement in the XML.

Returns:

The ID for the public DTD specified in the XML file that is being parsed.

getSysId

public java.lang.String getSysId()

Retrieves the ID of the private DTD that the XML document should adhere to. This is the DTD specified in the SYSTEM variant of the DOCTYPE statement in the XML.

Returns:

The ID for the private DTD specified in the XML file that is being parsed.

getLineNumber

public int getLineNumber()

Retrieves the line number where the exception occurred. This number identifies the line that contains the first character after the error in the document. Often, you will find the error in the line previous to the line number that this method returns.

Returns:

The line that contains the first character after the problem.

getColumnNumber

public int getColumnNumber()

Retrieves the column number where the exception occurred. This number identifies the column that contains the first character after the error in the document. Often, you will find the error in the column previous to the column number that this method returns.

Returns:

The column of the first character after the problem.

getType

public int getType()

Retrieves the type of problem that the parser encountered.

Returns:

A constant that represents the type of problem. Possible return values are: ERROR, FATAL_ERROR, WARNING.