ivory.core.data.dictionary

Interface Dictionary

All Superinterfaces:

Iterable<String>

All Known Subinterfaces:

FrequencySortedDictionary, LexicographicallySortedDictionary

All Known Implementing Classes:

DefaultFrequencySortedDictionary, FrontCodedDictionary

public interface Dictionary
extends Iterable<String>

A dictionary provides a bidirectional mapping terms (Strings) and term ids (integers). The semantics of the mapping is left unspecified, but the iteration order is always in increasing term id.

Author:

Jimmy Lin

Method Summary

Methods

Modifier and Type	Method and Description
int	getId(String term) Returns the id associated with this term.
String	getTerm(int id) Returns the term associated with this term id.
int	size() Returns the size of this dictionary.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getId

int getId(String term)

Returns the id associated with this term.

Parameters:

term - term

Returns:

id associated with this term

getTerm

String getTerm(int id)

Returns the term associated with this term id.

Parameters:

id - term id

Returns:

term associated with this term id

size

int size()

Returns the size of this dictionary.

Returns:

number of terms in this dictionary