public interface IndexLoader extends Loader
It is the responsibility of the loader to properly interpret each index it services by name, version, and provider.
Modifier and Type | Method and Description |
---|---|
void |
clear(AbsoluteCodingSchemeVersionReference ref,
Index index,
boolean async)
Remove index entries for the designated coding scheme.
|
void |
load(AbsoluteCodingSchemeVersionReference ref,
Index index,
boolean stopOnErrors,
boolean async)
Load index entries for the designated coding scheme.
|
void |
rebuild(AbsoluteCodingSchemeVersionReference ref,
Index index,
boolean async)
Force (re)build of index entries for the designated coding scheme.
|
clearLog, getCodingSchemeManifest, getCodingSchemeManifestURI, getCodingSchemeReferences, getLoaderPreferences, getLog, getOntologyFormat, getOptions, getStatus, load, setCodingSchemeManifest, setCodingSchemeManifestURI, setLoaderPreferences, setLoaderPreferences
getDescription, getName, getProvider, getVersion
void clear(AbsoluteCodingSchemeVersionReference ref, Index index, boolean async) throws LBException
ref
- Reference to the target coding scheme. If null, indexes will
be removed for all available content.index
- The index to be cleared. If null or empty, all indexes
controlled by the loader are removed.async
- Flag controlling whether this operation occurs in the calling
thread. If true, the load will occur in a separate
asynchronous process. If false, this method blocks until the
operation completes or fails. Regardless of setting, the
getStatus and getLog calls are used to fetch results.LBInvocationException
LBException
void load(AbsoluteCodingSchemeVersionReference ref, Index index, boolean stopOnErrors, boolean async) throws LBException
ref
- Reference to the target coding scheme. If null, indexes will
be created for all available content.index
- The index to be created. If null or empty, all indexes
controlled by the loader are created.stopOnErrors
- True means stop if any load error is detected. False means
attempt to load what can be loaded if recoverable errors are
encountered.async
- Flag controlling whether this operation occurs in the calling
thread. If true, the load will occur in a separate
asynchronous process. If false, this method blocks until the
operation completes or fails. Regardless of setting, the
getStatus and getLog calls are used to fetch results.LBException
void rebuild(AbsoluteCodingSchemeVersionReference ref, Index index, boolean async) throws LBException
ref
- Reference to the target coding scheme. If null, indexes will
be rebuilt for all available content.index
- The index to be rebuilt. If null or empty, all indexes
controlled by the loader are rebuilt.async
- Flag controlling whether this operation occurs in the calling
thread. If true, the load will occur in a separate
asynchronous process. If false, this method blocks until the
operation completes or fails. Regardless of setting, the
getStatus and getLog calls are used to fetch results.LBException