marytts.util

Class MaryCache

java.lang.Object

marytts.util.MaryCache

public class MaryCache
extends Object

Author:

marc

Constructor Summary

Constructors

Constructor and Description
MaryCache(File cacheFile, boolean clearCache) Create a MaryCache with the given file prefix.

Method Summary

Methods

Modifier and Type	Method and Description
static MaryCache	getCache() Try to get the MaryCache object.
static boolean	haveCache() Indicate whether there is a MaryCache currently available.
void	insertAudio(String inputtype, String locale, String voice, String inputtext, byte[] audio) Insert a record of a MARY request producing data of output type AUDIO into the cache.
void	insertAudio(String inputtype, String locale, String voice, String outputparams, String style, String effects, String inputtext, byte[] audio) Insert a record of a MARY request producing data of output type AUDIO into the cache.
void	insertText(String inputtype, String outputtype, String locale, String voice, String inputtext, String outputtext) Insert a record of a MARY request producing data of type text into the cache.
void	insertText(String inputtype, String outputtype, String locale, String voice, String outputparams, String style, String effects, String inputtext, String outputtext) Insert a record of a MARY request producing data of type text into the cache.
byte[]	lookupAudio(String inputtype, String locale, String voice, String inputtext) Carry out a lookup in the cache with the given parameters, for a request with output type AUDIO.
byte[]	lookupAudio(String inputtype, String locale, String voice, String outputparams, String style, String effects, String inputtext) Carry out a lookup in the cache with the given parameters, for a request with output type AUDIO.
String	lookupText(String inputtype, String outputtype, String locale, String voice, String inputtext) Carry out a lookup in the cache with the given parameters.
String	lookupText(String inputtype, String outputtype, String locale, String voice, String outputparams, String style, String effects, String inputtext) Carry out a lookup in the cache with the given parameters.
static void	main(String[] args)
void	shutdown() Shut down the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaryCache

public MaryCache(File cacheFile,
         boolean clearCache)
          throws ClassNotFoundException,
                 SQLException

Create a MaryCache with the given file prefix. This constructor is public only for tests; it should not normally be called. User code should call getCache() instead. TODO: Find a more elegant way to create a custom MaryCache from test code.

Parameters:

cacheFile - the file name prefix with which to create the cache database.

clearCache - if true, clear the cache; if false, keep it.

Throws:

ClassNotFoundException - if the HSQL JDBC driver is not in the classpath.

SQLException - if the database connection cannot be set up

Method Detail

getCache

public static MaryCache getCache()

Try to get the MaryCache object. This will either return the previously created MaryCache, or if none exists, it will try to create one.

Returns:

the MaryCache singleton object, or null if none could be created.

See Also:

if you just want to check if the cache exists. To the extent possible this method gives the no-throw guarantee: if the cache cannot be created, null will be returned and any exception will be logged.

haveCache

public static boolean haveCache()

Indicate whether there is a MaryCache currently available.

Returns:

true if there is a MaryCache, false otherwise.

insertText

public void insertText(String inputtype,
              String outputtype,
              String locale,
              String voice,
              String inputtext,
              String outputtext)
                throws SQLException

Insert a record of a MARY request producing data of type text into the cache. If a record with the same lookup keys (i.e., all parameters everything except outputtext) exists already, this call does nothing.

Parameters:

inputtype - the request's input type. Must not be null.

outputtype - the request's output type, which must be a text type. Must not be null.

locale - the locale of the request. Must not be null.

voice - the voice of the request. Can be null.

inputtext - the request's input text. Must not be null.

outputtext - the request's output text. Must not be null.

Throws:

NullPointerException - if one of the fields is null which must be non-null.

SQLException - if the record could not be entered into the cache.

insertText

public void insertText(String inputtype,
              String outputtype,
              String locale,
              String voice,
              String outputparams,
              String style,
              String effects,
              String inputtext,
              String outputtext)
                throws SQLException

Insert a record of a MARY request producing data of type text into the cache. If a record with the same lookup keys (i.e., all parameters everything except outputtext) exists already, this call does nothing.

Parameters:

inputtype - the request's input type. Must not be null.

outputtype - the request's output type, which must be a text type. Must not be null.

locale - the locale of the request. Must not be null.

voice - the voice of the request. Can be null.

outputparams - optionally, any output parameters. Can be null.

style - optionally, any style. Can be null.

effects - optionally, any effects. Can be null.

inputtext - the request's input text. Must not be null.

outputtext - the request's output text. Must not be null.

Throws:

NullPointerException - if one of the fields is null which must be non-null.

SQLException - if the record could not be entered into the cache.

insertAudio

public void insertAudio(String inputtype,
               String locale,
               String voice,
               String inputtext,
               byte[] audio)
                 throws SQLException

Insert a record of a MARY request producing data of output type AUDIO into the cache. If a record with the same lookup keys (i.e., all parameters everything except audio) exists already, this call does nothing.

Parameters:

inputtype - the request's input type. Must not be null.

locale - the locale of the request. Must not be null.

voice - the voice of the request. Can be null.

inputtext - the request's input text. Must not be null.

audio - the request's output data. Must not be null.

Throws:

NullPointerException - if one of the fields is null which must be non-null.

SQLException - if the record could not be entered into the cache.

insertAudio

public void insertAudio(String inputtype,
               String locale,
               String voice,
               String outputparams,
               String style,
               String effects,
               String inputtext,
               byte[] audio)
                 throws SQLException

Insert a record of a MARY request producing data of output type AUDIO into the cache. If a record with the same lookup keys (i.e., all parameters everything except audio) exists already, this call does nothing.

Parameters:

inputtype - the request's input type. Must not be null.

locale - the locale of the request. Must not be null.

voice - the voice of the request. Can be null.

outputparams - optionally, any output parameters. Can be null.

style - optionally, any style. Can be null.

effects - optionally, any effects. Can be null.

inputtext - the request's input text. Must not be null.

audio - the request's output data. Must not be null.

Throws:

NullPointerException - if one of the fields is null which must be non-null.

SQLException - if the record could not be entered into the cache.

lookupText

public String lookupText(String inputtype,
                String outputtype,
                String locale,
                String voice,
                String inputtext)
                  throws SQLException

Carry out a lookup in the cache with the given parameters.

Parameters:

inputtype - the request's input type. Must not be null.

outputtype - the request's output type, which must be a text type. Must not be null.

locale - the locale of the request. Must not be null.

voice - the voice of the request. Can be null.

inputtext - the request's input text. Must not be null.

Returns:

the output text associated with the with the given record, or null if the cache does not contain a record with these keys.

Throws:

NullPointerException - if one of the fields is null which must be non-null.

SQLException - if there is a problem querying the cache.

lookupText

public String lookupText(String inputtype,
                String outputtype,
                String locale,
                String voice,
                String outputparams,
                String style,
                String effects,
                String inputtext)
                  throws SQLException

Carry out a lookup in the cache with the given parameters.

Parameters:

inputtype - the request's input type. Must not be null.

outputtype - the request's output type, which must be a text type. Must not be null.

locale - the locale of the request. Must not be null.

voice - the voice of the request. Can be null.

outputparams - optionally, any output parameters. Can be null.

style - optionally, any style. Can be null.

effects - optionally, any effects. Can be null.

inputtext - the request's input text. Must not be null.

Returns:

the output text associated with the with the given record, or null if the cache does not contain a record with these keys.

Throws:

NullPointerException - if one of the fields is null which must be non-null.

SQLException - if there is a problem querying the cache.

lookupAudio

public byte[] lookupAudio(String inputtype,
                 String locale,
                 String voice,
                 String inputtext)
                   throws SQLException

Carry out a lookup in the cache with the given parameters, for a request with output type AUDIO.

Parameters:

inputtype - the request's input type. Must not be null.

locale - the locale of the request. Must not be null.

voice - the voice of the request. Can be null.

inputtext - the request's input text. Must not be null.

Returns:

the output text associated with the with the given record, or null if the cache does not contain a record with these keys.

Throws:

NullPointerException - if one of the fields is null which must be non-null.

SQLException - if there is a problem querying the cache.

lookupAudio

public byte[] lookupAudio(String inputtype,
                 String locale,
                 String voice,
                 String outputparams,
                 String style,
                 String effects,
                 String inputtext)
                   throws SQLException

Carry out a lookup in the cache with the given parameters, for a request with output type AUDIO.

Parameters:

inputtype - the request's input type. Must not be null.

locale - the locale of the request. Must not be null.

voice - the voice of the request. Can be null.

outputparams - optionally, any output parameters. Can be null.

style - optionally, any style. Can be null.

effects - optionally, any effects. Can be null.

inputtext - the request's input text. Must not be null.

Returns:

the output text associated with the with the given record, or null if the cache does not contain a record with these keys.

Throws:

NullPointerException - if one of the fields is null which must be non-null.

SQLException - if there is a problem querying the cache.

shutdown

public void shutdown()
              throws SQLException

Shut down the cache. After this has been called, any further calls to the object will throw exceptions.

Throws:

SQLException - if there is a problem executing the database SHUTDOWN command.

main

public static void main(String[] args)
                 throws SQLException,
                        MalformedURLException,
                        ClassNotFoundException

Parameters:

args - args

Throws:

SQLException - SQLException

MalformedURLException - MalformedURLException

ClassNotFoundException - ClassNotFoundException