This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).

%iKnow.Source.Global.Lister

class %iKnow.Source.Global.Lister extends %iKnow.Source.Lister

Lister implementation for retrieving sources directly from globals.

Lister Parameters to be supplied to AddListToBatch() and ProcessList() calls:

  1. globalref As %String - global reference where data is stored
  2. begsub As %String - beginning subscript (if not "")
  3. endsub As %String - ending subscript (default "")
  4. filter As %String - default "", $xecute expression, passed current subscript returns non-zero if this location needs to be processed

External ID structure: [GroupName]:[LocalRef]

Lister alias: "GLOBAL"

Default Processor: %iKnow.Source.Global.Processor

Method Inventory (Including Private)

Methods (Including Private)

private classmethod BuildFullRef(domainId As %Integer, groupName As %String, localRef As %String) as %String

Builds the full reference making a global reference with $NAME.

See also BuildFullRef() in %iKnow.Source.Lister.

method ExpandList(listparams As %List) as %Status

Scans through the global nodes as dictated by the Lister Parameters. No metadata is gathered along the way.

See also ExpandList in %iKnow.Source.Lister.

classmethod GetAlias() as %String

Lister alias: "GLOBAL"

private classmethod SplitFullRef(domainId As %Integer, fullRef As %String, Output groupName As %String, Output localRef As %String) as %Status

Splits the full reference in group name and local reference. The group name is the global reference, and the local reference is the final subscript.

See also SplitFullRef() in %iKnow.Source.Lister.

method TestParams(listerParams...) as %Status

Tests performed by this Lister:

  1. globalref: checks whether a vald global ref (but does not check global existence)
  2. begsub: no checks
  3. endsub: no checks
  4. filter: if nonempty, checks whether this is a valid expression for $xecute() with two parameters

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window