Package org.apache.tika.sax

Class XHTMLContentHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.tika.sax.ContentHandlerDecorator

org.apache.tika.sax.SafeContentHandler

org.apache.tika.sax.XHTMLContentHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class XHTMLContentHandler
extends SafeContentHandler

Content handler decorator that simplifies the task of producing XHTML events for Tika content parsers.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tika.sax.SafeContentHandler

SafeContentHandler.Output

Field Summary

Fields

Modifier and Type	Field	Description
static Set<String>	ENDLINE	The elements that get appended with the NL character.
static String	XHTML	The XHTML namespace URI

Constructor Summary

Constructors

Constructor	Description
XHTMLContentHandler(ContentHandler handler, Metadata metadata)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)
void	characters(String characters)
void	element(String name, String value)	Emits an XHTML element with the given text content.
void	endDocument()	Ends the XHTML document by writing the following footer and clearing the namespace mappings:
void	endElement(String name)
void	endElement(String uri, String local, String name)	Ends the given element.
protected boolean	isInvalid(int ch)	Checks whether the given Unicode character is an invalid XML character and should be replaced for output.
void	newline()
void	startDocument()	Starts an XHTML document by setting up the namespace mappings when called for the first time.
void	startElement(String name)
void	startElement(String name, String attribute, String value)
void	startElement(String uri, String local, String name, Attributes attributes)	Starts the given element.
void	startElement(String name, AttributesImpl attributes)

Methods inherited from class org.apache.tika.sax.SafeContentHandler

ignorableWhitespace, writeReplacement

Methods inherited from class org.apache.tika.sax.ContentHandlerDecorator

endPrefixMapping, handleException, processingInstruction, setContentHandler, setDocumentLocator, skippedEntity, startPrefixMapping, 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

Field Detail

XHTML

public static final String XHTML

The XHTML namespace URI

See Also:

Constant Field Values

ENDLINE

public static final Set<String> ENDLINE

The elements that get appended with the NL character.

Constructor Detail

XHTMLContentHandler

public XHTMLContentHandler(ContentHandler handler,
                           Metadata metadata)

Method Detail

startDocument

public void startDocument()
                   throws SAXException

Starts an XHTML document by setting up the namespace mappings when called for the first time. The standard XHTML prefix is generated lazily when the first element is started.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class ContentHandlerDecorator

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Ends the XHTML document by writing the following footer and clearing the namespace mappings:

   </body>
 </html>
 

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class SafeContentHandler

Throws:

SAXException

startElement

public void startElement(String uri,
                         String local,
                         String name,
                         Attributes attributes)
                  throws SAXException

Starts the given element. Table cells and list items are automatically indented by emitting a tab character as ignorable whitespace.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class SafeContentHandler

Throws:

SAXException

endElement

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

Ends the given element. Block elements are automatically followed by a newline character.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class SafeContentHandler

Throws:

SAXException

characters

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

Specified by:

characters in interface ContentHandler

Overrides:

characters in class SafeContentHandler

Throws:

SAXException

See Also:

TIKA-210

startElement

public void startElement(String name)
                  throws SAXException

Throws:

SAXException

startElement

public void startElement(String name,
                         String attribute,
                         String value)
                  throws SAXException

Throws:

SAXException

startElement

public void startElement(String name,
                         AttributesImpl attributes)
                  throws SAXException

Throws:

SAXException

endElement

public void endElement(String name)
                throws SAXException

Throws:

SAXException

characters

public void characters(String characters)
                throws SAXException

Throws:

SAXException

newline

public void newline()
             throws SAXException

Throws:

SAXException

element

public void element(String name,
                    String value)
             throws SAXException

Emits an XHTML element with the given text content. If the given text value is null or empty, then the element is not written.

Parameters:

name - XHTML element name

value - element value, possibly null

Throws:

SAXException - if the content element could not be written

isInvalid

protected boolean isInvalid(int ch)

Description copied from class: SafeContentHandler

Checks whether the given Unicode character is an invalid XML character and should be replaced for output. Subclasses can override this method to use an alternative definition of which characters should be replaced in the XML output. The default definition from the XML specification is:

 Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
 

Overrides:

isInvalid in class SafeContentHandler

Parameters:

ch - character

Returns:

true if the character should be replaced, false otherwise