Package org.apache.tika.parser.html

Interface HtmlMapper

All Known Implementing Classes:
DefaultHtmlMapper, IdentityHtmlMapper
public interface HtmlMapper
HTML mapper used to make incoming HTML documents easier to handle by Tika clients. The
invalid reference 
HtmlParser
looks up an optional HTML mapper from the parse context and uses it to map parsed HTML to "safe" XHTML. A client that wants to customize this mapping can place a custom HtmlMapper instance into the parse context.
Since:
Apache Tika 0.6

  • 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)
    Maps HTML attribute names to Tika's XHTML dialect.
    String
    mapSafeElement(String name)
    Maps HTML element names to Tika's XHTML dialect.

  • Method Details

    • mapSafeElement

      String mapSafeElement(String name)
      Maps HTML element names to Tika's XHTML dialect. If the given element is not part of that dialect, this method returns null and the element is dropped but the content inside it is still processed. "Safe" here means valid in the output dialect; this is not a browser sanitizer, and attribute values are passed through unchanged. See the isDiscardElement(String) method for a way to discard the entire contents of an element.
      Parameters:
      name - HTML element name (upper case)
      Returns:
      XHTML element name (lower case), or null if the element is not in the output dialect

    • isDiscardElement

      boolean isDiscardElement(String name)
      Checks whether all content within the given HTML element should be discarded instead of including it in the parse output.
      Parameters:
      name - HTML element name (upper case)
      Returns:
      true if content inside the named element should be ignored, false otherwise

    • mapSafeAttribute

      String mapSafeAttribute(String elementName, String attributeName)
      Maps HTML attribute names to Tika's XHTML dialect. If the given attribute is not part of that dialect for this element, this method returns null, and the attribute is dropped. Attribute values are not inspected. This method assumes that the element name is valid and normalised.
      Parameters:
      elementName - HTML element name (lower case)
      attributeName - HTML attribute name (lower case)
      Returns:
      XHTML attribute name (lower case), or null if the attribute is not in the output dialect