com.simiacryptus.util.text

Class CharTrieIndex

java.lang.Object

com.simiacryptus.util.text.CharTrie

com.simiacryptus.util.text.CharTrieIndex

public class CharTrieIndex
extends CharTrie

Field Summary

Fields

Modifier and Type	Field and Description
protected SerialArrayList<com.simiacryptus.util.text.CursorData>	cursors
protected ArrayList<String>	documents

Fields inherited from class com.simiacryptus.util.text.CharTrie

godparentIndex, nodes, parentIndex

Constructor Summary

Constructors

Constructor and Description
CharTrieIndex()
CharTrieIndex(CharTrieIndex copyFrom)

Method Summary

Modifier and Type	Method and Description
CharTrie	addAlphabet(String document)
int	addDictionary(String document) Adds a document to be indexed.
int	addDocument(String document) Adds a document to be indexed.
CharTrieIndex	copy()
long	getIndexedSize()
int	getMemorySize()
CharTrieIndex	index() Creates the index tree using the accumulated documents
CharTrieIndex	index(int maxLevels) Creates the index tree using the accumulated documents
CharTrieIndex	index(int maxLevels, int minWeight) Creates the index tree using the accumulated documents
static CharTrie	indexFulltext(Collection<String> documents, int maxLevels, int minWeight)
static CharTrie	indexWords(Collection<String> documents, int maxLevels, int minWeight)
IndexNode	root()
IndexNode	traverse(String search) Locate a node by finding the maximum prefix match with the given string
CharTrie	truncate() Removes cursor data, retaining only the tree of tokens and counts.

Methods inherited from class com.simiacryptus.util.text.CharTrie

add, contains, divide, equals, getAnalyzer, getCodec, getGenerator, getNodeCount, hashCode, matchEnd, matchPredictor, max, product, reduce, reducer, reduceSimple, reverse, rewrite, tokens, toStream

Methods inherited from class java.lang.Object

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

Field Detail

cursors

protected final SerialArrayList<com.simiacryptus.util.text.CursorData> cursors

documents

protected final ArrayList<String> documents

Constructor Detail

CharTrieIndex

public CharTrieIndex(CharTrieIndex copyFrom)

CharTrieIndex

public CharTrieIndex()

Method Detail

indexWords

public static CharTrie indexWords(Collection<String> documents,
                                  int maxLevels,
                                  int minWeight)

indexFulltext

public static CharTrie indexFulltext(Collection<String> documents,
                                     int maxLevels,
                                     int minWeight)

getMemorySize

public int getMemorySize()

Overrides:

getMemorySize in class CharTrie

getIndexedSize

public long getIndexedSize()

Overrides:

getIndexedSize in class CharTrie

truncate

public CharTrie truncate()

Removes cursor data, retaining only the tree of tokens and counts. Subsequent calls to methods dealing with cursors will fail.

Overrides:

truncate in class CharTrie

Returns:

this

index

public CharTrieIndex index()

Creates the index tree using the accumulated documents

Returns:

this

index

public CharTrieIndex index(int maxLevels)

Creates the index tree using the accumulated documents

Parameters:

maxLevels - - Maximum depth of the tree to build

Returns:

this

index

public CharTrieIndex index(int maxLevels,
                           int minWeight)

Creates the index tree using the accumulated documents

Parameters:

maxLevels - - Maximum depth of the tree to build

minWeight - - Minimum number of cursors for a node to be index using, exclusive bound

Returns:

this

addDictionary

public int addDictionary(String document)

Adds a document to be indexed. This can only be performed before splitting.

Parameters:

document -

Returns:

this

addDocument

public int addDocument(String document)

Adds a document to be indexed. This can only be performed before splitting.

Parameters:

document -

Returns:

this

addAlphabet

public CharTrie addAlphabet(String document)

copy

public CharTrieIndex copy()

Overrides:

copy in class CharTrie

root

public IndexNode root()

Overrides:

root in class CharTrie

traverse

public IndexNode traverse(String search)

Description copied from class: CharTrie

Locate a node by finding the maximum prefix match with the given string

Overrides:

traverse in class CharTrie

Returns: