edu.cmu.sphinx.jsgf

Class JSGFRuleGrammar

java.lang.Object

edu.cmu.sphinx.jsgf.JSGFRuleGrammar

public class JSGFRuleGrammar
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	importedRules
protected java.util.List<JSGFRuleName>	imports
protected java.util.Map<java.lang.String,edu.cmu.sphinx.jsgf.JSGFRuleGrammar.JSGFRuleState>	rules
protected java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	ruleTags

Constructor Summary

Constructors

Constructor and Description
JSGFRuleGrammar(java.lang.String name, JSGFRuleGrammarManager manager) Create a new RuleGrammar

Method Summary

Modifier and Type	Method and Description
void	addGrammarDocComment(java.lang.String comment) Add the Grammar comment.
void	addImport(JSGFRuleName importName) Import all rules or a specified rule from another grammar.
void	addImportDocComment(JSGFRuleName imp, java.lang.String comment) Add a new import comment.
void	addRuleDocComment(java.lang.String rname, java.lang.String comment) Add a new RuleGrammar comment.
void	addSampleSentence(java.lang.String ruleName, java.lang.String sample) add a sample sentence to the list of sample sentences that go with the specified rule
void	deleteRule(java.lang.String ruleName) Delete a rule from the grammar.
java.lang.String	getGrammarDocComment() Retrieve the Grammar comment.
java.lang.String	getImportDocComment(JSGFRuleName imp) Retrieve an import comment.
java.util.List<JSGFRuleName>	getImports() List the current imports.
java.util.Collection<java.lang.String>	getJSGFTags(java.lang.String ruleName) Returns the jsgf tags associated to the given rule.
java.lang.String	getName()
JSGFRule	getRule(java.lang.String ruleName) Return the data structure for the named rule.
java.lang.String	getRuleDocComment(java.lang.String rname) Retrieve a RuleGrammar comment.
java.util.Set<java.lang.String>	getRuleNames() List the names of all rules define in this Grammar.
boolean	isEnabled(java.lang.String ruleName)
boolean	isRuleChanged(java.lang.String ruleName)
boolean	isRulePublic(java.lang.String ruleName) Test whether the specified rule is public.
void	removeImport(JSGFRuleName importName) Remove an import.
JSGFRuleName	resolve(JSGFRuleName ruleName) Resolve a simple or qualified rule name as a full rule name.
void	resolveAllRules() Resolve and link up all rule references contained in all rules.
protected void	resolveRule(JSGFRule r) Resolve the given rule.
void	saveJSGF(java.net.URL url) This JSGFRule grammar will be saved to the file in the provided URL, Overwriting any contents in the provided file, or creating a new one if it does not exist.
void	setEnabled(boolean enabled) Set the enabled property of the Grammar.
void	setEnabled(java.lang.String ruleName, boolean enabled) Set the enabled state of the listed rule.
void	setRule(java.lang.String ruleName, JSGFRule rule, boolean isPublic) Set a rule in the grammar either by creating a new rule or updating an existing rule.
void	setRuleChanged(java.lang.String ruleName, boolean changed)
java.lang.String	toString() Returns a string containing the specification for this grammar.

Methods inherited from class java.lang.Object

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

Field Detail

rules

protected final java.util.Map<java.lang.String,edu.cmu.sphinx.jsgf.JSGFRuleGrammar.JSGFRuleState> rules

imports

protected final java.util.List<JSGFRuleName> imports

importedRules

protected final java.util.List<java.lang.String> importedRules

ruleTags

protected final java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> ruleTags

Constructor Detail

JSGFRuleGrammar

public JSGFRuleGrammar(java.lang.String name,
                       JSGFRuleGrammarManager manager)

Create a new RuleGrammar

Parameters:

name - the name of this Grammar.

manager - the manager for the created Grammars

Method Detail

addGrammarDocComment

public void addGrammarDocComment(java.lang.String comment)

Add the Grammar comment.

Parameters:

comment - text for comment

addImport

public void addImport(JSGFRuleName importName)

Import all rules or a specified rule from another grammar.

Parameters:

importName - the name of the rule(s) to import.

addImportDocComment

public void addImportDocComment(JSGFRuleName imp,
                                java.lang.String comment)

Add a new import comment.

Parameters:

imp - import name

comment - comment to add

addRuleDocComment

public void addRuleDocComment(java.lang.String rname,
                              java.lang.String comment)

Add a new RuleGrammar comment.

Parameters:

rname - rule doc name

comment - comment to add

addSampleSentence

public void addSampleSentence(java.lang.String ruleName,
                              java.lang.String sample)

add a sample sentence to the list of sample sentences that go with the specified rule

Parameters:

ruleName - name of the rule

sample - sample sentence

deleteRule

public void deleteRule(java.lang.String ruleName)
                throws java.lang.IllegalArgumentException

Delete a rule from the grammar.

Parameters:

ruleName - the name of the rule.

Throws:

java.lang.IllegalArgumentException

getGrammarDocComment

public java.lang.String getGrammarDocComment()

Retrieve the Grammar comment.

Returns:

comment

getImportDocComment

public java.lang.String getImportDocComment(JSGFRuleName imp)

Retrieve an import comment.

Parameters:

imp - rule name

Returns:

stored comment

getJSGFTags

public java.util.Collection<java.lang.String> getJSGFTags(java.lang.String ruleName)

Returns the jsgf tags associated to the given rule. Cf. jsgf-specification for details.

Parameters:

ruleName - name of the rule

Returns:

list of tags

getName

public java.lang.String getName()

getRule

public JSGFRule getRule(java.lang.String ruleName)

Return the data structure for the named rule.

Parameters:

ruleName - the name of the rule.

Returns:

rule object.

getRuleDocComment

public java.lang.String getRuleDocComment(java.lang.String rname)

Retrieve a RuleGrammar comment.

Parameters:

rname - name of the comment

Returns:

comment text

isRulePublic

public boolean isRulePublic(java.lang.String ruleName)
                     throws java.lang.IllegalArgumentException

Test whether the specified rule is public.

Parameters:

ruleName - the name of the rule.

Returns:

if rule is public

Throws:

java.lang.IllegalArgumentException

getImports

public java.util.List<JSGFRuleName> getImports()

List the current imports.

Returns:

the list of rule names for imports

getRuleNames

public java.util.Set<java.lang.String> getRuleNames()

List the names of all rules define in this Grammar.

Returns:

the list of rule names.

removeImport

public void removeImport(JSGFRuleName importName)

Remove an import.

Parameters:

importName - the name of the rule(s) to remove.

resolve

public JSGFRuleName resolve(JSGFRuleName ruleName)
                     throws JSGFGrammarException

Resolve a simple or qualified rule name as a full rule name.

Parameters:

ruleName - the name of the rule.

Returns:

rule name object

Throws:

JSGFGrammarException - an exception occured

resolveAllRules

public void resolveAllRules()
                     throws JSGFGrammarException

Resolve and link up all rule references contained in all rules.

Throws:

JSGFGrammarException - an exception occured

resolveRule

protected void resolveRule(JSGFRule r)
                    throws JSGFGrammarException

Resolve the given rule.

Parameters:

r - rule to resolve

Throws:

JSGFGrammarException - if something occurs

setEnabled

public void setEnabled(boolean enabled)

Set the enabled property of the Grammar.

Parameters:

enabled - the new desired state of the enabled property.

isEnabled

public boolean isEnabled(java.lang.String ruleName)

setEnabled

public void setEnabled(java.lang.String ruleName,
                       boolean enabled)
                throws java.lang.IllegalArgumentException

Set the enabled state of the listed rule.

Parameters:

ruleName - the name of the rule.

enabled - the new enabled state.

Throws:

java.lang.IllegalArgumentException

setRule

public void setRule(java.lang.String ruleName,
                    JSGFRule rule,
                    boolean isPublic)
             throws java.lang.NullPointerException,
                    java.lang.IllegalArgumentException

Set a rule in the grammar either by creating a new rule or updating an existing rule.

Parameters:

ruleName - the name of the rule.

rule - the definition of the rule.

isPublic - whether this rule is public or not.

Throws:

java.lang.NullPointerException

java.lang.IllegalArgumentException

toString

public java.lang.String toString()

Returns a string containing the specification for this grammar.

Overrides:

toString in class java.lang.Object

Returns:

specification for this grammar.

saveJSGF

public void saveJSGF(java.net.URL url)
              throws java.net.URISyntaxException,
                     java.io.IOException

This JSGFRule grammar will be saved to the file in the provided URL, Overwriting any contents in the provided file, or creating a new one if it does not exist.

Parameters:

url - The URL to save this JSGFRuleGrammar to.

Throws:

java.net.URISyntaxException - If there was a problem converting the given url to uri.

java.io.IOException - if an error occurs while saving or compiling the grammar

isRuleChanged

public boolean isRuleChanged(java.lang.String ruleName)

setRuleChanged

public void setRuleChanged(java.lang.String ruleName,
                           boolean changed)