|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gnu.xml.pipeline.EventFilter | +--gnu.xml.pipeline.WellFormednessFilter
This filter reports fatal exceptions in the case of event streams that are not well formed. The rules currently tested include:
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.
Field Summary |
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(char[] ch,
int start,
int length)
SAX2: passes this callback to the next consumer, if any |
void |
comment(char[] 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 |
endDocument()
SAX2: passes this callback to the next consumer, if any |
void |
endDTD()
SAX2: passes this callback to the next consumer, if any |
void |
endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
SAX2: passes this callback to the next consumer, if any |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
SAX2: passes this callback to the next consumer, if any |
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
SAX1: passes this callback to the next consumer, if any |
void |
processingInstruction(java.lang.String target,
java.lang.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 |
startDocument()
SAX2: passes this callback to the next consumer, if any |
void |
startDTD(java.lang.String root,
java.lang.String publicId,
java.lang.String systemId)
SAX2: passes this callback to the next consumer, if any |
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName,
Attributes atts)
SAX2: passes this callback to the next consumer, if any |
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notationName)
SAX1: passes this callback to the next consumer, if any |
Methods inherited from class gnu.xml.pipeline.EventFilter |
attributeDecl, bind, chainTo, elementDecl, endEntity, endPrefixMapping, externalEntityDecl, getContentHandler, getDocumentLocator, getDTDHandler, getErrorHandler, getNext, getProperty, internalEntityDecl, setContentHandler, setDTDHandler, setErrorHandler, setProperty, skippedEntity, startEntity, startPrefixMapping |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public WellFormednessFilter()
public WellFormednessFilter(EventConsumer consumer)
Method Detail |
public void reset()
public void setDocumentLocator(Locator locator)
setDocumentLocator
in interface ContentHandler
setDocumentLocator
in class EventFilter
locator
- the locator, to be used in error reporting or relative
URI resolution.
java.lang.IllegalStateException
- when called after the document
has already been startedLocator
public void startDocument() throws SAXException
EventFilter
startDocument
in interface ContentHandler
startDocument
in class EventFilter
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.endDocument()
public void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, Attributes atts) throws SAXException
EventFilter
startElement
in interface ContentHandler
startElement
in class EventFilter
localName
- The local name (without prefix), or the
empty string if Namespace processing is not being
performed.qName
- The qualified name (with prefix), or the
empty string if qualified names are not available.atts
- The attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object.
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) throws SAXException
EventFilter
endElement
in interface ContentHandler
endElement
in class EventFilter
localName
- The local name (without prefix), or the
empty string if Namespace processing is not being
performed.qName
- The qualified XML 1.0 name (with prefix), or the
empty string if qualified names are not available.
SAXException
- Any SAX exception, possibly
wrapping another exception.public void endDocument() throws SAXException
EventFilter
endDocument
in interface ContentHandler
endDocument
in class EventFilter
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.startDocument()
public void startDTD(java.lang.String root, java.lang.String publicId, java.lang.String systemId) throws SAXException
EventFilter
startDTD
in interface LexicalHandler
startDTD
in class EventFilter
root
- The document type name.publicId
- The declared public identifier for the
external DTD subset, or null if none was declared.systemId
- The declared system identifier for the
external DTD subset, or null if none was declared.
(Note that this is not resolved against the document
base URI.)
SAXException
- The application may raise an
exception.LexicalHandler.endDTD()
,
LexicalHandler.startEntity(java.lang.String)
public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws SAXException
EventFilter
notationDecl
in interface DTDHandler
notationDecl
in class EventFilter
name
- The notation name.publicId
- The notation's public identifier, or null if
none was given.systemId
- The notation's system identifier, or null if
none was given.
SAXException
- Any SAX exception, possibly
wrapping another exception.DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) throws SAXException
EventFilter
unparsedEntityDecl
in interface DTDHandler
unparsedEntityDecl
in class EventFilter
name
- The unparsed entity's name.publicId
- The entity's public identifier, or null if none
was given.systemId
- The entity's system identifier.notationName
- The name of the associated notation.
SAXException
- Any SAX exception, possibly
wrapping another exception.DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void endDTD() throws SAXException
EventFilter
endDTD
in interface LexicalHandler
endDTD
in class EventFilter
SAXException
- The application may raise an exception.LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)
public void characters(char[] ch, int start, int length) throws SAXException
EventFilter
characters
in interface ContentHandler
characters
in class EventFilter
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.ignorableWhitespace(char[], int, int)
,
Locator
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
EventFilter
ignorableWhitespace
in interface ContentHandler
ignorableWhitespace
in class EventFilter
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.characters(char[], int, int)
public void processingInstruction(java.lang.String target, java.lang.String data) throws SAXException
EventFilter
processingInstruction
in interface ContentHandler
processingInstruction
in class EventFilter
target
- The processing instruction target.data
- The processing instruction data, or null if
none was supplied. The data does not include any
whitespace separating it from the target.
SAXException
- Any SAX exception, possibly
wrapping another exception.public void comment(char[] ch, int start, int length) throws SAXException
EventFilter
comment
in interface LexicalHandler
comment
in class EventFilter
ch
- An array holding the characters in the comment.start
- The starting position in the array.length
- The number of characters to use from the array.
SAXException
- The application may raise an exception.public void startCDATA() throws SAXException
EventFilter
startCDATA
in interface LexicalHandler
startCDATA
in class EventFilter
SAXException
- The application may raise an exception.LexicalHandler.endCDATA()
public void endCDATA() throws SAXException
EventFilter
endCDATA
in interface LexicalHandler
endCDATA
in class EventFilter
SAXException
- The application may raise an exception.LexicalHandler.startCDATA()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Source code is under GPL (with library exception) in the JAXP project at http://www.gnu.org/software/classpathx/jaxp
This documentation was derived from that source code on 2003-06-07.