Package de.uni_trier.wi2.procake.retrieval

Class SimpleSimilarityResult

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 Details

    • SimpleSimilarityResult

      public SimpleSimilarityResult(String queryID)

  • Method Details

    • 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 @NotNull Iterator<IdSimilarityPair> iterator()
      Specified by:
      iterator in interface Iterable<IdSimilarityPair>