MatchingOperations (EBX® Add-ons Version 4.5.14 Java API)

public interface MatchingOperations

Provides operations for the {addon.label}. These operations must be called within a Procedure. Example:

        Procedure matching = new Procedure()
        {
                        public void execute(ProcedureContext procedureContext) throws Exception
                        {
                                Adaptation record = ...;
                                RecordContext context = new RecordContext(
                                        record,
                                        procedureContext);
                                MatchingOperations operations = MatchingOperationsFactory.getMatchingOperations();
                                if (...)
                                        operations.matchCluster(context);
                                else if (...)
                                operations.matchTable(context);
                                ...
                                operations.setDefinitiveGolden(context);
                        }
        };

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`addIntoCluster(RecordContext context)` Adds a record into a new cluster.
`void`	`addIntoCluster(RecordContext context, int clusterId)` Adds a record into an existing cluster.
`void`	`alignForeignKeys(RecordContext context)` Updates all foreign keys across dataspace, dataset that target merged records.
`void`	`alignForeignKeysInDataset(RecordContext context)` Updates foreign keys in the same dataset that target merged records.
`void`	`alignForeignKeysInDataspace(RecordContext context)` Updates foreign keys in the same dataspace that target merged records.
`void`	`automaticMerge(RecordContext context)` Executes the 'Automatic merge' operation on a record.
`SearchResult`	`checkSimilarity(RecordContext context, com.onwbp.adaptation.PrimaryKey target, String policyCode)` Checks similarity operation using `RecordContext`.
`void`	`delete(RecordContext context)` Deletes a specified record.
`void`	`disableMatchingPolicy(List<String> policyCodes)` Disables a list of matching policies.
`void`	`enableMatchingPolicy(List<String> policyCodes)` Enables a list of matching policies.
`void`	`exactMatchAtOnceToBeMatched(RecordContext context, ExactMatchAtOnceContext exactMatchAtOnceContext)` Performs an Exact match at once operation on the record in the `To Be Matched` state.
`void`	`exactMatchAtOnceToBeMatched(TableContext context, ExactMatchAtOnceContext exactMatchAtOnceContext)` Exact match at once operation on To Be Matched state.
`void`	`exactMatchAtOnceUnmatched(RecordContext context, ExactMatchAtOnceContext exactMatchAtOnceContext)` Performs an Exact match at once operation on the record in the `Unmatched` state.
`void`	`exactMatchAtOnceUnmatched(TableContext context, ExactMatchAtOnceContext exactMatchAtOnceContext)` Exact match at once operation on Unmatched state.
`void`	`executeSurvivorshipOnClusters(TableContext context, List<Integer> clusters)` Executes survivorship on each cluster sequentially.
`void`	`groupAtOnceToBeMatched(TableContext context, int maximumNumberOfGroups, boolean cleanMarkers)` Group at once operation on To be matched state.
`void`	`groupAtOnceUnmatched(TableContext context, int maximumNumberOfGroups, boolean cleanMarkers)` Group at once operation on Unmatched state.
`void`	`loadCache(LoadCacheContext context)` Loads the cache for the search engine dedicated to Matching.
`void`	`matchAtOnceFullModeToBeMatched(TableContext context, int maximumNumberOfMatch, boolean forceOrphansGolden, List<MatchingState> statesToTriggerMatching)` Match at once full mode operation on To be matched state.
`void`	`matchAtOnceFullModeUnmatched(TableContext context, int maximumNumberOfMatch, boolean forceOrphansGolden, List<MatchingState> statesToTriggerMatching)` Match at once full mode operation on Unmatched state.
`void`	`matchAtOnceToBeMatched(TableContext context, int maximumNumberOfMatch, boolean cleanMarkers, List<MatchingState> statesToTriggerMatching)` Match at once operation on To be matched state.
`void`	`matchAtOnceToBeMatchedOnGroups(TableContext context, boolean cleanMarkers, Set<Integer> groups)` Match at once operation on groups of To be matched records.
`void`	`matchAtOnceToBeMatchedParallelMode(TableContext context, boolean cleanMarkers)` Match at once operation on To Be Matched state with Parallel Mode.
`void`	`matchAtOnceUnmatched(TableContext context, int maximumNumberOfMatch, boolean cleanMarkers, List<MatchingState> statesToTriggerMatching)` Match at once operation on Unmatched state.
`void`	`matchAtOnceUnmatchedOnGroups(TableContext context, boolean cleanMarkers, Set<Integer> groups)` Match at once operation on groups of Unmatched records.
`void`	`matchAtOnceUnmatchedParallelMode(TableContext context, boolean cleanMarkers)` Match at once operation on Unmatched state with Parallel Mode.
`void`	`matchBestCluster(RecordContext context)` Puts the record in the best cluster.
`void`	`matchCluster(RecordContext context)` Match cluster operation.
`void`	`matchSelection(TableContext tableContext, List<MatchingState> sourceStates, List<MatchingState> targetStates)` Individually matches each source record in the source states against all target matching states.
`void`	`matchSelection(TableContext tableContext, Set<com.onwbp.adaptation.PrimaryKey> sourceRecords, List<MatchingState> targetStates)` Individually matches each source record against all target matching states.
`void`	`matchSelection(TableContext tableContext, Set<com.onwbp.adaptation.PrimaryKey> sourceRecords, Set<com.onwbp.adaptation.PrimaryKey> targetRecords)` Individually matches each source record against all target records.
`void`	`matchTable(RecordContext context)` Match table operation.
`void`	`purgeAtOnce(TableContext context, List<MatchingState> states)` Purges, or physically deletes, all records in the specified Matching states.
`void`	`removeFromNotSuspectWith(TableContext context, com.onwbp.adaptation.PrimaryKey primaryKey)` Cleans the reference to this PrimaryKey from the list of not suspect with.
`void`	`setAtOnceToBeMatched(RecordContext context)` Set at once To be matched operation on a record.
`void`	`setAtOnceToBeMatched(TableContext context, List<MatchingState> statesToReset, boolean setUnsetRecords)` Set at once To be matched operation on the whole table.
`void`	`setAtOnceUnmatched(RecordContext context)` Set at once Unmatched operation on a record.
`void`	`setAtOnceUnmatched(TableContext context, List<MatchingState> statesToReset, boolean setUnsetRecords)` Set at once Unmatched operation on the whole table.
`void`	`setBackGolden(RecordContext context)` Set back golden operation.
`void`	`setDefinitiveGolden(RecordContext context)` Set definitive golden operation.
`void`	`setGolden(RecordContext context)` Set golden operation.
`void`	`setNotSuspect(RecordContext context)` Set not suspect operation.
`List<SearchResult>`	`simulateMatchTable(RecordContext context)` Simulates match table operation using `RecordContext`.
`List<SearchResult>`	`simulateMatchTable(SearchContext context)` Simulates a match table operation using `SearchContext`.
`List<SearchResult>`	`simulateMatchTable(TransientRecordContext context)` Simulates a match table operation using `TransientRecordContext`.
`void`	`switchPivot(RecordContext context)` Switch pivot operation.
`void`	`undelete(RecordContext context)` Undelete operation.
`void`	`unmerge(RecordContext context)` Unmerge operation.
`void`	`unsetGolden(RecordContext context)` Unset golden operation.
`void`	`unsetGoldenRecursively(RecordContext context)` Unset golden recursively operation.

- Method Detail
  - alignForeignKeys
```
void alignForeignKeys(RecordContext context)
               throws com.orchestranetworks.service.OperationException
```
    Updates all foreign keys across dataspace, dataset that target merged records. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - alignForeignKeysInDataset
```
void alignForeignKeysInDataset(RecordContext context)
                        throws com.orchestranetworks.service.OperationException
```
    Updates foreign keys in the same dataset that target merged records. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.5.5
  - alignForeignKeysInDataspace
```
void alignForeignKeysInDataspace(RecordContext context)
                          throws com.orchestranetworks.service.OperationException
```
    Updates foreign keys in the same dataspace that target merged records. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.5.6
  - automaticMerge
```
void automaticMerge(RecordContext context)
             throws com.orchestranetworks.service.OperationException
```
    Executes the 'Automatic merge' operation on a record. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - addIntoCluster
```
void addIntoCluster(RecordContext context,
                    int clusterId)
             throws com.orchestranetworks.service.OperationException
```
    Adds a record into an existing cluster. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.4.0
  - addIntoCluster
```
int addIntoCluster(RecordContext context)
            throws com.orchestranetworks.service.OperationException
```
    Adds a record into a new cluster. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.4.0
  - delete
```
void delete(RecordContext context)
     throws com.orchestranetworks.service.OperationException
```
    Deletes a specified record. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - exactMatchAtOnceToBeMatched
```
void exactMatchAtOnceToBeMatched(TableContext context,
                                 ExactMatchAtOnceContext exactMatchAtOnceContext)
                          throws com.orchestranetworks.service.OperationException
```
    Exact match at once operation on To Be Matched state. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.7.5
  - exactMatchAtOnceUnmatched
```
void exactMatchAtOnceUnmatched(TableContext context,
                               ExactMatchAtOnceContext exactMatchAtOnceContext)
                        throws com.orchestranetworks.service.OperationException
```
    Exact match at once operation on Unmatched state. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.7.5
  - exactMatchAtOnceToBeMatched
```
void exactMatchAtOnceToBeMatched(RecordContext context,
                                 ExactMatchAtOnceContext exactMatchAtOnceContext)
                          throws com.orchestranetworks.service.OperationException
```
    Performs an Exact match at once operation on the record in the To Be Matched state. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.4.0
  - exactMatchAtOnceUnmatched
```
void exactMatchAtOnceUnmatched(RecordContext context,
                               ExactMatchAtOnceContext exactMatchAtOnceContext)
                        throws com.orchestranetworks.service.OperationException
```
    Performs an Exact match at once operation on the record in the Unmatched state. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.4.0
  - groupAtOnceUnmatched
```
void groupAtOnceUnmatched(TableContext context,
                          int maximumNumberOfGroups,
                          boolean cleanMarkers)
                   throws com.orchestranetworks.service.OperationException
```
    Group at once operation on Unmatched state. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.3
  - groupAtOnceToBeMatched
```
void groupAtOnceToBeMatched(TableContext context,
                            int maximumNumberOfGroups,
                            boolean cleanMarkers)
                     throws com.orchestranetworks.service.OperationException
```
    Group at once operation on To be matched state. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.3
  - loadCache
```
void loadCache(LoadCacheContext context)
        throws com.orchestranetworks.service.OperationException
```
    Loads the cache for the search engine dedicated to Matching. This method will load the cache for all Matching Policies associated to the table. Note that the cache is linked to the life-cycle of the table. Therefore, this method is useful mainly on table inside data spaces with preloading activated.
    
    Parameters:
    
    context - describes the cache to load.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.11.0
  - matchAtOnceToBeMatched
```
void matchAtOnceToBeMatched(TableContext context,
                            int maximumNumberOfMatch,
                            boolean cleanMarkers,
                            List<MatchingState> statesToTriggerMatching)
                     throws com.orchestranetworks.service.OperationException,
                            IllegalArgumentException
```
    Match at once operation on To be matched state. See the details of Matching operations here.
    
    Throws:
    
    IllegalArgumentException - if statesToTrigger contains other states than MatchingState.TO_BE_MATCHED or MatchingState.GOLDEN.
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.3
  - matchAtOnceToBeMatchedParallelMode
```
void matchAtOnceToBeMatchedParallelMode(TableContext context,
                                        boolean cleanMarkers)
                                 throws com.orchestranetworks.service.OperationException
```
    Match at once operation on To Be Matched state with Parallel Mode. Must use a TableContext outside an existing Procedure. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.8.1
    
    See Also:
    
    TableContext.TableContext(AdaptationTable, Session)
  - matchAtOnceFullModeToBeMatched
```
void matchAtOnceFullModeToBeMatched(TableContext context,
                                    int maximumNumberOfMatch,
                                    boolean forceOrphansGolden,
                                    List<MatchingState> statesToTriggerMatching)
                             throws com.orchestranetworks.service.OperationException,
                                    IllegalArgumentException
```
    Match at once full mode operation on To be matched state. See the details of Matching operations here.
    
    Throws:
    
    IllegalArgumentException - if statesToTrigger contains states other than MatchingState.TO_BE_MATCHED or MatchingState.GOLDEN or MatchingState.PIVOT or MatchingState.SUSPECT.
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.7.0
  - matchAtOnceToBeMatchedOnGroups
```
void matchAtOnceToBeMatchedOnGroups(TableContext context,
                                    boolean cleanMarkers,
                                    Set<Integer> groups)
                             throws com.orchestranetworks.service.OperationException,
                                    IllegalArgumentException
```
    Match at once operation on groups of To be matched records. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    IllegalArgumentException
    
    Since:
    
    1.5.3
  - matchAtOnceUnmatched
```
void matchAtOnceUnmatched(TableContext context,
                          int maximumNumberOfMatch,
                          boolean cleanMarkers,
                          List<MatchingState> statesToTriggerMatching)
                   throws com.orchestranetworks.service.OperationException,
                          IllegalArgumentException
```
    Match at once operation on Unmatched state. See the details of Matching operations here.
    
    Throws:
    
    IllegalArgumentException - if statesToTrigger contains other states than MatchingState.UNMATCHED or MatchingState.GOLDEN.
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.3
  - matchAtOnceUnmatchedParallelMode
```
void matchAtOnceUnmatchedParallelMode(TableContext context,
                                      boolean cleanMarkers)
                               throws com.orchestranetworks.service.OperationException
```
    Match at once operation on Unmatched state with Parallel Mode. Must use a TableContext outside an existing Procedure. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.8.1
    
    See Also:
    
    TableContext.TableContext(AdaptationTable, Session)
  - matchAtOnceFullModeUnmatched
```
void matchAtOnceFullModeUnmatched(TableContext context,
                                  int maximumNumberOfMatch,
                                  boolean forceOrphansGolden,
                                  List<MatchingState> statesToTriggerMatching)
                           throws com.orchestranetworks.service.OperationException,
                                  IllegalArgumentException
```
    Match at once full mode operation on Unmatched state. See the details of Matching operations here.
    
    Throws:
    
    IllegalArgumentException - if statesToTrigger contains states other than MatchingState.UNMATCHED or MatchingState.GOLDEN or MatchingState.PIVOT or MatchingState.SUSPECT.
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.7.0
  - matchAtOnceUnmatchedOnGroups
```
void matchAtOnceUnmatchedOnGroups(TableContext context,
                                  boolean cleanMarkers,
                                  Set<Integer> groups)
                           throws com.orchestranetworks.service.OperationException,
                                  IllegalArgumentException
```
    Match at once operation on groups of Unmatched records. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    IllegalArgumentException
    
    Since:
    
    1.5.3
  - matchCluster
```
void matchCluster(RecordContext context)
           throws com.orchestranetworks.service.OperationException
```
    Match cluster operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - matchTable
```
void matchTable(RecordContext context)
         throws com.orchestranetworks.service.OperationException
```
    Match table operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - purgeAtOnce
```
void purgeAtOnce(TableContext context,
                 List<MatchingState> states)
          throws com.orchestranetworks.service.OperationException
```
    Purges, or physically deletes, all records in the specified Matching states. The operation can be applied to any Matching state.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.2.0
  - removeFromNotSuspectWith
```
void removeFromNotSuspectWith(TableContext context,
                              com.onwbp.adaptation.PrimaryKey primaryKey)
                       throws com.orchestranetworks.service.OperationException
```
    Cleans the reference to this PrimaryKey from the list of not suspect with. Useful in case of a deletion of records deactivating the default behavior of the trigger.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.4
  - setAtOnceUnmatched
```
void setAtOnceUnmatched(RecordContext context)
                 throws com.orchestranetworks.service.OperationException
```
    Set at once Unmatched operation on a record. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.3
  - setAtOnceUnmatched
```
void setAtOnceUnmatched(TableContext context,
                        List<MatchingState> statesToReset,
                        boolean setUnsetRecords)
                 throws com.orchestranetworks.service.OperationException
```
    Set at once Unmatched operation on the whole table. See the details of Matching operations here.
    
    Parameters:
    
    setUnsetRecords - if true then records with no state will be set to "Unmatched".
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.3
  - setAtOnceToBeMatched
```
void setAtOnceToBeMatched(RecordContext context)
                   throws com.orchestranetworks.service.OperationException
```
    Set at once To be matched operation on a record. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.3
  - setAtOnceToBeMatched
```
void setAtOnceToBeMatched(TableContext context,
                          List<MatchingState> statesToReset,
                          boolean setUnsetRecords)
                   throws com.orchestranetworks.service.OperationException
```
    Set at once To be matched operation on the whole table. See the details of Matching operations here.
    
    Parameters:
    
    setUnsetRecords - if true then records with no state will be set to "To be matched".
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.3
  - setBackGolden
```
void setBackGolden(RecordContext context)
            throws com.orchestranetworks.service.OperationException
```
    Set back golden operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - setDefinitiveGolden
```
void setDefinitiveGolden(RecordContext context)
                  throws com.orchestranetworks.service.OperationException
```
    Set definitive golden operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - setGolden
```
void setGolden(RecordContext context)
        throws com.orchestranetworks.service.OperationException
```
    Set golden operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - setNotSuspect
```
void setNotSuspect(RecordContext context)
            throws com.orchestranetworks.service.OperationException
```
    Set not suspect operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - simulateMatchTable
```
List<SearchResult> simulateMatchTable(RecordContext context)
                               throws com.orchestranetworks.service.OperationException
```
    Simulates match table operation using RecordContext.
    
    Returns:
    
    the list of the simulation
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    See Also:
    
    RecordContext.RecordContext(Adaptation, String, ProcedureContext)
  - simulateMatchTable
```
List<SearchResult> simulateMatchTable(TransientRecordContext context)
                               throws com.orchestranetworks.service.OperationException
```
    Simulates a match table operation using TransientRecordContext. TransientRecordContext works much the same as RecordContext except in cases of relation matching. TransientRecordContext is used prior to record creation, so relation matching is not possible.
    
    Returns:
    
    the list of the simulation
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.8.4
    
    See Also:
    
    TransientRecordContext.TransientRecordContext(Map, String, AdaptationTable, Session)
  - simulateMatchTable
```
List<SearchResult> simulateMatchTable(SearchContext context)
                               throws com.orchestranetworks.service.OperationException
```
    Simulates a match table operation using SearchContext.
    
    Returns:
    
    the list of the simulation
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    See Also:
    
    SearchContext.SearchContext(AdaptationTable, Map, Locale)
  - switchPivot
```
void switchPivot(RecordContext context)
          throws com.orchestranetworks.service.OperationException
```
    Switch pivot operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.5.4
  - undelete
```
void undelete(RecordContext context)
       throws com.orchestranetworks.service.OperationException
```
    Undelete operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - unmerge
```
void unmerge(RecordContext context)
      throws com.orchestranetworks.service.OperationException
```
    Unmerge operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.4.0
  - unsetGolden
```
void unsetGolden(RecordContext context)
          throws com.orchestranetworks.service.OperationException
```
    Unset golden operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
  - unsetGoldenRecursively
```
void unsetGoldenRecursively(RecordContext context)
                     throws com.orchestranetworks.service.OperationException
```
    Unset golden recursively operation. See the details of Matching operations here.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    1.8.4
  - matchSelection
```
void matchSelection(TableContext tableContext,
                    Set<com.onwbp.adaptation.PrimaryKey> sourceRecords,
                    Set<com.onwbp.adaptation.PrimaryKey> targetRecords)
             throws com.orchestranetworks.service.OperationException
```
    Individually matches each source record against all target records.
    
    Parameters:
    
    sourceRecords - selects the records to include in the matching operation. Source records are those in the Unmatched, To be matched, Suspicious and Golden states.
    
    targetRecords - determines which records the source records will be matched against. Target records are those in the Unmatched, To be matched, Suspicious, Golden, Pivot and Suspect states.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.2.5
  - matchSelection
```
void matchSelection(TableContext tableContext,
                    Set<com.onwbp.adaptation.PrimaryKey> sourceRecords,
                    List<MatchingState> targetStates)
             throws com.orchestranetworks.service.OperationException
```
    Individually matches each source record against all target matching states.
    
    Parameters:
    
    sourceRecords - selects the records to include in the matching operation. Source records are those in the Unmatched, To be matched, Suspicious and Golden states.
    
    targetStates - determines which matching states the source records will be matched against. Target states are those in the Unmatched, To be matched, Suspicious, Golden, Pivot and Suspect states.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.5.4
  - matchSelection
```
void matchSelection(TableContext tableContext,
                    List<MatchingState> sourceStates,
                    List<MatchingState> targetStates)
             throws com.orchestranetworks.service.OperationException
```
    Individually matches each source record in the source states against all target matching states.
    
    Parameters:
    
    sourceStates - selects the records in the specific state to include in the matching operation. Source states are those in the Unmatched, To be matched, Suspicious and Golden states.
    
    targetStates - determines which matching states the source records will be matched against. Target states are those in the Unmatched, To be matched, Suspicious, Golden, Pivot and Suspect states.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.5.5
  - executeSurvivorshipOnClusters
```
void executeSurvivorshipOnClusters(TableContext context,
                                   List<Integer> clusters)
                            throws com.orchestranetworks.service.OperationException
```
    Executes survivorship on each cluster sequentially.
    
    Parameters:
    
    clusters - list of all clusters on which to execute survivorship.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.4.0
  - matchBestCluster
```
void matchBestCluster(RecordContext context)
               throws com.orchestranetworks.service.OperationException
```
    Puts the record in the best cluster. Match the best cluster operation using RecordContext.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.5.11
    
    See Also:
    
    RecordContext.RecordContext(Adaptation, ProcedureContext)
  - checkSimilarity
```
SearchResult checkSimilarity(RecordContext context,
                             com.onwbp.adaptation.PrimaryKey target,
                             String policyCode)
                      throws com.orchestranetworks.service.OperationException
```
    Checks similarity operation using RecordContext.
    
    Returns:
    
    the SearchResult
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.5.12
    
    See Also:
    
    RecordContext.RecordContext(Adaptation, ProcedureContext)
  - disableMatchingPolicy
```
void disableMatchingPolicy(List<String> policyCodes)
                    throws com.orchestranetworks.service.OperationException
```
    Disables a list of matching policies.
    
    Parameters:
    
    policyCodes - list of matching policy codes.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.5.13
  - enableMatchingPolicy
```
void enableMatchingPolicy(List<String> policyCodes)
                   throws com.orchestranetworks.service.OperationException
```
    Enables a list of matching policies.
    
    Parameters:
    
    policyCodes - list of matching policy codes.
    
    Throws:
    
    com.orchestranetworks.service.OperationException
    
    Since:
    
    2.5.13

Add-ons Version 4.5.14.

Copyright TIBCO Software Inc. 2001-2022. All rights reserved.
All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Interface MatchingOperations

Method Summary

Method Detail

alignForeignKeys

alignForeignKeysInDataset

alignForeignKeysInDataspace

automaticMerge

addIntoCluster

addIntoCluster

delete

exactMatchAtOnceToBeMatched

exactMatchAtOnceUnmatched

exactMatchAtOnceToBeMatched

exactMatchAtOnceUnmatched

groupAtOnceUnmatched

groupAtOnceToBeMatched

loadCache

matchAtOnceToBeMatched

matchAtOnceToBeMatchedParallelMode

matchAtOnceFullModeToBeMatched

matchAtOnceToBeMatchedOnGroups

matchAtOnceUnmatched

matchAtOnceUnmatchedParallelMode

matchAtOnceFullModeUnmatched

matchAtOnceUnmatchedOnGroups

matchCluster

matchTable

purgeAtOnce

removeFromNotSuspectWith

setAtOnceUnmatched

setAtOnceUnmatched

setAtOnceToBeMatched

setAtOnceToBeMatched

setBackGolden

setDefinitiveGolden

setGolden

setNotSuspect

simulateMatchTable

simulateMatchTable

simulateMatchTable

switchPivot

undelete

unmerge

unsetGolden

unsetGoldenRecursively

matchSelection

matchSelection

matchSelection

executeSurvivorshipOnClusters

matchBestCluster

checkSimilarity

disableMatchingPolicy

enableMatchingPolicy