org.jvoicexml.implementation
Class SpeakableSsmlText

java.lang.Object
  org.jvoicexml.implementation.SpeakableSsmlText

All Implemented Interfaces:

SpeakableText

public final class SpeakableSsmlText
extends Object
implements SpeakableText

Text to be passed to the TTS engine. This text may contain SSML markups, as defined in http://www.w3.org/TR/2003/CR-speech-synthesis-20031218/.

Since:

0.4

Version:

$LastChangedRevision: 122 $

Copyright © 2006 JVoiceXML group - http://jvoicexml.sourceforge.net/

Author:

Dirk Schnelle

Constructor Summary

SpeakableSsmlText(SsmlDocument doc)
Constructs a new object.

Method Summary

SpeakableText	appendSpeakableText(String str) Appends the given text to this speakable.
SsmlDocument	getDocument() Retrieves the SSML document to speak.
String	getSpeakableText() Retrieves the text to be passed to the TTS Engine.
boolean	isSpeakableTextEmpty() Checks if this speakable contains any text to be passed to the TTS engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeakableSsmlText

public SpeakableSsmlText(SsmlDocument doc)

Constructs a new object.

Parameters:

doc - The SSML document to speak.

Method Detail

getSpeakableText

public String getSpeakableText()

Retrieves the text to be passed to the TTS Engine.

Specified by:

getSpeakableText in interface SpeakableText

Returns:

Text to be spoken.

getDocument

public SsmlDocument getDocument()

Retrieves the SSML document to speak.

Returns:

SSML document to speak.

Since:

0.5

appendSpeakableText

public SpeakableText appendSpeakableText(String str)

Appends the given text to this speakable.

Specified by:

appendSpeakableText in interface SpeakableText

Parameters:

str - Text to be appended.

Returns:

This object.

isSpeakableTextEmpty

public boolean isSpeakableTextEmpty()

Checks if this speakable contains any text to be passed to the TTS engine.

Specified by:

isSpeakableTextEmpty in interface SpeakableText

Returns:

true if this speakable contains text.