MatchUp Object:Matchcode:Change Settings - Revision history

Admin at 00:19, 9 April 2022

2022-04-09T00:19:33Z

@@ Line 205: / Line 205: @@
 |.Net=mdMCC.SetSwap = MatchcodeSwap
 }}
 [[Category:MatchUp Object]]

Admin at 19:21, 7 August 2015

2015-08-07T19:21:05Z

← Older revision		Revision as of 19:21, 7 August 2015
Line 17:		Line 17:
	\|Syntax=mdMCC->SetComponentType(MatchcodeComponentType)		\|Syntax=mdMCC->SetComponentType(MatchcodeComponentType)
	\|C=mdMUMatchcodeComponentSetComponentType(mdMCC,mdMUMatchcodeComponentType)		\|C=mdMUMatchcodeComponentSetComponentType(mdMCC,mdMUMatchcodeComponentType)
	\|.Net=mdMCC.~~ComponentType~~ = MatchcodeComponentType		\|.Net=mdMCC.SetComponentType = MatchcodeComponentType
	}}		}}

Line 31:		Line 31:
	\|Syntax=mdMCC->SetSize(int)		\|Syntax=mdMCC->SetSize(int)
	\|C=mdMUMatchcodeComponentSetSize(mdMCC, int)		\|C=mdMUMatchcodeComponentSetSize(mdMCC, int)
	\|.Net=mdMCC.~~Size~~ = integer		\|.Net=mdMCC.SetSize = integer
	}}		}}

Line 45:		Line 45:
	\|Syntax=mdMCC->SetLabel(char)		\|Syntax=mdMCC->SetLabel(char)
	\|C=mdMUMatchcodeComponentSetLabel(mdMCC, char)		\|C=mdMUMatchcodeComponentSetLabel(mdMCC, char)
	\|.Net=mdMCC.~~Label~~ = string		\|.Net=mdMCC.SetLabel = string
	}}		}}

Line 59:		Line 59:
	\|Syntax=mdMCC->SetWordCount(int)		\|Syntax=mdMCC->SetWordCount(int)
	\|C=mdMUMatchcodeComponentSetWordCount(mdMCC, int)		\|C=mdMUMatchcodeComponentSetWordCount(mdMCC, int)
	\|.Net=mdMCC.~~WordCount~~ = integer		\|.Net=mdMCC.SetWordCount = integer
	}}		}}

Line 73:		Line 73:
	\|Syntax=mdMCC->SetStart(MatchcodeStart)		\|Syntax=mdMCC->SetStart(MatchcodeStart)
	\|C=mdMUMatchcodeComponentSetStart(mdMCC, mdMUMatchcodeStart)		\|C=mdMUMatchcodeComponentSetStart(mdMCC, mdMUMatchcodeStart)
	\|.Net=mdMCC.~~Start~~ = MatchcodeStart		\|.Net=mdMCC.SetStart = MatchcodeStart
	}}		}}

Line 87:		Line 87:
	\|Syntax=mdMCC->SetStartPos(int)		\|Syntax=mdMCC->SetStartPos(int)
	\|C=mdMUMatchcodeComponentSetStartPos(mdMCC, int)		\|C=mdMUMatchcodeComponentSetStartPos(mdMCC, int)
	\|.Net=mdMCC.~~StartPos~~ = integer		\|.Net=mdMCC.SetStartPos = integer
	}}		}}

Line 101:		Line 101:
	\|Syntax=mdMCC->SetTrim(MatchcodeTrim)		\|Syntax=mdMCC->SetTrim(MatchcodeTrim)
	\|C=mdMUMatchcodeComponentSetTrim(mdMCC, mdMUMatchcodeTrim)		\|C=mdMUMatchcodeComponentSetTrim(mdMCC, mdMUMatchcodeTrim)
	\|.Net=mdMCC.~~Trim~~ = MatchcodeTrim		\|.Net=mdMCC.SetTrim = MatchcodeTrim
	}}		}}

Line 115:		Line 115:
	\|Syntax=mdMCC->SetFuzzy(MatchcodeFuzzy)		\|Syntax=mdMCC->SetFuzzy(MatchcodeFuzzy)
	\|C=mdMUMatchcodeComponentSetFuzzy(mdMCC, mdMUMatchcodeFuzzy)		\|C=mdMUMatchcodeComponentSetFuzzy(mdMCC, mdMUMatchcodeFuzzy)
	\|.Net=mdMCC.~~Fuzzy~~ = MatchcodeFuzzy		\|.Net=mdMCC.SetFuzzy = MatchcodeFuzzy
	}}		}}

Line 127:		Line 127:
	\|Syntax=mdMCC->SetNear(int)		\|Syntax=mdMCC->SetNear(int)
	\|C=mdMUMatchcodeComponentSetNear(mdMCC, int)		\|C=mdMUMatchcodeComponentSetNear(mdMCC, int)
	\|.Net=mdMCC.~~Near~~ = integer		\|.Net=mdMCC.SetNear = integer
	}}		}}

Line 151:		Line 151:
	\|Syntax=mdMCC->SetNearDbl(double)		\|Syntax=mdMCC->SetNearDbl(double)
	\|C=mdMUMatchcodeComponentSetNearDbl(mdMUMatchcodeComponent, double)		\|C=mdMUMatchcodeComponentSetNearDbl(mdMUMatchcodeComponent, double)
	\|.Net=mdMCC.~~NearDbl~~(double)		\|.Net=mdMCC.SetNearDbl(double)
	}}		}}

Line 171:		Line 171:
	\|Syntax=mdMCC->SetFieldMatch(MatchcodeFieldMatch)		\|Syntax=mdMCC->SetFieldMatch(MatchcodeFieldMatch)
	\|C=mdMUMatchcodeComponentSetFieldMatch(mdMCC, mdMUMatchcodeFieldMatch)		\|C=mdMUMatchcodeComponentSetFieldMatch(mdMCC, mdMUMatchcodeFieldMatch)
	\|.Net=mdMCC.~~FieldMatch~~ = MatchcodeFieldMatch		\|.Net=mdMCC.SetFieldMatch = MatchcodeFieldMatch
	}}		}}

Line 187:		Line 187:
	\|Syntax=mdMCC->SetCombination(MatchcodeCombination)		\|Syntax=mdMCC->SetCombination(MatchcodeCombination)
	\|C=mdMUMatchcodeComponentSetCombination(mdMCC, mdMUMatchcodeCombination)		\|C=mdMUMatchcodeComponentSetCombination(mdMCC, mdMUMatchcodeCombination)
	\|.Net=mdMCC.~~Combination~~ = MatchcodeCombination		\|.Net=mdMCC.SetCombination = MatchcodeCombination
	}}		}}

Line 203:		Line 203:
	\|Syntax=mdMCC->SetSwap(MatchcodeSwap)		\|Syntax=mdMCC->SetSwap(MatchcodeSwap)
	\|C=mdMUMatchcodeComponentSetSwap(mdMCC, mdMUMatchcodeSwap)		\|C=mdMUMatchcodeComponentSetSwap(mdMCC, mdMUMatchcodeSwap)
	\|.Net=mdMCC.~~Swap~~ = MatchcodeSwap		\|.Net=mdMCC.SetSwap = MatchcodeSwap
	}}		}}


	[[Category:MatchUp Object]]		[[Category:MatchUp Object]]

Admin at 18:43, 5 August 2015

2015-08-05T18:43:27Z

Show changes

Admin: Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} The functions in this section set the values for the various settings of a matchcode component obje..."

2015-07-31T21:18:28Z

Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} The functions in this section set the values for the various settings of a matchcode component obje..."

New page

{{MatchUpObjectMatchcodeInterfaceNav
|FunctionsCollapse=
}}

{{CustomTOC}}

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 [[MatchUp Object:Enumerations#MatchcodeComponentType|Matchcode Component Type Enumerations]].

{{ Object Syntax
|Syntax=mdMCC->SetComponentType(MatchcodeComponentType)
|C=mdMUMatchcodeComponentSetComponentType(mdMCC,mdMUMatchcodeComponentType)
|.Net=mdMCC.ComponentType = MatchcodeComponentType
}}

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

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.

{{ Object Syntax
|Syntax=mdMCC->SetSize(int)
|C=mdMUMatchcodeComponentSetSize(mdMCC, int)
|.Net=mdMCC.Size = 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.

{{ Object Syntax
|Syntax=mdMCC->SetLabel(char)
|C=mdMUMatchcodeComponentSetLabel(mdMCC, char)
|.Net=mdMCC.Label = 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.

{{ Object Syntax
|Syntax=mdMCC->SetWordCount(int)
|C=mdMUMatchcodeComponentSetWordCount(mdMCC, int)
|.Net=mdMCC.WordCount = integer
}}

==SetStart==
This function sets the starting point used by the current MatchcodeComponent object: '''Left''', '''Right''', '''Character''', or '''Word'''. It controls where MatchUp Object starts counting when applying the component size and accepts an enumerated value of the type MatchcodeStart.

If the selected value is either '''StartAtPos''' or '''StartAtWord''', the application will need to call the [[#SetStartPos|SetStartPos]] function.

{{ Object Syntax
|Syntax=mdMCC->SetStart(MatchcodeStart)
|C=mdMUMatchcodeComponentSetStart(mdMCC, mdMUMatchcodeStart)
|.Net=mdMCC.Start = MatchcodeStart
}}

==SetStartPos==
This function sets the specific character position or word used as the starting point, when '''StartAtPos''' or '''StartAtWord''' are passed to the [[#SetStart|SetStart]] function.

This function is required if the selection from the [[#SetStart|SetStart]] function is either '''StartAtPos''' or '''StartAtWord'''.

It 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|SetStart]] function is set to '''StartAtWord''', MatchUp Object will start at the second word.

{|class="alternate01" cellspacing="0"
!Name!!Value!!Description
|-
|Left||0x08||The default. MatchUp Object starts counting from the beginning of the field.
|-
|Right||0x10||MatchUp Object starts counting backwards from the end of the field.
|-
|StartAtPos||0x20||MatchUp Object starts counting from the character position indicated by the SetStartPos function.
|-
|StartAtWord||0x40||MatchUp Object starts counting from the word indicated by the SetStartPos function.
|}

{{ Object Syntax
|Syntax=mdMCC->SetStartPos(int)
|C=mdMUMatchcodeComponentSetStartPos(mdMCC, int)
|.Net=mdMCC.StartPos = 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 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.

{|class="alternate01" cellspacing="0"
!Name!!Value
|-
|LeftTrim||0x02
|-
|RightTrim||0x04
|-
|AllTrim||0x06
|}

{{ Object Syntax
|Syntax=mdMCC->SetTrim(MatchcodeTrim)
|C=mdMUMatchcodeComponentSetTrim(mdMCC, mdMUMatchcodeTrim)
|.Net=mdMCC.Trim = MatchcodeTrim
}}

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

{|class="alternate01" cellspacing="0"
!Name!!Value
|-
|Exact||0x0000
|-
|SoundEx||0x0001
|-
|Phonetex||0x0002
|-
|Containment||0x0004
|-
|Frequency||0x0008
|-
|FastNear||0x0010
|-
|AccurateNear||0x0020
|-
|VowelsOnly||0x0040
|-
|ConsonantsOnly||0x0080
|-
|AlphasOnly||0x0100
|-
|NumericsOnly||0x0200
|-
|FrequencyNear||0x0400
|-
|NGram||0x0800
|-
|Jaro||0x1000
|-
|JaroWinkler||0x2000
|-
|LCS||0x4000
|-
|NeedlemanWunsch||0x8000
|-
|MDKeyboard||0x10000
|-
|SmithWatermanGotoh||0x20000
|-
|Dice||0x40000
|-
|Jaccard||0x80000
|-
|Overlap||0x100000
|-
|DoubleMetaphone||0x200000
|}

See [[MatchUp Object:Component Properties|Matchcode Component Properties]] for more information on the various matching strategies.

{{ Object Syntax
|Syntax=mdMCC->SetFuzzy(MatchcodeFuzzy)
|C=mdMUMatchcodeComponentSetFuzzy(mdMCC, mdMUMatchcodeFuzzy)
|.Net=mdMCC.Fuzzy = MatchcodeFuzzy
}}

==SetNear==
This function sets the degree of precision used when the [[#SetFuzzy|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|SetFuzzy]] function.

{{ Object Syntax
|Syntax=mdMCC->SetNear(int)
|C=mdMUMatchcodeComponentSetNear(mdMCC, int)
|.Net=mdMCC.Near = integer
}}

==SetNearDbl==
This function sets the minimum percentage of similarity which will return a match between two strings when the [[#SetFuzzy|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|SetFuzzy]] function.

{{ Object Syntax
|Syntax=mdMCC->SetNearDbl(double)
|C=mdMUMatchcodeComponentSetNearDbl(mdMUMatchcodeComponent, double)
|.Net=mdMCC.NearDbl(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.

{|class="alternate01" cellspacing="0"
!Name!!Value
|-
|NoFieldMatch||0x0000
|-
|BothBlankMatch||0x0100
|-
|OneBlankMatch||0x0200
|-
|InitialMatch||0x0400
|}

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 [[MatchUp Object:Component Combinations#First Component Restrictions|special rules for first components]]. The first component cannot use Initial Only matching or One Blank Field matching.

For more information, see [[MatchUp Object:Blank Field Matching|Blank Field Matching]].

{{ Object Syntax
|Syntax=mdMCC->SetFieldMatch(MatchcodeFieldMatch)
|C=mdMUMatchcodeComponentSetFieldMatch(mdMCC, mdMUMatchcodeFieldMatch)
|.Net=mdMCC.FieldMatch = MatchcodeFieldMatch
}}

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

{|class="alternate01" cellspacing="0"
!Name!!Value
|-
|Combo1||0x0001
|-
|Combo2||0x0002
|-
|Combo3||0x0004
|-
|Combo4||0x0008
|-
|Combo5||0x0010
|-
|Combo6||0x0020
|-
|Combo7||0x0040
|-
|Combo8||0x0080
|-
|Combo9||0x0100
|-
|Combo10||0x0200
|-
|Combo11||0x0400
|-
|Combo12||0x0800
|-
|Combo13||0x1000
|-
|Combo14||0x2000
|-
|Combo15||0x4000
|-
|Combo16||0x8000
|}

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.

{{ Object Syntax
|Syntax=mdMCC->SetCombination(MatchcodeCombination)
|C=mdMUMatchcodeComponentSetCombination(mdMCC, mdMUMatchcodeCombination)
|.Net=mdMCC.Combination = 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.

{|class="alternate01" cellspacing="0"
!Name!!Value
|-
|NoSwap||0x00
|-
|SwapA||0x01
|-
|SwapB||0x02
|-
|SwapC||0x04
|-
|SwapD||0x08
|-
|SwapE||0x10
|-
|SwapF||0x20
|-
|SwapG||0x40
|-
|SwapH||0x80
|}

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.

{{ Object Syntax
|Syntax=mdMCC->SetSwap(MatchcodeSwap)
|C=mdMUMatchcodeComponentSetSwap(mdMCC, mdMUMatchcodeSwap)
|.Net=mdMCC.Swap = MatchcodeSwap
}}

[[Category:MatchUp Object]]