B C D G I L S T

B

buildPDFDocument(Document) - Static method in class com.snowtide.pdf.lucene.LucenePDFDocumentFactory

Creates a new Lucene Document instance using the PDF text and metadata provided by the PDFxStream Document using a default LucenePDFConfiguration.LucenePDFConfiguration() to control Lucene field names, etc.

buildPDFDocument(Document, LucenePDFConfiguration) - Static method in class com.snowtide.pdf.lucene.LucenePDFDocumentFactory

Creates a new Lucene Document instance using the PDF text and metadata provided by the PDFxStream Document using the provided LucenePDFConfiguration to control Lucene field names, etc.

C

com.snowtide.pdf.lucene - package com.snowtide.pdf.lucene

The com.snowtide.pdf.lucene package provides an easy way to index PDF documents with Apache Lucene using PDFxStream.

copyAllPDFMetadata() - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns true if any PDF metadata attributes not explicitly mapped will be added to generated Lucene Documents using their names as specified in the source PDFs.

D

DEFAULT_MAIN_TEXT_FIELD_NAME - Static variable in class com.snowtide.pdf.lucene.LucenePDFConfiguration

The default name assigned to the Lucene Field containing the main body of text extracted from a PDF file: "text".

G

getBodyTextFieldName() - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns the name that will be assigned to Lucene Fields containing PDF body text content.

getMetadataFieldMapping() - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns a copy of the mapping between PDF metadata attributes and the names given to Lucene fields created for them.

getMetadataFieldMapping(String) - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns the name that should be given to Lucene Fields created from the value of the named PDF metadata attribute.

I

indexBodyText() - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns true if the main body text of PDFs added to Lucene Documents created through LucenePDFDocumentFactory using this config object will be indexed.

indexMetadata() - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns true if the PDF metadata attributes added Lucene Documents created through LucenePDFDocumentFactory using this config object will be indexed.

L

LucenePDFConfiguration - Class in com.snowtide.pdf.lucene

Instances of this class are used to control the creation of Lucene Documents from PDF content through the LucenePDFDocumentFactory class.

LucenePDFConfiguration(String) - Constructor for class com.snowtide.pdf.lucene.LucenePDFConfiguration

Creates a new config object.

LucenePDFConfiguration() - Constructor for class com.snowtide.pdf.lucene.LucenePDFConfiguration

Creates a new config object.

LucenePDFDocumentFactory - Class in com.snowtide.pdf.lucene

This class enables easy Lucene indexing of PDF text and metadata via integration with PDFxStream.

LucenePDFDocumentFactory() - Constructor for class com.snowtide.pdf.lucene.LucenePDFDocumentFactory

S

setBodyTextFieldName(String) - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Sets the name that will be assigned to Lucene Fields containing PDF body text content.

setBodyTextSettings(boolean, boolean, boolean) - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Sets Field attributes that will be used when creating the Field object for the main text content of a PDF document.

setCopyAllPDFMetadata(boolean) - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

setMetadataFieldMapping(String, String) - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Sets the name that will be assigned to Lucene Fields corresponding to the provided PDF metadata attribute name (e.g.

setMetadataSettings(boolean, boolean, boolean) - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Sets Field attributes that will be used when creating Field objects for the document attributes found in a PDF document.

storeBodyText() - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns true if the main body text of PDFs added to Lucene Documents created through LucenePDFDocumentFactory using this config object will be stored.

storeMetadata() - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns true if the PDF metadata attributes added Lucene Documents created through LucenePDFDocumentFactory using this config object will be stored.

T

tokenizeBodyText() - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns true if the main body text of PDFs added to Lucene Documents created through LucenePDFDocumentFactory using this config object will be tokenized.

tokenizeMetadata() - Method in class com.snowtide.pdf.lucene.LucenePDFConfiguration

Returns true if the PDF metadata attributes added Lucene Documents created through LucenePDFDocumentFactory using this config object will be tokenized.

B C D G I L S T