Package com.snowtide.pdf

Interface OutputSource

All Known Subinterfaces:

Block, Document, Line, Page, Spaces, Span, Table, Word

All Known Implementing Classes:

PDFTextStream

public interface OutputSource

This interface is implemented by every level of the PDFxStream document model that can emit content events to an OutputHandler.

Since:

v4.0

Method Summary

Modifier and Type	Method	Description
void	pipe(OutputHandler handler)	Equivalent to pipe(OutputHandler, Direction), with a base Direction determined by either Page.guessDirection() (if calling pipe on a page) or Block.guessDirection() (if calling pipe on a Block).
void	pipe(OutputHandler handler, Direction bd)	Extracts all available text from this OutputSource, sending all PDF text events to the given OutputHandler, with the specified Direction.

Method Detail

pipe

void pipe(OutputHandler handler)
   throws IOException

Equivalent to pipe(OutputHandler, Direction), with a base Direction determined by either Page.guessDirection() (if calling pipe on a page) or Block.guessDirection() (if calling pipe on a Block).

Throws:

IOException

pipe

void pipe(OutputHandler handler,
          Direction bd)
   throws IOException

Extracts all available text from this OutputSource, sending all PDF text events to the given OutputHandler, with the specified Direction.

If no special PDF text event handling is needed (i.e. you just want a straight text extract), then using an OutputTarget is recommended.

Parameters:

handler - an OutputHandler instance.

bd - the Direction that should be used to disambiguate the order in which extracted text is emitted

Throws:

IOException - if an error occurs during the extraction process

See Also:

OutputHandler, OutputTarget