Package org.apache.tika.sax

Class ContentHandlerDecorator

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.tika.sax.ContentHandlerDecorator

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

BodyContentHandler, CTAKESContentHandler, ElementMappingContentHandler, EmbeddedContentHandler, EndDocumentShieldingContentHandler, ExpandedTitleContentHandler, MatchingContentHandler, NSNormalizerContentHandler, OfflineContentHandler, PhoneExtractingContentHandler, SafeContentHandler, SecureContentHandler, StandardsExtractingContentHandler, TaggedContentHandler, WriteOutContentHandler

public class ContentHandlerDecorator
extends DefaultHandler

Decorator base class for the ContentHandler interface. This class simply delegates all SAX events calls to an underlying decorated handler instance. Subclasses can provide extra decoration by overriding one or more of the SAX event methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContentHandlerDecorator()	Creates a decorator that by default forwards incoming SAX events to a dummy content handler that simply ignores all the events.
	ContentHandlerDecorator(ContentHandler handler)	Creates a decorator for the given SAX event handler.

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(String uri, String localName, String name)
void	endPrefixMapping(String prefix)
void	error(SAXParseException exception)
void	fatalError(SAXParseException exception)
protected void	handleException(SAXException exception)	Handle any exceptions thrown by methods in this class.
void	ignorableWhitespace(char[] ch, int start, int length)
void	processingInstruction(String target, String data)
protected void	setContentHandler(ContentHandler handler)	Sets the underlying content handler.
void	setDocumentLocator(Locator locator)
void	skippedEntity(String name)
void	startDocument()
void	startElement(String uri, String localName, String name, Attributes atts)
void	startPrefixMapping(String prefix, String uri)
String	toString()
void	warning(SAXParseException exception)

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

notationDecl, resolveEntity, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Constructor Details

ContentHandlerDecorator

public ContentHandlerDecorator(ContentHandler handler)

Creates a decorator for the given SAX event handler.

Parameters:

handler - SAX event handler to be decorated

ContentHandlerDecorator

protected ContentHandlerDecorator()

Creates a decorator that by default forwards incoming SAX events to a dummy content handler that simply ignores all the events. Subclasses should use the setContentHandler(ContentHandler) method to switch to a more usable underlying content handler.

Method Details

setContentHandler

protected void setContentHandler(ContentHandler handler)

Sets the underlying content handler. All future SAX events will be directed to this handler instead of the one that was previously used.

Parameters:

handler - content handler

startPrefixMapping

public void startPrefixMapping(String prefix,
 String uri)
                        throws SAXException

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class DefaultHandler

Throws:

SAXException

processingInstruction

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

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

Throws:

SAXException

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

startElement

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

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

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

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

characters

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

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

ignorableWhitespace

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

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Throws:

SAXException

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class DefaultHandler

Throws:

SAXException

toString

public String toString()

Overrides:

toString in class Object

handleException

protected void handleException(SAXException exception)
                        throws SAXException

Handle any exceptions thrown by methods in this class. This method provides a single place to implement custom exception handling. The default behaviour is simply to re-throw the given exception, but subclasses can also provide alternative ways of handling the situation. If the wrapped handler is itself a ContentHandlerDecorator, the call is delegated to the wrapped handler's handleException(SAXException)

Parameters:

exception - the exception that was thrown

Throws:

SAXException - the exception (if any) thrown to the client

warning

public void warning(SAXParseException exception)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException

error

public void error(SAXParseException exception)
           throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException exception)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException