Difference between revisions of "MatchUp Object:Incremental:Functions"

From Melissa Data Wiki
Jump to navigation Jump to search
(Created page with "{{MatchUpObjectIncrementalNav |FunctionsCollapse= }} {{CustomTOC}} This is a master list of the functions in the Incremental deduper interface. ==[[MatchUp Object:Increment...")
 
 
(2 intermediate revisions by the same user not shown)
Line 24: Line 24:
|-
|-
|[[MatchUp Object:Incremental:Initialization#SetKeyFile|SetKeyFile]]
|[[MatchUp Object:Incremental:Initialization#SetKeyFile|SetKeyFile]]
|-
|[[MatchUp Object:Incremental:Initialization#SetReserved (Deprecated)|SetReserved (Deprecated)]]
|-
|[[MatchUp Object:Incremental:Initialization#SetMaximumCharacterSize|SetMaximumCharacterSize]]
|-
|[[MatchUp Object:Incremental:Initialization#SetEncoding|SetEncoding]]
|-
|-
|[[MatchUp Object:Incremental:Initialization#InitializeDataFiles|InitializeDataFiles]]
|[[MatchUp Object:Incremental:Initialization#InitializeDataFiles|InitializeDataFiles]]
Line 37: Line 43:
|[[MatchUp Object:Incremental:Initialization#GetLicenseExpirationDate|GetLicenseExpirationDate]]
|[[MatchUp Object:Incremental:Initialization#GetLicenseExpirationDate|GetLicenseExpirationDate]]
|}
|}


==[[MatchUp Object:Incremental:Mapping|Map Database Fields]]==
==[[MatchUp Object:Incremental:Mapping|Map Database Fields]]==
Line 48: Line 55:
|[[MatchUp Object:Incremental:Mapping#AddMapping|AddMapping]]
|[[MatchUp Object:Incremental:Mapping#AddMapping|AddMapping]]
|}
|}


==[[MatchUp Object:Incremental:Match Key|Read Data and Build the Match Key]]==
==[[MatchUp Object:Incremental:Match Key|Read Data and Build the Match Key]]==
Line 65: Line 73:
|[[MatchUp Object:Incremental:Match Key#SetUserInfo|SetUserInfo]]
|[[MatchUp Object:Incremental:Match Key#SetUserInfo|SetUserInfo]]
|}
|}


==[[MatchUp Object:Incremental:Comparison|Compare Record to Database]]==
==[[MatchUp Object:Incremental:Comparison|Compare Record to Database]]==
Line 92: Line 101:
|[[MatchUp Object:Incremental:Comparison#GetResults|GetResults]]
|[[MatchUp Object:Incremental:Comparison#GetResults|GetResults]]
|}
|}


==[[MatchUp Object:Incremental:Key File|Add New Record to Key File]]==
==[[MatchUp Object:Incremental:Key File|Add New Record to Key File]]==
Line 101: Line 111:
|[[MatchUp Object:Incremental:Key File#AddRecord|AddRecord]]
|[[MatchUp Object:Incremental:Key File#AddRecord|AddRecord]]
|}
|}


==[[MatchUp Object:Incremental:Transaction|Transaction Methods]]==
==[[MatchUp Object:Incremental:Transaction|Transaction Methods]]==
These functions enable the Incremental interface to use transactions, processing multiple calls to the AddRecord function before committing the changes to the key file.
These functions enable the Incremental interface to use transactions, processing multiple calls to the [[MatchUp Object:Incremental:Key File#AddRecord|AddRecord]] function before committing the changes to the key file.


{|class="alternate01 sortable" cellspacing="0"
{|class="alternate01 sortable" cellspacing="0"

Latest revision as of 16:55, 28 October 2015

← MatchUp Object Reference

MatchUp Object Incremental Interface Navigation
Overview
Order of Operations
Functions
Initialization
Mapping
Match Key
Comparison
Key File
Transaction



This is a master list of the functions in the Incremental deduper interface.

Initialize the Incremental Interface

These functions prepare the Incremental interface for use and link it to its supporting data files.

Function Name
SetPathToMatchUpFiles
SetLicenseString
SetMatchcodeName
SetMatchcodeObject
SetMustExist
SetKeyFile
SetReserved (Deprecated)
SetMaximumCharacterSize
SetEncoding
InitializeDataFiles
GetInitializeErrorString
GetBuildNumber
GetDatabaseDate
GetDatabaseExpirationDate
GetLicenseExpirationDate


Map Database Fields

Before generating match keys for the records in the database, the code must supply the Incremental interface with information about what sort of data it will be handling.

Function Name
ClearMappings
AddMapping


Read Data and Build the Match Key

These functions take the real data being compared and construct a match key according to the mappings defined with the mapping functions and the matchcode specified when the Incremental interface was initialized.

Function Name
ClearFields
AddField
BuildKey
SetKey
SetUserInfo


Compare Record to Database

These functions compare the new key with the existing key file and, if a duplicate is found, return information about the duplicate records in the file.

Function Name
MatchRecord
GetStatusCode
NextMatchingRecord
GetCount
GetDupeGroup
GetEntry
GetCombinations
GetKey
GetUserInfo
GetResults


Add New Record to Key File

The Incremental interface does not handle reading or writing data to the database. This function only adds the new match key to the key file for future comparisons.

Function Name
AddRecord


Transaction Methods

These functions enable the Incremental interface to use transactions, processing multiple calls to the AddRecord function before committing the changes to the key file.

Function Name
BeginTransaction
CommitTransaction
RollbackTransaction