Package org.aksw.palmetto.corpus.lucene.creation

Class PositionStoringLuceneIndexCreator

java.lang.Object

org.aksw.palmetto.corpus.lucene.creation.AbstractLuceneIndexCreator

org.aksw.palmetto.corpus.lucene.creation.PositionStoringLuceneIndexCreator

public class PositionStoringLuceneIndexCreator
extends AbstractLuceneIndexCreator

This class creates the Lucene indexes which are used to access the reference corpus during the coherence calculation using a WindowSupportingLuceneCorpusAdapter.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Field Summary

Fields

Modifier and Type	Field	Description
protected String	docLengthFieldName
private static org.slf4j.Logger	LOGGER

Fields inherited from class org.aksw.palmetto.corpus.lucene.creation.AbstractLuceneIndexCreator

commitInterval, DEFAULT_COMMIT_INTERVAL, textFieldName, version

Constructor Summary

Constructors

Constructor	Description
PositionStoringLuceneIndexCreator(String textFieldName, String docLengthFieldName)
PositionStoringLuceneIndexCreator(String textFieldName, String docLengthFieldName, int commitInterval)

Method Summary

Modifier and Type	Method	Description
boolean	createIndex(File indexPath, Iterator<IndexableDocument> docIterator)	Creates the index.

Methods inherited from class org.aksw.palmetto.corpus.lucene.creation.AbstractLuceneIndexCreator

addDocumentLength, getCommitInterval, getTextFieldName, setCommitInterval, toLuceneDocument

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

docLengthFieldName

protected String docLengthFieldName

Constructor Detail

PositionStoringLuceneIndexCreator

public PositionStoringLuceneIndexCreator(String textFieldName,
                                         String docLengthFieldName)

PositionStoringLuceneIndexCreator

public PositionStoringLuceneIndexCreator(String textFieldName,
                                         String docLengthFieldName,
                                         int commitInterval)

Method Detail

createIndex

public boolean createIndex(File indexPath,
                           Iterator<IndexableDocument> docIterator)

Creates the index.

Parameters:

indexPath - The path to the director in which the Lucene index will be created

docIterator - Iterator that iterates over the document texts.

Returns:

true if the creation was successful, else false.