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.Model.matching


class %iKnow.Model.matching extends %iKnow.Model.node

Model representation of all the dictionary data to be loaded into the iKnow domain (as represented by a %iKnow.Model.domain object).

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property autoExecute as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
Whether or not to automatically match all sources at the end of %Build()
Property methods: autoExecuteDisplayToLogical(), autoExecuteGet(), autoExecuteIsValid(), autoExecuteLogicalToDisplay(), autoExecuteLogicalToXSD(), autoExecuteNormalize(), autoExecuteSet(), autoExecuteXSDToLogical()
property defaultProfile as %String (MAXLEN = 150, XMLPROJECTION = "attribute");
The default matching profile to use in this domain. (this overwrites any $$$IKPMATDEFAULTPROFILE setting at the <domain> level)
Property methods: defaultProfileDisplayToLogical(), defaultProfileGet(), defaultProfileIsValid(), defaultProfileLogicalToDisplay(), defaultProfileLogicalToOdbc(), defaultProfileNormalize(), defaultProfileSet()
relationship dictionaries as array of %iKnow.Model.dictionary (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%iKnow.Model.dictionary","matching",+$this,"many",0,0) , Transient , Inverse = matching , Cardinality = many ];
The list of explicitly specified dictionaries for this domain.
Property methods: dictionariesGet(), dictionariesGetObject(), dictionariesGetObjectId(), dictionariesGetSwizzled(), dictionariesIsEmpty(), dictionariesIsValid(), dictionariesNewObject(), dictionariesRClose(), dictionariesRExec(), dictionariesRFetch(), dictionariesRelate(), dictionariesSQLCompute(), dictionariesSet(), dictionariesUnRelate()
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()
property dropBeforeBuild as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
Whether or not to drop all dictionary data at the start of %Build()
Property methods: dropBeforeBuildDisplayToLogical(), dropBeforeBuildGet(), dropBeforeBuildIsValid(), dropBeforeBuildLogicalToDisplay(), dropBeforeBuildLogicalToXSD(), dropBeforeBuildNormalize(), dropBeforeBuildSet(), dropBeforeBuildXSDToLogical()
relationship external as array of %iKnow.Model.dictionaryExternal (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%iKnow.Model.dictionaryExternal","matching",+$this,"many",0,0) , Transient , Inverse = matching , Cardinality = many ];
The list of externally defined dictionaries for this domain (CSV or query-based).
Property methods: externalGet(), externalGetObject(), externalGetObjectId(), externalGetSwizzled(), externalIsEmpty(), externalIsValid(), externalNewObject(), externalRClose(), externalRExec(), externalRFetch(), externalRelate(), externalSQLCompute(), externalSet(), externalUnRelate()
property ignoreDictionaryErrors as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
If set to true, errors occurring while creating dictionary elements will be ignored
Property methods: ignoreDictionaryErrorsDisplayToLogical(), ignoreDictionaryErrorsGet(), ignoreDictionaryErrorsIsValid(), ignoreDictionaryErrorsLogicalToDisplay(), ignoreDictionaryErrorsLogicalToXSD(), ignoreDictionaryErrorsNormalize(), ignoreDictionaryErrorsSet(), ignoreDictionaryErrorsXSDToLogical()
relationship profiles as array of %iKnow.Model.matchingProfile (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%iKnow.Model.matchingProfile","matching",+$this,"many",0,0) , Transient , Inverse = matching , Cardinality = many ];
Any profiles used by the dictionaries in this domain
Property methods: profilesGet(), profilesGetObject(), profilesGetObjectId(), profilesGetSwizzled(), profilesIsEmpty(), profilesIsValid(), profilesNewObject(), profilesRClose(), profilesRExec(), profilesRFetch(), profilesRelate(), profilesSQLCompute(), profilesSet(), profilesUnRelate()

Methods (Including Private)

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

Inherited Members

Inherited Methods (Including Private)