edu.cmu.sphinx.linguist.language.grammar

Class Grammar

java.lang.Object

edu.cmu.sphinx.linguist.language.grammar.Grammar

All Implemented Interfaces:

GrammarInterface, Configurable

Direct Known Subclasses:

AlignerGrammar, ForcedAlignerGrammar, FSTGrammar, JSGFGrammar, LatticeGrammar, LMGrammar, SimpleWordListGrammar

public abstract class Grammar
extends java.lang.Object
implements Configurable, GrammarInterface

Classes that implement this interface create grammars. A grammar is represented internally as a graph of GrammarNodes linked together by GrammarArcs. Calling getInitialNode will return the first node of the grammar graph. To traverse the grammar graph, one should call GrammarNode.getSuccessors, which will return an array of GrammarArcs, from which you can reach the neighboring GrammarNodes.

Note that all grammar probabilities are maintained in LogMath log domain.

Field Summary

Fields

Modifier and Type	Field and Description
protected Dictionary	dictionary
protected GrammarNode	initialNode
protected java.util.logging.Logger	logger
static java.lang.String	PROP_ADD_FILLER_WORDS Property to control whether filler words are inserted into the graph
static java.lang.String	PROP_ADD_SIL_WORDS Property to control whether silence words are inserted into the graph
static java.lang.String	PROP_DICTIONARY Property that defines the dictionary to use for this grammar
static java.lang.String	PROP_OPTIMIZE_GRAMMAR The default value for PROP_SHOW_GRAMMAR.
static java.lang.String	PROP_SHOW_GRAMMAR Property to control the the dumping of the grammar

Constructor Summary

Constructors

Constructor and Description
Grammar()
Grammar(boolean showGrammar, boolean optimizeGrammar, boolean addSilenceWords, boolean addFillerWords, Dictionary dictionary)

Method Summary

Modifier and Type	Method and Description
void	allocate() Create the grammar
protected abstract GrammarNode	createGrammar() Creates a grammar.
protected GrammarNode	createGrammar(java.lang.String bogusText) Create class from reference text (not implemented).
protected GrammarNode	createGrammarNode(boolean isFinal) Creates an empty grammar node in this grammar.
protected GrammarNode	createGrammarNode(int identity, boolean isFinal) Creates a grammar node in this grammar with the given identity
protected GrammarNode	createGrammarNode(int identity, java.lang.String word) Returns a new GrammarNode with the given single word.
protected GrammarNode	createGrammarNode(int identity, java.lang.String[][] alts) Returns a new GrammarNode with the given set of alternatives.
protected GrammarNode	createGrammarNode(java.lang.String word) Returns a new GrammarNode with the given single word.
void	deallocate() Deallocate resources allocated to this grammar
void	dumpGrammar(java.lang.String name) Dumps the grammar
void	dumpRandomSentences(int count) Dump a set of random sentences that fit this grammar
void	dumpRandomSentences(java.lang.String path, int count) Dump a set of random sentences that fit this grammar
void	dumpStatistics() Dumps statistics for this grammar
Dictionary	getDictionary() Gets the dictionary for this grammar
java.util.Set<GrammarNode>	getGrammarNodes() returns the set of of nodes in this grammar
GrammarNode	getInitialNode() Returns the initial node for the grammar
int	getNumNodes() returns the number of nodes in this grammar
java.lang.String	getRandomSentence() Returns a random sentence that fits this grammar
protected void	newGrammar() Prepare to create a new grammar
void	newProperties(PropertySheet ps) This method is called when this configurable component needs to be reconfigured.
protected void	postProcessGrammar() Perform the standard set of grammar post processing.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_SHOW_GRAMMAR

@S4Boolean(defaultValue=false)
public static final java.lang.String PROP_SHOW_GRAMMAR

Property to control the the dumping of the grammar

See Also:

Constant Field Values

PROP_OPTIMIZE_GRAMMAR

@S4Boolean(defaultValue=true)
public static final java.lang.String PROP_OPTIMIZE_GRAMMAR

The default value for PROP_SHOW_GRAMMAR.

See Also:

Constant Field Values

PROP_ADD_SIL_WORDS

@S4Boolean(defaultValue=false)
public static final java.lang.String PROP_ADD_SIL_WORDS

Property to control whether silence words are inserted into the graph

See Also:

Constant Field Values

PROP_ADD_FILLER_WORDS

@S4Boolean(defaultValue=false)
public static final java.lang.String PROP_ADD_FILLER_WORDS

Property to control whether filler words are inserted into the graph

See Also:

Constant Field Values

PROP_DICTIONARY

@S4Component(type=Dictionary.class)
public static final java.lang.String PROP_DICTIONARY

Property that defines the dictionary to use for this grammar

See Also:

Constant Field Values

logger

protected java.util.logging.Logger logger

dictionary

protected Dictionary dictionary

initialNode

protected GrammarNode initialNode

Constructor Detail

Grammar

public Grammar(boolean showGrammar,
               boolean optimizeGrammar,
               boolean addSilenceWords,
               boolean addFillerWords,
               Dictionary dictionary)

Grammar

public Grammar()

Method Detail

newProperties

public void newProperties(PropertySheet ps)
                   throws PropertyException

Description copied from interface: Configurable

This method is called when this configurable component needs to be reconfigured.

Specified by:

newProperties in interface Configurable

Parameters:

ps - a property sheet holding the new data

Throws:

PropertyException - if there is a problem with the properties.

allocate

public void allocate()
              throws java.io.IOException

Create the grammar

Throws:

java.io.IOException - if IO went wrong

deallocate

public void deallocate()

Deallocate resources allocated to this grammar

getInitialNode

public GrammarNode getInitialNode()

Returns the initial node for the grammar

Specified by:

getInitialNode in interface GrammarInterface

Returns:

the initial grammar node

postProcessGrammar

protected void postProcessGrammar()

Perform the standard set of grammar post processing. This can include inserting silence nodes and optimizing out empty nodes

dumpStatistics

public void dumpStatistics()

Dumps statistics for this grammar

dumpRandomSentences

public void dumpRandomSentences(java.lang.String path,
                                int count)

Dump a set of random sentences that fit this grammar

Parameters:

path - the name of the file to dump the sentences to

count - dumps no more than this. May dump less than this depending upon the number of uniqe sentences in the grammar.

dumpRandomSentences

public void dumpRandomSentences(int count)

Dump a set of random sentences that fit this grammar

Parameters:

count - dumps no more than this. May dump less than this depending upon the number of uniqe sentences in the grammar.

getRandomSentence

public java.lang.String getRandomSentence()

Returns a random sentence that fits this grammar

Returns:

a random sentence that fits this grammar

dumpGrammar

public void dumpGrammar(java.lang.String name)

Dumps the grammar

Parameters:

name - name of the file to dump to

getNumNodes

public int getNumNodes()

returns the number of nodes in this grammar

Returns:

the number of nodes

getGrammarNodes

public java.util.Set<GrammarNode> getGrammarNodes()

returns the set of of nodes in this grammar

Specified by:

getGrammarNodes in interface GrammarInterface

Returns:

the set of nodes

newGrammar

protected void newGrammar()

Prepare to create a new grammar

createGrammar

protected abstract GrammarNode createGrammar()
                                      throws java.io.IOException

Creates a grammar. Subclasses of grammar should implement this method.

Returns:

the initial node for the grammar

Throws:

java.io.IOException - if the grammar could not be loaded

createGrammar

protected GrammarNode createGrammar(java.lang.String bogusText)
                             throws java.lang.NoSuchMethodException

Create class from reference text (not implemented).

Parameters:

bogusText - dummy variable

Returns:

created grammar node

Throws:

java.lang.NoSuchMethodException - if called with reference sentence

getDictionary

public Dictionary getDictionary()

Gets the dictionary for this grammar

Returns:

the dictionary

createGrammarNode

protected GrammarNode createGrammarNode(int identity,
                                        java.lang.String[][] alts)

Returns a new GrammarNode with the given set of alternatives.

Parameters:

identity - the id for this node

alts - the set of alternative word lists for this GrammarNode

Returns:

created grammar node

createGrammarNode

protected GrammarNode createGrammarNode(java.lang.String word)

Returns a new GrammarNode with the given single word. If the word is not in the dictionary, an empty node is created. The grammar id is automatically assigned

Parameters:

word - the word for this grammar node

Returns:

created grammar node

createGrammarNode

protected GrammarNode createGrammarNode(boolean isFinal)

Creates an empty grammar node in this grammar. The gramar ID is automatically assigned.

Parameters:

isFinal - if true, this is a final node

Returns:

the grammar node

createGrammarNode

protected GrammarNode createGrammarNode(int identity,
                                        java.lang.String word)

Returns a new GrammarNode with the given single word. If the word is not in the dictionary, an empty node is created

Parameters:

identity - the id for this node

word - the word for this grammar node

Returns:

created grammar node

createGrammarNode

protected GrammarNode createGrammarNode(int identity,
                                        boolean isFinal)

Creates a grammar node in this grammar with the given identity

Parameters:

identity - the identity of the node

isFinal - if true, this is a final node

Returns:

the grammar node