marytts.modules

Class JTokeniser

java.lang.Object

marytts.modules.InternalModule

marytts.modules.JTokeniser

All Implemented Interfaces:

MaryModule

Direct Known Subclasses:

JTokeniser, JTokeniser, JTokeniser, JTokeniser, Tokenizer

public class JTokeniser
extends InternalModule

Author:

Marc Schröder

Field Summary

Fields

Modifier and Type	Field and Description
static int	TOKEN_MAXLENGTH

Fields inherited from class marytts.modules.InternalModule

logger, state

Fields inherited from interface marytts.modules.MaryModule

MODULE_OFFLINE, MODULE_RUNNING

Constructor Summary

Constructors

Constructor and Description
JTokeniser()
JTokeniser(Locale locale)
JTokeniser(MaryDataType inputType, MaryDataType outputType, Locale locale)
JTokeniser(String locale)

Method Summary

Methods

Modifier and Type	Method and Description
MaryData	process(MaryData d) Perform this module's processing on abstract "MaryData" input d.
protected void	setTokenizerLanguage(String languageCode) Set the tokenizer language to be different from the Locale of the module.
void	startup() Allow the module to start up, performing whatever is necessary to become operational.

Methods inherited from class marytts.modules.InternalModule

getInputType, getLocale, getOutputType, getState, inputType, name, outputType, powerOnSelfTest, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_MAXLENGTH

public static final int TOKEN_MAXLENGTH

See Also:

Constant Field Values

Constructor Detail

JTokeniser

public JTokeniser()

JTokeniser

public JTokeniser(String locale)

JTokeniser

public JTokeniser(Locale locale)

JTokeniser

public JTokeniser(MaryDataType inputType,
          MaryDataType outputType,
          Locale locale)

Method Detail

setTokenizerLanguage

protected void setTokenizerLanguage(String languageCode)

Set the tokenizer language to be different from the Locale of the module. This can be useful when reusing another language's tokenizer data.

Parameters:

languageCode - the language-code to use, as a two-character string such as "de" or "en".

startup

public void startup()
             throws 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:

Exception - Exception

process

public MaryData process(MaryData d)
                 throws 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

Parameters:

d - d

Returns:

A MaryData object of type outputType() encapsulating the processing result.

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

Throws:

Exception - Exception