edu.umd.cloud9.collection.trec
Class TrecForwardIndex

java.lang.Object
  edu.umd.cloud9.collection.trec.TrecForwardIndex

All Implemented Interfaces:

DocumentForwardIndex<TrecDocument>

public class TrecForwardIndex
extends Object
implements DocumentForwardIndex<TrecDocument>

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(Path index, Path mapping, FileSystem fs) Loads the index.
static void	main(String[] args) Simple program the provides access to the document contents.

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>

Returns:

docno for the docid

getDocid

public String getDocid(int docno)

Description copied from interface: DocumentForwardIndex

Returns the docid, given the docno.

Specified by:

getDocid in interface DocumentForwardIndex<TrecDocument>

Returns:

docid for the docno

getLastDocno

public int getLastDocno()

Description copied from interface: DocumentForwardIndex

Returns the last docno in the collection.

Specified by:

getLastDocno in interface DocumentForwardIndex<TrecDocument>

Returns:

the last docno in the collection

getFirstDocno

public int getFirstDocno()

Description copied from interface: DocumentForwardIndex

Returns the first docno in the collection.

Specified by:

getFirstDocno in interface DocumentForwardIndex<TrecDocument>

Returns:

the first docno in the collection

getCollectionPath

public String getCollectionPath()

Description copied from interface: DocumentForwardIndex

Returns the base path of the collection.

Specified by:

getCollectionPath in interface DocumentForwardIndex<TrecDocument>

Returns:

base path of the collection

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>

Returns:

the document object

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>

Returns:

the document object

loadIndex

public void loadIndex(Path index,
                      Path mapping,
                      FileSystem fs)
               throws IOException

Description copied from interface: DocumentForwardIndex

Loads the index.

Specified by:

loadIndex in interface DocumentForwardIndex<TrecDocument>

Parameters:

index - path of the index data

mapping - path of the docno/docid mapping data

fs - reference to the FileSystem

Throws:

IOException

main

public static void main(String[] args)
                 throws IOException

Simple program the provides access to the document contents.

Throws:

IOException