marytts.datatypes

Class MaryDataType

java.lang.Object

marytts.datatypes.MaryDataType

Direct Known Subclasses:

MaryDataTypeWithParams

public class MaryDataType
extends Object

A representation of the data types available as input/output of (partial) processing. List the data types available as input/output of (partial) processing. Provide static interfaces for obtaining a given data type.

Author:

Marc Schröder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaryDataType.Traits

Field Summary

Fields

Modifier and Type	Field and Description
static MaryDataType	ACOUSTPARAMS
static MaryDataType	ALLOPHONES
static MaryDataType	APML
static MaryDataType	AUDIO
static MaryDataType.Traits	BINARY
static MaryDataType	DURATIONS
static MaryDataType	EMOTIONML
static MaryDataType.Traits	EXTERNAL_MARKUP
static MaryDataType	FESTIVAL_UTT
static MaryDataType	HALFPHONE_TARGETFEATURES
static MaryDataType	HTSCONTEXT
static MaryDataType	INTONATION
static MaryDataType.Traits	MARYXML
static MaryDataType	PARTSOFSPEECH
static MaryDataType	PHONEMES
static MaryDataType.Traits	PLAIN_TEXT
static MaryDataType	PRAAT_TEXTGRID
static MaryDataType	RAWMARYXML
static MaryDataType	REALISED_ACOUSTPARAMS
static MaryDataType	REALISED_DURATIONS
static MaryDataType	SABLE
static MaryDataType	SIMPLEPHONEMES
static MaryDataType	SSML
static MaryDataType	TARGETFEATURES
static MaryDataType	TEXT
static MaryDataType	TOKENS
static MaryDataType.Traits	UTTERANCES
static MaryDataType	WORDS

Constructor Summary

Constructors

Constructor and Description
MaryDataType(String name, boolean isInputType, boolean isOutputType, MaryDataType.Traits traits)
MaryDataType(String name, boolean isInputType, boolean isOutputType, MaryDataType.Traits traits, String rootElement)

Method Summary

Methods

Modifier and Type	Method and Description
String	endMarker()
String	exampleText(Locale locale) Provide an example text for this data type, for the given locale, if one is available.
static MaryDataType	get(String name) Look up a data type by name.
static List<MaryDataType>	getDataTypes() Provide a list of known data types, i.e.
static String	getExampleText(MaryDataType type, Locale locale) Get an example text for the given type and the given locale.
static List<MaryDataType>	getInputTypes() Provide the list of all registered data types that can be used as input.
static Vector<String>	getInputTypeStrings() Provide the names of all registered data types that can be used as input.
static List<MaryDataType>	getOutputTypes() Provide the list of all registered data types that can be used as output.
static Vector<String>	getOutputTypeStrings() Provide the names of all registered data types that can be used as output.
static boolean	getRegistrationComplete() Determine whether or not the registration is complete.
protected MaryDataType.Traits	getTraits()
boolean	isInputType()
boolean	isMaryXML()
boolean	isOutputType()
boolean	isTextType()
boolean	isXMLType()
String	name()
static void	registerDataType(MaryDataType type)
String	rootElement()
static void	setRegistrationComplete() Indicate that the registration is now complete.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PLAIN_TEXT

public static final MaryDataType.Traits PLAIN_TEXT

EXTERNAL_MARKUP

public static final MaryDataType.Traits EXTERNAL_MARKUP

MARYXML

public static final MaryDataType.Traits MARYXML

UTTERANCES

public static final MaryDataType.Traits UTTERANCES

BINARY

public static final MaryDataType.Traits BINARY

ACOUSTPARAMS

public static final MaryDataType ACOUSTPARAMS

ALLOPHONES

public static final MaryDataType ALLOPHONES

APML

public static final MaryDataType APML

AUDIO

public static final MaryDataType AUDIO

DURATIONS

public static final MaryDataType DURATIONS

EMOTIONML

public static final MaryDataType EMOTIONML

FESTIVAL_UTT

public static final MaryDataType FESTIVAL_UTT

HALFPHONE_TARGETFEATURES

public static final MaryDataType HALFPHONE_TARGETFEATURES

HTSCONTEXT

public static final MaryDataType HTSCONTEXT

INTONATION

public static final MaryDataType INTONATION

PARTSOFSPEECH

public static final MaryDataType PARTSOFSPEECH

PHONEMES

public static final MaryDataType PHONEMES

PRAAT_TEXTGRID

public static final MaryDataType PRAAT_TEXTGRID

RAWMARYXML

public static final MaryDataType RAWMARYXML

REALISED_ACOUSTPARAMS

public static final MaryDataType REALISED_ACOUSTPARAMS

REALISED_DURATIONS

public static final MaryDataType REALISED_DURATIONS

SABLE

public static final MaryDataType SABLE

SIMPLEPHONEMES

public static final MaryDataType SIMPLEPHONEMES

SSML

public static final MaryDataType SSML

TARGETFEATURES

public static final MaryDataType TARGETFEATURES

TEXT

public static final MaryDataType TEXT

TOKENS

public static final MaryDataType TOKENS

WORDS

public static final MaryDataType WORDS

Constructor Detail

MaryDataType

public MaryDataType(String name,
            boolean isInputType,
            boolean isOutputType,
            MaryDataType.Traits traits)

MaryDataType

public MaryDataType(String name,
            boolean isInputType,
            boolean isOutputType,
            MaryDataType.Traits traits,
            String rootElement)

Method Detail

name

public String name()

isInputType

public boolean isInputType()

isOutputType

public boolean isOutputType()

isTextType

public boolean isTextType()

isXMLType

public boolean isXMLType()

isMaryXML

public boolean isMaryXML()

rootElement

public String rootElement()

endMarker

public String endMarker()

exampleText

public String exampleText(Locale locale)

Provide an example text for this data type, for the given locale, if one is available.

Parameters:

locale - locale

Returns:

an example text string, or null if none could be obtained.

toString

public String toString()

Overrides:

toString in class Object

getTraits

protected MaryDataType.Traits getTraits()

registerDataType

public static void registerDataType(MaryDataType type)

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.

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.

getInputTypeStrings

public static Vector<String> getInputTypeStrings()

Provide the names of all registered data types that can be used as input.

Returns:

a vector containing the string names of data types.

Throws:

IllegalStateException - if this method is called while registration is ongoing.

getOutputTypeStrings

public static Vector<String> getOutputTypeStrings()

Provide the names of all registered data types that can be used as output.

Returns:

a vector containing the string names of data types.

Throws:

IllegalStateException - if this method is called while registration is ongoing.

getInputTypes

public static List<MaryDataType> getInputTypes()

Provide the list of all registered data types that can be used as input.

Returns:

a list containing data types.

Throws:

IllegalStateException - if this method is called while registration is ongoing.

getOutputTypes

public static List<MaryDataType> getOutputTypes()

Provide the list of all registered data types that can be used as output.

Returns:

a list containing data types.

Throws:

IllegalStateException - if this method is called while registration is ongoing.

get

public static MaryDataType get(String name)

Look up a data type by name.

Parameters:

name - the name of the data type

Returns:

the requested data type, or null if there is no known data type with the given name

getDataTypes

public static List<MaryDataType> getDataTypes()

Provide a list of known data types, i.e. of data types used by any of the known modules, partially sorted in the order of processing.

Returns:

a list of all known data types

getExampleText

public static String getExampleText(MaryDataType type,
                    Locale locale)

Get an example text for the given type and the given locale.

Parameters:

type - type

locale - locale

Returns:

an example text suitable for type and locale, or null if none is available.