IRISLIB database
matchingProfile Class Reference

Model representation of a Matching Profile to use for matching sources against dictionaries. More...

Inheritance diagram for matchingProfile:
Collaboration diagram for matchingProfile:

Public Attributes

 crcTotalMultiplier
 The total score of a CRC-level match is multiplied by this number. More...
 
 disabled
 If set to 1, this element is ignored when compiling, validating and building the domain. More...
 
 disorderMultiplier
 This multiplier is applied to the aggegate match score for a CRC, path or sentence. More...
 
 matching
 Link to the <matching> element this profile belongs to. More...
 
 minMatchedConceptFraction
 Use this parameter to add an additional requirement on the number of concepts from the. More...
 
 minimalMatchScore
 This is the lower threshold for match scores. More...
 
 name
   More...
 
 negationMultiplier
 Use this parameter to modify the score of matched entities which are part of a negation. More...
 
 pathRelevantScoreMultiplier
 The entity-level score of path-relevant entities will be multiplied by this modifier. More...
 
 pathTotalMultiplier
 The total score of a path-level match is multiplied by this number. More...
 
 relationshipLengthMultiplier
 When calculating an aggregate match score for a CRC, path or sentence, the "length" of. More...
 
 relationshipScoreMultiplier
 The entity-level score of relationship entities will be multiplied by this modifier. More...
 
 scatteredMatchMultiplier
 The entity-level score of scattered entity matches will be multiplied by this modifier. More...
 
 sentTotalMultiplier
 The total score of a sentence-level match is multiplied by this number. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 
- Static Public Attributes inherited from abstractNode
 XMLINCLUDEINGROUP = None
 Do not include this class in the XML groupings.
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 
- Static Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Detailed Description

Model representation of a Matching Profile to use for matching sources against dictionaries.

See also <class>iKnow.Matching.MatchingProfile</class>.

Member Data Documentation

◆ crcTotalMultiplier

crcTotalMultiplier

The total score of a CRC-level match is multiplied by this number.

 

◆ disabled

disabled

If set to 1, this element is ignored when compiling, validating and building the domain.

 

◆ disorderMultiplier

disorderMultiplier

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.  

◆ matching

Link to the <matching> element this profile belongs to.

 

◆ minMatchedConceptFraction

minMatchedConceptFraction

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.  

◆ minimalMatchScore

minimalMatchScore

This is the lower threshold for match scores.

Matches having a total score less than

<property>MinimalMatchScore</property> will not be stored or returned.  

◆ name

name

 

 

◆ negationMultiplier

negationMultiplier

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.  

◆ pathRelevantScoreMultiplier

pathRelevantScoreMultiplier

The entity-level score of path-relevant entities will be multiplied by this modifier.

 

◆ pathTotalMultiplier

pathTotalMultiplier

The total score of a path-level match is multiplied by this number.

 

◆ relationshipLengthMultiplier

relationshipLengthMultiplier

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 <property>RelationshipLengthMultiplier</property> for each relationship. Therefore, setting this property to a lower value will decrease the weight of relationship entities in calculating this ratio.  

◆ relationshipScoreMultiplier

relationshipScoreMultiplier

The entity-level score of relationship entities will be multiplied by this modifier.

 

◆ scatteredMatchMultiplier

scatteredMatchMultiplier

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 <property>ScatteredMatchMultiplier</property>  

◆ sentTotalMultiplier

sentTotalMultiplier

The total score of a sentence-level match is multiplied by this number.