org.lemurproject.ireval

Class RetrievalEvaluator.Document

java.lang.Object

org.lemurproject.ireval.RetrievalEvaluator.Document

Enclosing class:

RetrievalEvaluator

public static class RetrievalEvaluator.Document
extends Object

This class represents a document returned by a retrieval system. It can be subclassed if you want to add system-dependent information to the document representation.

Field Summary

Fields

Modifier and Type	Field and Description
String	documentNumber The document identifier.
int	rank The rank of the document in a retrieved ranked list.
double	score The score given to this document by the retrieval system.

Constructor Summary

Constructors

Constructor and Description
RetrievalEvaluator.Document(String documentNumber) Constructs a new Document object.
RetrievalEvaluator.Document(String documentNumber, int rank, double score) Constructs a new Document object.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

rank

public int rank

The rank of the document in a retrieved ranked list.

documentNumber

public String documentNumber

The document identifier.

score

public double score

The score given to this document by the retrieval system.

Constructor Detail

RetrievalEvaluator.Document

public RetrievalEvaluator.Document(String documentNumber,
                           int rank,
                           double score)

Constructs a new Document object.

Parameters:

documentNumber - The document identifier.

rank - The rank of the document in a retrieved ranked list.

score - The score given to this document by the retrieval system.

RetrievalEvaluator.Document

public RetrievalEvaluator.Document(String documentNumber)

Constructs a new Document object.

Parameters:

documentNumber - The document identifier.