marytts.datatypes

Class MaryData

java.lang.Object

marytts.datatypes.MaryData

public class MaryData
extends Object

A representation of any type of mary data, be it input, intermediate or output data. The "technical" representation of the read data is hidden from the caller, but can be accessed on request. Internally, the data is appropriately represented according to this data's type, i.e. as a String containing plain text, an XML DOM tree, or an input stream containing audio data.

Author:

Marc Schröder

Constructor Summary

Constructors

Constructor and Description
MaryData(MaryDataType type, Locale locale)
MaryData(MaryDataType type, Locale locale, boolean createStubDocument)

Method Summary

Methods

Modifier and Type	Method and Description
void	append(MaryData md)
void	appendAudio(AudioInputStream audioToAppend) For audio data, append more audio data to the one currently present.
AudioInputStream	getAudio()
AudioFileFormat	getAudioFileFormat()
Object	getData()
String	getDefaultEffects()
String	getDefaultStyle()
Voice	getDefaultVoice()
Document	getDocument()
Locale	getLocale()
String	getOutputParams()
String	getPlainText()
MaryDataType	getType()
boolean	getValidating()
boolean	getWarnClient() Deprecated.
void	readFrom(InputStream is) Read data from input stream is, in the appropriate way as determined by our type.
void	readFrom(InputStream is, String endMarker) Read data from input stream is, in the appropriate way as determined by our type.
void	readFrom(Reader from) Read data from reader r in the appropriate way as determined by our type.
void	readFrom(Reader from, String endMarker) Read data from reader r in the appropriate way as determined by our type.
void	setAudio(AudioInputStream audio) Set the audio data.
void	setAudioFileFormat(AudioFileFormat audioFileFormat) The audio file format is required only for data types serving as input to modules producing AUDIO data (e.g., MBROLA data), as well as for the AUDIO data itself.
void	setData(String dataString) Set the content data of this MaryData object from the given String.
void	setDefaultEffects(String effects)
void	setDefaultStyle(String style)
void	setDefaultVoice(Voice voice)
void	setDocument(Document xmlDocument)
void	setOutputParams(String params)
void	setPlainText(String plainText)
void	setValidating(boolean doValidate)
void	setWarnClient(boolean doWarnClient) Deprecated.
String	toString()
void	writeTo(OutputStream os) Write our internal representation to output stream os, in the appropriate way as determined by our type.
void	writeTo(Writer w) Write our internal representation to writer w, in the appropriate way as determined by our type.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaryData

public MaryData(MaryDataType type,
        Locale locale)

MaryData

public MaryData(MaryDataType type,
        Locale locale,
        boolean createStubDocument)

Method Detail

getValidating

public boolean getValidating()

setValidating

public void setValidating(boolean doValidate)
                   throws ParserConfigurationException

Throws:

ParserConfigurationException

getWarnClient

@Deprecated
public boolean getWarnClient()

Deprecated.

setWarnClient

@Deprecated
public void setWarnClient(boolean doWarnClient)

Deprecated.

getType

public MaryDataType getType()

getLocale

public Locale getLocale()

readFrom

public void readFrom(InputStream is)
              throws ParserConfigurationException,
                     SAXException,
                     IOException,
                     TransformerConfigurationException,
                     TransformerException

Read data from input stream is, in the appropriate way as determined by our type.

Parameters:

is - is

Throws:

ParserConfigurationException - ParserConfigurationException

SAXException - SAXException

IOException - IOException

TransformerConfigurationException - TransformerConfigurationException

TransformerException - TransformerException

readFrom

public void readFrom(InputStream is,
            String endMarker)
              throws ParserConfigurationException,
                     SAXException,
                     IOException,
                     TransformerConfigurationException,
                     TransformerException

Read data from input stream is, in the appropriate way as determined by our type.

Parameters:

is - the InputStream from which to read.

endMarker - a string marking end of file. If this is null, read until end-of-file; if it is non-null, read up to (and including) the first line containing the end marker string. This will be ignored for audio data.

Throws:

ParserConfigurationException - ParserConfigurationException

SAXException - SAXException

IOException - IOException

TransformerConfigurationException - TransformerConfigurationException

TransformerException - TransformerException

readFrom

public void readFrom(Reader from)
              throws ParserConfigurationException,
                     SAXException,
                     IOException

Read data from reader r in the appropriate way as determined by our type. Only XML and Text data can be read from a reader, audio data cannot.

Parameters:

from - from

Throws:

ParserConfigurationException - ParserConfigurationException

SAXException - SAXException

IOException - IOException

readFrom

public void readFrom(Reader from,
            String endMarker)
              throws ParserConfigurationException,
                     SAXException,
                     IOException

Read data from reader r in the appropriate way as determined by our type. Only XML and Text data can be read from a reader, audio data cannot. "Helpers" needed to read the data, such as XML parser objects, are created when they are needed. If doWarnClient is set to true, warning and error messages related to XML parsing are logged to the log category connected to the client from which this request originated.

Parameters:

from - the Reader from which to read.

endMarker - a string marking end of file. If this is null, read until end-of-file; if it is non-null, read up to (and including) the first line containing the end marker string.

Throws:

ParserConfigurationException - ParserConfigurationException

SAXException - SAXException

IOException - IOException

setData

public void setData(String dataString)
             throws ParserConfigurationException,
                    SAXException,
                    IOException

Set the content data of this MaryData object from the given String. For XML data (MaryDataType.isXMLType()), parse the String representation of the data into a DOM tree.

Parameters:

dataString - string representation of the input data.

Throws:

ParserConfigurationException - ParserConfigurationException

IOException - IOException

SAXException - SAXException

IllegalArgumentException - if this method is called for MaryDataTypes that are neither text nor XML.

writeTo

public void writeTo(OutputStream os)
             throws TransformerConfigurationException,
                    FileNotFoundException,
                    TransformerException,
                    IOException,
                    Exception

Write our internal representation to output stream os, in the appropriate way as determined by our type.

Parameters:

os - os

Throws:

TransformerConfigurationException - TransformerConfigurationException

FileNotFoundException - FileNotFoundException

TransformerException - TransformerException

IOException - IOException

Exception - Exception

writeTo

public void writeTo(Writer w)
             throws TransformerConfigurationException,
                    FileNotFoundException,
                    TransformerException,
                    IOException,
                    Exception

Write our internal representation to writer w, in the appropriate way as determined by our type. Only XML and Text data can be written to a writer, audio data cannot. "Helpers" needed to read the data, such as XML parser objects, are created when they are needed.

Parameters:

w - w

Throws:

TransformerConfigurationException - TransformerConfigurationException

FileNotFoundException - FileNotFoundException

TransformerException - TransformerException

IOException - IOException

Exception - Exception

getData

public Object getData()

getPlainText

public String getPlainText()

setPlainText

public void setPlainText(String plainText)

getDocument

public Document getDocument()

setDocument

public void setDocument(Document xmlDocument)

getAudio

public AudioInputStream getAudio()

setAudio

public void setAudio(AudioInputStream audio)

Set the audio data. This will discard any previously set audio data. If audio data is to be appended, consider appendAudio().

Parameters:

audio - audio

setDefaultVoice

public void setDefaultVoice(Voice voice)

getDefaultVoice

public Voice getDefaultVoice()

setDefaultStyle

public void setDefaultStyle(String style)

getDefaultStyle

public String getDefaultStyle()

setDefaultEffects

public void setDefaultEffects(String effects)

getDefaultEffects

public String getDefaultEffects()

setAudioFileFormat

public void setAudioFileFormat(AudioFileFormat audioFileFormat)

The audio file format is required only for data types serving as input to modules producing AUDIO data (e.g., MBROLA data), as well as for the AUDIO data itself. It should be set by the calling code before passing the data to the module producing AUDIO data.

Parameters:

audioFileFormat - audioFileFormat

getAudioFileFormat

public AudioFileFormat getAudioFileFormat()

append

public void append(MaryData md)

appendAudio

public void appendAudio(AudioInputStream audioToAppend)

For audio data, append more audio data to the one currently present. If no audio data is set yet, this call is equivalent to setAudio().

Parameters:

audioToAppend - the new audio data to append

setOutputParams

public void setOutputParams(String params)

getOutputParams

public String getOutputParams()

toString

public String toString()

Overrides:

toString in class Object