This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


persistent class %iKnow.Objects.EntityMatch extends %Library.Persistent

SQL Table Name: %iKnow_Objects.EntityMatch

Note: the use of this class is no longer recommended for accessing elements of a specific domain. For those scenarios, %iKnow.Tables.Utils offers a more flexible and customizable way of projecting iKnow domain data to SQL

This is a read-only object representation wrapping the internal iKnow data structures for unique entity-level matches. These are NOT the actual matching results, which are exposed through %iKnow.Objects.DictionaryMatch

This class can be used from Cache ObjectScript or SQL to access a single or small number of entries, but the storage mappings are not meant to support elaborate or complex queries targeting this SQL table.

Please use the predefined queries in %iKnow.Matching.MatchingAPI and other query classes to consult matchig results as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

Property Inventory (Including Private)


parameter READONLY = 1;
Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.


property DictElemId as %Integer [ Required ];
Property methods: DictElemIdDisplayToLogical(), DictElemIdGet(), DictElemIdIsValid(), DictElemIdLogicalToDisplay(), DictElemIdNormalize(), DictElemIdSet()
property DictionaryElement as %iKnow.Objects.DictionaryElement [ Calculated ];
Property methods: DictionaryElementCompute(), DictionaryElementGet(), DictionaryElementGetObject(), DictionaryElementGetObjectId(), DictionaryElementSQLCompute()
property DomainId as %Integer [ Required ];
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()
property EntUniId as %Integer [ Required ];
Property methods: EntUniIdDisplayToLogical(), EntUniIdGet(), EntUniIdIsValid(), EntUniIdLogicalToDisplay(), EntUniIdNormalize(), EntUniIdSet()
property Entity as %iKnow.Objects.EntityUnique [ Calculated ];
Property methods: EntityCompute(), EntityGet(), EntityGetObject(), EntityGetObjectId(), EntitySQLCompute()
property FormatOutput as %String;
Property methods: FormatOutputDisplayToLogical(), FormatOutputGet(), FormatOutputIsValid(), FormatOutputLogicalToDisplay(), FormatOutputLogicalToOdbc(), FormatOutputNormalize(), FormatOutputSet()
property IsScattered as %Boolean;
Property methods: IsScatteredDisplayToLogical(), IsScatteredGet(), IsScatteredIsValid(), IsScatteredLogicalToDisplay(), IsScatteredNormalize(), IsScatteredSet()
property MatchScore as %Numeric;
Property methods: MatchScoreDisplayToLogical(), MatchScoreGet(), MatchScoreIsValid(), MatchScoreLogicalToDisplay(), MatchScoreNormalize(), MatchScoreSet()
property MatchedWordBits as %String;
Property methods: MatchedWordBitsDisplayToLogical(), MatchedWordBitsGet(), MatchedWordBitsIsValid(), MatchedWordBitsLogicalToDisplay(), MatchedWordBitsLogicalToOdbc(), MatchedWordBitsNormalize(), MatchedWordBitsSet()
property MatchedWords as %String [ Calculated ];
Property methods: MatchedWordsCompute(), MatchedWordsDisplayToLogical(), MatchedWordsGet(), MatchedWordsIsValid(), MatchedWordsLogicalToDisplay(), MatchedWordsLogicalToOdbc(), MatchedWordsNormalize(), MatchedWordsSQLCompute()


index (PKINDEX on DomainId,EntUniId,DictElemId) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)


Storage Model: CacheSQLStorage

Maps: 1