MatchUp Object:Matchcode:Read Settings - Revision history

Admin at 00:12, 8 August 2015

2015-08-08T00:12:08Z

← Older revision		Revision as of 00:12, 8 August 2015
Line 17:		Line 17:
	\|Syntax=MatchcodeComponentType = mdMCC->GetComponentType()		\|Syntax=MatchcodeComponentType = mdMCC->GetComponentType()
	\|C=mdMUMatchcodeComponentType=mdMUMatchcodeComponentGetComponentType(mdMCC)		\|C=mdMUMatchcodeComponentType=mdMUMatchcodeComponentGetComponentType(mdMCC)
	\|.Net=MatchcodeComponentType = mdMCC.~~ComponentType~~		\|.Net=MatchcodeComponentType = mdMCC.GetComponentType
	}}		}}

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

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

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

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

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

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

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

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

Line 140:		Line 140:
	\|Syntax=double = mdMCC->GetNearDbl()		\|Syntax=double = mdMCC->GetNearDbl()
	\|C=double = mdMUMatchcodeComponentGetNearDbl(mdMUMatchcodeComponent)		\|C=double = mdMUMatchcodeComponentGetNearDbl(mdMUMatchcodeComponent)
	\|.Net=double = mdMCC.~~NearDbl~~		\|.Net=double = mdMCC.GetNearDbl
	}}		}}

Line 158:		Line 158:
	\|Syntax=MatchcodeFieldMatch = mdMCC->GetFieldMatch()		\|Syntax=MatchcodeFieldMatch = mdMCC->GetFieldMatch()
	\|C=mdMUMatchcodeFieldMatch = mdMUMatchcodeComponentGetFieldMatch(mdMCC)		\|C=mdMUMatchcodeFieldMatch = mdMUMatchcodeComponentGetFieldMatch(mdMCC)
	\|.Net=MatchcodeFieldMatch = mdMCC.~~FieldMatch~~		\|.Net=MatchcodeFieldMatch = mdMCC.GetFieldMatch
	}}		}}

Line 174:		Line 174:
	\|Syntax=MatchcodeCombination = mdMCC->GetCombination()		\|Syntax=MatchcodeCombination = mdMCC->GetCombination()
	\|C=mdMUMatchcodeCombination = mdMUMatchcodeComponentGetCombination(mdMCC)		\|C=mdMUMatchcodeCombination = mdMUMatchcodeComponentGetCombination(mdMCC)
	\|.Net=MatchcodeCombination = mdMCC.~~Combination~~		\|.Net=MatchcodeCombination = mdMCC.GetCombination
	}}		}}

Line 189:		Line 189:
	{{ Object Syntax		{{ Object Syntax
	\|Syntax=MatchcodeSwap = mdMCC->GetSwap()		\|Syntax=MatchcodeSwap = mdMCC->GetSwap()
	\|C=mdMUMatchcodeSwap = ~~mdMUMatchcodeComponentGetSwap~~(mdMCC)		\|C=mdMUMatchcodeSwap = mdMUMatchcodeComponentGetMatchcodeSwap(mdMCC)
	\|.Net=MatchcodeSwap = mdMCC.~~Swap~~		\|.Net=MatchcodeSwap = mdMCC.GetSwap
	}}		}}


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

Admin at 19:46, 5 August 2015

2015-08-05T19:46:25Z

← Older revision		Revision as of 19:46, 5 August 2015
Line 163:		Line 163:

	==GetCombination==		==GetCombination==
	This function shows which combinations in the current matchcode will use this component. It returns an enumerated value of the type [[MatchUp Object:Enumerations#MatchcodeCombination\|MatchcodeCombination.		This function shows which combinations in the current matchcode will use this component. It returns an enumerated value of the type [[MatchUp Object:Enumerations#MatchcodeCombination\|MatchcodeCombination]].

	For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeCombination\|MatchcodeCombination Enumerations]].		For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeCombination\|MatchcodeCombination Enumerations]].

Admin at 19:00, 5 August 2015

2015-08-05T19:00:04Z

← Older revision		Revision as of 19:00, 5 August 2015
Line 10:		Line 10:
	This function returns the component type of the current MatchcodeComponent object.		This function returns the component type of the current MatchcodeComponent object.

	The return value for this function is an enumerated value of the type MatchcodeComponentType.		The return value for this function is an enumerated value of the type [[MatchUp Object:Enumerations#MatchcodeComponentType\|MatchcodeComponentType]].

	For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeComponentType\|~~MatchcodeComponentType~~ Enumerations]].		For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeComponentType\|Matchcode Component Type Enumerations]].

	{{ Object Syntax		{{ Object Syntax

Admin: Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} The following functions read and return the settings from a specific matchcode component variable. ..."

2015-08-01T00:14:39Z

Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} The following functions read and return the settings from a specific matchcode component variable. ..."

New page

{{MatchUpObjectMatchcodeInterfaceNav
|FunctionsCollapse=
}}

{{CustomTOC}}

The following functions read and return the settings from a specific matchcode component variable.

==GetComponentType==
This function returns the component type of the current MatchcodeComponent object.

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

For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeComponentType|MatchcodeComponentType Enumerations]].

{{ Object Syntax
|Syntax=MatchcodeComponentType = mdMCC->GetComponentType()
|C=mdMUMatchcodeComponentType=mdMUMatchcodeComponentGetComponentType(mdMCC)
|.Net=MatchcodeComponentType = mdMCC.ComponentType
}}

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

This integer value shows 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=int = mdMCC->GetSize()
|C=int = mdMUMatchcodeComponentGetSize(mdMCC)
|.Net=integer = mdMCC.Size
}}

==GetLabel==
This function returns the label, if any, of 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) use a label because they are not used for mapping.

Components that are not assigned a label will return the name of their component type.

{{ Object Syntax
|Syntax=char = mdMCC->GetLabel()
|C=char = mdMUMatchcodeComponentGetLabel(mdMCC)
|.Net=string = mdMCC.Label
}}

==GetWordCount==
This function returns 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 [[MatchUp Object:Matchcode:Change Settings#SetSize|SetSize]] function, then the data will still be truncated at that character, regardless of the setting returned by this function.

{{ Object Syntax
|Syntax=int = mdMCC->GetWordCount()
|C=int = mdMUMatchcodeComponentGetWordCount(mdMCC)
|.Net=integer = mdMCC.WordCount
}}

==GetStart==
This function returns an enumerated value of the type MatchcodeStart that shows where MatchUp Object starts counting when applying the component size.

For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeStart|MatchcodeStart Enumerations]].

If the selected value is either '''StartAtPos''' or '''StartAtWord''', the application will need to call the [[#GetStartPos|GetStartPos]] function to discover what starting word or character position is being used.

{{ Object Syntax
|Syntax=MatchcodeStart = mdMCC->GetStart()
|C=mdMUMatchcodeStart= mdMUMatchcodeComponentGetStart(mdMCC)
|.Net=MatchcodeStart = mdMCC.Start
}}

==GetStartPos==
This functions returns the specific character position or word used as the starting point, when the [[MatchUp Object:Matchcode:Change Settings#SetStart|SetStart]] function is set to '''Position''' or '''Word'''.

It will return an integer value when the [[MatchUp Object:Matchcode:Change Settings#SetStart|SetStart]] function has been set to either '''StartAtPos''' or '''StartAtWord'''.

It returns either the character position or the word where MatchUp Object starts counting when adding a field to a match key.

{{ Object Syntax
|Syntax=int = mdMCC->GetStartPos()
|C=int = mdMUMatchcodeComponentGetStartPos(mdMCC)
|.Net=integer = mdMCC.StartPos
}}

==GetTrim==
This function returns an enumerated value of the type MatchcodeTrim, showing whether the current matchcode will trim beginning or ending spaces from the data before performing other operations upon it.

For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeTrim|MatchcodeTrim Enumerations]].

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

{{ Object Syntax
|Syntax=MatchcodeTrim = mdMCC->GetTrim()
|C=mdMUMatchcodeTrim = mdMUMatchcodeComponentGetTrim(mdMCC)
|.Net=MatchcodeTrim = mdMCC.Trim
}}

==GetFuzzy==
This function returns an enumerated value of the type [[MatchUp Object:Enumerations#MatchcodeFuzzy|MatchcodeFuzzy]] used when comparing this MatchcodeComponent.

For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeFuzzy|MatchcodeFuzzy Enumerations]].

For more information, see [[MatchUp Object:Component Properties#|Matchcode Component Properties]].

{{ Object Syntax
|Syntax=MatchcodeFuzzy = mdMCC->GetFuzzy()
|C=mdMUMatchcodeFuzzy = mdMUMatchcodeComponentGetFuzzy(mdMCC)
|.Net=MatchcodeFuzzy = mdMCC.Fuzzy
}}

==GetNear==
This function returns the degree of precision used when the [[MatchUp Object:Matchcode:Change Settings#SetFuzzy|SetFuzzy]] function is set to '''Fast Near''', '''Accurate Near''', or '''Frequency Near'''.

The integer value from 1 to 4 shows 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 [[MatchUp Object:Matchcode:Change Settings#SetFuzzy|SetFuzzy]] function.

{{ Object Syntax
|Syntax=int mdMCC->GetNear()
|C=int = mdMUMatchcodeComponentGetNear(mdMCC)
|.Net=integer = mdMCC.Near
}}

==GetNearDbl==
This function returns the minimum percentage of similarity which will return a match between two strings when the [[MatchUp Object:Matchcode:Change Settings#SetFuzzy|SetFuzzy]] function is set to Proximity, N-Gram, Jaro, Jaro
Winkler, LCS, Needleman, MDKeyboard, Smith Waterman, Dice's Coefficient, Jaccard, Overlap Coefficient, or DoubleMetaphone algorithm.

The double value from 100 to 0 shows 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 [[MatchUp Object:Matchcode:Change Settings#SetFuzzy|SetFuzzy]] function.

{{ Object Syntax
|Syntax=double = mdMCC->GetNearDbl()
|C=double = mdMUMatchcodeComponentGetNearDbl(mdMUMatchcodeComponent)
|.Net=double = mdMCC.NearDbl
}}

==GetFieldMatch==
This function returns an enumerated value of the type [[MatchUp Object:Enumerations#MatchcodeFieldMatch|MatchcodeFieldMatch]], which determines how MatchUp Object handles blank or partial fields when applying a matchcode.

For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeFieldMatch|MatchcodeFieldMatch Enumerations]].

These selections are not mutually exclusive. In order to determine which settings are being used, you will need to use a logical AND operation to check the return value against each of the above values.

Some languages, such as C++, do not easily handle using logical operation on enumerations. In these cases, it may be necessary to cast the return values as an integer before using the AND operation to check the values.

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

{{ Object Syntax
|Syntax=MatchcodeFieldMatch = mdMCC->GetFieldMatch()
|C=mdMUMatchcodeFieldMatch = mdMUMatchcodeComponentGetFieldMatch(mdMCC)
|.Net=MatchcodeFieldMatch = mdMCC.FieldMatch
}}

==GetCombination==
This function shows which combinations in the current matchcode will use this component. It returns an enumerated value of the type [[MatchUp Object:Enumerations#MatchcodeCombination|MatchcodeCombination.

For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeCombination|MatchcodeCombination Enumerations]].

These selections are not mutually exclusive. In order to determine which settings are being used, you will need to use a logical AND operation to check the return value against each of the above values.

Some languages, such as C++, do not easily handle using logical operation on enumerations. In these cases, it may be necessary to cast the return values as an integer before using the AND operation to check the values.

{{ Object Syntax
|Syntax=MatchcodeCombination = mdMCC->GetCombination()
|C=mdMUMatchcodeCombination = mdMUMatchcodeComponentGetCombination(mdMCC)
|.Net=MatchcodeCombination = mdMCC.Combination
}}

==GetSwap==
This function shows which swap pairs in the current matchcode will use this component. It accepts an enumerated value of the type [[MatchUp Object:Enumerations#MatchcodeSwap|MatchcodeSwap]].

For a list of these enumerations, see [[MatchUp Object:Enumerations#MatchcodeSwap|MatchcodeSwap Enumerations]].

These selections are not mutually exclusive. In order to determine which settings are being used, you will need to use a logical AND operation to check the return value against each of the above values.

Some languages, such as C++, do not easily handle using logical operation on enumerations. In these cases, it may be necessary to cast the return values as an integer before using the AND operation to check the values.

{{ Object Syntax
|Syntax=MatchcodeSwap = mdMCC->GetSwap()
|C=mdMUMatchcodeSwap = mdMUMatchcodeComponentGetSwap(mdMCC)
|.Net=MatchcodeSwap = mdMCC.Swap
}}

[[Category:MatchUp Object]]