This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %iKnow.Objects.DictionaryMatch

%iKnow.Objects.DictionaryMatch

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

SQL Table Name: %iKnow_Objects.DictionaryMatch

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

Property Inventory (Including Private)

Parameters

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.

Properties (Including Private)

property Dictionary as %iKnow.Objects.Dictionary [ Calculated ];
Property methods: DictionaryCompute(), DictionaryGet(), DictionaryGetObject(), DictionaryGetObjectId(), DictionaryIdDisplayToLogical(), DictionaryIdGet(), DictionaryIdIsValid(), DictionaryIdLogicalToDisplay(), DictionaryIdNormalize(), DictionaryIdSet(), DictionaryItemCompute(), DictionaryItemGet(), DictionaryItemGetObject(), DictionaryItemGetObjectId(), DictionaryItemIdDisplayToLogical(), DictionaryItemIdGet(), DictionaryItemIdIsValid(), DictionaryItemIdLogicalToDisplay(), DictionaryItemIdNormalize(), DictionaryItemIdSet(), DictionaryItemSQLCompute(), DictionaryMatchIdDisplayToLogical(), DictionaryMatchIdGet(), DictionaryMatchIdIsValid(), DictionaryMatchIdLogicalToDisplay(), DictionaryMatchIdNormalize(), DictionaryMatchIdSet(), DictionarySQLCompute(), DictionaryTermCompute(), DictionaryTermGet(), DictionaryTermGetObject(), DictionaryTermGetObjectId(), DictionaryTermIdDisplayToLogical(), DictionaryTermIdGet(), DictionaryTermIdIsValid(), DictionaryTermIdLogicalToDisplay(), DictionaryTermIdNormalize(), DictionaryTermIdSet(), DictionaryTermSQLCompute()
property DictionaryId as %Integer;
Property methods: DictionaryIdDisplayToLogical(), DictionaryIdGet(), DictionaryIdIsValid(), DictionaryIdLogicalToDisplay(), DictionaryIdNormalize(), DictionaryIdSet()
property DictionaryItem as %iKnow.Objects.DictionaryItem [ Calculated ];
Property methods: DictionaryItemCompute(), DictionaryItemGet(), DictionaryItemGetObject(), DictionaryItemGetObjectId(), DictionaryItemIdDisplayToLogical(), DictionaryItemIdGet(), DictionaryItemIdIsValid(), DictionaryItemIdLogicalToDisplay(), DictionaryItemIdNormalize(), DictionaryItemIdSet(), DictionaryItemSQLCompute()
property DictionaryItemId as %Integer;
Property methods: DictionaryItemIdDisplayToLogical(), DictionaryItemIdGet(), DictionaryItemIdIsValid(), DictionaryItemIdLogicalToDisplay(), DictionaryItemIdNormalize(), DictionaryItemIdSet()
property DictionaryMatchId as %Integer [ Required ];
Property methods: DictionaryMatchIdDisplayToLogical(), DictionaryMatchIdGet(), DictionaryMatchIdIsValid(), DictionaryMatchIdLogicalToDisplay(), DictionaryMatchIdNormalize(), DictionaryMatchIdSet()
property DictionaryTerm as %iKnow.Objects.DictionaryTerm [ Calculated ];
Property methods: DictionaryTermCompute(), DictionaryTermGet(), DictionaryTermGetObject(), DictionaryTermGetObjectId(), DictionaryTermIdDisplayToLogical(), DictionaryTermIdGet(), DictionaryTermIdIsValid(), DictionaryTermIdLogicalToDisplay(), DictionaryTermIdNormalize(), DictionaryTermIdSet(), DictionaryTermSQLCompute()
property DictionaryTermId as %Integer;
Property methods: DictionaryTermIdDisplayToLogical(), DictionaryTermIdGet(), DictionaryTermIdIsValid(), DictionaryTermIdLogicalToDisplay(), DictionaryTermIdNormalize(), DictionaryTermIdSet()
property DomainId as %Integer [ Required ];
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()
property FirstMatchedPositionInPath as %Integer;
Property methods: FirstMatchedPositionInPathDisplayToLogical(), FirstMatchedPositionInPathGet(), FirstMatchedPositionInPathIsValid(), FirstMatchedPositionInPathLogicalToDisplay(), FirstMatchedPositionInPathNormalize(), FirstMatchedPositionInPathSet()
property IsOrdered as %Boolean;
Property methods: IsOrderedDisplayToLogical(), IsOrderedGet(), IsOrderedIsValid(), IsOrderedLogicalToDisplay(), IsOrderedNormalize(), IsOrderedSet()
property LastMatchedPositionInPath as %Integer;
Property methods: LastMatchedPositionInPathDisplayToLogical(), LastMatchedPositionInPathGet(), LastMatchedPositionInPathIsValid(), LastMatchedPositionInPathLogicalToDisplay(), LastMatchedPositionInPathNormalize(), LastMatchedPositionInPathSet()
property MatchScore as %Numeric;
Property methods: MatchScoreDisplayToLogical(), MatchScoreGet(), MatchScoreIsValid(), MatchScoreLogicalToDisplay(), MatchScoreNormalize(), MatchScoreSet()
property MatchedConceptCount as %Integer;
Property methods: MatchedConceptCountDisplayToLogical(), MatchedConceptCountGet(), MatchedConceptCountIsValid(), MatchedConceptCountLogicalToDisplay(), MatchedConceptCountNormalize(), MatchedConceptCountSet()
property MatchedCrcOccurrence as %iKnow.Objects.CrcOccurrence [ Calculated ];
Property methods: MatchedCrcOccurrenceCompute(), MatchedCrcOccurrenceGet(), MatchedCrcOccurrenceGetObject(), MatchedCrcOccurrenceGetObjectId(), MatchedCrcOccurrenceSQLCompute()
property MatchedEntityCount as %Integer [ Calculated ];
Property methods: MatchedEntityCountCompute(), MatchedEntityCountDisplayToLogical(), MatchedEntityCountGet(), MatchedEntityCountIsValid(), MatchedEntityCountLogicalToDisplay(), MatchedEntityCountNormalize(), MatchedEntityCountSQLCompute()
property MatchedEntityOccurrence as %iKnow.Objects.EntityOccurrence [ Calculated ];
Property methods: MatchedEntityOccurrenceCompute(), MatchedEntityOccurrenceGet(), MatchedEntityOccurrenceGetObject(), MatchedEntityOccurrenceGetObjectId(), MatchedEntityOccurrenceSQLCompute()
property MatchedPath as %iKnow.Objects.Path [ Calculated ];
Property methods: MatchedPathCompute(), MatchedPathGet(), MatchedPathGetObject(), MatchedPathGetObjectId(), MatchedPathSQLCompute(), MatchedPathSectionLengthCompute(), MatchedPathSectionLengthDisplayToLogical(), MatchedPathSectionLengthGet(), MatchedPathSectionLengthIsValid(), MatchedPathSectionLengthLogicalToDisplay(), MatchedPathSectionLengthNormalize(), MatchedPathSectionLengthSQLCompute()
property MatchedPathSectionLength as %Integer [ Calculated ];
Property methods: MatchedPathSectionLengthCompute(), MatchedPathSectionLengthDisplayToLogical(), MatchedPathSectionLengthGet(), MatchedPathSectionLengthIsValid(), MatchedPathSectionLengthLogicalToDisplay(), MatchedPathSectionLengthNormalize(), MatchedPathSectionLengthSQLCompute()
property MatchedRelationCount as %Integer;
Property methods: MatchedRelationCountDisplayToLogical(), MatchedRelationCountGet(), MatchedRelationCountIsValid(), MatchedRelationCountLogicalToDisplay(), MatchedRelationCountNormalize(), MatchedRelationCountSet()
property NegatedEntityCount as %Integer;
Property methods: NegatedEntityCountDisplayToLogical(), NegatedEntityCountGet(), NegatedEntityCountIsValid(), NegatedEntityCountLogicalToDisplay(), NegatedEntityCountNormalize(), NegatedEntityCountSet()
property PartialMatchCount as %Integer;
Property methods: PartialMatchCountDisplayToLogical(), PartialMatchCountGet(), PartialMatchCountIsValid(), PartialMatchCountLogicalToDisplay(), PartialMatchCountNormalize(), PartialMatchCountSet()
property Sentence as %iKnow.Objects.Sentence [ Calculated ];
Property methods: SentenceCompute(), SentenceGet(), SentenceGetObject(), SentenceGetObjectId(), SentenceSQLCompute()
property TargetId as %Integer;
Property methods: TargetIdDisplayToLogical(), TargetIdGet(), TargetIdIsValid(), TargetIdLogicalToDisplay(), TargetIdNormalize(), TargetIdSet()
property TargetType as %Integer;
Property methods: TargetTypeDisplayToLogical(), TargetTypeGet(), TargetTypeIsValid(), TargetTypeLogicalToDisplay(), TargetTypeNormalize(), TargetTypeSet(), TargetTypeStringCompute(), TargetTypeStringDisplayToLogical(), TargetTypeStringGet(), TargetTypeStringIsValid(), TargetTypeStringLogicalToDisplay(), TargetTypeStringLogicalToOdbc(), TargetTypeStringNormalize(), TargetTypeStringSQLCompute()
property TargetTypeString as %String [ Calculated ];
Property methods: TargetTypeStringCompute(), TargetTypeStringDisplayToLogical(), TargetTypeStringGet(), TargetTypeStringIsValid(), TargetTypeStringLogicalToDisplay(), TargetTypeStringLogicalToOdbc(), TargetTypeStringNormalize(), TargetTypeStringSQLCompute()

Indexes

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

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheSQLStorage

Maps: 2

FeedbackOpens in a new window