nl.inl.blacklab.index

Class HookableSaxHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

nl.inl.blacklab.index.HookableSaxHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class HookableSaxHandler
extends DefaultHandler

SAX parser with the ability to attach "SAX-path hooks" to process specific elements/attributes in the XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HookableSaxHandler.ContentCapturingHandler A SAX parser hook handler that captures the element's character content for processing in the endElement() method.
static class	HookableSaxHandler.ElementHandler Represents a handler for when a SAX path condition matches
static class	HookableSaxHandler.SaxPathExpressionChecker Describes a path in an XML document that can be evaluated while doing SAX parsing, and keeps track of the current matching state(s).

Field Summary

Fields

Modifier and Type	Field and Description
protected Locator	locator To keep track of the position within the document

Constructor Summary

Constructors

Constructor and Description
HookableSaxHandler()

Method Summary

Modifier and Type	Method and Description
void	addHook(String condition, HookableSaxHandler.ElementHandler handler) Add a hook to the parser.
void	addHook(String condition, HookableSaxHandler.ElementHandler handler, boolean callHandlerForAllDescendants) Add a hook to the parser.
void	characters(char[] ch, int start, int length) Called when character content (not a tag) is encountered in the XML.
String	describePosition() Describe current parsing position
void	endElement(String uri, String localName, String qName) Called when an end tag (element close tag) is encountered in the XML.
void	setDocumentLocator(Locator locator)
void	startElement(String uri, String localName, String qName, Attributes attributes) Called when an start tag (element open tag) is encountered in the XML.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

locator

protected Locator locator

To keep track of the position within the document

Constructor Detail

HookableSaxHandler

public HookableSaxHandler()

Method Detail

addHook

public void addHook(String condition,
                    HookableSaxHandler.ElementHandler handler,
                    boolean callHandlerForAllDescendants)

Add a hook to the parser.

Parameters:

condition - when to invoke the handler (xpath subset expression)

handler - what to do when the condition matches

callHandlerForAllDescendants - whether or not to call the handler for all descendants of the matched element

addHook

public void addHook(String condition,
                    HookableSaxHandler.ElementHandler handler)

Add a hook to the parser. The hook is called only for the matched element itself, not all its descendants.

Parameters:

condition - when to invoke the handler (xpath subset expression)

handler - what to do when the condition matches

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

describePosition

public String describePosition()

Describe current parsing position

Returns:

the description

characters

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

Called when character content (not a tag) is encountered in the XML.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

endElement

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

Called when an end tag (element close tag) is encountered in the XML.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes attributes)

Called when an start tag (element open tag) is encountered in the XML.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler