org.jvoicexml.implementation.dtmf

Class BufferedDtmfInput

java.lang.Object

org.jvoicexml.implementation.dtmf.BufferedDtmfInput

All Implemented Interfaces:

DtmfInput, ExternalResource, InputDevice, SpokenInput, RemoteConnectable

public class BufferedDtmfInput
extends java.lang.Object
implements DtmfInput, SpokenInput

Buffered DTMF input.

Since:

0.5

Constructor Summary

Constructors

Constructor and Description
BufferedDtmfInput() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates this resource, when it is retrieved from the pool.
void	activateGrammars(java.util.Collection<GrammarImplementation<?>> grammars) Activates the given grammars.
void	addDtmf(char dtmf) The user entered a DTMF.
void	addListener(SpokenInputListener inputListener) Adds a listener for user input events.
void	close() Closes and releases the acquired resources.
void	connect(ConnectionInformation client) Establishes a connection from the given ConnectionInformation to this object.
void	deactivateGrammars(java.util.Collection<GrammarImplementation<?>> grammars) Deactivates the given grammar.
void	disconnect(ConnectionInformation client) Closes a previously established connection.
void	fireInputEvent(SpokenInputEvent event) Notifies all registered listeners about the given event.
java.util.Collection<org.jvoicexml.xml.vxml.BargeInType>	getSupportedBargeInTypes() Retrieves the barge-in types supported by this UserInput.
java.util.Collection<org.jvoicexml.xml.srgs.GrammarType>	getSupportedGrammarTypes() Retrieves the grammar types that are supported by this implementation.
java.lang.String	getType() Retrieves a unique identifier for this external resource.
boolean	isAccepted(RecognitionResult result) Checks if one of the active grammars accepts the current recognition result.
boolean	isBusy() Checks if this device is busy.
GrammarImplementation<?>	loadGrammar(java.net.URI uri, org.jvoicexml.xml.srgs.GrammarType type) Creates a GrammarImplementation from the contents provided by the Reader.
void	open() Initializes and and acquires the needed resources.
void	passivate() Passivates this resource, when it is returned to the pool.
void	removeListener(SpokenInputListener inputListener) Removes a listener for user input events.
void	setGrammarParsers(java.util.List<GrammarParser<?>> grammarParsers) Sets the grammar parsers to use.
void	startRecognition(DataModel dataModel, SpeechRecognizerProperties speech, DtmfRecognizerProperties dtmf) Detects and reports character and/or spoken input simultaneously.
void	stopRecognition() Stops a previously started recognition.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedDtmfInput

public BufferedDtmfInput()

Constructs a new object.

Method Detail

setGrammarParsers

public void setGrammarParsers(java.util.List<GrammarParser<?>> grammarParsers)

Sets the grammar parsers to use.

Parameters:

grammarParsers - the grammar parsers to use

Since:

0.7.8

activateGrammars

public void activateGrammars(java.util.Collection<GrammarImplementation<?>> grammars)
                      throws BadFetchError,
                             UnsupportedLanguageError,
                             NoresourceError

Activates the given grammars. It is guaranteed that all grammars types are supported by this implementation.

Specified by:

activateGrammars in interface SpokenInput

Parameters:

grammars - Grammars to activate.

Throws:

BadFetchError - Grammar is not know by the recognizer.

UnsupportedLanguageError - The specified language is not supported.

NoresourceError - The input resource is not available.

Since:

0.7

deactivateGrammars

public void deactivateGrammars(java.util.Collection<GrammarImplementation<?>> grammars)
                        throws NoresourceError,
                               BadFetchError

Deactivates the given grammar. Do nothing if the input resource is not available. It is guaranteed that all grammars types are supported by this implementation.

Specified by:

deactivateGrammars in interface SpokenInput

Parameters:

grammars - Grammars to deactivate.

Throws:

BadFetchError - Grammar is not known by the recognizer.

NoresourceError - The input resource is not available.

Since:

0.7

addDtmf

public void addDtmf(char dtmf)
             throws java.lang.IllegalArgumentException

The user entered a DTMF.

Specified by:

addDtmf in interface DtmfInput

Parameters:

dtmf - Entered DTMF.

Throws:

java.lang.IllegalArgumentException - if the char is not one of 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, #, *.

startRecognition

public void startRecognition(DataModel dataModel,
                             SpeechRecognizerProperties speech,
                             DtmfRecognizerProperties dtmf)
                      throws NoresourceError,
                             BadFetchError

Detects and reports character and/or spoken input simultaneously.

Specified by:

startRecognition in interface InputDevice

Parameters:

dataModel - the data model to use for generating a semantic interpretation

speech - the speech recognizer properties to use

dtmf - the DTMF recognizer properties to use

Throws:

NoresourceError - The input resource is not available.

BadFetchError - The active grammar contains some errors.

isAccepted

public boolean isAccepted(RecognitionResult result)

Checks if one of the active grammars accepts the current recognition result.

Parameters:

result - the recognized DTMF result

Returns:

true if the result is accepted.

Since:

0.7

stopRecognition

public void stopRecognition()

Stops a previously started recognition.

Specified by:

stopRecognition in interface InputDevice

See Also:

InputDevice.startRecognition(org.jvoicexml.interpreter.datamodel.DataModel, org.jvoicexml.SpeechRecognizerProperties, org.jvoicexml.DtmfRecognizerProperties)

addListener

public void addListener(SpokenInputListener inputListener)

Adds a listener for user input events.

The implementation of this interface must notify the listener about all events.

Specified by:

addListener in interface SpokenInput

Parameters:

inputListener - The listener.

removeListener

public void removeListener(SpokenInputListener inputListener)

Removes a listener for user input events.

Specified by:

removeListener in interface SpokenInput

Parameters:

inputListener - The listener.

fireInputEvent

public void fireInputEvent(SpokenInputEvent event)

Notifies all registered listeners about the given event.

Parameters:

event - the event.

Since:

0.6

getType

public java.lang.String getType()

Retrieves a unique identifier for this external resource.

Specified by:

getType in interface ExternalResource

Returns:

unique identifier.

open

public void open()
          throws NoresourceError

Initializes and and acquires the needed resources.

Specified by:

open in interface ExternalResource

Throws:

NoresourceError - The resource could not be opened.

activate

public void activate()
              throws NoresourceError

Activates this resource, when it is retrieved from the pool.

Specified by:

activate in interface ExternalResource

Throws:

NoresourceError - The resource could not be activated.

passivate

public void passivate()
               throws NoresourceError

Passivates this resource, when it is returned to the pool.

The external resource is requested to return all resources that were assigned while it was active.

Specified by:

passivate in interface ExternalResource

Throws:

NoresourceError - The resource could not be opened.

close

public void close()

Closes and releases the acquired resources.

Specified by:

close in interface ExternalResource

isBusy

public boolean isBusy()

Checks if this device is busy.

A device can be busy only if it is activated. Closed or passivated devices must return false.

Specified by:

isBusy in interface ExternalResource

Returns:

true if the device is busy.

connect

public void connect(ConnectionInformation client)
             throws java.io.IOException

Establishes a connection from the given ConnectionInformation to this object.

Specified by:

connect in interface RemoteConnectable

Parameters:

client - data container with connection relevant data.

Throws:

java.io.IOException - error establishing the connection.

disconnect

public void disconnect(ConnectionInformation client)

Closes a previously established connection.

Specified by:

disconnect in interface RemoteConnectable

Parameters:

client - data container with connection relevant data.

getSupportedGrammarTypes

public java.util.Collection<org.jvoicexml.xml.srgs.GrammarType> getSupportedGrammarTypes()

Retrieves the grammar types that are supported by this implementation.

Specified by:

getSupportedGrammarTypes in interface SpokenInput

Returns:

supported grammars.

loadGrammar

public GrammarImplementation<?> loadGrammar(java.net.URI uri,
                                            org.jvoicexml.xml.srgs.GrammarType type)
                                     throws NoresourceError,
                                            java.io.IOException,
                                            UnsupportedFormatError

Creates a GrammarImplementation from the contents provided by the Reader. If the grammar contained in the Reader already exists, it is over-written.

This method is mainly needed for non SRGS grammars, e.g. JSGF. The grammar implementation is platform specific, so it the responsibility of the implementation platform to return load it's specific grammar. However, loading an SRGS grammar is quite easy and can be implemented e.g. as

final InputSource inputSource = new InputSource(reader);
SrgsXmlDocument doc = new SrgsXmlDocument(inputSource);
// Pass it to the recognizer
return doc;

Specified by:

loadGrammar in interface SpokenInput

Parameters:

uri - the URI to load the grammar

type - type of the grammar to read. The type is one of the supported types of the implementation, that has been requested via SpokenInput.getSupportedGrammarTypes().

Returns:

Read grammar.

Throws:

NoresourceError - the input resource is not available.

java.io.IOException - error reading the grammar.

UnsupportedFormatError - invalid grammar format.

getSupportedBargeInTypes

public java.util.Collection<org.jvoicexml.xml.vxml.BargeInType> getSupportedBargeInTypes()

Retrieves the barge-in types supported by this UserInput.

Specified by:

getSupportedBargeInTypes in interface SpokenInput

Returns:

Collection of supported barge-in types, an empty collection, if no types are supported.