org.apache.tika.parser.txt
Class TXTParser

java.lang.Object
  org.apache.tika.parser.txt.TXTParser

All Implemented Interfaces:

Parser

public class TXTParser
extends Object
implements Parser

Plain text parser. The text encoding of the document stream is automatically detected based on the byte patterns found at the beginning of the stream. The input metadata key HttpHeaders.CONTENT_ENCODING is used as an encoding hint if the automatic encoding detection fails.

This parser sets the following output metadata entries:

HttpHeaders.CONTENT_TYPE

text/plain

HttpHeaders.CONTENT_ENCODING

The detected text encoding of the document.

HttpHeaders.CONTENT_LANGUAGE and DublinCore.LANGUAGE

The default language of the detected encoding. Only set if the detected encoding is associated with some specific language (for example KOI8-R with Russian or SJIS with Japanese).

Constructor Summary

TXTParser()

Method Summary

void	parse(InputStream stream, ContentHandler handler, Metadata metadata) Deprecated. This method will be removed in Apache Tika 1.0.
void	parse(InputStream stream, ContentHandler handler, Metadata metadata, ParseContext context) Parses a document stream into a sequence of XHTML SAX events.

Methods inherited from class java.lang.Object

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

Constructor Detail

TXTParser

public TXTParser()

Method Detail

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.

Specified by:

parse in interface Parser

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

parse

public void parse(InputStream stream,
                  ContentHandler handler,
                  Metadata metadata)
           throws IOException,
                  SAXException,
                  TikaException

Deprecated. This method will be removed in Apache Tika 1.0.

Description copied from interface: Parser

The parse() method from Tika 0.4 and earlier. Please use the #parse(InputStream, ContentHandler, Metadata, Map) method instead in new code. Calls to this backwards compatibility method are forwarded to the new parse() method with an empty parse context.

Specified by:

parse in interface Parser

Throws:

IOException

SAXException

TikaException