Overview | Package | Class | Tree | Index | Help
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class javax.speech.recognition.GrammarSyntaxDetail

java.lang.Object
  |
  +--javax.speech.recognition.GrammarSyntaxDetail

public class GrammarSyntaxDetail

extends Object

Description of a problem found in a grammar usually bundled with a GrammarException. The grammar may have been created programmatically or by loading a Java Speech Grammar Format document. Multiple GrammarSyntaxDetail objects may be encapsulated by a single GrammarException.

Depending on the type of error and the context in which the error is identified, some or all of the following information may be provided:

• Grammar name,
• Grammar location (URL or system resource),
• Rule name in which error is found,
• Import name,
• Line number of error in JSGF,
• Character number (within line) in JSGF,
• A printable description string.

The following problems may be encountered when loading JSGF from a URL or Reader, or through the ruleForJSGF method of the RuleGrammar interface.

• Missing or illegal grammar name declaration, or grammar name doesn't match URL or file name.
• missing URL or URL does not contain JSGF file.
• Illegal import declaration.
• Illegal rule name or token.
• Missing semi-colon.
• Redefinition of a rule.
• Definition of a reserved rule name (<NULL>, <VOID>).
• Unclosed quotes, tags, comment, or rule name.
• Unclosed grouping "()" or "[]".
• Empty rule definition or empty alternative.
• Missing or illegal weight on alternatives.
• Illegal attachment of unary operators (count and tag).
• Some other error.

When the commitChanges method of a Recognizer is called, it performs addition checks to ensure all loaded grammars are legal. The following problems may be encountered:

• Unable to resolve import because grammar or rule is not defined.
• Reference to an undefined rule name.
• Illegal recursion: a rule refers to itself illegally. Only right recursion is allowed (defined by JSGF).
• Ambiguous reference to imported rule.

See Also:

GrammarException, loadJSGF(java.io.Reader), loadJSGF(java.net.URL, java.lang.String), ruleForJSGF, commitChanges

Field Summary

int	charNumber Character number in line in JSGF file for problem.
URL	grammarLocation URL location of grammar in which problem is encountered.
String	grammarName Name of grammar in which problem is encountered.
RuleName	importName Name in grammar import declaration in which problem is encountered.
int	lineNumber Line number in JSGF file for problem.
String	message Printable string describing problem.
String	ruleName Name of rule within grammar in which problem is encountered.

Constructor Summary

GrammarSyntaxDetail()
Empty constructor.

GrammarSyntaxDetail(String grammarName, URL grammarLocation, String ruleName, RuleName importName, int lineNumber, int charNumber, String message)
Complete constructor describing a syntax problem.

Methods inherited from class java.lang.Object

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

Field Detail

grammarName

public String grammarName

Name of grammar in which problem is encountered. May be null.

grammarLocation

public URL grammarLocation

URL location of grammar in which problem is encountered. May be null.

ruleName

public String ruleName

Name of rule within grammar in which problem is encountered. May be null.

importName

public RuleName importName

Name in grammar import declaration in which problem is encountered. May be null.

lineNumber

public int lineNumber

Line number in JSGF file for problem. Negative values indicate that the line number unknown.

charNumber

public int charNumber

Character number in line in JSGF file for problem. Negative values indicate that the line number unknown.

message

public String message

Printable string describing problem. May be null.

Constructor Detail

GrammarSyntaxDetail

public GrammarSyntaxDetail()

Empty constructor.

GrammarSyntaxDetail

public GrammarSyntaxDetail(String grammarName,
                           URL grammarLocation,
                           String ruleName,
                           RuleName importName,
                           int lineNumber,
                           int charNumber,
                           String message)

Complete constructor describing a syntax problem.