Overview  Package   Class  Use  Deprecated  Index
Home >> All >> recoin >> [ container overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

recoin.container
Class RetrievalResult  

java.lang.Object
  recoin.container.Result
      recoin.container.RetrievalResult

All Implemented Interfaces:

recoin.group.postresult.Mergeable, java.io.Serializable

Direct Known Subclasses:

MergedResult

---

public class RetrievalResult

extends Result

The RetrievalResult is an implementation of the abstract Result class providing fields for a document number and a score.

Version:

0.2.9

---

Field Summary
protected  java.lang.String	docNo           The document number.
(package private) static org.apache.log4j.Logger	logger           The logger of this class.
protected  float	score           The retrieval score (RSV = Retrieval Status Value)

 

Fields inherited from class recoin.container.Result

list

 

Constructor Summary

RetrievalResult()           Creates a new RetrievalResult.

RetrievalResult(ResultList rl, java.lang.String docNo, float score)           Creates a new RetrievalResult connected to the specified ResultList with the specified docNo and score.

RetrievalResult(java.lang.String docNo, float score)           Creates a new RetrievalResult with the specified docNo and score.

 

Method Summary
boolean	equals(Result r)           Compares this RetrievalResult to the specified Result object.
float	getScore()           Returns the score (RSV) of this RetrievalResult.
java.lang.Object	getUniqueIdentifier()           Returns the unique identifier of this RetrievalResult which coincides with its document number.
void	setScore(float f)           Sets the score (RSV) of this RetrievalResult.
java.lang.String	toString()           Returns a String representation of this RetrievalResult.
java.lang.String	toXML()           Returns a XML representation of this RetrievalResult.

 

Methods inherited from class recoin.container.Result

getResultList, setResultList

 

Methods inherited from class java.lang.Object

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

 

Field Detail

logger

static org.apache.log4j.Logger logger

The logger of this class.

---

docNo

protected java.lang.String docNo

The document number.

---

score

protected float score

The retrieval score (RSV = Retrieval Status Value)

Constructor Detail

RetrievalResult

public RetrievalResult()

Creates a new RetrievalResult.

---

RetrievalResult

public RetrievalResult(java.lang.String docNo,
                       float score)

Creates a new RetrievalResult with the specified docNo and score.

---

RetrievalResult

public RetrievalResult(ResultList rl,
                       java.lang.String docNo,
                       float score)

Creates a new RetrievalResult connected to the specified ResultList with the specified docNo and score.

Method Detail

getUniqueIdentifier

public java.lang.Object getUniqueIdentifier()

Returns the unique identifier of this RetrievalResult which coincides with its document number.

Specified by:

getUniqueIdentifier in interface recoin.group.postresult.Mergeable

Specified by:

getUniqueIdentifier in class Result

---

toString

public java.lang.String toString()

Returns a String representation of this RetrievalResult.

Specified by:

toString in class Result

---

toXML

public java.lang.String toXML()

Returns a XML representation of this RetrievalResult.

Specified by:

toXML in class Result

---

getScore

public float getScore()

Returns the score (RSV) of this RetrievalResult.

---

setScore

public void setScore(float f)

Sets the score (RSV) of this RetrievalResult.

---

equals

public boolean equals(Result r)

Compares this RetrievalResult to the specified Result object.

Specified by:

equals in class Result

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> recoin >> [ container overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---