SimpleSimilarityResult (ProCAKE Framework 4.0.0 API)

java.lang.Object
- de.uni_trier.wi2.procake.retrieval.SimpleSimilarityResult

All Implemented Interfaces:

Iterable<IdSimilarityPair>
```
public class SimpleSimilarityResult
extends Object
implements Iterable<IdSimilarityPair>
```
This class is meant to be a lightweight version of the retrieval result with only a query id and a list of cases with their respective similarity.

Author:

Maximilian Hoffmann

Constructor Summary

Constructors
Constructor Description

SimpleSimilarityResult(String queryID)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addCase(IdSimilarityPair pair)`
`void`	`addCase(String caseID, double similarity)`
`static List<SimpleSimilarityResult>`	`fromMultiKeyMap(org.apache.commons.collections4.map.MultiKeyMap<String,Double> multiKeyMap)`	Create a simple similarity result from a multi-key map (usually from parsed CSV).
`static SimpleSimilarityResult`	`fromRetrievalResultList(RetrievalResultList retrievalResultList)`	Create a simple similarity result from a retrieval result list.
`Collection<IdSimilarityPair>`	`getCaseSimilarities()`
`String`	`getQueryID()`
`Iterator<IdSimilarityPair>`	`iterator()`
`int`	`size()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Constructor Detail

SimpleSimilarityResult

public SimpleSimilarityResult(String queryID)

Method Detail

fromRetrievalResultList
```
public static SimpleSimilarityResult fromRetrievalResultList(RetrievalResultList retrievalResultList)
```
Create a simple similarity result from a retrieval result list.

Parameters:

retrievalResultList - the retrieval result list to transform

Returns:

the transformed result

fromMultiKeyMap
```
public static List<SimpleSimilarityResult> fromMultiKeyMap(org.apache.commons.collections4.map.MultiKeyMap<String,Double> multiKeyMap)
```
Create a simple similarity result from a multi-key map (usually from parsed CSV).

Parameters:

multiKeyMap - a multi-key map (first key: query, second key: case, value: similarity)

Returns:

the transformed result

addCase

public void addCase(String caseID,
                    double similarity)

addCase

public void addCase(IdSimilarityPair pair)

getQueryID
```
public String getQueryID()
```

getCaseSimilarities

public Collection<IdSimilarityPair> getCaseSimilarities()

size
```
public int size()
```

iterator
```
@NotNull
public Iterator<IdSimilarityPair> iterator()
```
Specified by:

iterator in interface Iterable<IdSimilarityPair>