com.snowtide.pdf.lucene

Class LucenePDFDocumentFactory

java.lang.Object

com.snowtide.pdf.lucene.LucenePDFDocumentFactory

public class LucenePDFDocumentFactory
extends java.lang.Object

This class enables easy Lucene indexing of PDF text and metadata via integration with PDFxStream. A supported lucene-core library jar must be on any application's classpath that uses this class.

Typical usage would be to create a new LucenePDFConfiguration object, configure it as desired, and pass that object into buildPDFDocument(com.snowtide.pdf.Document, LucenePDFConfiguration) along with an open Document. A Lucene Document will be returned containing Fields corresponding to the source PDF document's text and metadata, as dictated by the provided configuration object.

buildPDFDocument(com.snowtide.pdf.Document) is also provided; this does not require a configuration object, but results in Lucene Documents that contain a direct dump of the PDF's text content and metadata attributes according to a default configuration. This makes little sense in most environments, where the default names of PDF metadata attributes are unlikely to match the names of the corresponding Lucene Fields for those metadata attributes. See LucenePDFConfiguration for details of the default configuration of instances of that class.

Version:

©2004-2014 Snowtide, http://snowtide.com, licensed under MIT. See LICENSE in the top level of the lucene-pdf project directory.

See Also:

Indexing PDF Documents with Lucene and PDFxStream for usage details

Constructor Summary

Constructors

Constructor and Description
LucenePDFDocumentFactory()

Method Summary

Modifier and Type	Method and Description
static org.apache.lucene.document.Document	buildPDFDocument(com.snowtide.pdf.Document pdf) 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.
static org.apache.lucene.document.Document	buildPDFDocument(com.snowtide.pdf.Document pdf, LucenePDFConfiguration config) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LucenePDFDocumentFactory

public LucenePDFDocumentFactory()

Method Detail

buildPDFDocument

public static org.apache.lucene.document.Document buildPDFDocument(com.snowtide.pdf.Document pdf)
                                                            throws java.io.IOException

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.

Throws:

java.io.IOException

buildPDFDocument

public static org.apache.lucene.document.Document buildPDFDocument(com.snowtide.pdf.Document pdf,
                                                                   LucenePDFConfiguration config)
                                                            throws java.io.IOException

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.

Throws:

java.io.IOException