org.deeplearning4j.text.invertedindex

Class LuceneInvertedIndex

java.lang.Object

org.deeplearning4j.text.invertedindex.LuceneInvertedIndex

All Implemented Interfaces:

Serializable, InvertedIndex

public class LuceneInvertedIndex
extends Object
implements InvertedIndex

Lucene based inverted index

Author:

Adam Gibson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LuceneInvertedIndex.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	WORD_FIELD

Constructor Summary

Constructors

Constructor and Description
LuceneInvertedIndex(VocabCache vocabCache, boolean cache)

Method Summary

Modifier and Type	Method and Description
void	addWordsToDoc(int doc, List<VocabWord> words) Adds words to the given document
void	addWordToDoc(int doc, VocabWord word) Add word to a document
Collection<Integer>	allDocs() Returns a list of all documents
List<VocabWord>	document(int index) Returns a list of words for a document
List<Integer>	documents(VocabWord vocabWord) Returns the list of documents a vocab word is in
void	finish() Finishes saving data
int	numDocuments() Returns the number of documents

Methods inherited from class java.lang.Object

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

Field Detail

WORD_FIELD

public static final String WORD_FIELD

See Also:

Constant Field Values

Constructor Detail

LuceneInvertedIndex

public LuceneInvertedIndex(VocabCache vocabCache,
                           boolean cache)

Method Detail

document

public List<VocabWord> document(int index)

Description copied from interface: InvertedIndex

Returns a list of words for a document

Specified by:

document in interface InvertedIndex

Returns:

documents

public List<Integer> documents(VocabWord vocabWord)

Description copied from interface: InvertedIndex

Returns the list of documents a vocab word is in

Specified by:

documents in interface InvertedIndex

Parameters:

vocabWord - the vocab word to get documents for

Returns:

the documents for a vocab word

numDocuments

public int numDocuments()

Description copied from interface: InvertedIndex

Returns the number of documents

Specified by:

numDocuments in interface InvertedIndex

Returns:

allDocs

public Collection<Integer> allDocs()

Description copied from interface: InvertedIndex

Returns a list of all documents

Specified by:

allDocs in interface InvertedIndex

Returns:

the list of all documents

addWordToDoc

public void addWordToDoc(int doc,
                         VocabWord word)

Description copied from interface: InvertedIndex

Add word to a document

Specified by:

addWordToDoc in interface InvertedIndex

Parameters:

doc - the document to add to

word - the word to add

addWordsToDoc

public void addWordsToDoc(int doc,
                          List<VocabWord> words)

Description copied from interface: InvertedIndex

Adds words to the given document

Specified by:

addWordsToDoc in interface InvertedIndex

Parameters:

doc - the document to add to

words - the words to add

finish

public void finish()

Description copied from interface: InvertedIndex

Finishes saving data

Specified by:

finish in interface InvertedIndex