marytts.modules
Class OpenNLPPosTagger

java.lang.Object
  extended by marytts.modules.InternalModule
      extended by marytts.modules.OpenNLPPosTagger
All Implemented Interfaces:
MaryModule

public class OpenNLPPosTagger
extends InternalModule

Part-of-speech tagger using OpenNLP.

Author:
Marc Schröder

Field Summary
 
Fields inherited from class marytts.modules.InternalModule
logger, state
 
Fields inherited from interface marytts.modules.MaryModule
MODULE_OFFLINE, MODULE_RUNNING
 
Constructor Summary
OpenNLPPosTagger(java.lang.String locale, java.lang.String propertyPrefix)
          Constructor which can be directly called from init info in the config file.
 
Method Summary
 MaryData process(MaryData d)
          Perform this module's processing on abstract "MaryData" input d.
 void startup()
          Allow the module to start up, performing whatever is necessary to become operational.
 
Methods inherited from class marytts.modules.InternalModule
getLocale, getState, inputType, name, outputType, powerOnSelfTest, shutdown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OpenNLPPosTagger

public OpenNLPPosTagger(java.lang.String locale,
                        java.lang.String propertyPrefix)
                 throws java.lang.Exception
Constructor which can be directly called from init info in the config file. Different languages can call this code with different settings.

Parameters:
locale - a locale string, e.g. "en"
Throws:
java.lang.Exception
Method Detail

startup

public void startup()
             throws java.lang.Exception
Description copied from interface: MaryModule
Allow the module to start up, performing whatever is necessary to become operational. After successful completion, getState() should return MODULE_RUNNING.

Specified by:
startup in interface MaryModule
Overrides:
startup in class InternalModule
Throws:
java.lang.Exception

process

public MaryData process(MaryData d)
                 throws java.lang.Exception
Description copied from class: InternalModule
Perform this module's processing on abstract "MaryData" input d. Subclasses need to make sure that the process() method is thread-safe, because in server-mode, it will be called from different threads at the same time. A sensible way to do this seems to be not to use any global or static variables, or to use them read-only.

Specified by:
process in interface MaryModule
Overrides:
process in class InternalModule
Returns:
A MaryData object of type outputType() encapsulating the processing result.

This method just returns its input. Subclasses should override this.

Throws:
java.lang.Exception