edu.umd.cloud9.collection.trec
Class TrecForwardIndex

java.lang.Object
  extended by edu.umd.cloud9.collection.trec.TrecForwardIndex
All Implemented Interfaces:
DocumentForwardIndex<TrecDocument>

public class TrecForwardIndex
extends Object
implements DocumentForwardIndex<TrecDocument>

Object representing a document forward index for TREC collections.

Author:
Jimmy Lin

Constructor Summary
TrecForwardIndex()
           
 
Method Summary
 String getCollectionPath()
          Returns the base path of the collection.
 String getDocid(int docno)
          Returns the docid, given the docno
 int getDocno(String docid)
          Returns the docno, given the docid
 TrecDocument getDocument(int docno)
          Fetches the document for a given docno.
 TrecDocument getDocument(String docid)
          Fetches the document for a given docid.
 int getFirstDocno()
          Returns the first docno in the collection.
 int getLastDocno()
          Returns the last docno in the collection.
 void loadIndex(String indexFile, String mappingDataFile)
          Loads the index.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TrecForwardIndex

public TrecForwardIndex()
Method Detail

getDocno

public int getDocno(String docid)
Description copied from interface: DocumentForwardIndex
Returns the docno, given the docid

Specified by:
getDocno in interface DocumentForwardIndex<TrecDocument>

getDocid

public String getDocid(int docno)
Description copied from interface: DocumentForwardIndex
Returns the docid, given the docno

Specified by:
getDocid in interface DocumentForwardIndex<TrecDocument>

getLastDocno

public int getLastDocno()
Description copied from interface: DocumentForwardIndex
Returns the last docno in the collection.

Specified by:
getLastDocno in interface DocumentForwardIndex<TrecDocument>

getFirstDocno

public int getFirstDocno()
Description copied from interface: DocumentForwardIndex
Returns the first docno in the collection.

Specified by:
getFirstDocno in interface DocumentForwardIndex<TrecDocument>

getCollectionPath

public String getCollectionPath()
Description copied from interface: DocumentForwardIndex
Returns the base path of the collection.

Specified by:
getCollectionPath in interface DocumentForwardIndex<TrecDocument>

getDocument

public TrecDocument getDocument(String docid)
Description copied from interface: DocumentForwardIndex
Fetches the document for a given docid.

Specified by:
getDocument in interface DocumentForwardIndex<TrecDocument>

getDocument

public TrecDocument getDocument(int docno)
Description copied from interface: DocumentForwardIndex
Fetches the document for a given docno.

Specified by:
getDocument in interface DocumentForwardIndex<TrecDocument>

loadIndex

public void loadIndex(String indexFile,
                      String mappingDataFile)
               throws IOException
Description copied from interface: DocumentForwardIndex
Loads the index.

Specified by:
loadIndex in interface DocumentForwardIndex<TrecDocument>
Throws:
IOException