MatchingQAPI Class Reference

Inheritance diagram for MatchingQAPI:

Collaboration diagram for MatchingQAPI:

Static Public Member Functions
_.Library.Boolean	ClearLogs (_.Library.Integer domainId)
	Clears any matching-related logfiles for the specified domain.
_.Library.Integer	GetSentenceIdForMatchTarget (_.Library.Integer domainId, _.Library.Integer targetType, _.Library.Integer targetId, _.Library.Integer vSrcId)
	Utility method to retrieve the Sentence ID for a given match target, as specified by its target type. More...
_.Library.Integer	GetSourceIdForMatchTarget (_.Library.Integer domainId, _.Library.Integer targetType, _.Library.Integer targetId)
	Utility method to retrieve the Source ID for a given match target, as specified by its target type. More...
_.Library.Boolean	InvalidateMatchingResults (_.Library.Integer domainId, _.Library.String dictIds, _.Library.Integer pMode)
_.Library.Boolean	MatchSource (_.Library.Integer domainId, _.Library.Integer srcId, _.Library.String dictIds, _.iKnow.Matching.MatchingProfile overrideProfile)
_.Library.Boolean	MatchSources (_.Library.Integer domainId, _.Library.String filter, _.Library.String dictIds, _.iKnow.Matching.MatchingProfile overrideProfile)

Detailed Description

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Matching.MatchingAPI</class>, exposed as SqlProc methods.

See the classdocs for <class>iKnow.Matching.MatchingAPI</class> for more information.

Member Function Documentation

GetSentenceIdForMatchTarget()

_.Library.Integer GetSentenceIdForMatchTarget ( _.Library.Integer  domainId, _.Library.Integer  targetType, _.Library.Integer  targetId, _.Library.Integer  vSrcId  )

static

Utility method to retrieve the Sentence ID for a given match target, as specified by its target type.

(either of $$$DMTARGETENTITY, $$$DMTARGETCRC, $$$DMTARGETPATH or $$$DMTARGETSENT) and ID.

GetSourceIdForMatchTarget()

_.Library.Integer GetSourceIdForMatchTarget ( _.Library.Integer  domainId, _.Library.Integer  targetType, _.Library.Integer  targetId  )

static

Utility method to retrieve the Source ID for a given match target, as specified by its target type.

(either of $$$DMTARGETENTITY, $$$DMTARGETCRC, $$$DMTARGETPATH or $$$DMTARGETSENT) and ID.

InvalidateMatchingResults()

_.Library.Boolean InvalidateMatchingResults ( _.Library.Integer  domainId, _.Library.String  dictIds, _.Library.Integer  pMode  )

static

Deletes all current matching results for the list of Dictionary IDs passed in dictIds.

Specifying "" for dictIds will drop results for all Dictionaries in this domain.

pMode can be used to specify whether to keep intermediary (not source-related) matching results as follows:

• 0: only source-related matching results are erased (default)
• 1: the matching results for unique entities are also erased
• 2: the matching results for unique entities and indexing results for dictionary terms are all erased (only available if dictIds="")

This parameter is mostly for internal use.

Note: pMode=2 will not erase the indexing results for dictionary terms of cross-domain dictionaries.
Note: matching results for virtual sources are always completely dropped, regardless of the value of dictIds and with the same effect as pMode=1

MatchSource()

_.Library.Boolean MatchSource ( _.Library.Integer  domainId, _.Library.Integer  srcId, _.Library.String  dictIds, _.iKnow.Matching.MatchingProfile  overrideProfile  )

static

Matches an individual source against the list of Dictionary IDs passed in dictIds.

Use negative numbers to identify any cross-domain dictionaries to match against. A Matching Profile to calculate match scores can be specified either by passing in an <class>iKnow.Matching.MatchingProfile</class> object, or a Matching Profile ID. When passing in the ID, a negative number is treated as a namespace-wide profile, whereas a positive ID will be looked up within the context of the domain.

Specifying "" for dictIds will match against all Dictionaries in this domain and passing $$$ALLXDOMDICTIONARIES will match against all cross-domain dictionaries.

A negative Source ID is interpreted as a Virtual Source.

MatchSources()

_.Library.Boolean MatchSources ( _.Library.Integer  domainId, _.Library.String  filter, _.Library.String  dictIds, _.iKnow.Matching.MatchingProfile  overrideProfile  )

static

Matches all sources in the domain, optionally restricted to those satisfying the criteria of a

<class>iKnow.Filters.Filter</class> object provided as filter, against the list of Dictionary IDs passed in dictIds. Use negative numbers to mark cross-domain dictionaries.

A Matching Profile to calculate match scores can be specified either by passing in an <class>iKnow.Matching.MatchingProfile</class> object, or a Matching Profile ID. When passing in the ID, a negative number is treated as a namespace-wide profile, whereas a positive ID will be looked up within the context of the domain.

Specifying "" for dictIds will match against all Dictionaries in this domain and passing $$$ALLXDOMDICTIONARIES will match against all cross-domain dictionaries.