com.simiacryptus.text

Class CharTrieIndex

java.lang.Object

com.simiacryptus.text.CharTrie

com.simiacryptus.text.CharTrieIndex

public class CharTrieIndex
extends CharTrie

The type Char trie index.

Field Summary

Fields

Modifier and Type	Field and Description
protected SerialArrayList<com.simiacryptus.text.CursorData>	cursors The Cursors.
protected ArrayList<CharSequence>	documents The Documents.

Fields inherited from class com.simiacryptus.text.CharTrie

godparentIndex, nodes, parentIndex

Constructor Summary

Constructors

Constructor and Description
CharTrieIndex() Instantiates a new Char trie index.
CharTrieIndex(CharTrieIndex copyFrom) Instantiates a new Char trie index.

Method Summary

Modifier and Type	Method and Description
CharTrie	addAlphabet(CharSequence document) Add alphabet char trie.
int	addDictionary(CharSequence document) Adds a document to be indexed.
int	addDocument(CharSequence document) Adds a document to be indexed.
CharTrieIndex	copy() Copy char trie.
long	getIndexedSize() Gets indexed size.
int	getMemorySize() Gets memory size.
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<CharSequence> documents, int maxLevels, int minWeight) Index fulltext char trie.
static CharTrie	indexWords(Collection<CharSequence> documents, int maxLevels, int minWeight) Index words char trie.
IndexNode	root() Root trie node.
IndexNode	traverse(String search) Locate a node by finding the maximum prefix match apply the given string
CharTrie	truncate() Removes cursor data, retaining only the tree of tokens and counts.

Methods inherited from class com.simiacryptus.text.CharTrie

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

Methods inherited from class java.lang.Object

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

Field Detail

cursors

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

The Cursors.

documents

protected final ArrayList<CharSequence> documents

The Documents.

Constructor Detail

CharTrieIndex

public CharTrieIndex(CharTrieIndex copyFrom)

Instantiates a new Char trie index.

Parameters:

copyFrom - the copy from

CharTrieIndex

public CharTrieIndex()

Instantiates a new Char trie index.

Method Detail

indexWords

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

Index words char trie.

Parameters:

documents - the documents

maxLevels - the max levels

minWeight - the min weight

Returns:

the char trie

indexFulltext

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

Index fulltext char trie.

Parameters:

documents - the documents

maxLevels - the max levels

minWeight - the min weight

Returns:

the char trie

getMemorySize

public int getMemorySize()

Description copied from class: CharTrie

Gets memory size.

Overrides:

getMemorySize in class CharTrie

Returns:

the memory size

getIndexedSize

public long getIndexedSize()

Description copied from class: CharTrie

Gets indexed size.

Overrides:

getIndexedSize in class CharTrie

Returns:

the indexed size

truncate

public CharTrie truncate()

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

Overrides:

truncate in class CharTrie

Returns:

this

index

public CharTrieIndex index()

Creates the index tree using the accumulated documents

Returns:

this char trie index

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 char trie index

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 char trie index

addDictionary

public int addDictionary(CharSequence document)

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

Parameters:

document - the document

Returns:

this int

addDocument

public int addDocument(CharSequence document)

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

Parameters:

document - the document

Returns:

this int

addAlphabet

public CharTrie addAlphabet(CharSequence document)

Add alphabet char trie.

Parameters:

document - the document

Returns:

the char trie

copy

public CharTrieIndex copy()

Description copied from class: CharTrie

Copy char trie.

Overrides:

copy in class CharTrie

Returns:

the char trie

root

public IndexNode root()

Description copied from class: CharTrie

Root trie node.

Overrides:

root in class CharTrie

Returns:

the trie node

traverse

public IndexNode traverse(String search)

Description copied from class: CharTrie

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

Overrides:

traverse in class CharTrie

Parameters:

search - the search

Returns:

trie node