com.revolsys.io.xml

Interface XmlProcessorContext

All Superinterfaces:

XMLReporter

All Known Implementing Classes:

SimpleXmlProcessorContext

public interface XmlProcessorContext
extends XMLReporter

The XmlProcessorContext interface is used by XmlProcessor implementations to record errors in processing an XML document and to share attributes (objects) between the process methods. The interface also acts as an XMLReporter for recording errors from the XMLStreamReader.

Author:

Paul Austin

Method Summary

Methods

Modifier and Type	Method and Description
void	addError(String message, Object relatedInformation, Location location) Add the error to the list of errors in processing the XML Document.
void	addError(XmlProcessorError error) Add the error to the list of errors in processing the XML Document.
Object	getAttribute(String name) Get the value of an attribute.
Collection	getErrors() Get the list of XmlProcessorErrors in processing the XML Document.
void	setAttribute(String name, Object value) Set the value of an attribute.

Methods inherited from interface javax.xml.stream.XMLReporter

report

Method Detail

addError

void addError(String message,
            Object relatedInformation,
            Location location)

Add the error to the list of errors in processing the XML Document.

Parameters:

message - The error message.

relatedInformation - Additional information about the error.

location - The location of the error.

addError

void addError(XmlProcessorError error)

Add the error to the list of errors in processing the XML Document.

Parameters:

error - The error.

getAttribute

Object getAttribute(String name)

Get the value of an attribute.

Parameters:

name - The name of the attribute.

Returns:

The attribute value.

getErrors

Collection getErrors()

Get the list of XmlProcessorErrors in processing the XML Document.

Returns:

The list of XmlProcessorErrors in processing the XML Document.

setAttribute

void setAttribute(String name,
                Object value)

Set the value of an attribute. Attributes can be used to share objects between the methods

Parameters:

name - The name of the attribute.

value - The value of the attribute.