Class HtmlParser

    • Constructor Detail

      • HtmlParser

        public HtmlParser()
    • Method Detail

      • getSupportedTypes

        public Set<MediaType> getSupportedTypes​(ParseContext context)
        Description copied from interface: Parser
        Returns the set of media types supported by this parser when used with the given parse context.
        Parameters:
        context - parse context
        Returns:
        immutable set of media types
      • parse

        public void parse​(InputStream stream,
                          ContentHandler handler,
                          Metadata metadata,
                          ParseContext context)
                   throws IOException,
                          SAXException,
                          TikaException
        Description copied from interface: Parser
        Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

        The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

        Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

        Parameters:
        stream - the document stream (input)
        handler - handler for the XHTML SAX events (output)
        metadata - document metadata (input and output)
        context - parse context
        Throws:
        IOException - if the document stream could not be read
        SAXException - if the SAX events could not be processed
        TikaException - if the document could not be parsed
      • 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 -