nl.inl.blacklab.mocks

Class MockTerms

java.lang.Object

nl.inl.blacklab.forwardindex.Terms

nl.inl.blacklab.mocks.MockTerms

public class MockTerms
extends Terms

Field Summary

Fields inherited from class nl.inl.blacklab.forwardindex.Terms

BYTES_PER_INT, DEFAULT_CHARSET, DEFAULT_MAX_MAP_SIZE, NO_TERM

Constructor Summary

Constructors

Constructor and Description
MockTerms(String... words)

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the Terms object.
String	get(int id) Get a term by id.
int	idToSortPosition(int id, MatchSensitivity sensitivity) Get the sort position for a term based on its term id
void	indexOf(org.eclipse.collections.api.set.primitive.MutableIntSet results, String term, MatchSensitivity sensitivity) Get the index number(s) of terms matching a string.
int	indexOf(String term) Get the existing index number of a term, or add it to the term list and assign it a new index number.
int	numberOfTerms()
protected void	setBlockBasedFile(boolean useBlockBasedTermsFile)
boolean	termsEqual(int[] termId, MatchSensitivity sensitivity)
void	write(File termsFile) Write the terms file

Methods inherited from class nl.inl.blacklab.forwardindex.Terms

compareSortPosition, deserializeToken, initialize, openForReading, openForWriting, readFromFileChannel, serializeTerm, toSortOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

MockTerms

public MockTerms(String... words)

Method Detail

indexOf

public int indexOf(String term)

Description copied from class: Terms

Get the existing index number of a term, or add it to the term list and assign it a new index number. In index mode, this is fast. In search mode, this is slower, because we have to do a binary search through the memory-mapped terms file. However, this is only done rarely. If you care about this being fast, call buildTermIndex() at the start of your application.

Specified by:

indexOf in class Terms

Parameters:

term - the term to get the index number for

Returns:

the term's index number

indexOf

public void indexOf(org.eclipse.collections.api.set.primitive.MutableIntSet results,
                    String term,
                    MatchSensitivity sensitivity)

Description copied from class: Terms

Get the index number(s) of terms matching a string. This is used in search mode when translating queries into NFAs. Depending on case-sensitivity settings, a single term string may match multiple terms.

Specified by:

indexOf in class Terms

Parameters:

results - (out) index numbers for the matching term(s)

term - the term to get the index number for

sensitivity - compare sensitively? (case-sensitivity currently switches both case- and diacritics-sensitivity)

clear

public void clear()

Description copied from class: Terms

Clear the Terms object.

Specified by:

clear in class Terms

write

public void write(File termsFile)

Description copied from class: Terms

Write the terms file

Specified by:

write in class Terms

Parameters:

termsFile - where to write the terms file

get

public String get(int id)

Description copied from class: Terms

Get a term by id. Only works in search mode.

Specified by:

get in class Terms

Parameters:

id - the term id

Returns:

the corresponding term

numberOfTerms

public int numberOfTerms()

Specified by:

numberOfTerms in class Terms

Returns:

the number of terms in this object

idToSortPosition

public int idToSortPosition(int id,
                            MatchSensitivity sensitivity)

Description copied from class: Terms

Get the sort position for a term based on its term id

Specified by:

idToSortPosition in class Terms

Parameters:

id - the term id

sensitivity - whether we want the sensitive or insensitive sort position

Returns:

the sort position

setBlockBasedFile

protected void setBlockBasedFile(boolean useBlockBasedTermsFile)

Specified by:

setBlockBasedFile in class Terms

termsEqual

public boolean termsEqual(int[] termId,
                          MatchSensitivity sensitivity)

Specified by:

termsEqual in class Terms