Package org.opencastproject.elasticsearch.api

Interface SearchResultItem<T>

All Superinterfaces:
Comparable<SearchResultItem<T>>
All Known Implementing Classes:
SearchResultItemImpl
public interface SearchResultItem<T> extends Comparable<SearchResultItem<T>>
The search result is what is delivered by the search function.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getRelevance()
    Returns the relevance of this hit with respect to the search terms.
    T
    getSource()
    Returns the source of this search result.

    Methods inherited from interface java.lang.Comparable

    compareTo

  • Method Details

    • getRelevance

      double getRelevance()
      Returns the relevance of this hit with respect to the search terms. Greater values mean increased relevance, a 1.0 signifies a direct hit while 0.0 means a very unlikely hit.
      Returns:
      the relevance

    • getSource

      T getSource()
      Returns the source of this search result. This will usually be the site or a site's module.
      Returns:
      the source