de.unidu.is.evaluation.trec
Class TRECResult

java.lang.Object
  de.unidu.is.evaluation.trec.TRECResult

public class TRECResult

extends java.lang.Object

A class for writing and reading TREC result files.

The result file must have the format [query id] * [document id] * [weight] *

Since:

2004-01-06

Version:

$Revision: 1.7 $, $Date: 2005/02/28 22:27:55 $

Author:

Henrik Nottelmann

Constructor Summary

TRECResult()

Method Summary

static java.util.List	readResult(java.io.File file, int numDocs) Reads the result from the specified file (TREC format).
static java.util.List	readResult(java.io.Reader reader, int numDocs) Reads the result from the specified file (TREC format).
static java.util.List	readResult(java.net.URL url, int numDocs) Reads the result from the specified file (TREC format).
static void	writeResult(java.io.File file, java.lang.String queryID, java.util.List result) Writes the specified result in the specified file (TREC format).
static void	writeResult(java.io.File file, java.lang.String queryID, java.util.List result, boolean append) Writes the specified result in the specified file (TREC format).
static void	writeResult(java.io.File file, java.lang.String queryID, java.util.List result, boolean append, boolean dummyLineIfEmptyResult) Writes the specified result in the specified file (TREC format).
static void	writeResult(java.io.Writer writer, java.lang.String queryID, java.util.List result, boolean dummyLineIfEmptyResult) Writes the specified result in the specified file (TREC format).

Methods inherited from class java.lang.Object

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

Constructor Detail

TRECResult

public TRECResult()

Method Detail

writeResult

public static void writeResult(java.io.File file,
                               java.lang.String queryID,
                               java.util.List result)

Writes the specified result in the specified file (TREC format).

Parameters:

file - file for the result

queryID - query ID

result - list of ProbDoc instances

writeResult

public static void writeResult(java.io.File file,
                               java.lang.String queryID,
                               java.util.List result,
                               boolean append)

Writes the specified result in the specified file (TREC format).

Parameters:

file - file for the result

queryID - query ID

result - list of ProbDoc instances

append - if true, appends the data

writeResult

public static void writeResult(java.io.File file,
                               java.lang.String queryID,
                               java.util.List result,
                               boolean append,
                               boolean dummyLineIfEmptyResult)

Writes the specified result in the specified file (TREC format).

Parameters:

file - file for the result

queryID - query ID

result - list of ProbDoc instances

append - if true, appends the data

dummyLineIfEmptyResult - if true, prints a dummy line if the result is empty

writeResult

public static void writeResult(java.io.Writer writer,
                               java.lang.String queryID,
                               java.util.List result,
                               boolean dummyLineIfEmptyResult)

Writes the specified result in the specified file (TREC format).

Parameters:

writer - stream for the result

queryID - query ID

result - list of ProbDoc instances

dummyLineIfEmptyResult - if true, prints a dummy line if the result is empty

readResult

public static java.util.List readResult(java.io.File file,
                                        int numDocs)

Reads the result from the specified file (TREC format).

Parameters:

file - file for the result

numDocs - maximum number of documents to read

Returns:

list of ProbDoc instances

readResult

public static java.util.List readResult(java.net.URL url,
                                        int numDocs)

Reads the result from the specified file (TREC format).

Parameters:

url - url for the result

numDocs - maximum number of documents to read

Returns:

list of ProbDoc instances

readResult

public static java.util.List readResult(java.io.Reader reader,
                                        int numDocs)

Reads the result from the specified file (TREC format).

Parameters:

reader - stream for the result

numDocs - maximum number of documents to read

Returns:

list of ProbDoc instances