%iKnow.Source.Listerdeprecatedabstract class %iKnow.Source.Lister
Deprecation note: Direct use of this class is still supported, but it is recommended to use either
Domain Definitions (cf
This is the base class for any Lister implementations. Lister classes are used at the start of the
load process to identify the sources that need to be loaded.
Each Lister implemenation is specifically designed to be able to scan a certain type of source
locations, for example a filesystem for
Each Lister implementation class defines a set of Lister Parameters, specifying how to reach the sources in the particular type of location this Lister class is designed to work with. For a file lister, this would include parameters such as the directory where to look and the type of files to load from that directory. These Lister Parameters are documented by each Lister implementation in its class documentation.
Utility local Loader instance for the
surrogate domain ID for use in IRIS.Temp guaranteed to be unique across namespaces
This callback method is invoked by the
%Newmethod to provide notification that a new instance of an object is being created.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.
Utility method to store a (new) Group Name for this Lister, returning the corresponding ID. If the Group Name already exists for this domain and lister ID, it returns the existing groups ID.
Static version of
This method is used to register a list the Lister implementation will later on scan through as part of the execution of the
%iKnow.Source.LoaderProcessBatch process. This method takes this Lister implementations Lister Parameters as its arguments, as specified in the class documentation of this Lister implementation.
This method will assemble an External ID, starting from the lister ID, group ID and local reference.
The exact implementation of combining the group name and local reference into a full reference is delegated to
BuildFullRefmethod of the specific Lister implementation referenced by the listerId.
This method will, assuming it is called for the appropriate Lister class, build the External ID based on the group name and local reference.
WARNING: this method will throw an error if called from the abstract Lister class, as this combination of groupName and localRef is specific to the Lister implementation class.
This method should be implemented by subclasses, taking into account the Full Reference structure for this particular Lister. It builds the Full Reference based on a Group Name and Local Reference.
Builds a reference for use in $$$IKPSIMPLEEXTIDS domains. Defaults to the Local Ref
This method returns the default
%iKnow.Source.Processorclass to use (without any parameters) if none was registered explicitly through calls to SetProcessor . By default, this selects (if it exists) a class called Processor in the same package as this Lister implementation, but subclasses might wish to override this and hardcode a specific default Processor to use.
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
AddListToBatchcall 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, StoreTempor StoreTempStreamcall. Optionally, it can store metadata for each of these refs using the SetMetadataValuesmethod.
NOTE: This method is used by the iKnow loading frameworkand should never be called by custom code.
Utility method to format the parameter string passed in AddList for display by the %iKnow.Source.Loader.GetCurrentLists() method. Defaults to $lts() but should be overridden to nicen up complex datatypes in the parameter list.
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)
This utility method provides the prefix that is prepended to the Full Reference
Utility method to retrieve the group ID corresponding to a partiular Group Name, for a given domain and lister ID, or zero when the group name is not recognized.
Utility method to retrieve the Group Name corresponding to a particular group ID, for a given domain and lister ID. An error is passed through the sc output parameter if no group was found for this ID.
Shorthand method invoking
SetConfig, SetProcessorand SetConverterin one call. A Lister can be re-initialized between calls to AddListToBatchor ProcessList, resulting in different settings to be used for the respective lists.
Wrapper method to process a single List in one call. This method instantiates a
%iKnow.Source.Loaderobject, registers itself with it and then calls the ProcessList methodon the Loader with the supplied parameters.
This method takes the Lister Parameters for this particular Lister implementation.
ProcessList, but sources will be added as Virtual Sources.
Basic method to check if a given reference exists already in the domain, which can be used in the Lister process to take appropriate action, such as skipping this particular ref or raising an error. If checkStaging is set to 1, it will also loop through the sources listed so far (by
ExpandListcalls) to see if there is no name conflict with these either.
Registers fixed metadata values pValues for the metadata fields in pKeys, for all sources to be listed as part of the next
ProcessListor AddListToBatchcalls, until the next call to RegistereFixedMetadata. The keys and values in pKeys and pValues should correspond positionally.
The entries in the supplied %List have to be existing metadata field names for the current domain, otherwise they will be ignored.
Internal method. Allows explicitly updating the current metadata list to ensure new values for fixed fields are picked up.
Utility method to report failures for a given source (identified through a Composite Ref)
Utility method to report warnings for a given source (identified through a Composite Ref)
BDB304 - Reset the current ref, to be run after Loader.ProcessList()
%iKnow.Source.Configurationname to use when indexing sources from from the lists registered through AddListToBatchor ProcessListcalls onwards. Using this method to set a different Configuration between two AddListToBatchcalls will not impact any lists already registered in earlier calls.
%iKnow.Source.Converterclass and parameters to use when indexing sources from from the lists registered through AddListToBatchor ProcessListcalls onwards. Using this method to set a different Converter between two AddListToBatchcalls will not impact any lists already registered in earlier calls.
Stores the supplied metadata values for the source being listed identified by ref. The values in metavalues should correspond positionally to the metadata field names passed in the most recent call to
RegisterMetadataKeysfor this Lister instance.
%iKnow.Source.Processorclass and parameters to use when indexing sources from from the lists registered through AddListToBatchor ProcessListcalls onwards. Using this method to set a different Processor between two AddListToBatchcalls will not impact any lists already registered in earlier calls.
This method will split a complete External ID into the lister reference, group name and local reference and return the corresponding lister ID, group ID and local reference.
The exact implementation of splitting the full reference into a group name and local reference is delegated to
SplitFullRefmethod of the specific Lister implementation as referenced by the lister reference, which is the first part of the full External ID.
This method should be implemented by subclasses, taking into account the Full Reference structure for this particular Lister implementation. It derives the Group Name and Local Reference from the supplied Full Reference.
Stores the supplied reference for a source to be processed.
Stores the supplied reference for a source to be loaded, along with the sources contents passed in through 'data' as a
%Stringto be processed by %iKnow.Source.Temp.Processor(make sure it is set using SetProcessorat runtime or DefaultProcessoras the overall default!).
This method can be called with the same ref multiple times, which will append the
%Stringdata passed in.
Stores the supplied reference for a source to be loaded, along with the sources contents passed in through 'data' in the form of a
%Stream.GlobalCharacterto be processed by %iKnow.Source.Temp.Processor.
This method is called at the start of
ProcessListand AddListToBatchto validate the supplied Lister Parameters. Subclasses should override this method to execute the validation logic specific to their Lister Parameters.