rita.support
Class RiUtteranceTokenizer

java.lang.Object
  rita.support.RiUtteranceTokenizer

All Implemented Interfaces:

com.sun.speech.freetts.Tokenizer

public class RiUtteranceTokenizer
extends java.lang.Object
implements com.sun.speech.freetts.Tokenizer

Field Summary

static java.lang.String	DEFAULT_POSTPUNCTUATION_SYMBOLS A string containing the default post-punctuation characters.
static java.lang.String	DEFAULT_PREPUNCTUATION_SYMBOLS A string containing the default pre-punctuation characters.
static java.lang.String	DEFAULT_SINGLE_CHAR_SYMBOLS A string containing the default single characters.
static java.lang.String	DEFAULT_WHITESPACE_SYMBOLS A string containing the default whitespace characters.
static int	EOF A constant indicating that the end of the stream has been read.

Constructor Summary

RiUtteranceTokenizer()
Constructs a Tokenizer.

RiUtteranceTokenizer(java.io.Reader file)
Creates a tokenizer that will return tokens from the given file.

RiUtteranceTokenizer(java.lang.String string)
Creates a tokenizer that will return tokens from the given string.

Method Summary

java.lang.String	getErrorDescription() if hasErrors returns true, this will return a description of the error encountered, otherwise it will return null
com.sun.speech.freetts.Token	getNextToken() Returns the next token.
boolean	hasErrors() Returns true if there were errors while reading tokens
boolean	hasMoreTokens() Returns true if there are more tokens, false otherwise.
boolean	isBreak() Determines if the current token should start a new sentence.
void	setInputReader(java.io.Reader reader) Sets the input reader
void	setInputText(java.lang.String inputString) Sets the text to tokenize.
void	setPostpunctuationSymbols(java.lang.String symbols) Sets the postpunctuation symbols of this Tokenizer to the given symbols.
void	setPrepunctuationSymbols(java.lang.String symbols) Sets the prepunctuation symbols of this Tokenizer to the given symbols.
void	setSingleCharSymbols(java.lang.String symbols) Sets the single character symbols of this Tokenizer to the given symbols.
void	setWhitespaceSymbols(java.lang.String symbols) Sets the whitespace symbols of this Tokenizer to the given symbols.

Methods inherited from class java.lang.Object

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

Field Detail

EOF

public static final int EOF

A constant indicating that the end of the stream has been read.

See Also:

Constant Field Values

DEFAULT_WHITESPACE_SYMBOLS

public static final java.lang.String DEFAULT_WHITESPACE_SYMBOLS

A string containing the default whitespace characters.

See Also:

Constant Field Values

DEFAULT_SINGLE_CHAR_SYMBOLS

public static final java.lang.String DEFAULT_SINGLE_CHAR_SYMBOLS

A string containing the default single characters.

See Also:

Constant Field Values

DEFAULT_PREPUNCTUATION_SYMBOLS

public static final java.lang.String DEFAULT_PREPUNCTUATION_SYMBOLS

A string containing the default pre-punctuation characters.

See Also:

Constant Field Values

DEFAULT_POSTPUNCTUATION_SYMBOLS

public static final java.lang.String DEFAULT_POSTPUNCTUATION_SYMBOLS

A string containing the default post-punctuation characters.

See Also:

Constant Field Values

Constructor Detail

RiUtteranceTokenizer

public RiUtteranceTokenizer()

Constructs a Tokenizer.

RiUtteranceTokenizer

public RiUtteranceTokenizer(java.lang.String string)

Creates a tokenizer that will return tokens from the given string.

Parameters:

string - the string to tokenize

RiUtteranceTokenizer

public RiUtteranceTokenizer(java.io.Reader file)

Creates a tokenizer that will return tokens from the given file.

Parameters:

file - where to read the input from

Method Detail

setWhitespaceSymbols

public void setWhitespaceSymbols(java.lang.String symbols)

Sets the whitespace symbols of this Tokenizer to the given symbols.

Specified by:

setWhitespaceSymbols in interface com.sun.speech.freetts.Tokenizer

Parameters:

symbols - the whitespace symbols

setSingleCharSymbols

public void setSingleCharSymbols(java.lang.String symbols)

Sets the single character symbols of this Tokenizer to the given symbols.

Specified by:

setSingleCharSymbols in interface com.sun.speech.freetts.Tokenizer

Parameters:

symbols - the single character symbols

setPrepunctuationSymbols

public void setPrepunctuationSymbols(java.lang.String symbols)

Sets the prepunctuation symbols of this Tokenizer to the given symbols.

Specified by:

setPrepunctuationSymbols in interface com.sun.speech.freetts.Tokenizer

Parameters:

symbols - the prepunctuation symbols

setPostpunctuationSymbols

public void setPostpunctuationSymbols(java.lang.String symbols)

Sets the postpunctuation symbols of this Tokenizer to the given symbols.

Specified by:

setPostpunctuationSymbols in interface com.sun.speech.freetts.Tokenizer

Parameters:

symbols - the postpunctuation symbols

setInputText

public void setInputText(java.lang.String inputString)

Sets the text to tokenize.

Specified by:

setInputText in interface com.sun.speech.freetts.Tokenizer

Parameters:

inputString - the string to tokenize

setInputReader

public void setInputReader(java.io.Reader reader)

Sets the input reader

Specified by:

setInputReader in interface com.sun.speech.freetts.Tokenizer

Parameters:

reader - the input source

getNextToken

public com.sun.speech.freetts.Token getNextToken()

Returns the next token.

Specified by:

getNextToken in interface com.sun.speech.freetts.Tokenizer

Returns:

the next token if it exists, null if no more tokens

hasMoreTokens

public boolean hasMoreTokens()

Returns true if there are more tokens, false otherwise.

Specified by:

hasMoreTokens in interface com.sun.speech.freetts.Tokenizer

Returns:

true if there are more tokens false otherwise

hasErrors

public boolean hasErrors()

Returns true if there were errors while reading tokens

Specified by:

hasErrors in interface com.sun.speech.freetts.Tokenizer

Returns:

true if there were errors; false otherwise

getErrorDescription

public java.lang.String getErrorDescription()

if hasErrors returns true, this will return a description of the error encountered, otherwise it will return null

Specified by:

getErrorDescription in interface com.sun.speech.freetts.Tokenizer

Returns:

a description of the last error that occurred.

isBreak

public boolean isBreak()

Determines if the current token should start a new sentence.

Specified by:

isBreak in interface com.sun.speech.freetts.Tokenizer

Returns:

true if a new sentence should be started