org.nineml.coffeegrinder.parser

Class Grammar

java.lang.Object

org.nineml.coffeegrinder.parser.Grammar

Direct Known Subclasses:

ParserGrammar, SourceGrammar

public abstract class Grammar
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	logcategory

Constructor Summary

Constructors

Constructor and Description
Grammar()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getMetadataProperies() Gets the metadata properties.
java.lang.String	getMetadataProperty(java.lang.String name) Gets a metadata property.
java.util.List<Rule>	getRules() Get the rules currently defined in this grammar.
java.util.Map<NonterminalSymbol,java.util.List<Rule>>	getRulesBySymbol() Get the rules currently defined in this grammar organized by symbol.
java.util.List<Rule>	getRulesForSymbol(NonterminalSymbol symbol) Get the rules currently defined in this grammar for a particular symbol.
java.util.Set<NonterminalSymbol>	getSymbols() Get the currently defined nonterminals in the grammar.
abstract boolean	isNullable(Symbol symbol) Is the symbol nullable?

Methods inherited from class java.lang.Object

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

Field Detail

logcategory

public static final java.lang.String logcategory

See Also:

Constant Field Values

Constructor Detail

Grammar

public Grammar()

Method Detail

getRules

public java.util.List<Rule> getRules()

Get the rules currently defined in this grammar.

For a ParserGrammar, this is the final set.

Returns:

Returns the rules that define the grammar.

getSymbols

public java.util.Set<NonterminalSymbol> getSymbols()

Get the currently defined nonterminals in the grammar.

For a ParserGrammar, this is the final set.

Returns:

the set of nonterminals.

getRulesBySymbol

public java.util.Map<NonterminalSymbol,java.util.List<Rule>> getRulesBySymbol()

Get the rules currently defined in this grammar organized by symbol.

For a ParserGrammar, this is the final set.

Returns:

Returns the rules that define the grammar.

getRulesForSymbol

public java.util.List<Rule> getRulesForSymbol(NonterminalSymbol symbol)

Get the rules currently defined in this grammar for a particular symbol.

For a ParserGrammar, this is the final set.

Parameters:

symbol - The symbol.

Returns:

Returns the rules that define the grammar.

getMetadataProperty

public java.lang.String getMetadataProperty(java.lang.String name)

Gets a metadata property.

Metadata properties exist solely for annotations by an application. They have no bearing on the function of the grammar. The GrammarCompiler stores metadata properties in the compiled grammar and they are restored when a parsed grammar is loaded.

Parameters:

name - the name of the property

Returns:

the value of the property, or null if no such property exists

Throws:

java.lang.NullPointerException - if the name is null

getMetadataProperies

public java.util.Map<java.lang.String,java.lang.String> getMetadataProperies()

Gets the metadata properties.

Metadata properties exist solely for annotations by an application. They have no bearing on the function of the grammar. The GrammarCompiler stores metadata properties in the compiled grammar and they are restored when a parsed grammar is loaded.

Returns:

the metadata properties

isNullable

public abstract boolean isNullable(Symbol symbol)

Is the symbol nullable?

A TerminalSymbol is never nullable.

For a ParserGrammar, the answer is definitive. For an SourceGrammar, a symbol that isn't currently nullable could become nullable by the addition of more rules.

Parameters:

symbol - The symbol.

Returns:

true if the symbol is nullable