marytts.modules

Class ModuleRegistry

java.lang.Object

marytts.modules.ModuleRegistry

public class ModuleRegistry
extends Object

A hierarchical repository for Mary modules, allowing the flexible indexing by an ordered hierarchy of datatype, locale and voice. A given lookup will search for a combination of datatype, locale and voice first; if it does not find a value, it will look for datatype, locale, and null; if it does notfind that, it will look for datatype, null, and null.

Author:

marc

Method Summary

Methods

Modifier and Type	Method and Description
static List<MaryModule>	getAllModules() Provide a list containing all MaryModules instances.
static MaryModule	getModule(Class<?> moduleClass) Find an active module by its class.
static List<MaryModule>	getPreferredModulesForInputType(MaryDataType wanted_input_type) Provide a list containing preferred modules for the specified input type
static boolean	getRegistrationComplete() Determine whether or not the registration is complete.
static MaryModule	instantiateModule(String moduleInitInfo) From the given module init info, instantiate a new mary module.
static LinkedList<MaryModule>	modulesRequiredForProcessing(MaryDataType sourceType, MaryDataType targetType, Locale locale) A method for determining the list of modules required to transform the given source data type into the requested target data type.
static LinkedList<MaryModule>	modulesRequiredForProcessing(MaryDataType sourceType, MaryDataType targetType, Locale locale, Voice voice) A method for determining the list of modules required to transform the given source data type into the requested target data type.
static void	registerModule(MaryModule module, Locale locale, Voice voice) Register a MaryModule as an appropriate module to process the given combination of MaryDataType for the input data, locale of the input data, and voice requested for processing.
static void	setRegistrationComplete() Indicate that the registration is now complete.

Methods inherited from class java.lang.Object

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

Method Detail

instantiateModule

public static MaryModule instantiateModule(String moduleInitInfo)
                                    throws MaryConfigurationException

From the given module init info, instantiate a new mary module.

Parameters:

moduleInitInfo - a string description of the module to instantiate. The moduleInitInfo is expected to have one of the following forms:

1. my.class.which.extends.MaryModule
2. my.class.which.extends.MaryModule(any,string,args,without,spaces)
3. my.class.which.extends.MaryModule(arguments,$my.special.property,other,args)

where 'my.special.property' is a property in the property file.

Returns:

m

Throws:

MaryConfigurationException - if the module cannot be instantiated

registerModule

public static void registerModule(MaryModule module,
                  Locale locale,
                  Voice voice)
                           throws IllegalStateException

Register a MaryModule as an appropriate module to process the given combination of MaryDataType for the input data, locale of the input data, and voice requested for processing. Note that it is possible to register more than one module for a given combination of input type, locale and voice; in that case, all of them will be remembered, and will be returned as a List by get().

Parameters:

module - the module to add to the registry, under its input type and the given locale and voice.

locale - the locale (language or language-COUNTRY) of the input data; can be null to signal that the module is locale-independent.

voice - a voice for which this module is suited. Can be null to indicate that the module is not specific to any voice.

Throws:

IllegalStateException - if called after registration is complete.

getRegistrationComplete

public static boolean getRegistrationComplete()

Determine whether or not the registration is complete. When the registration is not (yet) complete, calls to

Returns:

false when the registration is still open, true when it is complete.

See Also:

are possible; when the registration is complete, calls to the other methods are possible.

setRegistrationComplete

public static void setRegistrationComplete()
                                    throws IllegalStateException

Indicate that the registration is now complete. No further calls to registerModules() will be possible.

Throws:

IllegalStateException - if called when registration was already completed before.

getPreferredModulesForInputType

public static List<MaryModule> getPreferredModulesForInputType(MaryDataType wanted_input_type)

Provide a list containing preferred modules for the specified input type

Parameters:

wanted_input_type - the specified input type

Returns:

the list of system wide preferred modules, null if none

getAllModules

public static List<MaryModule> getAllModules()

Provide a list containing all MaryModules instances. The order is not important.

Returns:

Collections.unmodifiableList(allModules)

Throws:

IllegalStateException - if called while registration is not yet complete.

getModule

public static MaryModule getModule(Class<?> moduleClass)

Find an active module by its class.

Parameters:

moduleClass - moduleClass

Returns:

the module instance if found, or null if not found.

Throws:

IllegalStateException - if called while registration is not yet complete.

modulesRequiredForProcessing

public static LinkedList<MaryModule> modulesRequiredForProcessing(MaryDataType sourceType,
                                                  MaryDataType targetType,
                                                  Locale locale)

A method for determining the list of modules required to transform the given source data type into the requested target data type.

Parameters:

sourceType - sourceType

targetType - targetType

locale - locale

Returns:

the (ordered) list of modules required, or null if no such list could be found.

Throws:

IllegalStateException - if called while registration is not yet complete.

NullPointerException - if source data type, target data type or locale is null.

modulesRequiredForProcessing

public static LinkedList<MaryModule> modulesRequiredForProcessing(MaryDataType sourceType,
                                                  MaryDataType targetType,
                                                  Locale locale,
                                                  Voice voice)

A method for determining the list of modules required to transform the given source data type into the requested target data type. If the voice given is not null, any preferred modules it may have are taken into account.

Parameters:

sourceType - sourceType

targetType - target type

locale - locale

voice - voice

Returns:

the (ordered) list of modules required, or null if no such list could be found.

Throws:

IllegalStateException - if called while registration is not yet complete.

NullPointerException - if source data type, target data type or locale is null.