marytts.client

Class MaryFormData

java.lang.Object

marytts.client.MaryFormData

public class MaryFormData
extends Object

This class nests all the information and functions that a Mary client needs to receive/send data from/to server. To be able to use the functionality provided by this class, all Mary clients should either: (i) extend this class (Example: MaryHttpClient, MaryWebHttpClient) (ii) use an object of type MaryHttpForm or of a derived class (Example: MaryGUIClient)

Author:

Oytun Türk

Field Summary

Fields

Modifier and Type	Field and Description
Vector<MaryClient.DataType>	allDataTypes
Vector<MaryClient.Voice>	allVoices
Map<String,String>	audioEffectHelpTextsMap
String	audioEffects
String	audioEffectsHelpTextLineBreak
Vector<String>	audioFileFormatTypes
int	audioFormatSelected
int	audioOutSelected
Vector<String>	audioOutTypes
String	currentExampleText
AudioEffectsBoxData	effectsBoxData
String	errorMessage
Address	hostAddress
Vector<MaryClient.DataType>	inputDataTypes
String	inputText
int	inputTypeSelected
boolean	isOutputText
Map<String,String>	keyValuePairs
Vector<String>	limitedDomainExampleTexts
int	limitedDomainExampleTextSelected
Map<String,Vector<String>>	limitedDomainVoices
Set<Locale>	locales
String	mimeType
String	outputAudioResponseID
Vector<MaryClient.DataType>	outputDataTypes
String	outputText
int	outputTypeSelected
boolean	serverCanStream
Map<String,String>	serverExampleTexts
String	serverVersionInfo
String	serverVersionNo
Map<String,String>	voiceExampleTextsGeneralDomain
Map<String,Vector<String>>	voiceExampleTextsLimitedDomain
Map<Locale,Vector<MaryClient.Voice>>	voicesByLocaleMap
int	voiceSelected

Constructor Summary

Constructors

Constructor and Description
MaryFormData()
MaryFormData(Address serverAddress)
MaryFormData(Address serverAddress, Map<String,String> keyValuePairsIn, String versionIn, String voicesIn, String dataTypesIn, String audioFileFormatTypesIn, String audioEffectHelpTextLineBreakIn, String defaultAudioEffects, Vector<String> defaultVoiceExampleTexts)
MaryFormData(Address serverAddress, String versionIn, String voicesIn, String dataTypesIn, String audioFileFormatTypesIn, String audioEffectHelpTextLineBreakIn, String defaultAudioEffects, Vector<String> defaultVoiceExampleTexts)

Method Summary

Modifier and Type	Method and Description
void	checkAndCorrectSelections()
void	init(Address serverAddress, Map<String,String> keyValuePairsIn, String versionIn, String voicesIn, String dataTypesIn, String audioFileFormatTypesIn, String audioEffectHelpTextLineBreakIn, String defaultAudioEffects, Vector<String> defaultVoiceExampleTexts)
boolean	isServerVersionAtLeast(String serverVersionToCompare)
static Locale	string2locale(String localeString) This helper method converts a string (e.g., "en_US") into a proper Locale object.
void	toAudioEffects(String availableAudioEffects)
void	toAudioEffectsHelpTextLineBreak(String strLineBreak)
void	toAudioFileFormatAndOutTypes(String info)
void	toDataTypes(String info)
void	toLocales(String info)
void	toServerVersionInfo(String info)
void	toVoices(String info)

Methods inherited from class java.lang.Object

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

Field Detail

hostAddress

public Address hostAddress

serverVersionInfo

public String serverVersionInfo

serverVersionNo

public String serverVersionNo

serverCanStream

public boolean serverCanStream

allVoices

public Vector<MaryClient.Voice> allVoices

voicesByLocaleMap

public Map<Locale,Vector<MaryClient.Voice>> voicesByLocaleMap

limitedDomainVoices

public Map<String,Vector<String>> limitedDomainVoices

locales

public Set<Locale> locales

allDataTypes

public Vector<MaryClient.DataType> allDataTypes

inputDataTypes

public Vector<MaryClient.DataType> inputDataTypes

outputDataTypes

public Vector<MaryClient.DataType> outputDataTypes

serverExampleTexts

public Map<String,String> serverExampleTexts

currentExampleText

public String currentExampleText

voiceExampleTextsLimitedDomain

public Map<String,Vector<String>> voiceExampleTextsLimitedDomain

voiceExampleTextsGeneralDomain

public Map<String,String> voiceExampleTextsGeneralDomain

audioEffectHelpTextsMap

public Map<String,String> audioEffectHelpTextsMap

audioFileFormatTypes

public Vector<String> audioFileFormatTypes

audioOutTypes

public Vector<String> audioOutTypes

inputText

public String inputText

outputText

public String outputText

errorMessage

public String errorMessage

isOutputText

public boolean isOutputText

voiceSelected

public int voiceSelected

inputTypeSelected

public int inputTypeSelected

outputTypeSelected

public int outputTypeSelected

audioFormatSelected

public int audioFormatSelected

audioOutSelected

public int audioOutSelected

limitedDomainExampleTextSelected

public int limitedDomainExampleTextSelected

audioEffects

public String audioEffects

audioEffectsHelpTextLineBreak

public String audioEffectsHelpTextLineBreak

effectsBoxData

public AudioEffectsBoxData effectsBoxData

limitedDomainExampleTexts

public Vector<String> limitedDomainExampleTexts

keyValuePairs

public Map<String,String> keyValuePairs

outputAudioResponseID

public String outputAudioResponseID

mimeType

public String mimeType

Constructor Detail

MaryFormData

public MaryFormData()

MaryFormData

public MaryFormData(Address serverAddress)

MaryFormData

public MaryFormData(Address serverAddress,
                    String versionIn,
                    String voicesIn,
                    String dataTypesIn,
                    String audioFileFormatTypesIn,
                    String audioEffectHelpTextLineBreakIn,
                    String defaultAudioEffects,
                    Vector<String> defaultVoiceExampleTexts)

MaryFormData

public MaryFormData(Address serverAddress,
                    Map<String,String> keyValuePairsIn,
                    String versionIn,
                    String voicesIn,
                    String dataTypesIn,
                    String audioFileFormatTypesIn,
                    String audioEffectHelpTextLineBreakIn,
                    String defaultAudioEffects,
                    Vector<String> defaultVoiceExampleTexts)

Method Detail

init

public void init(Address serverAddress,
                 Map<String,String> keyValuePairsIn,
                 String versionIn,
                 String voicesIn,
                 String dataTypesIn,
                 String audioFileFormatTypesIn,
                 String audioEffectHelpTextLineBreakIn,
                 String defaultAudioEffects,
                 Vector<String> defaultVoiceExampleTexts)

toServerVersionInfo

public void toServerVersionInfo(String info)

toVoices

public void toVoices(String info)

toDataTypes

public void toDataTypes(String info)

toLocales

public void toLocales(String info)

toAudioFileFormatAndOutTypes

public void toAudioFileFormatAndOutTypes(String info)

toAudioEffectsHelpTextLineBreak

public void toAudioEffectsHelpTextLineBreak(String strLineBreak)

toAudioEffects

public void toAudioEffects(String availableAudioEffects)

isServerVersionAtLeast

public boolean isServerVersionAtLeast(String serverVersionToCompare)

checkAndCorrectSelections

public void checkAndCorrectSelections()

string2locale

public static Locale string2locale(String localeString)

This helper method converts a string (e.g., "en_US") into a proper Locale object.

Parameters:

localeString - a string representation of the locale

Returns:

a Locale object.