nl.inl.blacklab.indexers.preprocess

Interface Plugin

All Known Subinterfaces:

ConvertPlugin, TagPlugin

All Known Implementing Classes:

ConvertPluginOpenConvert, TagPluginDutchTagger, TagPluginNoop

public interface Plugin

Interface of converting a plugin (including using external services) Only a single instance of a plugin is constructed, so plugins must be threadsafe. A plugin must define a no-argument constructor.

Method Summary

Modifier and Type	Method and Description
static String	configStr(Map<String,String> config, String nodeName) Read a value from our config if present.
String	getDescription()
String	getDisplayName() Return a user-friendly name for this plugin that can be used in messages, etc.
String	getId() Return a globally unique id for this plugin class.
void	init(Map<String,String> config) Initializes the plugin, called once after the initial loading of the class.
boolean	needsConfig() Does this plugin require configuration parameters? If not, the plugin will always be initialized.

Method Detail

configStr

static String configStr(Map<String,String> config,
                        String nodeName)
                 throws PluginException

Read a value from our config if present.

Parameters:

config - root node of our config object

nodeName - node to read

Returns:

the value as a string

Throws:

PluginException - on missing key or null value

getId

String getId()

Return a globally unique id for this plugin class. This ID must be constant across runs and versions.

Returns:

the global identifier for this plugin

getDisplayName

String getDisplayName()

Return a user-friendly name for this plugin that can be used in messages, etc.

Returns:

a user-friendly name for this plugin

getDescription

String getDescription()

init

void init(Map<String,String> config)
   throws PluginException

Initializes the plugin, called once after the initial loading of the class.

Parameters:

config - the config settings for this plugin

Throws:

PluginException

needsConfig

boolean needsConfig()

Does this plugin require configuration parameters? If not, the plugin will always be initialized. If so, it will only be initialized if configuration parameters were specified.

Returns:

true if parameters are required, false if not