org.terrier.structures

Class FSOMapFileLexicon

java.lang.Object

org.terrier.structures.Lexicon<K1>

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

org.terrier.structures.FSOMapFileLexiconGeneric<String,org.apache.hadoop.io.Text>

org.terrier.structures.FSOMapFileLexicon

All Implemented Interfaces:

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

public class FSOMapFileLexicon
extends FSOMapFileLexiconGeneric<String,org.apache.hadoop.io.Text>

Instance of a Lexicon<String> where a FSOrderedMapFile is always used as a backing store.

Index Properties:

• index.STRUCTURENAME.bsearchshortcut - depicts if the String lookups can be sped up using a binary search shortcut. Possible values are {charmap,default}. Charmap means a hashmap object will be read into memory that defines where to look for a given starting character of the lookup string.
• See also the super-class

Since:

3.0

Author:

Craig Macdonald

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FSOMapFileLexicon.MapFileLexiconEntryIterator
static class	FSOMapFileLexicon.MapFileLexiconIterator

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

MapLexicon.Id2EntryIndexLookup, MapLexicon.IdIsIndex

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

Lexicon.LexiconFileEntry<KEY2>

Field Summary

Fields

Modifier and Type	Field and Description
static String	HASH_EXT

Fields inherited from class org.terrier.structures.FSOMapFileLexiconGeneric

ID_EXT, MAPFILE_EXT

Fields inherited from class org.terrier.structures.MapLexicon

keyFactory, map, modificationLock

Constructor Summary

Constructors

Constructor and Description
FSOMapFileLexicon(String structureName, IndexOnDisk index) Construct a new FSOMapFileLexicon
FSOMapFileLexicon(String structureName, String path, String prefix, FixedSizeWriteableFactory<org.apache.hadoop.io.Text> _keyFactory, FixedSizeWriteableFactory<LexiconEntry> _valueFactory, String termIdLookup, String termLookup, String dataFile)

Method Summary

Modifier and Type	Method and Description
static void	deleteMapFileLexicon(String structureName, String path, String prefix) Delete a FSOMapFileLexicon within the specified index location
Iterator<Map.Entry<String,LexiconEntry>>	iterator()
static void	renameMapFileLexicon(String SrcStructureName, String SrcPath, String SrcPrefix, String destStructureName, String destPath, String destPrefix) Rename a FSOMapFileLexicon within the specified index location
protected void	setK2(String key, org.apache.hadoop.io.Text instance)
protected String	toK1(org.apache.hadoop.io.Text key)

Methods inherited from class org.terrier.structures.FSOMapFileLexiconGeneric

constructFilename

Methods inherited from class org.terrier.structures.MapLexicon

close, getIthLexiconEntry, getLexiconEntry, getLexiconEntry, getLexiconEntryRange, numberOfEntries, setTermIdLookup

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, spliterator

Field Detail

HASH_EXT

public static final String HASH_EXT

See Also:

Constant Field Values

Constructor Detail

FSOMapFileLexicon

public FSOMapFileLexicon(String structureName,
                         IndexOnDisk index)
                  throws IOException

Construct a new FSOMapFileLexicon

Throws:

IOException

FSOMapFileLexicon

public FSOMapFileLexicon(String structureName,
                         String path,
                         String prefix,
                         FixedSizeWriteableFactory<org.apache.hadoop.io.Text> _keyFactory,
                         FixedSizeWriteableFactory<LexiconEntry> _valueFactory,
                         String termIdLookup,
                         String termLookup,
                         String dataFile)
                  throws IOException

Throws:

IOException

Method Detail

iterator

public Iterator<Map.Entry<String,LexiconEntry>> iterator()

toK1

protected String toK1(org.apache.hadoop.io.Text key)

Specified by:

toK1 in class MapLexicon<String,org.apache.hadoop.io.Text>

setK2

protected void setK2(String key,
                     org.apache.hadoop.io.Text instance)

Specified by:

setK2 in class MapLexicon<String,org.apache.hadoop.io.Text>

renameMapFileLexicon

public static void renameMapFileLexicon(String SrcStructureName,
                                        String SrcPath,
                                        String SrcPrefix,
                                        String destStructureName,
                                        String destPath,
                                        String destPrefix)

Rename a FSOMapFileLexicon within the specified index location

deleteMapFileLexicon

public static void deleteMapFileLexicon(String structureName,
                                        String path,
                                        String prefix)

Delete a FSOMapFileLexicon within the specified index location