gnu.xml.pipeline

Class WellFormednessFilter

java.lang.Object

gnu.xml.pipeline.EventFilter

gnu.xml.pipeline.WellFormednessFilter

Implemented Interfaces:: ContentHandler, ContentHandler2, DeclHandler, DTDHandler, EventConsumer, LexicalHandler

public final class WellFormednessFilter

extends EventFilter

This filter reports fatal exceptions in the case of event streams that are not well formed. The rules currently tested include:

setDocumentLocator ... may be called only before startDocument
startDocument/endDocument ... must be paired, and all other calls (except setDocumentLocator) must be nested within these.
startElement/endElement ... must be correctly paired, and may never appear within CDATA sections.
comment ... can't contain "--"
character data ... can't contain "]]>"
whitespace ... can't contain CR
whitespace and character data must be within an element
processing instruction ... can't contain "?>" or CR
startCDATA/endCDATA ... must be correctly paired.

Other checks for event stream correctness may be provided in the future. For example, insisting that entity boundaries nest correctly, namespace scopes nest correctly, namespace values never contain relative URIs, attributes don't have "<" characters; and more.

Fields inherited from class gnu.xml.pipeline.EventFilter
`DECL_HANDLER`, `FEATURE_URI`, `LEXICAL_HANDLER`, `PROPERTY_URI`

Constructor Summary
`WellFormednessFilter()` Swallows all events after performing well formedness checks.
`WellFormednessFilter(EventConsumer consumer)` Passes events through to the specified consumer, after first processing them.

Method Summary
`void`	`characters(ch[] , int start, int length)` SAX2: passes this callback to the next consumer, if any
`void`	`comment(ch[] , int start, int length)` SAX2: passes this callback to the next consumer, if any
`void`	`endCDATA()` SAX2: passes this callback to the next consumer, if any
`void`	`endDTD()` SAX2: passes this callback to the next consumer, if any
`void`	`endDocument()` SAX2: passes this callback to the next consumer, if any
`void`	`endElement(String uri, String localName, String qName)` SAX2: passes this callback to the next consumer, if any
`void`	`ignorableWhitespace(ch[] , int start, int length)` SAX2: passes this callback to the next consumer, if any
`void`	`notationDecl(String name, String publicId, String systemId)` SAX1: passes this callback to the next consumer, if any
`void`	`processingInstruction(String target, String data)` SAX2: passes this callback to the next consumer, if any
`void`	`reset()` Resets state as if any preceding event stream was well formed.
`void`	`setDocumentLocator(Locator locator)` Throws an exception when called after startDocument.
`void`	`startCDATA()` SAX2: passes this callback to the next consumer, if any
`void`	`startDTD(String root, String publicId, String systemId)` SAX2: passes this callback to the next consumer, if any
`void`	`startDocument()` SAX2: passes this callback to the next consumer, if any
`void`	`startElement(String uri, String localName, String qName, Attributes atts)` SAX2: passes this callback to the next consumer, if any
`void`	`unparsedEntityDecl(String name, String publicId, String systemId, String notationName)` SAX1: passes this callback to the next consumer, if any

WellFormednessFilter

public WellFormednessFilter()

Swallows all events after performing well formedness checks.

WellFormednessFilter

public WellFormednessFilter(EventConsumer consumer)

Passes events through to the specified consumer, after first processing them.

characters

public void characters(ch[] ,
                       int start,
                       int length)
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
characters in interface ContentHandler
Overrides:
characters in interface EventFilter

comment

public void comment(ch[] ,
                    int start,
                    int length)
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
comment in interface LexicalHandler
Overrides:
comment in interface EventFilter

endCDATA

public void endCDATA()
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
endCDATA in interface LexicalHandler
Overrides:
endCDATA in interface EventFilter

endDTD

public void endDTD()
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
endDTD in interface LexicalHandler
Overrides:
endDTD in interface EventFilter

endDocument

public void endDocument()
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
endDocument in interface ContentHandler
Overrides:
endDocument in interface EventFilter

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
endElement in interface ContentHandler
Overrides:
endElement in interface EventFilter

ignorableWhitespace

public void ignorableWhitespace(ch[] ,
                                int start,
                                int length)
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
ignorableWhitespace in interface ContentHandler
Overrides:
ignorableWhitespace in interface EventFilter

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
            throws SAXException

SAX1: passes this callback to the next consumer, if any
Specified by:
notationDecl in interface DTDHandler
Overrides:
notationDecl in interface EventFilter

processingInstruction

public void processingInstruction(String target,
                                  String data)
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
processingInstruction in interface ContentHandler
Overrides:
processingInstruction in interface EventFilter

reset

public void reset()

Resets state as if any preceding event stream was well formed. Particularly useful if it ended through some sort of error, and the endDocument call wasn't made.

setDocumentLocator

public void setDocumentLocator(Locator locator)

Throws an exception when called after startDocument.
Specified by:
setDocumentLocator in interface ContentHandler
Overrides:
setDocumentLocator in interface EventFilter
Parameters:
locator - the locator, to be used in error reporting or relative URI resolution.

startCDATA

public void startCDATA()
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
startCDATA in interface LexicalHandler
Overrides:
startCDATA in interface EventFilter

startDTD

public void startDTD(String root,
                     String publicId,
                     String systemId)
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
startDTD in interface LexicalHandler
Overrides:
startDTD in interface EventFilter

startDocument

public void startDocument()
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
startDocument in interface ContentHandler
Overrides:
startDocument in interface EventFilter

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes atts)
            throws SAXException

SAX2: passes this callback to the next consumer, if any
Specified by:
startElement in interface ContentHandler
Overrides:
startElement in interface EventFilter

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
            throws SAXException

SAX1: passes this callback to the next consumer, if any
Specified by:
unparsedEntityDecl in interface DTDHandler
Overrides:
unparsedEntityDecl in interface EventFilter

Overview Package Tree Index Deprecated About
Prev Class \| Next Class	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr

gnu.xml.pipeline

Class WellFormednessFilter

Field Summary

Fields inherited from class gnu.xml.pipeline.EventFilter

Constructor Summary

Method Summary

Methods inherited from class gnu.xml.pipeline.EventFilter

Constructor Details

WellFormednessFilter

WellFormednessFilter

Method Details

characters

comment

endCDATA

endDTD

endDocument

endElement

ignorableWhitespace

notationDecl

processingInstruction

reset

setDocumentLocator

startCDATA

startDTD

startDocument

startElement

unparsedEntityDecl