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 CLEFResultListMerger  

java.lang.Object
  recoinx.clef.CLEFResultListMerger

---

public class CLEFResultListMerger

extends java.lang.Object

The CLEFResultListMerger provides methods to merge a certain number of CLEFResultList objects into one CLEFResultList.

Version:

0.2.9

---

Field Summary
private  int	cutOff           The cut-off for this CLEFResultListMerger.
(package private) static org.apache.log4j.Logger	logger           The logger for this class.

 

Constructor Summary

CLEFResultListMerger()           Creates a new CLEFResultListMerger.

CLEFResultListMerger(int cut)           Creates a new CLEFResultListMerger that cuts off the resulting list using the specified cut-off value.

 

Method Summary
CLEFMergedResultList	createMergedResultList(recoin.container.ResultList[] resultLists, float[] resultWeights)           Merges the specified CLEFResultLists according to the specified weights into a MergedResultList. The CLEFResult objects inside the MergedResult objects in the merged list are references to the original objects in the specified lists, therefore they shouldn't be changed to preserve the original results as records.
CLEFResult	getEqualResultFromList(java.util.Vector results, CLEFResult equalResult)           Returns the CLEFResult from the specified vector that equals the specified CLEFResult.
CLEFResultList	mergeResultLists(CLEFResultList[] resultLists, float[] resultWeights)           Merges the specified CLEFResultLists according to the specified weights.
CLEFResultList	mergeResultLists(CLEFResultList listA, CLEFResultList listB, float weightA, float weightB)           Merges the two specified CLEFResultLists according to the specified weights.
CLEFResultList	mergeResultLists(java.util.Vector lists)           Merges the CLEFResultLists in the specified Vector.
CLEFResultList	sortResultList(CLEFResultList list)           Sorts the specified CLEFResultList returns it with the highest score first.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

logger

static org.apache.log4j.Logger logger

The logger for this class.

---

cutOff

private int cutOff

The cut-off for this CLEFResultListMerger.

Constructor Detail

CLEFResultListMerger

public CLEFResultListMerger(int cut)

Creates a new CLEFResultListMerger that cuts off the resulting list using the specified cut-off value.

---

CLEFResultListMerger

public CLEFResultListMerger()

Creates a new CLEFResultListMerger.

Method Detail

mergeResultLists

public CLEFResultList mergeResultLists(java.util.Vector lists)

Merges the CLEFResultLists in the specified Vector. Duplicate results are merged by adding their scores. No weights are applied.

---

mergeResultLists

public CLEFResultList mergeResultLists(CLEFResultList[] resultLists,
                                       float[] resultWeights)

Merges the specified CLEFResultLists according to the specified weights. If the length of the two arrays does not match, the method returns NULL.

The CLEFResult objects in the merged list are copies of the original objects in the specified lists, so the results (and scores) in the original lists are preserved.

---

mergeResultLists

public CLEFResultList mergeResultLists(CLEFResultList listA,
                                       CLEFResultList listB,
                                       float weightA,
                                       float weightB)

Merges the two specified CLEFResultLists according to the specified weights. A new CLEFResultList is returned that is initialized with the same values as listA. The CLEFResult objects in the merged list are copies of the original objects in the specified lists, so the results (and scores) in the original lists are preserved.

---

sortResultList

public CLEFResultList sortResultList(CLEFResultList list)

Sorts the specified CLEFResultList returns it with the highest score first.

---

getEqualResultFromList

public CLEFResult getEqualResultFromList(java.util.Vector results,
                                         CLEFResult equalResult)

Returns the CLEFResult from the specified vector that equals the specified CLEFResult.

---

createMergedResultList

public CLEFMergedResultList createMergedResultList(recoin.container.ResultList[] resultLists,
                                                   float[] resultWeights)

Merges the specified CLEFResultLists according to the specified weights into a MergedResultList.
The CLEFResult objects inside the MergedResult objects in the merged list are references to the original objects in the specified lists, therefore they shouldn't be changed to preserve the original results as records. They are kept as references to preserve memory and more importantly because they possess references to the original ResultList objects which contain important information like the collection and chain ID of the ResultList the CLEFResult stems from.

---

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

---