Inheritance diagram for MatchingProfile:

[legend]

Collaboration diagram for MatchingProfile:

[legend]

Public Member Functions
_.Library.Status	OnBeforeSave (_.Library.Boolean insert)

_.Library.Status	OnNew (_.Library.Integer pDomainId, _.Library.String pName)
	Creates a new Matching Profile instance in domain pDomainId (set to 0 to use. More...

_.Library.Status	ApplyProperties (_.iKnow.Matching.MatchingProfile pOtherProfile)
	Copies all non-ReadOnly property values of the supplied Matching Profile object. More...

Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

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...

Static Public Member Functions
_.iKnow.Matching.MatchingProfile	GetProfile (_.Library.Integer pDomainId, _.Library.Integer pProfileId, _.Library.Status pSC)

_.iKnow.Matching.MatchingProfile	GetProfileByName (_.Library.Integer pDomainId, _.Library.String pName, _.Library.Status pSC)
	Looks up a Matching Profile by name in the domain identified by pDomainId (or. More...

Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Public Attributes
	CrcTotalMultiplier
	The total score of a CRC-level match is multiplied by this number. More...

	DisorderMultiplier
	This multiplier is applied to the aggregate match score for a CRC, path or sentence. More...

	DomainId
	The domain ID this Matching Profile is associated with. 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
	A name for this profile. 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...

	ProfileId
	The ID of this profile. 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
Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

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...

Detailed Description

This class represents the parameters controlling the match score calculation resulting from the iKnow Smart Matching process driven from the <class>iKnow.Matching.MatchingAPI</class>.

A Matching Profile can be linked to a domain, or just exist "namespace-wide", when setting the <property>DomainId</property> property to 0. In the latter case, the profile is typically referred to with a negative value for its <property>ProfileId</property>.

Use <method>GetProfile</method> to retrieve or instantiate a profile object.

Member Function Documentation

◆ OnBeforeSave()

_.Library.Status OnBeforeSave ( _.Library.Boolean insert )

This class represents the parameters controlling the match score calculation resulting from the iKnow Smart Matching process driven from the <class>iKnow.Matching.MatchingAPI</class>.

A Matching Profile can be linked to a domain, or just exist "namespace-wide", when setting the <property>DomainId</property> property to 0. In the latter case, the profile is typically referred to with a negative value for its <property>ProfileId</property>.

Use <method>GetProfile</method> to retrieve or instantiate a profile object.

◆ OnNew()

_.Library.Status OnNew	(	_.Library.Integer	pDomainId,
		_.Library.String	pName
	)

Creates a new Matching Profile instance in domain pDomainId (set to 0 to use.

the profile across domains) named pName. The name is optional but if specified, should be unique within the domain (or within the cross-domain profiles) and cannot contain colon characters.

◆ ApplyProperties()

_.Library.Status ApplyProperties ( _.iKnow.Matching.MatchingProfile pOtherProfile )

Copies all non-ReadOnly property values of the supplied Matching Profile object.

to the current object. This excludes <property>ProfileId</property>, <property>DomainId</property> and <property>Name</property>.

◆ GetProfile()

_.iKnow.Matching.MatchingProfile GetProfile	(	_.Library.Integer	pDomainId,
		_.Library.Integer	pProfileId,
		_.Library.Status	pSC
	)

static

Utility method to instantiate a Matching Profile. If passed a negative integer for

pProfileId, it will look for a namespace-wide Matching Profile (which means <property>DomainId</property> is 0), otherwise it will take look in the domain specified through pDomainId. If pProfileId is empty, the default profile for this domain will be returned.

This is the recommended way of instantiating a <class>iKnow.Matching.MatchingProfile</class> object.

◆ GetProfileByName()

_.iKnow.Matching.MatchingProfile GetProfileByName	(	_.Library.Integer	pDomainId,
		_.Library.String	pName,
		_.Library.Status	pSC
	)

static

Looks up a Matching Profile by name in the domain identified by pDomainId (or.

in the set of cross-domain profiles if pDomainId = 0). pName should be a nonempty string and can be prepended with the domain ID to look into (overriding the value of pDomainId), separated by a colon. This allows configuration settings to refer to a particular Matching Profile with a single string. Matching Profiles without a name cannot be looked up through this method and should be looked up by ID using <method>GetProfile</method> instead.

Member Data Documentation

◆ CrcTotalMultiplier

CrcTotalMultiplier

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

◆ DisorderMultiplier

DisorderMultiplier

This multiplier is applied to the aggregate match score for a CRC, path or sentence.

if the matched entities appear in a different order than in the dictionary term.

◆ DomainId

DomainId

The domain ID this Matching Profile is associated with.

When 0, this profile can be

used across the namespace.

◆ 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

A name for this profile.

This name should be unique within the domain (case-insensitive)

and cannot contain colons. For backwards compatibility, empty names are permitted, but these profiles cannot be retrieved with <method>GetProfileByName</method>

◆ 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.

◆ ProfileId

ProfileId

The ID of this profile.

This will be a negative number for namespace-wide profiles (which

have <property>DomainId</property> = 0).

◆ 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.

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members