org.apache.tika.parser.pdf
Class PDFParser

java.lang.Object
  org.apache.tika.parser.AbstractParser
      org.apache.tika.parser.pdf.PDFParser

All Implemented Interfaces:

Serializable, org.apache.tika.parser.Parser

public class PDFParser
extends org.apache.tika.parser.AbstractParser

PDF parser.

This parser can process also encrypted PDF documents if the required password is given as a part of the input metadata associated with a document. If no password is given, then this parser will try decrypting the document using the empty password that's often used with PDFs. If the PDF contains any embedded documents (for example as part of a PDF package) then this parser will use the EmbeddedDocumentExtractor to handle them.

See Also:

Serialized Form

Field Summary

static String

PASSWORD Deprecated. Supply a PasswordProvider on the ParseContext instead

Constructor Summary

PDFParser()

Method Summary

boolean	getEnableAutoSpace()
boolean	getExtractAnnotationText() If true, text in annotations will be extracted.
boolean	getSortByPosition()
Set<org.apache.tika.mime.MediaType>	getSupportedTypes(org.apache.tika.parser.ParseContext context)
boolean	getSuppressDuplicateOverlappingText()
void	parse(InputStream stream, ContentHandler handler, org.apache.tika.metadata.Metadata metadata, org.apache.tika.parser.ParseContext context)
void	setEnableAutoSpace(boolean v) If true (the default), the parser should estimate where spaces should be inserted between words.
void	setExtractAnnotationText(boolean v) If true (the default), text in annotations will be extracted.
void	setSortByPosition(boolean v) If true, sort text tokens by their x/y position before extracting text.
void	setSuppressDuplicateOverlappingText(boolean v) If true, the parser should try to remove duplicated text over the same region.

Methods inherited from class org.apache.tika.parser.AbstractParser

parse

Methods inherited from class java.lang.Object

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

Field Detail

PASSWORD

public static final String PASSWORD

Deprecated. Supply a PasswordProvider on the ParseContext instead

Metadata key for giving the document password to the parser.

Since:

Apache Tika 0.5

See Also:

Constant Field Values

Constructor Detail

PDFParser

public PDFParser()

Method Detail

getSupportedTypes

public Set<org.apache.tika.mime.MediaType> getSupportedTypes(org.apache.tika.parser.ParseContext context)

parse

public void parse(InputStream stream,
                  ContentHandler handler,
                  org.apache.tika.metadata.Metadata metadata,
                  org.apache.tika.parser.ParseContext context)
           throws IOException,
                  SAXException,
                  org.apache.tika.exception.TikaException

Throws:

IOException

SAXException

org.apache.tika.exception.TikaException

setEnableAutoSpace

public void setEnableAutoSpace(boolean v)

If true (the default), the parser should estimate where spaces should be inserted between words. For many PDFs this is necessary as they do not include explicit whitespace characters.

getEnableAutoSpace

public boolean getEnableAutoSpace()

See Also:

#setEnableAutoSpace.

setExtractAnnotationText

public void setExtractAnnotationText(boolean v)

If true (the default), text in annotations will be extracted.

getExtractAnnotationText

public boolean getExtractAnnotationText()

If true, text in annotations will be extracted.

setSuppressDuplicateOverlappingText

public void setSuppressDuplicateOverlappingText(boolean v)

If true, the parser should try to remove duplicated text over the same region. This is needed for some PDFs that achieve bolding by re-writing the same text in the same area. Note that this can slow down extraction substantially (PDFBOX-956) and sometimes remove characters that were not in fact duplicated (PDFBOX-1155). By default this is disabled.

getSuppressDuplicateOverlappingText

public boolean getSuppressDuplicateOverlappingText()

See Also:

#setSuppressDuplicateOverlappingText.

setSortByPosition

public void setSortByPosition(boolean v)

If true, sort text tokens by their x/y position before extracting text. This may be necessary for some PDFs (if the text tokens are not rendered "in order"), while for other PDFs it can produce the wrong result (for example if there are 2 columns, the text will be interleaved). Default is false.

getSortByPosition

public boolean getSortByPosition()

See Also:

#setSortByPosition.