de.unidu.is.retrieval
Class ProbDoc

java.lang.Object
  de.unidu.is.retrieval.ProbDoc

All Implemented Interfaces:

java.lang.Comparable

Direct Known Subclasses:

Path

public class ProbDoc

extends java.lang.Object

implements java.lang.Comparable

A (document ID,weight) pair.

Since:

2004-01-02

Version:

$Revision: 1.7 $, $Date: 2005/03/14 17:33:13 $

Author:

Henrik Nottelmann

Field Summary

protected java.lang.String	docID The ID of the document.
protected double	weight The weight of the document.

Constructor Summary

ProbDoc()
Creates a new, empty instance.

ProbDoc(java.lang.String docID, double weight)
Creates a new instance.

Method Summary

int	compareTo(java.lang.Object obj) Compares this entry (the score in decreasing order) with the specified one.
boolean	equals(java.lang.Object obj)
java.lang.String	getDocID() Returns the ID of the document.
double	getWeight() Returns the weight of the document.
int	hashCode()
void	setDocID(java.lang.String docID) Sets the ID of the document.
void	setWeight(double weight) Sets the weight of the document.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

docID

protected java.lang.String docID

The ID of the document.

weight

protected double weight

The weight of the document.

Constructor Detail

ProbDoc

public ProbDoc()

Creates a new, empty instance.

ProbDoc

public ProbDoc(java.lang.String docID,
               double weight)

Creates a new instance.

Method Detail

getDocID

public java.lang.String getDocID()

Returns the ID of the document.

Returns:

ID of the document

setDocID

public void setDocID(java.lang.String docID)

Sets the ID of the document.

Parameters:

docID - ID of the document.

getWeight

public double getWeight()

Returns the weight of the document.

Returns:

weight of the document.

setWeight

public void setWeight(double weight)

Sets the weight of the document.

Parameters:

weight - weight of the document

equals

public boolean equals(java.lang.Object obj)

compareTo

public int compareTo(java.lang.Object obj)

Compares this entry (the score in decreasing order) with the specified one.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - the reference object with which to compare.

Returns:

negative, zero, positive

hashCode

public int hashCode()

toString

public java.lang.String toString()