%iKnow.Objects.DictionaryElement

hidden deprecated persistent class %iKnow.Objects.DictionaryElement extends %Library.Persistent

SQL Table Name: %iKnow_Objects.DictionaryElement

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

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

Property Inventory

• Dictionary
• DictionaryElementId
• DictionaryId
• DictionaryTerm
• DictionaryTermId
• DomainId
• MinMatchScore
• NbOfSiblings
• RequiredPosition
• RequiredRole
• StringValue
• Type
• Value

Method Inventory

• ComputeStringValue()
• Open()

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

property Dictionary as %iKnow.Objects.Dictionary [ Calculated ];

Property methods: DictionaryCompute(), DictionaryGet(), DictionaryGetObject(), DictionaryGetObjectId(), DictionarySQLCompute()

property DictionaryElementId as %Integer [ Required ];

Property methods: DictionaryElementIdDisplayToLogical(), DictionaryElementIdGet(), DictionaryElementIdIsValid(), DictionaryElementIdLogicalToDisplay(), DictionaryElementIdNormalize(), DictionaryElementIdSet()

property DictionaryId as %Integer;

Property methods: DictionaryIdDisplayToLogical(), DictionaryIdGet(), DictionaryIdIsValid(), DictionaryIdLogicalToDisplay(), DictionaryIdNormalize(), DictionaryIdSet()

property DictionaryTerm as %iKnow.Objects.DictionaryTerm [ Calculated ];

Property methods: DictionaryTermCompute(), DictionaryTermGet(), DictionaryTermGetObject(), DictionaryTermGetObjectId(), 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 MinMatchScore as %Numeric;

Property methods: MinMatchScoreDisplayToLogical(), MinMatchScoreGet(), MinMatchScoreIsValid(), MinMatchScoreLogicalToDisplay(), MinMatchScoreNormalize(), MinMatchScoreSet()

property NbOfSiblings as %Integer;

Property methods: NbOfSiblingsDisplayToLogical(), NbOfSiblingsGet(), NbOfSiblingsIsValid(), NbOfSiblingsLogicalToDisplay(), NbOfSiblingsNormalize(), NbOfSiblingsSet()

property RequiredPosition as %Integer;

Property methods: RequiredPositionDisplayToLogical(), RequiredPositionGet(), RequiredPositionIsValid(), RequiredPositionLogicalToDisplay(), RequiredPositionNormalize(), RequiredPositionSet()

property RequiredRole as %Integer;

Property methods: RequiredRoleDisplayToLogical(), RequiredRoleGet(), RequiredRoleIsValid(), RequiredRoleLogicalToDisplay(), RequiredRoleNormalize(), RequiredRoleSet()

property StringValue as %String [ Calculated ];

Property methods: StringValueCompute(), StringValueDisplayToLogical(), StringValueGet(), StringValueIsValid(), StringValueLogicalToDisplay(), StringValueLogicalToOdbc(), StringValueNormalize(), StringValueSQLCompute()

property Type as %Integer;

Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeNormalize(), TypeSet()

property Value as %String (MAXLEN = 1000);

Property methods: ValueDisplayToLogical(), ValueGet(), ValueIsValid(), ValueLogicalToDisplay(), ValueLogicalToOdbc(), ValueNormalize(), ValueSet()

Methods

classmethod ComputeStringValue(pDomainId As %Integer, pDEId As %Integer) as %String

classmethod Open(pDomainId As %Integer, pDictionaryElementId As %Integer) as %iKnow.Objects.DictionaryElement

Returns a %iKnow.Objects.DictionaryElement object using the supplied identifiers, resolving negative dictionary Element IDs to the appropriate coordinates for a cross-domain dictionary entry.

Indexes

index (PKINDEX on DomainId,DictionaryElementId) [IdKey, PrimaryKey, Type = key, Unique];

Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()