org.icij.extract.parser

Class ParsingReader

java.lang.Object

java.io.Reader

org.icij.extract.parser.ParsingReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

Direct Known Subclasses:

EmbeddingHTMLParsingReader

public class ParsingReader
extends Reader

Reader for the content from a given binary stream. This class uses a background parsing task with a Parser to parse the content from a given input stream. A ContentHandler class and a pipe is used to convert the push-based SAX event stream to the pull-based character stream defined by the Reader interface. Based on an implementation from the Tika source. This version adds functionality for markup output.

Since:

1.0.0-beta

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.tika.parser.ParseContext	context The parse context.
protected ContentHandler	handler Receives SAX events.
protected InputStream	input The binary stream being parsed.
protected org.apache.tika.metadata.Metadata	metadata Metadata associated with the document being parsed.
protected org.apache.tika.parser.Parser	parser Parser instance used for parsing the given binary stream.
protected Reader	reader Buffered read end of the pipe.

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
ParsingReader(InputStream input) Creates a reader for the content of the given binary stream.
ParsingReader(InputStream input, String name) Creates a reader for the content of the given binary stream with the given name.
ParsingReader(org.apache.tika.parser.Parser parser, InputStream input, org.apache.tika.metadata.Metadata metadata, org.apache.tika.parser.ParseContext context)
ParsingReader(org.apache.tika.parser.Parser parser, InputStream input, org.apache.tika.metadata.Metadata metadata, org.apache.tika.parser.ParseContext context, java.util.function.Function<Writer,ContentHandler> handler) Creates a reader for the content of the given binary stream with the given document metadata.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the read end of the pipe.
void	parse() Parses the given binary stream and writes the text content to the write end of the pipe.
int	read(char[] buffer, int off, int len) Reads parsed text from the pipe connected to the parsing thread.

Methods inherited from class java.io.Reader

mark, markSupported, read, read, read, ready, reset, skip

Methods inherited from class java.lang.Object

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

Field Detail

parser

protected final org.apache.tika.parser.Parser parser

Parser instance used for parsing the given binary stream.

reader

protected final Reader reader

Buffered read end of the pipe.

input

protected final InputStream input

The binary stream being parsed.

metadata

protected final org.apache.tika.metadata.Metadata metadata

Metadata associated with the document being parsed.

context

protected final org.apache.tika.parser.ParseContext context

The parse context.

handler

protected final ContentHandler handler

Receives SAX events.

Constructor Detail

ParsingReader

public ParsingReader(InputStream input)
              throws IOException

Creates a reader for the content of the given binary stream.

Parameters:

input - binary stream

Throws:

IOException - if the document can not be parsed

ParsingReader

public ParsingReader(InputStream input,
                     String name)
              throws IOException

Creates a reader for the content of the given binary stream with the given name.

Parameters:

input - binary stream

name - document name

Throws:

IOException - if the document can not be parsed

ParsingReader

public ParsingReader(org.apache.tika.parser.Parser parser,
                     InputStream input,
                     org.apache.tika.metadata.Metadata metadata,
                     org.apache.tika.parser.ParseContext context)
              throws IOException

Throws:

IOException

ParsingReader

public ParsingReader(org.apache.tika.parser.Parser parser,
                     InputStream input,
                     org.apache.tika.metadata.Metadata metadata,
                     org.apache.tika.parser.ParseContext context,
                     java.util.function.Function<Writer,ContentHandler> handler)
              throws IOException

Creates a reader for the content of the given binary stream with the given document metadata. The given parser is used for the parsing task that is run with the given executor. The created reader will be responsible for closing the given stream. The stream and any associated resources will be closed at or before the time when the close() method is called on this reader.

Parameters:

parser - parser instance

input - binary stream

metadata - document metadata

context - parsing context

Throws:

IOException - if the document can not be parsed

Method Detail

read

public int read(char[] buffer,
                int off,
                int len)
         throws IOException

Reads parsed text from the pipe connected to the parsing thread. Fails if the parsing thread has thrown an exception.

Specified by:

read in class Reader

Parameters:

buffer - character buffer

off - start offset within the buffer

len - maximum number of characters to read

Throws:

IOException - if the parsing thread has failed or if for some reason the pipe does not work properly

close

public void close()
           throws IOException

Closes the read end of the pipe. If the parsing thread is still running, next write to the pipe will fail and cause the thread to stop. Thus there is no need to explicitly terminate the thread.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

Throws:

IOException - if the pipe cannot be closed

parse

public void parse()

Parses the given binary stream and writes the text content to the write end of the pipe. Potential exceptions (including the one caused if the read end is closed unexpectedly) are stored before the input stream is closed and processing is stopped.