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

---

recoinx.clef
Class CLEFResult  

java.lang.Object
  recoin.container.Result
      recoin.container.RetrievalResult
          recoinx.clef.CLEFResult

All Implemented Interfaces:

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

---

public class CLEFResult

extends recoin.container.RetrievalResult

The CLEFResult is the representation of a CLEF document that has been retrieved.

Version:

0.2.9

---

Field Summary
(package private) static org.apache.log4j.Logger	logger           The logger of this class.

 

Fields inherited from class recoin.container.RetrievalResult

docNo, score

 

Fields inherited from class recoin.container.Result

list

 

Constructor Summary

CLEFResult(recoin.container.ResultList rl, java.lang.String docNo, float score)           Creates a new CLEFResult in the specified ResultList storing the specified docNo and score.

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

 

Method Summary
CLEFResult	copy()           Returns a copy of this CLEFResult.
boolean	equals(recoin.container.Result r)           Compares this CLEFResult to the specified Result.
java.lang.String	getDocNo()           Returns the document number of this CLEFResult. This method is just for convenience, because a call to the method getUniqueIdentifier() would return the same value as an Object which would have to be cast back into a String.
java.lang.String	getTopicNumber()           Returns the topic number that is set in the CLEFResultList.
java.lang.String	toXML()           Returns a XML representation of this CLEFResult.

 

Methods inherited from class recoin.container.RetrievalResult

getScore, getUniqueIdentifier, setScore, toString

 

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.

Constructor Detail

CLEFResult

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

Creates a new CLEFResult holding the specified docNo and score.

---

CLEFResult

public CLEFResult(recoin.container.ResultList rl,
                  java.lang.String docNo,
                  float score)

Creates a new CLEFResult in the specified ResultList storing the specified docNo and score.

Method Detail

toXML

public java.lang.String toXML()

Returns a XML representation of this CLEFResult.

---

equals

public boolean equals(recoin.container.Result r)

Compares this CLEFResult to the specified Result. Returns true if the specified Result is an instance of CLEFResult and if it equals this CLEFResult.

---

copy

public CLEFResult copy()

Returns a copy of this CLEFResult.

---

getTopicNumber

public java.lang.String getTopicNumber()

Returns the topic number that is set in the CLEFResultList.

---

getDocNo

public java.lang.String getDocNo()

Returns the document number of this CLEFResult.
This method is just for convenience, because a call to the method getUniqueIdentifier() would return the same value as an Object which would have to be cast back into a String.

---

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

---