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


class %iKnow.Model.dictionary extends %iKnow.Model.node

Model representation of a Dictionary to be used for matching. See also %iKnow.Matching.DictionaryAPI

Property Inventory (Including Private)

Method Inventory (Including Private)


property description as %String (MAXLEN = 1000, XMLPROJECTION = "ATTRIBUTE");
An optional description for this Dictionary.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property disabled as %Boolean (XMLPROJECTION = "attribute");
If set to 1, this element is ignored when compiling, validating and building the domain
Property methods: disabledDisplayToLogical(), disabledGet(), disabledIsValid(), disabledLogicalToDisplay(), disabledLogicalToXSD(), disabledNormalize(), disabledSet(), disabledXSDToLogical()
relationship items as array of %iKnow.Model.dictionaryItem (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%iKnow.Model.dictionaryItem","dictionary",+$this,"many",0,0) , Transient , Inverse = dictionary , Cardinality = many ];
The Dictionary Items registered in this Dictionary
Property methods: itemsGet(), itemsGetObject(), itemsGetObjectId(), itemsGetSwizzled(), itemsIsEmpty(), itemsIsValid(), itemsNewObject(), itemsRClose(), itemsRExec(), itemsRFetch(), itemsRelate(), itemsSQLCompute(), itemsSet(), itemsUnRelate()
property language as %String (MAXLEN = 10, XMLPROJECTION = "ATTRIBUTE");
The default language items and terms in this Dictionary are expressed in.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
relationship matching as %iKnow.Model.matching (XMLPROJECTION = "none") [ Inverse = dictionaries , Cardinality = one ];
Link to the <matching> element this dictionary belongs to.
Property methods: matchingGet(), matchingGetObject(), matchingGetObjectId(), matchingGetSwizzled(), matchingIsValid(), matchingNewObject(), matchingRClose(), matchingRExec(), matchingRFetch(), matchingRelate(), matchingSQLCompute(), matchingSet(), matchingUnRelate()
property name as %String (MAXLEN = 150, XMLPROJECTION = "ATTRIBUTE");
A name for this Dictionary. A dictionary name should be unique within the domain.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property profile as %String (MAXLEN = 150, XMLPROJECTION = "ATTRIBUTE");
The Matching profile to be used for matching terms in this dictionary. See also %iKnow.Model.matchingProfile. Leave blank to use the default.
Property methods: profileDisplayToLogical(), profileGet(), profileIsValid(), profileLogicalToDisplay(), profileLogicalToOdbc(), profileNormalize(), profileSet()


method %Validate(pDomainId As %Integer, pDomainDefinition As %iKnow.Model.domain) as %Status

Inherited Members

Inherited Methods (Including Private)