MatchUp Object:Matchcode:Change Settings

From Melissa Data Wiki
Jump to navigation Jump to search

← MatchUp Object Reference

MatchUp Object Matchcode Interface Navigation
Overview
Order of Operations
Mapping Information
Functions
Initialization
Creation
Retrieval
Properties
Component Information
Mapping
Change Settings
Read Settings
Modification
Saving



The functions in this section set the values for the various settings of a matchcode component object. They can be used to construct new matchcode components when adding them to a matchcode, or to change the settings of an existing component. Every function in this section requires a variable based on the mdMatchcodeComponent class.

SetComponentType

This function specifies the type for the current MatchcodeComponent object.

The only parameter for this function is an enumerated value of the type MatchcodeComponentType.

For a list of these enumerations, see Matchcode Component Type Enumerations.

Syntax mdMCC->SetComponentType(MatchcodeComponentType)
C mdMUMatchcodeComponentSetComponentType(mdMCC,mdMUMatchcodeComponentType)
.Net mdMCC.SetComponentType = MatchcodeComponentType


SetSize

This function sets how many characters from the source data will be used by the current MatchcodeComponent object.

This integer value sets the number of characters that this component will use from the related field from each record. If the field is longer than this value, the data will be truncated. If the field is shorter, it will be padded with spaces.

Size is only applied to a piece of data after all other component properties have been considered.

Syntax mdMCC->SetSize(int)
C mdMUMatchcodeComponentSetSize(mdMCC, int)
.Net mdMCC.SetSize = integer


SetLabel

This function assigns a label to the current MatchcodeComponent object.

Not all components accept a label. For example, none of the street address components (Street number, street name and so on) can have a label since they are not used for mapping.

Components that are not assigned a label will return the name of their component type. If a label is passed to a component that cannot use one, the component will ignore it.

Syntax mdMCC->SetLabel(char)
C mdMUMatchcodeComponentSetLabel(mdMCC, char)
.Net mdMCC.SetLabel = string


SetWordCount

This function sets the maximum number of words used by the current MatchcodeComponent object.

The maximum number of words offers further control over the amount of data used by each component. If this function is set to 1, then MatchUp Object will take every character up to, but not including, the first space.

If the first word is shorter than the value passed to the SetSize function, the data will still be truncated at that character, regardless of the setting from this function.

Syntax mdMCC->SetWordCount(int)
C mdMUMatchcodeComponentSetWordCount(mdMCC, int)
.Net mdMCC.SetWordCount = integer


SetStart

This function sets the starting point used by the current MatchcodeComponent object. It controls where MatchUp Object starts counting when applying the component size and accepts an enumerated value of the type MatchcodeStart.

For a list of these enumerations, see Matchcode Start Enumerations.

If the selected value is either StartAtPos or StartAtWord, the application will need to call the SetStartPos function.

Syntax mdMCC->SetStart(MatchcodeStart)
C mdMUMatchcodeComponentSetStart(mdMCC, mdMUMatchcodeStart)
.Net mdMCC.SetStart = MatchcodeStart


SetStartPos

This function is required if the selection from the SetStart function is either StartAtPos or StartAtWord.

This function sets either the character position or the word where MatchUp Object starts counting when adding a field to a match key.

For example, if the value passed to SetStartPos is 2 and the SetStart function is set to StartAtWord, MatchUp Object will start at the second word.

Syntax mdMCC->SetStartPos(int)
C mdMUMatchcodeComponentSetStartPos(mdMCC, int)
.Net mdMCC.SetStartPos = integer


SetTrim

This function enables or disables trimming of blank spaces from the beginning or end of field data through an enumerated value of the type MatchcodeTrim.

For a list of these enumerations, see Matchcode Trim Enumerations.

For most applications, this function will be set to AllTrim, which trims excess blank spaces from both the start and end of a field before adding to a match key.

Syntax mdMCC->SetTrim(MatchcodeTrim)
C mdMUMatchcodeComponentSetTrim(mdMCC, mdMUMatchcodeTrim)
.Net mdMCC.SetTrim = MatchcodeTrim


SetFuzzy

The function selects the matching algorithm used when comparing this MatchcodeComponent. It accepts an enumerated value of the type MatchcodeFuzzy.

For a list of these enumerations, see Matchcode Fuzzy Enumerations.

See Matchcode Component Properties for more information on the various matching strategies.

Syntax mdMCC->SetFuzzy(MatchcodeFuzzy)
C mdMUMatchcodeComponentSetFuzzy(mdMCC, mdMUMatchcodeFuzzy)
.Net mdMCC.SetFuzzy = MatchcodeFuzzy


SetNear

This function sets the degree of precision used when the SetFuzzy function is set to Fast Near, Accurate Near, or Frequency Near.

The integer value from 1 to 4 sets how many differences are allowed before two keys are no longer considered a match when one of the Near matching strategies is selected with the SetFuzzy function.

Syntax mdMCC->SetNear(int)
C mdMUMatchcodeComponentSetNear(mdMCC, int)
.Net mdMCC.SetNear = integer


SetNearDbl

This function sets the minimum percentage of similarity which will return a match between two strings when the SetFuzzy function is set to any of the following:

  • Proximity
  • N-Gram
  • Jaro
  • Jaro Winkler
  • LCS
  • Needleman
  • MDKeyboard
  • Smith Waterman
  • Dice's Coefficient
  • Jaccard
  • Overlap Coefficient
  • DoubleMetaphone algorithm.

The double value from 100 to 0 sets the minimum threshold percent similarity between two keys which will be considered a match when one of the NearDbl matching strategies is selected with the SetFuzzy function.

Syntax mdMCC->SetNearDbl(double)
C mdMUMatchcodeComponentSetNearDbl(mdMUMatchcodeComponent, double)
.Net mdMCC.SetNearDbl(double)


SetFieldMatch

This function determines how MatchUp Object handles blank or partial fields when applying a matchcode. It accepts an enumerated value of the type MatchcodeFieldMatch.

For a list of these enumerations, see Matchcode Field Match Enumerations.

These selections are not mutually exclusive. In order to select more than one, you will need to use a logical OR operation to combine multiple options and pass that value to the function.

Some languages, such as C++, do not easily handle using logical operation on enumerations. In these cases, it may be necessary to cast the enumerated values as integers and then combine them using the OR operation.

When working with the first component of a matchcode, keep in mind the special rules for first components. The first component cannot use Initial Only matching or One Blank Field matching.

For more information, see Blank Field Matching.

Syntax mdMCC->SetFieldMatch(MatchcodeFieldMatch)
C mdMUMatchcodeComponentSetFieldMatch(mdMCC, mdMUMatchcodeFieldMatch)
.Net mdMCC.SetFieldMatch = MatchcodeFieldMatch


SetCombination

This function selects which combinations in the current matchcode will use this component. It accepts an enumerated value of the type MatchcodeCombination.

For a list of these enumerations, see Matchcode Combinations Enumerations.

These selections are not mutually exclusive. In order to select more than one, you will need to use a logical OR operation to combine multiple options and pass that value to the function.

Some languages, such as C++, do not easily handle using logical operation on enumerations. In these cases, it may be necessary to cast the enumerated values as integers and then combine them using the OR operation.

Syntax mdMCC->SetCombination(MatchcodeCombination)
C mdMUMatchcodeComponentSetCombination(mdMCC, mdMUMatchcodeCombination)
.Net mdMCC.SetCombination = MatchcodeCombination


SetSwap

This function selects the swap pair or swap pairs to which this MatchcodeComponent object belongs and accepts an enumerated value of the type MatchcodeSwap.

For a list of these enumerations, see Matchcode Swap Enumerations.

These selections are not mutually exclusive. In order to select more than one, you will need to use a logical OR operation to combine multiple options and pass that value to the function.

Some languages, such as C++, do not easily handle using logical operation on enumerations. In these cases, it may be necessary to cast the enumerated values as integers and then combine them using the OR operation.

Syntax mdMCC->SetSwap(MatchcodeSwap)
C mdMUMatchcodeComponentSetSwap(mdMCC, mdMUMatchcodeSwap)
.Net mdMCC.SetSwap = MatchcodeSwap