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

Class SimpleLuceneIndexCreator

java.lang.Object

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

org.aksw.palmetto.corpus.lucene.creation.SimpleLuceneIndexCreator

public class SimpleLuceneIndexCreator
extends AbstractLuceneIndexCreator

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

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
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
SimpleLuceneIndexCreator(String fieldName)	Constructor.
SimpleLuceneIndexCreator(String textFieldName, int commitInterval)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	createIndex(File indexPath, Iterator<String> 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 Details

LOGGER

private static final org.slf4j.Logger LOGGER

Constructor Details

SimpleLuceneIndexCreator

public SimpleLuceneIndexCreator(String fieldName)

Constructor.

Parameters:

fieldName - The name of the field in which the document texts are stored.

SimpleLuceneIndexCreator

public SimpleLuceneIndexCreator(String textFieldName,
 int commitInterval)

Constructor.

Parameters:

textFieldName - The name of the field in which the document texts are stored.

commitInterval - The interval in which changes are committed to the index.

Method Details

createIndex

public boolean createIndex(File indexPath,
 Iterator<String> 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.