%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]

• GroupName = globalref passed to lister
• LocalRef = final subscript

Lister alias: "GLOBAL"

Default Processor: %iKnow.Source.Global.Processor

Method Inventory (Including Private)

• BuildFullRef()
• ExpandList()
• GetAlias()
• SplitFullRef()
• TestParams()

Methods (Including Private)Copy link to this section

private classmethod BuildFullRef(domainId As %Integer, groupName As %String, localRef As %String) as %String [ Language = objectscript ] Copy link to this section

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

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

method ExpandList(listparams As %List) as %Status [ Language = objectscript ] Copy link to this section

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 [ Language = objectscript ] Copy link to this section

Lister alias: "GLOBAL"

private classmethod SplitFullRef(domainId As %Integer, fullRef As %String, Output groupName As %String, Output localRef As %String) as %Status [ Language = objectscript ] Copy link to this section

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 [ Language = objectscript ] Copy link to this section

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 MembersCopy link to this section

Inherited Properties (Including Private)

• Configuration
• ConfigurationId
• ConvParams
• Converter
• ConverterId
• CurrentRef
• DomainId
• ListId
• ListerClassId
• Processor
• ProcessorId
• ProcessorParams
• TempId

Inherited Methods (Including Private)

• %AddToSaveSet()
• %ClassIsLatestVersion()
• %ClassName()
• %ConstructClone()
• %ConstructCloneInit()
• %DispatchClassMethod()
• %DispatchGetModified()
• %DispatchGetProperty()
• %DispatchMethod()
• %DispatchSetModified()
• %DispatchSetMultidimProperty()
• %DispatchSetProperty()
• %Extends()
• %GetParameter()
• %IsA()
• %IsModified()
• %New()
• %NormalizeObject()
• %ObjectModified()
• %OnAddToSaveSet()
• %OnClose()
• %OnConstructClone()
• %OnNew()
• %OnValidateObject()
• %OriginalNamespace()
• %PackageName()
• %RemoveFromSaveSet()
• %SerializeObject()
• %SetModified()
• %ValidateObject()
• AddGroup()
• AddListToBatch()
• BuildExtId()
• BuildExtIdFromName()
• DefaultProcessor()
• FormatParams()
• GetExtidPrefix()
• GetGroupId()
• GetGroupName()
• Init()
• ProcessList()
• ProcessVirtualList()
• RefExists()
• RegisterFixedMetadata()
• RegisterMetadataKeys()
• ReportError()
• ReportWarning()
• SetConfig()
• SetConverter()
• SetMetadataValues()
• SetProcessor()
• SplitExtId()
• StoreRef()
• StoreTemp()
• StoreTempStream()