marytts.modules

Class InternalModule

java.lang.Object

marytts.modules.InternalModule

All Implemented Interfaces:

MaryModule

Direct Known Subclasses:

AcousticModeller, APMLParser, CARTDurationModeller, CARTF0Modeller, DummyAllophones2AcoustParams, DummyDuration2AcoustParams, DummyTokens2Words, EmotionmlParser, HMMDurationF0Modeller, HTSEngine, JPhonemiser, JPhonemiser, JTokeniser, KlattDurationModeller, MaryXMLToText, MinimalisticPosTagger, OpenNLPPosTagger, Phonemiser, PolynomialF0Modeller, PraatTextGridGenerator, Preprocess, Preprocess, Preprocess, Preprocess, PronunciationModel, ProsodyGeneric, RealisedAcoustparamsExtractor, RealisedDurationsExtractor, SableParser, SimplePhoneme2AP, SoPDurationModeller, SoPF0Modeller, SSMLParser, Synthesis, SynthesisCallerBase, TargetFeatureLister, TextToMaryXML

public class InternalModule
extends Object
implements MaryModule

A stub implementation of the MaryModule interface as a basis for internal modules.

Any internal module extending this class will need to implement a constructor calling this class's constructor, and override process() in a meaningful way. Care must be taken to make sure the process() method is thread-seafe.

Example for a subclass:

 public class Postlex extends InternalModule {
        public Postlex() {
                super("Postlex", MaryDataType.PHONEMISED, MaryDataType.POSTPROCESSED);
        }
 
        public MaryData process(MaryData d) throws Exception {
                Document doc = d.getDocument();
                mtuPostlex(doc);
                phonologicalRules(doc);
                MaryData result = new MaryData(outputType());
                result.setDocument(doc);
                return result;
        }
 
        private void mtuPostlex(Document doc) {...}
 
        private void phonologicalRules(Document doc) {...}
 }
 

Author:

Marc Schröder

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.log4j.Logger	logger The logger instance to be used by this module.
protected int	state

Fields inherited from interface marytts.modules.MaryModule

MODULE_OFFLINE, MODULE_RUNNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalModule(String name, MaryDataType inputType, MaryDataType outputType, Locale locale)

Method Summary

Methods

Modifier and Type	Method and Description
MaryDataType	getInputType()
Locale	getLocale() The locale of this module, i.e.
MaryDataType	getOutputType()
int	getState() Inform about the state of this module.
MaryDataType	inputType() Deprecated.
String	name() This module's name, as free text, for example "Tokeniser"
MaryDataType	outputType() Deprecated.
void	powerOnSelfTest() Perform a power-on self test by processing some example input data.
MaryData	process(MaryData d) Perform this module's processing on abstract "MaryData" input d.
void	shutdown() Allow the module to shut down cleanly.
void	startup() Allow the module to start up, performing whatever is necessary to become operational.

Methods inherited from class java.lang.Object

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

Field Detail

state

protected int state

logger

protected org.apache.log4j.Logger logger

The logger instance to be used by this module. It will identify the origin of the log message in the log file.

Constructor Detail

InternalModule

protected InternalModule(String name,
              MaryDataType inputType,
              MaryDataType outputType,
              Locale locale)

Method Detail

name

public String name()

Description copied from interface: MaryModule

This module's name, as free text, for example "Tokeniser"

Specified by:

name in interface MaryModule

Returns:

name

inputType

@Deprecated
public MaryDataType inputType()

Deprecated.

Description copied from interface: MaryModule

The type of input data needed by this module.

Specified by:

inputType in interface MaryModule

Returns:

input type

getInputType

public MaryDataType getInputType()

Specified by:

getInputType in interface MaryModule

outputType

@Deprecated
public MaryDataType outputType()

Deprecated.

Description copied from interface: MaryModule

The type of output data produced by this module.

Specified by:

outputType in interface MaryModule

Returns:

outputType

getOutputType

public MaryDataType getOutputType()

Specified by:

getOutputType in interface MaryModule

getLocale

public Locale getLocale()

Description copied from interface: MaryModule

The locale of this module, i.e. the locale of data that this module can process. If null, indicates that the module can use data of any locale (i.e., the module is language-independent.)

Specified by:

getLocale in interface MaryModule

Returns:

the locale of this module, if any, or null

getState

public int getState()

Description copied from interface: MaryModule

Inform about the state of this module.

Specified by:

getState in interface MaryModule

Returns:

an int identifying the state of this module, either MODULE_OFFLINE or MODULE_RUNNING.

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

Throws:

Exception - Exception

powerOnSelfTest

public void powerOnSelfTest()
                     throws Error

Perform a power-on self test by processing some example input data.

Specified by:

powerOnSelfTest in interface MaryModule

Throws:

Error - if the module does not work properly.

shutdown

public void shutdown()

Description copied from interface: MaryModule

Allow the module to shut down cleanly. After this has successfully completed, getState() should return MODULE_OFFLINE.

Specified by:

shutdown in interface MaryModule

process

public MaryData process(MaryData d)
                 throws Exception

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

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