Package org.apache.tika.parser.html

Class DefaultHtmlMapper

java.lang.Object

org.apache.tika.parser.html.DefaultHtmlMapper

All Implemented Interfaces:

HtmlMapper

public class DefaultHtmlMapper
extends Object
implements HtmlMapper

The default HTML mapping rules in Tika.

Since:

Apache Tika 0.6

Field Summary

Fields

Modifier and Type	Field	Description
static final HtmlMapper	INSTANCE

Constructor Summary

Constructors

Constructor	Description
DefaultHtmlMapper()

Method Summary

Modifier and Type	Method	Description
boolean	isDiscardElement(String name)	Checks whether all content within the given HTML element should be discarded instead of including it in the parse output.
String	mapSafeAttribute(String elementName, String attributeName)	Normalizes an attribute name.
String	mapSafeElement(String name)	Maps "safe" HTML element names to semantic XHTML equivalents.

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final HtmlMapper INSTANCE

Since:

Apache Tika 0.8

Constructor Details

DefaultHtmlMapper

public DefaultHtmlMapper()

Method Details

mapSafeElement

public String mapSafeElement(String name)

Description copied from interface: HtmlMapper

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 HtmlMapper.isDiscardElement(String) method for a way to discard the entire contents of an element.

Specified by:

mapSafeElement in interface HtmlMapper

Parameters:

name - HTML element name (upper case)

Returns:

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

mapSafeAttribute

public String mapSafeAttribute(String elementName,
 String attributeName)

Normalizes an attribute name. Assumes that the element name is valid and normalized

Specified by:

mapSafeAttribute in interface HtmlMapper

Parameters:

elementName - HTML element name (lower case)

attributeName - HTML attribute name (lower case)

Returns:

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

isDiscardElement

public boolean isDiscardElement(String name)

Description copied from interface: HtmlMapper

Checks whether all content within the given HTML element should be discarded instead of including it in the parse output.

Specified by:

isDiscardElement in interface HtmlMapper

Parameters:

name - HTML element name (upper case)

Returns:

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