Package org.apache.tika.parser.html

Class HtmlParser

java.lang.Object

org.apache.tika.parser.AbstractParser

org.apache.tika.parser.AbstractEncodingDetectorParser

org.apache.tika.parser.html.HtmlParser

All Implemented Interfaces:

Serializable, org.apache.tika.parser.Parser

public class HtmlParser
extends org.apache.tika.parser.AbstractEncodingDetectorParser

HTML parser. Uses TagSoup to turn the input document to HTML SAX events, and post-processes the events to produce XHTML and metadata expected by Tika clients.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
HtmlParser()
HtmlParser(org.apache.tika.detect.EncodingDetector encodingDetector)

Method Summary

Modifier and Type	Method	Description
Set<org.apache.tika.mime.MediaType>	getSupportedTypes(org.apache.tika.parser.ParseContext context)
protected boolean	isDiscardElement(String name)	Deprecated. Use the HtmlMapper mechanism to customize the HTML mapping.
boolean	isExtractScripts()
String	mapSafeAttribute(String elementName, String attributeName)	Deprecated. Use the HtmlMapper mechanism to customize the HTML mapping.
protected String	mapSafeElement(String name)	Deprecated. Use the HtmlMapper mechanism to customize the HTML mapping.
void	parse(InputStream stream, ContentHandler handler, org.apache.tika.metadata.Metadata metadata, org.apache.tika.parser.ParseContext context)
void	setExtractScripts(boolean extractScripts)	Whether or not to extract contents in script entities.

Methods inherited from class org.apache.tika.parser.AbstractEncodingDetectorParser

getEncodingDetector, getEncodingDetector, setEncodingDetector

Methods inherited from class org.apache.tika.parser.AbstractParser

parse

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlParser

public HtmlParser()

HtmlParser

public HtmlParser(org.apache.tika.detect.EncodingDetector encodingDetector)

Method Details

getSupportedTypes

public Set<org.apache.tika.mime.MediaType> getSupportedTypes(org.apache.tika.parser.ParseContext context)

parse

public void parse(InputStream stream,
 ContentHandler handler,
 org.apache.tika.metadata.Metadata metadata,
 org.apache.tika.parser.ParseContext context)
           throws IOException,
SAXException,
org.apache.tika.exception.TikaException

Throws:

IOException

SAXException

org.apache.tika.exception.TikaException

mapSafeElement

protected String mapSafeElement(String name)

Deprecated.

Use the HtmlMapper mechanism to customize the HTML mapping. This method will be removed in Tika 1.0.

Maps "safe" HTML element names to semantic XHTML equivalents. If the given element is unknown or deemed unsafe for inclusion in the parse output, then this method returns null and the element will be ignored but the content inside it is still processed. See the isDiscardElement(String) method for a way to discard the entire contents of an element.

Subclasses can override this method to customize the default mapping.

Parameters:

name - HTML element name (upper case)

Returns:

XHTML element name (lower case), or null if the element is unsafe

Since:

Apache Tika 0.5

isDiscardElement

protected boolean isDiscardElement(String name)

Deprecated.

Use the HtmlMapper mechanism to customize the HTML mapping. This method will be removed in Tika 1.0.

Checks whether all content within the given HTML element should be discarded instead of including it in the parse output. Subclasses can override this method to customize the set of discarded elements.

Parameters:

name - HTML element name (upper case)

Returns:

true if content inside the named element should be ignored, false otherwise

Since:

Apache Tika 0.5

mapSafeAttribute

public String mapSafeAttribute(String elementName,
 String attributeName)

Deprecated.

Use the HtmlMapper mechanism to customize the HTML mapping. This method will be removed in Tika 1.0.

isExtractScripts

public boolean isExtractScripts()

setExtractScripts

@Field
public void setExtractScripts(boolean extractScripts)

Whether or not to extract contents in script entities. Default is false

Parameters:

extractScripts -