Class SuggestionGroup

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable<AnnotationSuggestion>, java.util.Collection<AnnotationSuggestion>

    public class SuggestionGroup
    extends java.util.AbstractCollection<AnnotationSuggestion>
    implements java.io.Serializable
    Group of alternative suggestions generated by one or more recommenders. The group maintains an order of the alternative suggestions, by default using the confidence score.
    See Also:
    Serialized Form
    • Constructor Detail

      • SuggestionGroup

        public SuggestionGroup()
    • Method Detail

      • getFeature

        public java.lang.String getFeature()
      • getLayerId

        public long getLayerId()
      • getDocumentName

        public java.lang.String getDocumentName()
      • getOffset

        public Offset getOffset()
      • getAllDeltas

        public java.util.Map<java.lang.Long,​java.util.List<SuggestionGroup.Delta>> getAllDeltas()
        Get the deltas of all candidates. The deltas are calculated separately for each recommender if the group contains recommendations from multiple recommenders. That is necessary because the confidence scores of different recommenders are not necessarily on the same scale. Additionally, only suggestions that are visible are taken into consideration.
      • getTopDeltas

        public java.util.Map<java.lang.Long,​SuggestionGroup.Delta> getTopDeltas()
        Get the top delta per recommender. The deltas are calculated separately for each recommender if the group contains recommendations from multiple recommenders. That is necessary because the confidence scores of different recommenders are not necessarily on the same scale. Additionally, only suggestions that are visible are taken into consideration.