ErrorReportImpl (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- org.openxml.parser.ErrorReportImpl

All Implemented Interfaces:

ErrorReport, ErrorHandler
```
public class ErrorReportImpl
extends Object
implements ErrorHandler, ErrorReport
```
Implements an error report facility which is also a SAX error handler. This implementation is used by parsers to implement error reporting selecting throwing, based on the ErrorReport interface. This implementation also supports the SAX error handler interface, so it can be used with other parsers as well.
If this error report is used with an OpenXML parser, the parser will use the error report facility to extend the SAX error handler with two features. It will skip warning reporting if they are not desired by this error report, and it will report the level of errors. When used with a SAX parser, all errors will be reported at the default ErrorReport.GENERAL level.

Author:

Assaf Arkin

See Also:

ErrorReport, ErrorHandler

Field Summary
- Fields inherited from interface org.openxml.parser.ErrorReport
  CONTENT, FATAL, GENERAL, PROCESSING, REPORT_ALL_ERRORS, REPORT_NOTHING, REPORT_WITH_WARNING, STOP_AT_CONTENT, STOP_AT_FATAL, STOP_AT_FIRST_ERROR, STOP_AT_NO_ERROR, STOP_AT_PROCESSING, STOP_AT_VALIDITY, STOP_AT_WELL_FORMED, VALIDITY, WARNING, WELL_FORMED

Constructor Summary

Constructors
Constructor and Description
`ErrorReportImpl()` Create a new error reporter with the report level `ErrorReport.REPORT_ALL_ERRORS` and the stop level `ErrorReport.STOP_AT_NO_ERROR`.
`ErrorReportImpl(int stopAtLevel, int reportLevel)` Create a new error reporter with the specified report level and stop level.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`error(SAXParseException except)`
`void`	`fatalError(Exception except)` Report a fatal exception derived from an exception.
`void`	`fatalError(SAXParseException except)`
`protected String`	`formatLocation(Object location)` Given the location returns a suitably formatted string.
`protected String`	`formatMessage(org.openxml.parser.ErrorReportEntry error)` Given the error record returns a suitably formatted string.
`int`	`getCount()` Returns the number of errors contained in this report.
`int`	`getErrorLevel(int index)` Returns the error level of the numbered error.
`SAXException`	`getException(int index)` Returns the error's exception.
`SAXException`	`getLastException()` Return the last error exception.
`String`	`getLastMessage()` Return the last error as formatted message.
`String`	`getMessage(int index)` Returns formatted error message.
`boolean`	`isReporting(int errorLevel)` True if errors in this level are to be reported.
`SAXException[]`	`listExceptions(int fromErrorLevel)` Returns a list of error exceptions.
`String[]`	`listMessages(int fromErrorLevel)` Returns a list of error messages.
`void`	`reportError(int errorLevel, Node node, SAXException except)` Report a processing error at the specified level.
`protected void`	`reportError(int errorLevel, Object location, SAXException except)` Internal error reporting method.
`void`	`reportError(int errorLevel, SAXException except)` Report a parse error at the specified level.
`void`	`reportError(int errorLevel, String location, SAXException except)` Report a processing error at the specified level.
`void`	`warning(SAXParseException except)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ErrorReportImpl
```
public ErrorReportImpl()
```
    Create a new error reporter with the report level ErrorReport.REPORT_ALL_ERRORS and the stop level ErrorReport.STOP_AT_NO_ERROR. The application uses this to report all errors for the purpose of bug fixing, but assumes that the application can recover and continue in spite of errors.
  - ErrorReportImpl
```
public ErrorReportImpl(int stopAtLevel,
                       int reportLevel)
```
    Create a new error reporter with the specified report level and stop level. reportLevel and stopAtLevel are often used in the following combinations:
    - ErrorReport.STOP_AT_NO_ERROR, ErrorReport.REPORT_WITH_WARNING: Parsing and locating errors in the document; all errors and warnings are reported at the end.
    - ErrorReport.STOP_AT_NO_ERROR, ErrorReport.REPORT_ALL_ERRORS: Working with user interaction; will attempt to report all errors for purpose of bug fixing, but assumes that the application can go on until the user stops it.
    - ErrorReport.STOP_AT_FIRST_ERROR, ErrorReport.REPORT_NOTHING: Working non-interactive: there should be no problem, if there is, processing stops and the last error is reported.
    Parameters:
    
    stopAtLevel - The error level at which to stop processing and throw an exception
    
    reportLevel - The error levels to report
- Method Detail
  - warning
```
public void warning(SAXParseException except)
             throws SAXException
```
    Specified by:
    
    warning in interface ErrorHandler
    
    Throws:
    
    SAXException
  - error
```
public void error(SAXParseException except)
           throws SAXException
```
    Specified by:
    
    error in interface ErrorHandler
    
    Throws:
    
    SAXException
  - fatalError
```
public void fatalError(SAXParseException except)
                throws SAXException
```
    Specified by:
    
    fatalError in interface ErrorHandler
    
    Throws:
    
    SAXException
  - reportError
```
public void reportError(int errorLevel,
                        String location,
                        SAXException except)
                 throws SAXException
```
    Description copied from interface: ErrorReport
    
    Report a processing error at the specified level. A textual string is used to identify the error's location. It is reported and possibly thrown based on the error level.
    
    Specified by:
    
    reportError in interface ErrorReport
    
    Parameters:
    
    errorLevel - The error level to report
    
    location - The location at which the error occured
    
    except - The exception to be reported
    
    Throws:
    
    SAXException - Will throw the exception if set to stop at this error level
  - reportError
```
public void reportError(int errorLevel,
                        Node node,
                        SAXException except)
                 throws SAXException
```
    Description copied from interface: ErrorReport
    
    Report a processing error at the specified level. A document tree node is used to identify the error's location in the document. It is reported and possibly thrown based on the error level.
    
    Specified by:
    
    reportError in interface ErrorReport
    
    Parameters:
    
    errorLevel - The error level to report
    
    node - The document tree node at which the error occured
    
    except - The exception to be reported
    
    Throws:
    
    SAXException - Will throw the exception if set to stop at this error level
  - reportError
```
public void reportError(int errorLevel,
                        SAXException except)
                 throws SAXException
```
    Description copied from interface: ErrorReport
    
    Report a parse error at the specified level. The parse exception already contains the error's location in the source document. It is reported and possibly thrown based on the error level.
    
    Specified by:
    
    reportError in interface ErrorReport
    
    Parameters:
    
    errorLevel - The error level to report
    
    except - The exception to be reported
    
    Throws:
    
    SAXException - Will throw the exception if set to stop at this error level
  - fatalError
```
public void fatalError(Exception except)
                throws SAXException
```
    Description copied from interface: ErrorReport
    
    Report a fatal exception derived from an exception. The exception is usually an I/O or runtime exception, which is transformed to and reported as a fatal error. This method will always throw an exception.
    
    Specified by:
    
    fatalError in interface ErrorReport
    
    Parameters:
    
    except - The exception to be reported as fatal
    
    Throws:
    
    SAXException - The exception is reported and thrown as this SAX exception
  - isReporting
```
public boolean isReporting(int errorLevel)
```
    Description copied from interface: ErrorReport
    
    True if errors in this level are to be reported. This method can be used to determine if this report is interested in an error of a particular level (e.g. warnings are often ignored).
    
    Specified by:
    
    isReporting in interface ErrorReport
    
    Returns:
    
    True if interested in this error level
  - getCount
```
public int getCount()
```
    Description copied from interface: ErrorReport
    
    Returns the number of errors contained in this report. It is possible that new errors will be added to this report after this method has returned.
    
    Specified by:
    
    getCount in interface ErrorReport
  - getErrorLevel
```
public int getErrorLevel(int index)
```
    Description copied from interface: ErrorReport
    
    Returns the error level of the numbered error. This method can be used to tell if a given error is fatal, warning or other.
    
    Specified by:
    
    getErrorLevel in interface ErrorReport
    
    Parameters:
    
    index - The error message number
    
    Returns:
    
    The error level
  - getException
```
public SAXException getException(int index)
```
    Description copied from interface: ErrorReport
    
    Returns the error's exception. Each error is associated with a single SAXException exception, SAXParseException if the error was generated by a parser.
    
    Specified by:
    
    getException in interface ErrorReport
    
    Parameters:
    
    index - The error message number
    
    Returns:
    
    The error exception
  - getMessage
```
public String getMessage(int index)
```
    Description copied from interface: ErrorReport
    
    Returns formatted error message. The error message is formatted to contain the location of the error and the description of the message. The formatted string is returned in the current locale.
    
    Specified by:
    
    getMessage in interface ErrorReport
    
    Parameters:
    
    index - The error message number
    
    Returns:
    
    The formatted message
  - getLastException
```
public SAXException getLastException()
```
    Description copied from interface: ErrorReport
    
    Return the last error exception. This is the last error reported to this facility, even if it was not stored; it will not be a warning.
    
    Specified by:
    
    getLastException in interface ErrorReport
    
    Returns:
    
    The error as exception
  - getLastMessage
```
public String getLastMessage()
```
    Description copied from interface: ErrorReport
    
    Return the last error as formatted message. This is the last error reported to this facility, even if it was not stored; it will not be a warning. The error message is formatted to contain the location of the error and the description of the message. The formatted string is returned in the current locale.
    
    Specified by:
    
    getLastMessage in interface ErrorReport
    
    Returns:
    
    The formatted message
  - listMessages
```
public String[] listMessages(int fromErrorLevel)
```
    Description copied from interface: ErrorReport
    
    Returns a list of error messages. The returned list is in the same order in which the errors were reported. To selectively view errors, set fromErrorLevel to a value that is higher than a ErrorReport.WARNING.
    
    Specified by:
    
    listMessages in interface ErrorReport
    
    Parameters:
    
    fromErrorLevel - Return only errors of this or higher error level
    
    Returns:
    
    List of error message (could be empty)
  - listExceptions
```
public SAXException[] listExceptions(int fromErrorLevel)
```
    Description copied from interface: ErrorReport
    
    Returns a list of error exceptions. The returned list is in the same order in which the errors were reported. To selectively view errors, set fromErrorLevel to a value that is higher than a ErrorReport.WARNING.
    
    Specified by:
    
    listExceptions in interface ErrorReport
    
    Parameters:
    
    fromErrorLevel - Return only errors of this or higher error level
    
    Returns:
    
    List of errors (could be empty)
  - reportError
```
protected void reportError(int errorLevel,
                           Object location,
                           SAXException except)
                    throws SAXException
```
    Internal error reporting method. This method is called to report an error and based on its level will either record it, throw an exception or plainly ignore it. Warnings never throw an exception, fatal errors always throw an exception.
    
    Parameters:
    
    errorLevel - The level of the reported error
    
    location - Object that describes location at which error occured
    
    except - The error's exception
    
    Throws:
    
    SAXException
  - formatMessage
```
protected String formatMessage(org.openxml.parser.ErrorReportEntry error)
```
    Given the error record returns a suitably formatted string. The error location is formatted using formatLocation(java.lang.Object).
    The following parameters are used in formatting the message:
    - {0} Error level (integer)
    - {1} Location (from formatLocation(java.lang.Object))
    - {2} Error exception class name
    - {3} Error message
    Parameters:
    
    error - The error record
    
    Returns:
    
    The formatted error message
  - formatLocation
```
protected String formatLocation(Object location)
```
    Given the location returns a suitably formatted string. If the location is a Locator or SAXException, the location in the source document is returned in a suitable format; if the location is a DOM node, its location in the document tree is returned; if the location is a string, or a null, it is returned as is.
    The following parameters are used in formatting the location in the source document:
    - {0} Document system identifier
    - {1} Document public identifier
    - {2} Line number (1-based)
    - {3} Column number in line (1-based)
    For location in the document tree, starting with the root, each parent node is printed as node name followed by '/', e.g.:
```
HTML/HEAD/TITLE/#text
```
    Parameters:
    
    location - The location object
    
    Returns:
    
    The formatted error location

Class ErrorReportImpl

Field Summary

Fields inherited from interface org.openxml.parser.ErrorReport

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ErrorReportImpl

ErrorReportImpl

Method Detail

warning

error

fatalError

reportError

reportError

reportError

fatalError

isReporting

getCount

getErrorLevel

getException

getMessage

getLastException

getLastMessage

listMessages

listExceptions

reportError

formatMessage

formatLocation