Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%iKnow] >  [Objects] >  [DictionaryMatch]
Private  Storage   

persistent class %iKnow.Objects.DictionaryMatch extends %Persistent

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

This class can be used from 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 Dictionary Match data as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 25 2


%Concurrency Dictionary DictionaryId DictionaryItem
DictionaryItemId DictionaryMatchId DictionaryTerm DictionaryTermId
DomainId FirstMatchedPositionInPath IsOrdered LastMatchedPositionInPath
MatchScore MatchedConceptCount MatchedCrcOccurrence MatchedEntityCount
MatchedEntityOccurrence MatchedPath MatchedPathSectionLength MatchedRelationCount
NegatedEntityCount PartialMatchCount Sentence TargetId
TargetType TargetTypeString

%%OIDGet %1Check %AddJrnObjToSyncSet %AddToSaveSet
%AddToSyncSet %BMEBuilt %BindExport %BuildIndices
%BuildIndicesAsync %BuildIndicesAsyncResponse %BuildObjectGraph %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %Close
%ComposeOid %ConstructClone %Delete %DeleteExtent
%DeleteId %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DowngradeConcurrency %ExecuteAfterTriggers %ExecuteBeforeTriggers %Exists
%ExistsId %Extends %FileIndices %GUID
%GUIDSet %GetLock %GetParameter %GetSwizzleObject
%Id %IncrementCount %IsA %IsModified
%IsNull %JournalObject %KillExtent %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PurgeIndices %Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %SQLAcquireLock %SQLAcquireTableLock %SQLAfterTriggers
%SQLBeforeTriggers %SQLBuildIndices %SQLBuildPurgeIndexForRow %SQLBuildPurgeIndices
%SQLCheckUnique %SQLCheckUniqueIndices %SQLCheckUniqueKeys %SQLCopyIcolIntoName
%SQLCopyNameIntoIcol %SQLCreateInsDelTables %SQLDefineiDjVars %SQLDelete
%SQLDeleteChildren %SQLDeleteTempStreams %SQLEExit %SQLExists
%SQLFKeyDelLock %SQLFastInsert %SQLFieldValidate %SQLGetLock
%SQLGetOld %SQLGetOldAll %SQLGetOldIndex %SQLInsert
%SQLInsertComputes %SQLInsertStreams %SQLInvalid %SQLInvalid2
%SQLMVDelete %SQLMVIndexDelete %SQLMVIndexInsert %SQLMVIndexUpdate
%SQLMVInsert %SQLMVUpdate %SQLMissing %SQLNormalizeCompFields
%SQLNormalizeFields %SQLPurgeIndices %SQLQuickBulkInsert %SQLQuickBulkLoad
%SQLQuickBulkSave %SQLQuickBulkUpdate %SQLQuickDelete %SQLQuickDeleteChildren
%SQLQuickFindPKeyByRowID %SQLQuickFindRowIDByPKey %SQLQuickInsert %SQLQuickLoad
%SQLQuickLoadChildren %SQLQuickLogicalToOdbc %SQLQuickOdbcToLogical %SQLQuickUpdate
%SQLReleaseLock %SQLReleaseTableLock %SQLStorageValidation %SQLTrigDelTab
%SQLTrigInsTab %SQLUnlock %SQLUnlock2 %SQLUnlockError
%SQLUnlockRef %SQLUpdate %SQLUpdateComputes %SQLUpdateStreams
%SQLValidateCompFields %SQLValidateFields %SQLicompView %SQLnBuild
%Save %SaveDirect %SaveIndices %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %UpgradeConcurrency
%ValidateIndices %ValidateObject


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


• property Dictionary as %iKnow.Objects.Dictionary [ Calculated ];
• property DictionaryId as %Integer;
• property DictionaryItem as %iKnow.Objects.DictionaryItem [ Calculated ];
• property DictionaryItemId as %Integer;
• property DictionaryMatchId as %Integer;
• property DictionaryTerm as %iKnow.Objects.DictionaryTerm [ Calculated ];
• property DictionaryTermId as %Integer;
• property DomainId as %Integer;
• property FirstMatchedPositionInPath as %Integer;
• property IsOrdered as %Boolean;
• property LastMatchedPositionInPath as %Integer;
• property MatchScore as %Numeric;
• property MatchedConceptCount as %Integer;
• property MatchedCrcOccurrence as %iKnow.Objects.CrcOccurrence [ Calculated ];
• property MatchedEntityCount as %Integer [ Calculated ];
• property MatchedEntityOccurrence as %iKnow.Objects.EntityOccurrence [ Calculated ];
• property MatchedPath as %iKnow.Objects.Path [ Calculated ];
• property MatchedPathSectionLength as %Integer [ Calculated ];
• property MatchedRelationCount as %Integer;
• property NegatedEntityCount as %Integer;
• property PartialMatchCount as %Integer;
• property Sentence as %iKnow.Objects.Sentence [ Calculated ];
• property TargetId as %Integer;
• property TargetType as %Integer;
• property TargetTypeString as %String [ Calculated ];


•index (DictItemIndex on DomainId,DictionaryItemId);
•index (PKINDEX on DomainId,DictionaryMatchId) [IdKey,PrimaryKey,Unique];

Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.