nl.inl.blacklab.indexers.preprocess

Class TagPluginNoop

java.lang.Object

nl.inl.blacklab.indexers.preprocess.TagPluginNoop

All Implemented Interfaces:

Plugin, TagPlugin

public class TagPluginNoop
extends Object
implements TagPlugin

Constructor Summary

Constructors

Constructor and Description
TagPluginNoop()

Method Summary

Modifier and Type	Method and Description
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.
String	getInputFormat() Get the name of the format this plugin can tag.
String	getOutputFileName(String inputFileName) Unfortunate side-effect of docIndexers requiring a filename to do their work.
String	getOutputFormatIdentifier() Get the name of the format this plugin tags into.
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.
void	perform(Reader reader, Writer writer) Perform on a text file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nl.inl.blacklab.indexers.preprocess.Plugin

configStr

Constructor Detail

TagPluginNoop

public TagPluginNoop()

Method Detail

needsConfig

public boolean needsConfig()

Description copied from interface: Plugin

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.

Specified by:

needsConfig in interface Plugin

Returns:

true if parameters are required, false if not

getId

public String getId()

Description copied from interface: Plugin

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

Specified by:

getId in interface Plugin

Returns:

the global identifier for this plugin

getDisplayName

public String getDisplayName()

Description copied from interface: Plugin

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

Specified by:

getDisplayName in interface Plugin

Returns:

a user-friendly name for this plugin

getDescription

public String getDescription()

Specified by:

getDescription in interface Plugin

init

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

Description copied from interface: Plugin

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

Specified by:

init in interface Plugin

Parameters:

config - the config settings for this plugin

Throws:

PluginException

getInputFormat

public String getInputFormat()

Description copied from interface: TagPlugin

Get the name of the format this plugin can tag. Should be as descriptive as possible (e.g. just "xml" is not exact enough, because xml can mean different things based on the contents of the file, so instead use "folia" or "tei", or whatever contents the file happens to have). see ConvertPlugin.getOutputFormat().

Specified by:

getInputFormat in interface TagPlugin

Returns:

the format this convertplugin outputs.

getOutputFormatIdentifier

public String getOutputFormatIdentifier()

Description copied from interface: TagPlugin

Get the name of the format this plugin tags into. This should match a DocIndexerFactory.Format so that the tagged data can then be indexed by a DocIndexer

Specified by:

getOutputFormatIdentifier in interface TagPlugin

Returns:

the formatIdentifier

getOutputFileName

public String getOutputFileName(String inputFileName)

Description copied from interface: TagPlugin

Unfortunate side-effect of docIndexers requiring a filename to do their work.

Specified by:

getOutputFileName in interface TagPlugin

Returns:

a valid file name for an indexable file of the type as returned by TagPlugin.getOutputFormatIdentifier()

perform

public void perform(Reader reader,
                    Writer writer)
             throws PluginException

Description copied from interface: TagPlugin

Perform on a text file.

Specified by:

perform in interface TagPlugin

Parameters:

reader - input. Should not be closed by the implementation.

writer - output. Should not be closed by the implementation.

Throws:

PluginException