Package com.orchestranetworks.addon.mame.service.group

Interface Group

  • public interface Group
    Represents a collection of records within an EBX table that were grouped during a matching operation. It provides methods to manage these records based on their matching and suspect statuses.

    Through this interface, you can perform operations like:

    • Retrieving the associated EBX table for a group.
    • Fetching records identified as matches or suspects.
    • Removing records wrongly identified as matches (false positives).
    • Accepting or rejecting suspect records based on duplication checks.

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void acceptSuspects​(java.util.Set<com.onwbp.adaptation.Adaptation> suspectRecords)
      Confirms that a set of records that were identified as suspects are duplicates of other records in the group.
      java.math.BigDecimal getGroupId()
      Returns the group's Id.
      java.lang.String getGroupLabel()
      Returns the group's label.
      CloseableIterator<com.onwbp.adaptation.Adaptation> getMatchedRecords()
      Returns records from the group that are considered as matching.
      RecordIterable getMatches()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since version 6.1.3.
      CloseableIterator<com.onwbp.adaptation.Adaptation> getSuspectRecords()
      Returns records that are suspected of matching other records in the group.
      RecordIterable getSuspects()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since version 6.1.3.
      com.onwbp.adaptation.AdaptationTable getTable()
      Retrieves the EBX table associated with this group.
      void rejectSuspects​(java.util.Set<com.onwbp.adaptation.Adaptation> suspectRecords)
      Confirms that a set of records, identified as suspects, are in fact not suspects of other records in the group.
      void removeMatches​(java.util.Set<com.onwbp.adaptation.Adaptation> matchedRecords)
      Confirms that a set of records, identified as matching, are in fact false positives and not duplicates.

    • Method Detail

      • getTable

        com.onwbp.adaptation.AdaptationTable getTable()

        Retrieves the EBX table associated with this group. This allows you to manage the group's records, including operations such as retrieving records in the group, removing matching records, rejecting suspect records, and accepting suspect records as duplicates.

        Returns:
        AdaptationTable the EBX table which enables management of records in a group.

      • getMatches

        @Deprecated(forRemoval=true,
            since="6.1.3")
RecordIterable getMatches()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since version 6.1.3. Use getMatchedRecords()
        This method is deprecated and should not be used to get records in a group that are considered as being matches. Use getMatchedRecords() instead.
        Returns:
        RecordIterable containing the records that are considered as matches

      • getSuspects

        @Deprecated(forRemoval=true,
            since="6.1.3")
RecordIterable getSuspects()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since version 6.1.3. Use getSuspectRecords()
        This method is is deprecated and should not be used to get the group's suspect records. Use getSuspectRecords() instead.
        Returns:
        RecordIterable containing the group's suspect records

      • getMatchedRecords

        CloseableIterator<com.onwbp.adaptation.Adaptation> getMatchedRecords()
        Returns records from the group that are considered as matching.
        Since:
        6.1.3

      • getSuspectRecords

        CloseableIterator<com.onwbp.adaptation.Adaptation> getSuspectRecords()
        Returns records that are suspected of matching other records in the group.
        Since:
        6.1.3

      • getGroupId

        java.math.BigDecimal getGroupId()
        Returns the group's Id.
        Returns:
        BigDecimal the group Id

      • getGroupLabel

        java.lang.String getGroupLabel()
        Returns the group's label.
        Returns:
        String the label of a group

      • removeMatches

        void removeMatches​(java.util.Set<com.onwbp.adaptation.Adaptation> matchedRecords)
        Confirms that a set of records, identified as matching, are in fact false positives and not duplicates. These records are then moved out of this group.
        Parameters:
        matchedRecords - the group's set of matched records
        Throws:
        java.lang.IllegalStateException - when unexpected technical errors occur
        java.lang.IllegalArgumentException - when one of the following errors occurs:
        1. At least one of the given records is not a match of the group.
        2. The group's center record is being removed from the group.

      • acceptSuspects

        void acceptSuspects​(java.util.Set<com.onwbp.adaptation.Adaptation> suspectRecords)
        Confirms that a set of records that were identified as suspects are duplicates of other records in the group.
        Parameters:
        suspectRecords - the group's set of suspect records
        Throws:
        java.lang.IllegalStateException - when unexpected technical errors occur
        java.lang.IllegalArgumentException - when at least one of the given records is not a suspect of the group.

      • rejectSuspects

        void rejectSuspects​(java.util.Set<com.onwbp.adaptation.Adaptation> suspectRecords)
        Confirms that a set of records, identified as suspects, are in fact not suspects of other records in the group. These records are not included in future matching operations.
        Parameters:
        suspectRecords - the group's set of suspect records
        Throws:
        java.lang.IllegalStateException - when unexpected technical errors occur
        java.lang.IllegalArgumentException - when at least one of the given records is not a suspect of the group.