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

%iKnow.Model.listGlobal

class %iKnow.Model.listGlobal extends %iKnow.Model.list

Subclass of %iKnow.Model.list dedicated to represent lists for the Global Lister. This class has its own set of properties representing the specific Lister paramaters of the Global Lister and hence is more easy to use than the generic list class. Any <parameter> elements nested within this element will be overwritten with the values specified for the corresponding shorthand attributes.

See also %iKnow.Source.Global.Lister for more details on these Lister Parameters.

Property Inventory (Including Private)

Parameters

parameter XMLNAME = global;
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 (Including Private)

property beginSubscript as %String (MAXLEN = 250);
The subscript to start from (default "")
Property methods: beginSubscriptDisplayToLogical(), beginSubscriptGet(), beginSubscriptIsValid(), beginSubscriptLogicalToDisplay(), beginSubscriptLogicalToOdbc(), beginSubscriptNormalize(), beginSubscriptSet()
property endSubscript as %String (MAXLEN = 250);
End subscript (default "")
Property methods: endSubscriptDisplayToLogical(), endSubscriptGet(), endSubscriptIsValid(), endSubscriptLogicalToDisplay(), endSubscriptLogicalToOdbc(), endSubscriptNormalize(), endSubscriptSet()
property filterCondition as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
If set, this COS expression is called using xecute command for every node visited by the Global Lister. If it returns false, the node is skipped.
Property methods: filterConditionDisplayToLogical(), filterConditionGet(), filterConditionIsValid(), filterConditionLogicalToDisplay(), filterConditionLogicalToOdbc(), filterConditionNormalize(), filterConditionSet()
property globalReference as %String (MAXLEN = 250, XMLPROJECTION = "attribute");
The global containing the data to be indexed.
Property methods: globalReferenceDisplayToLogical(), globalReferenceGet(), globalReferenceIsValid(), globalReferenceLogicalToDisplay(), globalReferenceLogicalToOdbc(), globalReferenceNormalize(), globalReferenceSet()
property globalType as %Integer (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
How the textual data in the global nodes between beginSubscript and endSubscript is stored. Either of the following:
  • 0 - single node (default)
  • 1 - top node has count with subnodes 1..n having data
  • 2 - top node has metadata, subnodes 1..n have data
Property methods: globalTypeDisplayToLogical(), globalTypeGet(), globalTypeIsValid(), globalTypeLogicalToDisplay(), globalTypeNormalize(), globalTypeSet(), globalTypeXSDToLogical()
property listerClass as %String (MAXLEN = 250, XMLPROJECTION = "attribute") [ InitialExpression = "%iKnow.Source.Global.Lister" , ReadOnly ];
Inherited description: The Lister class to use for loading data defined in this list element. This class should extend %iKnow.Source.Lister. The Lister class defined here dictates the contents of the parameters property.
Property methods: listerClassDisplayToLogical(), listerClassGet(), listerClassIsValid(), listerClassLogicalToDisplay(), listerClassLogicalToOdbc(), listerClassNormalize(), listerClassSet()
property metadataFields as %String (MAXLEN = 2000, XMLPROJECTION = "attribute");
For globalType = 2 only, a comma-separated list of metadata fields stored in the top node.
Property methods: metadataFieldsDisplayToLogical(), metadataFieldsGet(), metadataFieldsIsValid(), metadataFieldsLogicalToDisplay(), metadataFieldsLogicalToOdbc(), metadataFieldsNormalize(), metadataFieldsSet()
property separator as %String (MAXLEN = 50, XMLPROJECTION = "attribute");
Separator to add between nodes if globalType is 1 or 2. Defaults to "".
Property methods: separatorDisplayToLogical(), separatorGet(), separatorIsValid(), separatorLogicalToDisplay(), separatorLogicalToOdbc(), separatorNormalize(), separatorSet()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback