Class Reference
IRIS for UNIX 2024.1.2
|
|
Private
Storage
|
Deprecation note: Direct use of this class is still supported, but it is recommended to use either
Domain Definitions (cf
This class coordinates the loading process.
For Batch Loading, use the
For Direct Loading, register a
For Direct Text Loading, you can simply queue
With both Direct Loading options, the IDs of the sources added in the last execution are
available through
|
|
Properties |
---|
DomainId |
|
|
Lines up the data supplied to this method to be indexed as a new source with the provided reference in a subsequent call to
ProcessBuffer orProcessVirtualBuffer .Multiple calls to this method using the same ref before calling the Process* method, will result in the data being appended to what was previously buffered for that ref. All buffering and processing operations should happen within the same process.
This method clears any data supplied so far through calls to
BufferSource
Clears the logs, as directed by the boolean parameters.
Deletes all Virtual Sources associated with this domain.
This method deletes a single source from the domain, including all its entity and CRC occurrences, sentences and paths. Unique entities and CRCs occurring in this source will have their frequency and spread updated.
If there's any metadata or matching results associated with this source, it will also be deleted.
This method deletes a single Virtual Source from the domain, including all its entity and CRC occurrences, sentences and paths.
This method returns all the data currently in the buffer, as entered through calls to
BufferSource , since the last call toProcessBuffer orClearBuffer . Data is returned in a two-level array structure:pBuffer(reference) = numberOfEntries
pBuffer(reference, n) = data
Simple utility method to retrieve an overview of all Lists as currently scheduled through AddListToBatch calls on
%iKnow.Source.Lister objects for this Loaders domain.
Returns all logged errors for this domain. By default only the errors logged since this Loader object's last load operation are returned, unless the returnAll parameter is set to 1. The returned result contains the following columns:
- Error message
- Location: indication of the class and method where the error occurred
- Timestamp: in $horolog format
Returns all logged source failures for this domain. By default only the failures logged since this Loader object's last load operation are returned, unless the returnAll parameter is set to 1. The returned result contains the following columns:
- Composite reference: elements used to generate the external ID (in case it didn't get generated)
- External ID
- Location: indication of the class and method where the error occurred
- Error message
- Internal error ID: Contact WRC if this is a positive integer.
- Timestamp: in $horolog format
This method returns the Source IDs of the sources created in the last call to
ProcessList ,ProcessBuffer ,ProcessVirtualList orProcessVirtualBuffer .
Returns all logged warnings for this domain. By default only the warnings logged since this Loader object's last load operation are returned, unless the returnAll parameter is set to 1. The returned result contains the following columns:
- Composite reference: elements used to generate the external ID (in case it didn't get generated)
- External ID
- Location: indication of the class and method where the error occurred
- Error message
- Timestamp: in $horolog format
args(1) = number of sources. args(2) = the status global to log the process for LoadSources. args(3) = the time to queue work into the queue.
This is the primary method for starting a Batch Load. When executed, this method will first go through the lists registered through AddListToBatch() calls on
%iKnow.Source.Lister objects and call their ExpandList() method to get a complete list of all the sources to index. Then, it will instantiate the appropriate%iKnow.Source.Processor objects to read their contents and forward it to the iKnow engine (optionally through a%iKnow.Source.Converter instance). Finally, it will invoke the ^%iKnow.BuildGlobals routine to transform the output of the iKnow engine into the persistent domain data structures.
Indexes all data buffered within this process through previous calls to
BufferSource using the Direct Loading approach. This includes callingSetLister with a%iKnow.Source.Temp.Lister instance and initiating the Direct Load throughProcessList . The buffer is cleaned automatically at the end of successfully processing the data.After this method has finished, the generated source IDs can be retrieved through
GetSourceIds .
This method initiates a Direct Load, indexing the sources identified by the Lister registered with
SetLister . The Lister Parameters passed as listargs to this method should correspond in type and number to what the currently registered Lister expects as its (implementation-specific) Lister Parameters.All operations will execute within the current process and therefore has superior performance over Batch Loading when used for small numbers of sources.
After this method has finished, the generated source IDs can be retrieved through
GetSourceIds .
Same As ProcessBuffer
, but buffered sources will be added as Virtual Sources.
Same As
ProcessList , but listed sources will be added as Virtual Sources.
This method resets the internal globals used during the load process.
This call registers the supplied
%iKnow.Source.Lister object to be used for Direct Loading by subsequent calls toProcessList .The supplied Lister object should be fully configured, but cannot have any lists already scheduled for it (through calls to its AddListToBatch method).