org.terrier.structures

Class MapLexicon<K1,K2 extends org.apache.hadoop.io.WritableComparable>

java.lang.Object

org.terrier.structures.Lexicon<K1>

org.terrier.structures.MapLexicon<K1,K2>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Map.Entry<K1,LexiconEntry>>

Direct Known Subclasses:

FSOMapFileLexiconGeneric, MemoryLexicon

public abstract class MapLexicon<K1,K2 extends org.apache.hadoop.io.WritableComparable>
extends Lexicon<K1>
implements Closeable

Implementation of a lexicon. This class should be subclassed by any lexicon implementation which use a java.util.Map for storing entries.

Since:

3.0

Author:

Craig Macdonald

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	MapLexicon.Id2EntryIndexLookup Interface for getting the lexicon term index for a given term id
protected static class	MapLexicon.IdIsIndex Lexicon map where the termid is the term index

Nested classes/interfaces inherited from class org.terrier.structures.Lexicon

Lexicon.LexiconFileEntry<KEY2>

Field Summary

Fields

Modifier and Type	Field and Description
protected WriteableFactory<K2>	keyFactory
protected Map<K2,LexiconEntry>	map
protected Object	modificationLock

Constructor Summary

Constructors

Constructor and Description
MapLexicon(Map<K2,LexiconEntry> backingMap) Construct an instance of the class with
MapLexicon(Map<K2,LexiconEntry> backingMap, MapLexicon.Id2EntryIndexLookup idlookupobject) Construct an instance of the class with

Method Summary

Modifier and Type	Method and Description
void	close()
Map.Entry<K1,LexiconEntry>	getIthLexiconEntry(int index) Get the term and LexiconEntry (contains statistics and a pointer) for the entry in the lexicon with the specified index.
Map.Entry<K1,LexiconEntry>	getLexiconEntry(int termid) Get the term and LexiconEntry (contains statistics and a pointer) for a given term id.
LexiconEntry	getLexiconEntry(K1 term) Get the LexiconEntry (contains statistics and a pointer) for the given term.
Iterator<Map.Entry<K1,LexiconEntry>>	getLexiconEntryRange(K1 from, K1 to) Returns an iterator over a set of LexiconEntries within a range of entries in the lexicon.
int	numberOfEntries() Return the number of entries in the lexicon
protected abstract void	setK2(K1 key, K2 instance)
protected void	setTermIdLookup(MapLexicon.Id2EntryIndexLookup idlookupobject)
protected abstract K1	toK1(K2 key)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

keyFactory

protected WriteableFactory<K2 extends org.apache.hadoop.io.WritableComparable> keyFactory

modificationLock

protected Object modificationLock

map

protected final Map<K2 extends org.apache.hadoop.io.WritableComparable,LexiconEntry> map

Constructor Detail

MapLexicon

public MapLexicon(Map<K2,LexiconEntry> backingMap)

Construct an instance of the class with

Parameters:

backingMap -

MapLexicon

public MapLexicon(Map<K2,LexiconEntry> backingMap,
                  MapLexicon.Id2EntryIndexLookup idlookupobject)

Construct an instance of the class with

Parameters:

backingMap -

idlookupobject -

Method Detail

setTermIdLookup

protected void setTermIdLookup(MapLexicon.Id2EntryIndexLookup idlookupobject)

getLexiconEntry

public LexiconEntry getLexiconEntry(K1 term)

Get the LexiconEntry (contains statistics and a pointer) for the given term. Returns null if the term is not found in the lexicon.

Specified by:

getLexiconEntry in class Lexicon<K1>

Parameters:

term - key to lookup the lexicon with

Returns:

LexiconEntry for that term, or null if not found

getIthLexiconEntry

public Map.Entry<K1,LexiconEntry> getIthLexiconEntry(int index)

Get the term and LexiconEntry (contains statistics and a pointer) for the entry in the lexicon with the specified index. Throws NoSuchElementException is the termid is not found.

Specified by:

getIthLexiconEntry in class Lexicon<K1>

Parameters:

index - the entry number to lookup in the lexicon

Returns:

Map.Entry tuple containing the term and the LexiconEntry

getLexiconEntryRange

public Iterator<Map.Entry<K1,LexiconEntry>> getLexiconEntryRange(K1 from,
                                                                 K1 to)

Returns an iterator over a set of LexiconEntries within a range of entries in the lexicon.

Specified by:

getLexiconEntryRange in class Lexicon<K1>

Parameters:

from - low endpoint term in the subset, inclusive.

to - high endpoint term in the subset, exclusive.

Returns:

Iterator over the set.

getLexiconEntry

public Map.Entry<K1,LexiconEntry> getLexiconEntry(int termid)

Get the term and LexiconEntry (contains statistics and a pointer) for a given term id. Throws NoSuchElementException is the termid is not found.

Specified by:

getLexiconEntry in class Lexicon<K1>

Parameters:

termid - the term id to lookup in the lexicon

Returns:

Map.Entry tuple containing the term and the LexiconEntry

numberOfEntries

public int numberOfEntries()

Return the number of entries in the lexicon

Specified by:

numberOfEntries in class Lexicon<K1>

toK1

protected abstract K1 toK1(K2 key)

setK2

protected abstract void setK2(K1 key,
                              K2 instance)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException