Difference between revisions of "MatchUp Object:Matchcode:Functions"
Jump to navigation
Jump to search
(Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} This is a master list of the functions in the Matchcode interface. ==[[MatchUp Object:Matchcode In...") |
|||
| Line 7: | Line 7: | ||
This is a master list of the functions in the Matchcode interface. | This is a master list of the functions in the Matchcode interface. | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Initialization|Initialize MatchUp Object]]== | ||
Initializing the Matchcode interface is simpler than the other interfaces, since no license string is required. | Initializing the Matchcode interface is simpler than the other interfaces, since no license string is required. | ||
| Line 13: | Line 13: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Initialization#SetPathToMatchUpFiles|SetPathToMatchUpFiles]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Initialization#InitializeDataFiles|InitializeDataFiles]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Initialization#GetInitializeErrorString|GetInitializeErrorString]] | ||
|} | |} | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Creation|Create a New Matchcode]]== | ||
This function is part of the Matchcode class and creates a new, blank matchcode that can be populated with matchcode components and saved to the current matchcode file. | This function is part of the Matchcode class and creates a new, blank matchcode that can be populated with matchcode components and saved to the current matchcode file. | ||
| Line 27: | Line 27: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Creation#CreateNewMatchcode|CreateNewMatchcode]] | ||
|} | |} | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Retrieval|Retrieve Existing Matchcodes]]== | ||
These functions are used to retrieve a specific matchcode from the matchcode file. | These functions are used to retrieve a specific matchcode from the matchcode file. | ||
| Line 37: | Line 37: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Retrieval#FindMatchcode|FindMatchcode]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Retrieval#GetMatchcodeName|GetMatchcodeName]] | ||
|} | |} | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Properties|General Matchcode Properties]]== | ||
These functions help with defining various Matchcode properties. | These functions help with defining various Matchcode properties. | ||
| Line 49: | Line 49: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Properties#GetDescription|GetDescription]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Properties#SetDescription|SetDescription]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Properties#GetNGram|GetNGram]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Properties#SetNGram|SetNGram]] | ||
|} | |} | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Read Information|Read Matchcode Component Information]]== | ||
The functions in this section retrieve the number of components in a given matchcode and retrieve the contents of a specific matchcode component. | The functions in this section retrieve the number of components in a given matchcode and retrieve the contents of a specific matchcode component. | ||
| Line 65: | Line 65: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Information#GetMatchcodeItemCount|GetMatchcodeItemCount]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Information#GetMatchcodeItem|GetMatchcodeItem]] | ||
|} | |} | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Mapping|Get Mapping Information]]== | ||
Mapping information is different from component information, revealing the order and mapping types that should be used when creating the mappings in any one of the interfaces. | Mapping information is different from component information, revealing the order and mapping types that should be used when creating the mappings in any one of the interfaces. | ||
| Line 77: | Line 77: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Mapping#GetMappingItemCount|GetMappingItemCount]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Mapping#GetMappingItemType|GetMappingItemType]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Mapping#GetMappingItemLabel|GetMappingItemLabel]] | ||
|} | |} | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Change Settings|Change Matchcode Component Settings]]== | ||
These functions 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. | These functions 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. | ||
| Line 91: | Line 91: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetComponentType|SetComponentType]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetSize|SetSize]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetLabel|SetLabel]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetWordCount|SetWordCount]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetStart|SetStart]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetStartPos|SetStartPos]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetTrim|SetTrim]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetFuzzy|SetFuzzy]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetNear|SetNear]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetNearDbl|SetNearDbl]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetFieldMatch|SetFieldMatch]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetCombination|SetCombination]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Change Settings#SetSwap|SetSwap]] | ||
|} | |} | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Read Settings|Read Matchcode Component Settings]]== | ||
These functions read and return the settings from a specific matchcode component variable. | These functions read and return the settings from a specific matchcode component variable. | ||
| Line 125: | Line 125: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetComponentType|GetComponentType]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetSize|GetSize]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetLabel|GetLabel]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetWordCount|GetWordCount]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetStart|GetStart]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetStartPos|GetStartPos]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetTrim|GetTrim]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetFuzzy|GetFuzzy]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetNear|GetNear]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetNearDbl|GetNearDbl]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetFieldMatch|GetFieldMatch]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetCombination|GetCombination]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Read Settings#GetSwap|GetSwap]] | ||
|} | |} | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Modification|Add, Modify or Delete Matchcode Components]]== | ||
These functions add, insert, update, or delete matchcode components from the current Matchcode object. | These functions add, insert, update, or delete matchcode components from the current Matchcode object. | ||
| Line 159: | Line 159: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Modification#AddMatchcodeItem|AddMatchcodeItem]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Modification#InsertMatchcodeItem|InsertMatchcodeItem]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Modification#ChangeMatchcodeItem|ChangeMatchcodeItem]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Modification#DeleteMatchcodeItem|DeleteMatchcodeItem]] | ||
|} | |} | ||
==[[MatchUp Object:Matchcode | ==[[MatchUp Object:Matchcode:Saving|Save Changes to the Matchcode File]]== | ||
These functions save changes to the current matchcode file, either back to the original default file or to a new file. | These functions save changes to the current matchcode file, either back to the original default file or to a new file. | ||
| Line 175: | Line 175: | ||
!Function Name | !Function Name | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Saving#Save|Save]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Saving#SaveToFile|SaveToFile]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Saving#RenameMatchcode|RenameMatchcode]] | ||
|- | |- | ||
|[[MatchUp Object:Matchcode | |[[MatchUp Object:Matchcode:Saving#DeleteMatchcode|DeleteMatchcode]] | ||
|} | |} | ||
[[Category:MatchUp Object]] | [[Category:MatchUp Object]] | ||
Revision as of 18:44, 29 July 2015
| MatchUp Object Matchcode Interface Navigation | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Overview | |||||||||||
| Order of Operations | |||||||||||
| Mapping Information | |||||||||||
|
This is a master list of the functions in the Matchcode interface.
Initialize MatchUp Object
Initializing the Matchcode interface is simpler than the other interfaces, since no license string is required.
| Function Name |
|---|
| SetPathToMatchUpFiles |
| InitializeDataFiles |
| GetInitializeErrorString |
Create a New Matchcode
This function is part of the Matchcode class and creates a new, blank matchcode that can be populated with matchcode components and saved to the current matchcode file.
| Function Name |
|---|
| CreateNewMatchcode |
Retrieve Existing Matchcodes
These functions are used to retrieve a specific matchcode from the matchcode file.
| Function Name |
|---|
| FindMatchcode |
| GetMatchcodeName |
General Matchcode Properties
These functions help with defining various Matchcode properties.
| Function Name |
|---|
| GetDescription |
| SetDescription |
| GetNGram |
| SetNGram |
Read Matchcode Component Information
The functions in this section retrieve the number of components in a given matchcode and retrieve the contents of a specific matchcode component.
| Function Name |
|---|
| GetMatchcodeItemCount |
| GetMatchcodeItem |
Get Mapping Information
Mapping information is different from component information, revealing the order and mapping types that should be used when creating the mappings in any one of the interfaces.
| Function Name |
|---|
| GetMappingItemCount |
| GetMappingItemType |
| GetMappingItemLabel |
Change Matchcode Component Settings
These functions 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.
| Function Name |
|---|
| SetComponentType |
| SetSize |
| SetLabel |
| SetWordCount |
| SetStart |
| SetStartPos |
| SetTrim |
| SetFuzzy |
| SetNear |
| SetNearDbl |
| SetFieldMatch |
| SetCombination |
| SetSwap |
Read Matchcode Component Settings
These functions read and return the settings from a specific matchcode component variable.
| Function Name |
|---|
| GetComponentType |
| GetSize |
| GetLabel |
| GetWordCount |
| GetStart |
| GetStartPos |
| GetTrim |
| GetFuzzy |
| GetNear |
| GetNearDbl |
| GetFieldMatch |
| GetCombination |
| GetSwap |
Add, Modify or Delete Matchcode Components
These functions add, insert, update, or delete matchcode components from the current Matchcode object.
| Function Name |
|---|
| AddMatchcodeItem |
| InsertMatchcodeItem |
| ChangeMatchcodeItem |
| DeleteMatchcodeItem |
Save Changes to the Matchcode File
These functions save changes to the current matchcode file, either back to the original default file or to a new file.
| Function Name |
|---|
| Save |
| SaveToFile |
| RenameMatchcode |
| DeleteMatchcode |