%iKnow.Model.dictionaryExternalColumn

class %iKnow.Model.dictionaryExternalColumn extends %iKnow.Model.node

Model representation for columns in an external dictionary content source. Each column represents an attribute of the dictionary, item or terms, as specified by the role property.

Property Inventory

external
fixedValue
position
role
stripQuotes

Method Inventory

%Validate()

Parameters

parameter XMLNAME = column;

Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

relationship external as %iKnow.Model.dictionaryExternal (XMLPROJECTION = "none") [ Inverse = columns , Cardinality = one ];

Link to the <matching> element this dictionary belongs to.

Property methods: externalGet(), externalGetObject(), externalGetObjectId(), externalGetSwizzled(), externalIsValid(), externalNewObject(), externalRClose(), externalRExec(), externalRFetch(), externalRelate(), externalSQLCompute(), externalSet(), externalUnRelate()

property fixedValue as %String (XMLPROJECTION = "ATTRIBUTE");

As an alternative to a position within the file or query result set, fixedValue allows hardcoding a particular value.

Property methods: fixedValueDisplayToLogical(), fixedValueGet(), fixedValueIsValid(), fixedValueLogicalToDisplay(), fixedValueLogicalToOdbc(), fixedValueNormalize(), fixedValueSet()

property position as %Integer (XMLPROJECTION = "ATTRIBUTE");

The position of the column in the file or query result set to be loaded

Property methods: positionDisplayToLogical(), positionGet(), positionIsValid(), positionLogicalToDisplay(), positionNormalize(), positionSet(), positionXSDToLogical()

property role as %String (VALUELIST = ",dictionary name,dictionary description,item name,item URI,term,language", XMLPROJECTION = "ATTRIBUTE");

The type of content this <column> contains, to be used for creating dictionary content. Each possible value can only be listed once, with the exception of "term", which can occur any number of times (>0) to simplify adding multiple columns as dictionary terms. The "term", "dictionary name" and "item URI" roles must be supplied for this <external> element to be valid.

Property methods: roleDisplayToLogical(), roleGet(), roleIsValid(), roleLogicalToDisplay(), roleLogicalToOdbc(), roleNormalize(), roleSet()

property stripQuotes as %Boolean (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 1 ];

If referring to a column in a CSV file, this boolean defines whether or not to strip quotes surrounding the actual value of that column.

Property methods: stripQuotesDisplayToLogical(), stripQuotesGet(), stripQuotesIsValid(), stripQuotesLogicalToDisplay(), stripQuotesLogicalToXSD(), stripQuotesNormalize(), stripQuotesSet(), stripQuotesXSDToLogical()

Methods

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