org.apache.tika.sax
Class ContentHandlerDecorator

java.lang.Object
  extended by org.xml.sax.helpers.DefaultHandler
      extended by org.apache.tika.sax.ContentHandlerDecorator
All Implemented Interfaces:
ContentHandler, DTDHandler, EntityResolver, ErrorHandler
Direct Known Subclasses:
BodyContentHandler, ElementMappingContentHandler, EmbeddedContentHandler, EndDocumentShieldingContentHandler, MatchingContentHandler, NSNormalizerContentHandler, OfflineContentHandler, SafeContentHandler, SecureContentHandler, TaggedContentHandler, WriteOutContentHandler

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(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(String uri, String localName, String name)
           
 void endPrefixMapping(String prefix)
           
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()
           
 
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(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(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 org.xml.sax.helpers.DefaultHandler
Throws:
SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException
Specified by:
endPrefixMapping in interface ContentHandler
Overrides:
endPrefixMapping in class org.xml.sax.helpers.DefaultHandler
Throws:
SAXException

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException
Specified by:
processingInstruction in interface ContentHandler
Overrides:
processingInstruction in class org.xml.sax.helpers.DefaultHandler
Throws:
SAXException

setDocumentLocator

public void setDocumentLocator(Locator locator)
Specified by:
setDocumentLocator in interface ContentHandler
Overrides:
setDocumentLocator in class org.xml.sax.helpers.DefaultHandler

startDocument

public void startDocument()
                   throws SAXException
Specified by:
startDocument in interface ContentHandler
Overrides:
startDocument in class org.xml.sax.helpers.DefaultHandler
Throws:
SAXException

endDocument

public void endDocument()
                 throws SAXException
Specified by:
endDocument in interface ContentHandler
Overrides:
endDocument in class org.xml.sax.helpers.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 org.xml.sax.helpers.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 org.xml.sax.helpers.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 org.xml.sax.helpers.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 org.xml.sax.helpers.DefaultHandler
Throws:
SAXException

skippedEntity

public void skippedEntity(String name)
                   throws SAXException
Specified by:
skippedEntity in interface ContentHandler
Overrides:
skippedEntity in class org.xml.sax.helpers.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.

Parameters:
exception - the exception that was thrown
Throws:
SAXException - the exception (if any) thrown to the client


Copyright © 2007-2011 The Apache Software Foundation. All Rights Reserved.