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.Source.Temp.Lister

%iKnow.Source.Temp.Lister

Internal Lister implementation working on the temporary structures generated by BufferSource calls from %iKnow.Source.Loader.

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

External ID structure: [LocalRef] (no GroupName)

Lister alias: "TEMP"

Default Processor: %iKnow.Source.Temp.Processor

Method Inventory (Including Private)

Methods (Including Private)

classmethod DefaultProcessor() as %String
method ExpandList(listparams As %List) as %Status
Inherited description:

This method should be overridden by subclasses, implementing how they scan through the particular type of source location or structures they specialize in. The arguments for this method are the same Lister Parameters as those used when issuing the corresponding AddListToBatch() call and are specified and documented by the Lister implementation.

When expanding the list, the Lister should build a "Composite reference": a %List containing the lister ID, the group ID and the local reference for each (candidate) source it found and pass that to either a StoreRef(), StoreTemp() or StoreTempStream() call. Optionally, it can store metadata for each of these refs using the SetMetadataValues() method.

NOTE: This method is used by the iKnow loading frameworkand should never be called by custom code.

classmethod GetAlias() as %String
Inherited description:

This method returns the simple alias for this Lister class, to be prefixed with a colon. If this method returns the empty string, the Lister Reference will start with the full Lister class name rather than this alias (prefixed with a colon)

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window