de.datexis.index.impl

Class LuceneWordIndex

java.lang.Object

de.datexis.index.impl.LuceneIndex

de.datexis.index.impl.LuceneWordIndex

All Implemented Interfaces:

WordIndex

public class LuceneWordIndex
extends LuceneIndex
implements WordIndex

Author:

Sebastian Arnold

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FIELD_ID
protected static String	FIELD_TEXT
protected static String	FIELD_WORDS
protected static org.slf4j.Logger	log
protected static int	NUM_CANDIDATES
protected static String	PARAM_FUZZY
protected static String	PARAM_PROXIMITY

Fields inherited from class de.datexis.index.impl.LuceneIndex

analyzer, preprocessor, reader, searcher, sim

Constructor Summary

Constructors

Constructor and Description
LuceneWordIndex()
LuceneWordIndex(Iterable<String> texts)
LuceneWordIndex(LookupCacheEncoder encoder)

Method Summary

Modifier and Type	Method and Description
protected org.apache.lucene.analysis.Analyzer	buildAnalyzer()
void	createIndex(Iterable<String> texts, org.apache.lucene.store.Directory index)
void	createIndexDirectory(Iterable<String> texts, Resource cacheDir)
void	createIndexRAM(Iterable<String> texts) Creates and opens a new index in local RAM
List<String>	queryExactText(String text, int hits) Retrieve candidates for a query on the "text" field.
protected List<String>	queryIndex(org.apache.lucene.search.Query query, int hits)
List<String>	queryPrefixText(String prefix, int hits) Retrieve candidates for auto completion on the "text" field.
List<String>	queryText(String text, int hits) Retrieve candidates for a query on the "text" field.

Methods inherited from class de.datexis.index.impl.LuceneIndex

addNameField, addStringField, addTextField, openIndex, openIndex, splitString

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

FIELD_WORDS

protected static final String FIELD_WORDS

See Also:

Constant Field Values

FIELD_TEXT

protected static final String FIELD_TEXT

See Also:

Constant Field Values

FIELD_ID

protected static final String FIELD_ID

See Also:

Constant Field Values

PARAM_PROXIMITY

protected static final String PARAM_PROXIMITY

See Also:

Constant Field Values

PARAM_FUZZY

protected static final String PARAM_FUZZY

See Also:

Constant Field Values

NUM_CANDIDATES

protected static final int NUM_CANDIDATES

See Also:

Constant Field Values

Constructor Detail

LuceneWordIndex

public LuceneWordIndex()

LuceneWordIndex

public LuceneWordIndex(Iterable<String> texts)

LuceneWordIndex

public LuceneWordIndex(LookupCacheEncoder encoder)

Method Detail

createIndexRAM

public void createIndexRAM(Iterable<String> texts)

Creates and opens a new index in local RAM

createIndexDirectory

public void createIndexDirectory(Iterable<String> texts,
                                 Resource cacheDir)
                          throws IOException

Throws:

IOException

createIndex

public void createIndex(Iterable<String> texts,
                        org.apache.lucene.store.Directory index)

queryText

public List<String> queryText(String text,
                              int hits)

Retrieve candidates for a query on the "text" field. All given words have to match (lowercase, any order).

Specified by:

queryText in interface WordIndex

queryExactText

public List<String> queryExactText(String text,
                                   int hits)

Retrieve candidates for a query on the "text" field. Complete text has to match (lowercase, correct order).

Specified by:

queryExactText in interface WordIndex

queryPrefixText

public List<String> queryPrefixText(String prefix,
                                    int hits)

Retrieve candidates for auto completion on the "text" field.

Specified by:

queryPrefixText in interface WordIndex

buildAnalyzer

protected org.apache.lucene.analysis.Analyzer buildAnalyzer()

Specified by:

buildAnalyzer in class LuceneIndex

queryIndex

protected List<String> queryIndex(org.apache.lucene.search.Query query,
                                  int hits)