com.snowtide.pdf.lucene

Class LucenePDFConfiguration

java.lang.Object

com.snowtide.pdf.lucene.LucenePDFConfiguration

public class LucenePDFConfiguration
extends java.lang.Object

Instances of this class are used to control the creation of Lucene Documents from PDF content through the LucenePDFDocumentFactory 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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_MAIN_TEXT_FIELD_NAME The default name assigned to the Lucene Field containing the main body of text extracted from a PDF file: "text".

Constructor Summary

Constructors

Constructor and Description
LucenePDFConfiguration() Creates a new config object.
LucenePDFConfiguration(java.lang.String mainTextFieldName) Creates a new config object.

Method Summary

Modifier and Type	Method and Description
boolean	copyAllPDFMetadata() 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.
java.lang.String	getBodyTextFieldName() Returns the name that will be assigned to Lucene Fields containing PDF body text content.
java.util.Map<java.lang.String,java.lang.String>	getMetadataFieldMapping() Returns a copy of the mapping between PDF metadata attributes and the names given to Lucene fields created for them.
java.lang.String	getMetadataFieldMapping(java.lang.String pdfMetadataAttr) Returns the name that should be given to Lucene Fields created from the value of the named PDF metadata attribute.
boolean	indexBodyText() Returns true if the main body text of PDFs added to Lucene Documents created through LucenePDFDocumentFactory using this config object will be indexed.
boolean	indexMetadata() Returns true if the PDF metadata attributes added Lucene Documents created through LucenePDFDocumentFactory using this config object will be indexed.
void	setBodyTextFieldName(java.lang.String bodyTextFieldName) Sets the name that will be assigned to Lucene Fields containing PDF body text content.
void	setBodyTextSettings(boolean store, boolean index, boolean token) Sets Field attributes that will be used when creating the Field object for the main text content of a PDF document.
void	setCopyAllPDFMetadata(boolean b)
void	setMetadataFieldMapping(java.lang.String pdfMetadataAttr, java.lang.String fieldName) Sets the name that will be assigned to Lucene Fields corresponding to the provided PDF metadata attribute name (e.g.
void	setMetadataSettings(boolean store, boolean index, boolean token) Sets Field attributes that will be used when creating Field objects for the document attributes found in a PDF document.
boolean	storeBodyText() Returns true if the main body text of PDFs added to Lucene Documents created through LucenePDFDocumentFactory using this config object will be stored.
boolean	storeMetadata() Returns true if the PDF metadata attributes added Lucene Documents created through LucenePDFDocumentFactory using this config object will be stored.
boolean	tokenizeBodyText() Returns true if the main body text of PDFs added to Lucene Documents created through LucenePDFDocumentFactory using this config object will be tokenized.
boolean	tokenizeMetadata() Returns true if the PDF metadata attributes added Lucene Documents created through LucenePDFDocumentFactory using this config object will be tokenized.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAIN_TEXT_FIELD_NAME

public static final java.lang.String DEFAULT_MAIN_TEXT_FIELD_NAME

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

See Also:

Constant Field Values

Constructor Detail

LucenePDFConfiguration

public LucenePDFConfiguration(java.lang.String mainTextFieldName)

Creates a new config object. The resulting object retains the default configuration except for the name assigned to the Lucene Field that contains the main PDF text content.

Parameters:

mainTextFieldName - - the name that should be assigned to Fields containing the main PDF text content.

LucenePDFConfiguration

public LucenePDFConfiguration()

Creates a new config object. Fields containing the main text content of PDF documents converted into Lucene Documents will be assigned a default name. Other configuration defaults are as follows:

• All PDF metadata attributes are copied to the resulting Lucene documents
• The main text content is tokenized and indexed, but not stored
• The PDF metadata attributes are tokenized, stored, and indexed.

Method Detail

setBodyTextFieldName

public void setBodyTextFieldName(java.lang.String bodyTextFieldName)

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

getBodyTextFieldName

public java.lang.String getBodyTextFieldName()

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

getMetadataFieldMapping

public java.util.Map<java.lang.String,java.lang.String> getMetadataFieldMapping()

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

getMetadataFieldMapping

public java.lang.String getMetadataFieldMapping(java.lang.String pdfMetadataAttr)

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

setMetadataFieldMapping

public void setMetadataFieldMapping(java.lang.String pdfMetadataAttr,
                                    java.lang.String fieldName)

Sets the name that will be assigned to Lucene Fields corresponding to the provided PDF metadata attribute name (e.g. Document.ATTR_AUTHOR, etc).

copyAllPDFMetadata

public boolean copyAllPDFMetadata()

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.

setCopyAllPDFMetadata

public void setCopyAllPDFMetadata(boolean b)

See Also:

copyAllPDFMetadata()

setBodyTextSettings

public void setBodyTextSettings(boolean store,
                                boolean index,
                                boolean token)

Sets Field attributes that will be used when creating the Field object for the main text content of a PDF document. These attributes correspond to the store, index, and token parameters of the Field constructor before Lucene v4.x and the same-named attributes of FieldType afterwards.

setMetadataSettings

public void setMetadataSettings(boolean store,
                                boolean index,
                                boolean token)

Sets Field attributes that will be used when creating Field objects for the document attributes found in a PDF document. These attributes correspond to the store, index, and token parameters of the Field constructor before Lucene v4.x and the same-named attributes of FieldType afterwards.

indexBodyText

public boolean indexBodyText()

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

storeBodyText

public boolean storeBodyText()

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

tokenizeBodyText

public boolean tokenizeBodyText()

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

indexMetadata

public boolean indexMetadata()

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

storeMetadata

public boolean storeMetadata()

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

tokenizeMetadata

public boolean tokenizeMetadata()

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