org.jvoicexml.interpreter.grammar

Class GrammarIdentifierCentral

java.lang.Object

org.jvoicexml.interpreter.grammar.GrammarIdentifierCentral

public final class GrammarIdentifierCentral
extends java.lang.Object

The GrammarIdentifierCentral takes control over the process of identifying a grammar. It provides some convenience methods as an entry point for the identification.

Constructor Summary

Constructors

Constructor and Description
GrammarIdentifierCentral() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	addIdentifier(GrammarIdentifier id) Adds the given grammar identifier.
protected java.util.List<GrammarIdentifier>	getAvailableIdentifier(org.jvoicexml.xml.srgs.GrammarType type) Returns a List of identifiers, that have been registered and are supporting the given type.
org.jvoicexml.xml.srgs.GrammarType	identifyGrammar(GrammarDocument grammar, org.jvoicexml.xml.srgs.GrammarType expectedType) Identifies the given grammar.
void	setIdentifier(java.util.List<GrammarIdentifier> grammarIdenifier) Adds the given list of idententifiers.
boolean	typeSupported(org.jvoicexml.xml.srgs.GrammarType type) Checks whether the given type is supported by one of the registered identifiers or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrammarIdentifierCentral

public GrammarIdentifierCentral()

Constructs a new object.

Method Detail

identifyGrammar

public org.jvoicexml.xml.srgs.GrammarType identifyGrammar(GrammarDocument grammar,
                                                          org.jvoicexml.xml.srgs.GrammarType expectedType)
                                                   throws UnsupportedFormatError

Identifies the given grammar. If the grammar could not be identified an UnsupportedFormatError is thrown.

Parameters:

grammar - The given grammar which will be identified.

expectedType - the expected grammar type

Returns:

The actual type of the grammar.

Throws:

UnsupportedFormatError - If no identifier is able to identify this grammar.

getAvailableIdentifier

protected java.util.List<GrammarIdentifier> getAvailableIdentifier(org.jvoicexml.xml.srgs.GrammarType type)

Returns a List of identifiers, that have been registered and are supporting the given type.

Parameters:

type - Required type.

Returns:

List List of available identifiers.

typeSupported

public boolean typeSupported(org.jvoicexml.xml.srgs.GrammarType type)

Checks whether the given type is supported by one of the registered identifiers or not. Returns true if type is supported, else false

Parameters:

type - String representing the type

Returns:

boolean true if type is supported, else false.

setIdentifier

public void setIdentifier(java.util.List<GrammarIdentifier> grammarIdenifier)

Adds the given list of idententifiers.

Parameters:

grammarIdenifier - List with identifiers to add.

Since:

0.5

addIdentifier

public void addIdentifier(GrammarIdentifier id)

Adds the given grammar identifier.

Parameters:

id - The GrammarIdentifier to add.