Home > Class Reference > %SYS namespace > %iKnow.Model.matchingProfile


class %iKnow.Model.matchingProfile extends %iKnow.Model.node

Model representation of a Matching Profile to use for matching sources against dictionaries. See also %iKnow.Matching.MatchingProfile.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter XMLNAME = profile;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties (Including Private)

property crcTotalMultiplier as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 1 ];
The total score of a CRC-level match is multiplied by this number.
Property methods: crcTotalMultiplierDisplayToLogical(), crcTotalMultiplierGet(), crcTotalMultiplierIsValid(), crcTotalMultiplierLogicalToDisplay(), crcTotalMultiplierNormalize(), crcTotalMultiplierSet(), crcTotalMultiplierXSDToLogical()
property disabled as %Boolean (XMLPROJECTION = "attribute");
If set to 1, this element is ignored when compiling, validating and building the domain
Property methods: disabledDisplayToLogical(), disabledGet(), disabledIsValid(), disabledLogicalToDisplay(), disabledLogicalToXSD(), disabledNormalize(), disabledSet(), disabledXSDToLogical()
property disorderMultiplier as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0.7 ];
This multiplier is applied to the aggegate match score for a CRC, path or sentence if the matched entities appear in a different order than in the dictionary term.
Property methods: disorderMultiplierDisplayToLogical(), disorderMultiplierGet(), disorderMultiplierIsValid(), disorderMultiplierLogicalToDisplay(), disorderMultiplierNormalize(), disorderMultiplierSet(), disorderMultiplierXSDToLogical()
relationship matching as %iKnow.Model.matching (XMLPROJECTION = "none") [ Inverse = profiles , Cardinality = one ];
Link to the <matching> element this profile belongs to.
Property methods: matchingGet(), matchingGetObject(), matchingGetObjectId(), matchingGetSwizzled(), matchingIsValid(), matchingNewObject(), matchingRClose(), matchingRExec(), matchingRFetch(), matchingRelate(), matchingSQLCompute(), matchingSet(), matchingUnRelate()
property minMatchedConceptFraction as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0 ];
Use this parameter to add an additional requirement on the number of concepts from the Dictionary Term that should be matched for an aggregate match to be considered. A value of 1 (100%) implies all concepts should be matched. A value of at least 0.51 for example means both concepts in a CRC should match. A value of 0 (default) does not impose additional restrictions.
Property methods: minMatchedConceptFractionDisplayToLogical(), minMatchedConceptFractionGet(), minMatchedConceptFractionIsValid(), minMatchedConceptFractionLogicalToDisplay(), minMatchedConceptFractionNormalize(), minMatchedConceptFractionSet(), minMatchedConceptFractionXSDToLogical()
property minimalMatchScore as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0.33 ];
This is the lower threshold for match scores. Matches having a total score less than MinimalMatchScore will not be stored or returned.
Property methods: minimalMatchScoreDisplayToLogical(), minimalMatchScoreGet(), minimalMatchScoreIsValid(), minimalMatchScoreLogicalToDisplay(), minimalMatchScoreNormalize(), minimalMatchScoreSet(), minimalMatchScoreXSDToLogical()
property name as %String (MAXLEN = 50, XMLPROJECTION = "ATTRIBUTE");
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property negationMultiplier as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 1 ];
Use this parameter to modify the score of matched entities which are part of a negation. Typically, this value will be either 1, ignoring the fact an entity is part of a negation, or 0, which will make the algorithm skip these entities. Other positive numeric values are also accepted and just modify the entity-level score for the affected entities, causing them to be considered partial matches.
Property methods: negationMultiplierDisplayToLogical(), negationMultiplierGet(), negationMultiplierIsValid(), negationMultiplierLogicalToDisplay(), negationMultiplierNormalize(), negationMultiplierSet(), negationMultiplierXSDToLogical()
property pathRelevantScoreMultiplier as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0.33 ];
The entity-level score of path-relevant entities will be multiplied by this modifier.
Property methods: pathRelevantScoreMultiplierDisplayToLogical(), pathRelevantScoreMultiplierGet(), pathRelevantScoreMultiplierIsValid(), pathRelevantScoreMultiplierLogicalToDisplay(), pathRelevantScoreMultiplierNormalize(), pathRelevantScoreMultiplierSet(), pathRelevantScoreMultiplierXSDToLogical()
property pathTotalMultiplier as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 1 ];
The total score of a path-level match is multiplied by this number.
Property methods: pathTotalMultiplierDisplayToLogical(), pathTotalMultiplierGet(), pathTotalMultiplierIsValid(), pathTotalMultiplierLogicalToDisplay(), pathTotalMultiplierNormalize(), pathTotalMultiplierSet(), pathTotalMultiplierXSDToLogical()
property relationshipLengthMultiplier as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0.2 ];
When calculating an aggregate match score for a CRC, path or sentence, the "length" of the matched section is compared to the total "length" of the CRC, path or sentence. This "length" is calculated taking a value of 1 for each concept and a value of RelationshipLengthMultiplier for each relationship. Therefore, setting this property to a lower value will decrease the weight of relationship entities in calculating this ratio.
Property methods: relationshipLengthMultiplierDisplayToLogical(), relationshipLengthMultiplierGet(), relationshipLengthMultiplierIsValid(), relationshipLengthMultiplierLogicalToDisplay(), relationshipLengthMultiplierNormalize(), relationshipLengthMultiplierSet(), relationshipLengthMultiplierXSDToLogical()
property relationshipScoreMultiplier as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0.5 ];
The entity-level score of relationship entities will be multiplied by this modifier.
Property methods: relationshipScoreMultiplierDisplayToLogical(), relationshipScoreMultiplierGet(), relationshipScoreMultiplierIsValid(), relationshipScoreMultiplierLogicalToDisplay(), relationshipScoreMultiplierNormalize(), relationshipScoreMultiplierSet(), relationshipScoreMultiplierXSDToLogical()
property scatteredMatchMultiplier as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0.75 ];
The entity-level score of scattered entity matches will be multiplied by this modifier. For example when matching the entity "blue big car" against the term "big blue car", The initial score of 1 (as all words in the entity are matched) will be multiplied with ScatteredMatchMultiplier
Property methods: scatteredMatchMultiplierDisplayToLogical(), scatteredMatchMultiplierGet(), scatteredMatchMultiplierIsValid(), scatteredMatchMultiplierLogicalToDisplay(), scatteredMatchMultiplierNormalize(), scatteredMatchMultiplierSet(), scatteredMatchMultiplierXSDToLogical()
property sentTotalMultiplier as %Numeric (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 1 ];
The total score of a sentence-level match is multiplied by this number.
Property methods: sentTotalMultiplierDisplayToLogical(), sentTotalMultiplierGet(), sentTotalMultiplierIsValid(), sentTotalMultiplierLogicalToDisplay(), sentTotalMultiplierNormalize(), sentTotalMultiplierSet(), sentTotalMultiplierXSDToLogical()

Methods (Including Private)

method %Validate(pDomainId As %Integer, pDomainDefinition As %iKnow.Model.domain) as %Status [ Language = objectscript ]

Inherited Members

Inherited Methods (Including Private)