org.apache.tika.sax
Class ContentHandlerDecorator

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      org.apache.tika.sax.ContentHandlerDecorator

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

Direct Known Subclasses:

BodyContentHandler, ElementMappingContentHandler, EmbeddedContentHandler, MatchingContentHandler, OfflineContentHandler, SafeContentHandler, SecureContentHandler, TaggedContentHandler

public class ContentHandlerDecorator
extends org.xml.sax.helpers.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

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

Method Summary

void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String name)
void	endPrefixMapping(java.lang.String prefix)
protected void	handleException(org.xml.sax.SAXException exception) Handle any exceptions thrown by methods in this class.
void	ignorableWhitespace(char[] ch, int start, int length)
void	processingInstruction(java.lang.String target, java.lang.String data)
protected void	setContentHandler(org.xml.sax.ContentHandler handler) Sets the underlying content handler.
void	setDocumentLocator(org.xml.sax.Locator locator)
void	skippedEntity(java.lang.String name)
void	startDocument()
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String name, org.xml.sax.Attributes atts)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)
java.lang.String	toString()

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

error, fatalError, notationDecl, resolveEntity, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentHandlerDecorator

public ContentHandlerDecorator(org.xml.sax.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 Detail

setContentHandler

protected void setContentHandler(org.xml.sax.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(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Overrides:

processingInstruction in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Overrides:

setDocumentLocator in class org.xml.sax.helpers.DefaultHandler

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String name,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String name)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Overrides:

ignorableWhitespace in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Overrides:

skippedEntity in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

handleException

protected void handleException(org.xml.sax.SAXException exception)
                        throws org.xml.sax.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.

Parameters:

exception - the exception that was thrown

Throws:

org.xml.sax.SAXException - the exception (if any) thrown to the client