Interface IGroupOutput

  • All Known Implementing Classes:
    CsvGroupOutput

    public interface IGroupOutput
    Implemented by the application to define how groups are stored.
    • Method Detail

      • outputGroup

        void outputGroup​(int id,
                         int num_subgroups,
                         float max_score,
                         java.lang.Iterable<GroupedRecord> records,
                         java.lang.Iterable<GroupedPair> pairs)
        Outputs the data for a group. Called by the grouping engine when a complete group is ready for output.
        Parameters:
        id - The group id
        num_subgroups - Number of subgroups within the group.
        max_score - Highest score of any pair in the group.
        records - A list of the records in the group, ordered by position.
        pairs - A list of the highest-scoring pairs that span the group.
      • done

        void done()
           throws java.lang.Exception
        Called when grouping is done. The implementation may use this to clean up resources.
        Throws:
        java.lang.Exception - if an error occurred.