marytts.config

Class MaryConfig

java.lang.Object

marytts.config.MaryConfig

Direct Known Subclasses:

LanguageConfig, MainConfig, SynthesisConfig, VoiceConfig

public abstract class MaryConfig
extends Object

Author:

marc

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MaryConfig(InputStream propertyStream)

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkConsistency() This method will try to check that the available configs are consistent and will spot obvious reasons why they might not work together as a full system.
static int	countConfigs()
static int	countLanguageConfigs()
static int	countVoiceConfigs()
static AllophoneSet	getAllophoneSet(Locale locale) Get the allophone set for the given locale, or null if it cannot be retrieved.
static Iterable<MaryConfig>	getConfigs()
static LanguageConfig	getLanguageConfig(Locale locale)
static Iterable<LanguageConfig>	getLanguageConfigs()
List<String>	getList(String propertyName) For the given property name, return the value of that property as a list of items (interpreting the property value as a space-separated list).
static MaryConfig	getMainConfig()
Properties	getProperties()
PropertiesAccessor	getPropertiesAccessor(boolean systemPropertiesOverride) Convenience access to this config's properties.
String	getProperty(String property, String defaultValue) Get the given property.
static VoiceConfig	getVoiceConfig(String voiceName) Get the voice config for the given voice name, or null if there is no such voice config.
static Iterable<VoiceConfig>	getVoiceConfigs()
boolean	isLanguageConfig()
boolean	isMainConfig()
boolean	isSynthesisConfig()
boolean	isVoiceConfig()

Methods inherited from class java.lang.Object

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

Constructor Detail

MaryConfig

protected MaryConfig(InputStream propertyStream)
              throws MaryConfigurationException

Throws:

MaryConfigurationException

Method Detail

checkConsistency

public static void checkConsistency()
                             throws MaryConfigurationException

This method will try to check that the available configs are consistent and will spot obvious reasons why they might not work together as a full system. Reasons that are detected include:

• There is no main config;
• There is a voice with a certain locale but no language component has that locale.

This method will return allright if everything is OK; if there is a problem, it will throw an Exception with a message indicating the problem.

Throws:

MaryConfigurationException - if the configuration cannot work as it is now.

countConfigs

public static int countConfigs()

countLanguageConfigs

public static int countLanguageConfigs()

countVoiceConfigs

public static int countVoiceConfigs()

getMainConfig

public static MaryConfig getMainConfig()

getLanguageConfigs

public static Iterable<LanguageConfig> getLanguageConfigs()

getVoiceConfigs

public static Iterable<VoiceConfig> getVoiceConfigs()

getLanguageConfig

public static LanguageConfig getLanguageConfig(Locale locale)

getVoiceConfig

public static VoiceConfig getVoiceConfig(String voiceName)

Get the voice config for the given voice name, or null if there is no such voice config.

Parameters:

voiceName - voiceName

Returns:

vc if vc.getName().equals(voiceName), null otherwise

getConfigs

public static Iterable<MaryConfig> getConfigs()

getAllophoneSet

public static AllophoneSet getAllophoneSet(Locale locale)
                                    throws MaryConfigurationException

Get the allophone set for the given locale, or null if it cannot be retrieved.

Parameters:

locale - locale

Returns:

the allophone set for the given locale, or null of the locale is not supported.

Throws:

MaryConfigurationException - if the locale is supported in principle but no allophone set can be retrieved.

isMainConfig

public boolean isMainConfig()

isLanguageConfig

public boolean isLanguageConfig()

isVoiceConfig

public boolean isVoiceConfig()

isSynthesisConfig

public boolean isSynthesisConfig()

getProperties

public Properties getProperties()

getPropertiesAccessor

public PropertiesAccessor getPropertiesAccessor(boolean systemPropertiesOverride)

Convenience access to this config's properties.

Parameters:

systemPropertiesOverride - whether to use system properties in priority if they exist. If true, any property requested from this properties accessor will first be looked up in the system properties, and only if it is not defined there, it will be looked up in this config's properties.

Returns:

PropertiesAccessor(props, systemPropertiesOverride, maryBaseMap)

getProperty

public String getProperty(String property,
                 String defaultValue)

Get the given property. If it is not defined, the defaultValue is returned.

Parameters:

property - name of the property to retrieve

defaultValue - value to return if the property is not defined.

Returns:

props.getProperty(property, defaultValue)

getList

public List<String> getList(String propertyName)

For the given property name, return the value of that property as a list of items (interpreting the property value as a space-separated list).

Parameters:

propertyName - propertyName

Returns:

the list of items, or an empty list if the property is not defined or contains no items