dragon.onlinedb.trec

Class TrecCollectionReader

java.lang.Object

dragon.onlinedb.trec.TrecCollectionReader

All Implemented Interfaces:

CollectionReader

public class TrecCollectionReader
extends Object
implements CollectionReader

TREC collection reader

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Constructor Summary

Constructors

Constructor and Description
TrecCollectionReader(ArticleParser parser)
TrecCollectionReader(String collectionPath, ArticleParser parser)
TrecCollectionReader(String collectionPath, String indexFile, ArticleParser parser)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the collection reader and releases all occupied resources.
Article	getArticleByKey(String key) Reads out the article according to its key
String	getArticleFilename()
int	getArticleLength()
long	getArticleOffset()
ArticleParser	getArticleParser() Gets the article parser of the collection reader
Article	getNextArticle() Collection readers only support forward-only read mode.
boolean	loadCollection(String collectionPath)
boolean	loadCollection(String collectionPath, String indexFile)
void	restart() The collection reader supports forward-only read mode.
void	setArticleParser(ArticleParser parser) Sets the article parse for the collection reader
int	size() The size of the collection.
boolean	supportArticleKeyRetrieval() if the query supports this retrieval mode, one can get articles by calling getArticleByKey method.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrecCollectionReader

public TrecCollectionReader(ArticleParser parser)

TrecCollectionReader

public TrecCollectionReader(String collectionPath,
                            ArticleParser parser)

TrecCollectionReader

public TrecCollectionReader(String collectionPath,
                            String indexFile,
                            ArticleParser parser)

Method Detail

loadCollection

public boolean loadCollection(String collectionPath)

loadCollection

public boolean loadCollection(String collectionPath,
                              String indexFile)

getArticleParser

public ArticleParser getArticleParser()

Description copied from interface: CollectionReader

Gets the article parser of the collection reader

Specified by:

getArticleParser in interface CollectionReader

Returns:

the article parser

setArticleParser

public void setArticleParser(ArticleParser parser)

Description copied from interface: CollectionReader

Sets the article parse for the collection reader

Specified by:

setArticleParser in interface CollectionReader

Parameters:

parser - the article parser

getArticleByKey

public Article getArticleByKey(String key)

Description copied from interface: CollectionReader

Reads out the article according to its key

Specified by:

getArticleByKey in interface CollectionReader

Parameters:

key - the unique entry number of the article

Returns:

an article if exists

getNextArticle

public Article getNextArticle()

Description copied from interface: CollectionReader

Collection readers only support forward-only read mode. When one call this method after calling restart method or creating the collection reader, it actually return the first article of the collection.

Specified by:

getNextArticle in interface CollectionReader

Returns:

the next article

getArticleOffset

public long getArticleOffset()

getArticleLength

public int getArticleLength()

getArticleFilename

public String getArticleFilename()

close

public void close()

Description copied from interface: CollectionReader

Closes the collection reader and releases all occupied resources.

Specified by:

close in interface CollectionReader

supportArticleKeyRetrieval

public boolean supportArticleKeyRetrieval()

Description copied from interface: CollectionReader

if the query supports this retrieval mode, one can get articles by calling getArticleByKey method.

Specified by:

supportArticleKeyRetrieval in interface CollectionReader

Returns:

true if the query support the article retrieval by key.

restart

public void restart()

Description copied from interface: CollectionReader

The collection reader supports forward-only read mode. If one wants to scan the collection for the second time, it is required to call this method. Otherwise when one getNextArticle method, it always return null.

Specified by:

restart in interface CollectionReader

size

public int size()

Description copied from interface: CollectionReader

The size of the collection. If the returned size is -1, it means the exact size is unknown.

Specified by:

size in interface CollectionReader

Returns:

the size of the collection.