Package de.uni_trier.wi2.procake.retrieval

Interface RetrievalResult

All Superinterfaces:
Comparable<RetrievalResult>
All Known Subinterfaces:
DependencyRetrievalResult
All Known Implementing Classes:
DependencyRetrievalResultImpl, RetrievalResultImpl
public interface RetrievalResult extends Comparable<RetrievalResult>
One retrieval result.

The retrieval result contains the similarity value of the retrieved object and the id of the retrieved object. Whether the object can be get with getObject() depends on Query.setRetrieveCases(boolean) is set to true or false.

Author:
Rainer Maximini

  • Method Details

    • getObject

      DataObject getObject()
      Whether the object can be get depends on Query.setRetrieveCases(boolean) is set to true or false.
      Returns:
      the retrieval result object if Query.setRetrieveCases(boolean) was true

    • getObjectId

      String getObjectId()
      Returns:
      The object id of the retrieval result.

    • getSimilarity

      Similarity getSimilarity()
      Returns:
      the similarity value of the retrieval result.

    • getRetrievalTime

      long getRetrievalTime()
      Returns:
      The time used for retrieval in nanoseconds.