Package org.nineml.coffeegrinder.gll

Class GllResult

java.lang.Object

org.nineml.coffeegrinder.gll.GllResult

All Implemented Interfaces:

GearleyResult

public class GllResult
extends java.lang.Object
implements GearleyResult

The results of a GLL parse.

Field Summary

Fields

Modifier and Type	Field	Description
boolean	success

Constructor Summary

Constructors

Constructor	Description
GllResult(GllParser parser, BinarySubtree bsr)

Method Summary

Modifier and Type	Method	Description
GearleyResult	continueParsing()	After a successful prefix parse, this method continues parsing.
GearleyResult	continueParsing(GearleyParser parser)	After a successful prefix parse, this method continues parsing with a new parser.
Arborist	getArborist()	Get an arborist to extract trees from the forest.
Arborist	getArborist(Axe axe)	Get an arborist to extract trees from the forest.
int	getColumnNumber()	Returns the column number of the last character on the last line read by the parser.
ParseForest	getForest()	Return the parse forest created by the parser.
Token	getLastToken()	Return the last token parsed.
int	getLineNumber()	Returns the line number of the last line read by the parser.
int	getOffset()	Returns the last offset read by the parser.
GearleyParser	getParser()	The parser used.
long	getParseTime()	Returns the number of milliseconds spent parsing.
java.util.Set<TerminalSymbol>	getPredictedTerminals()	Returns the symbols predicted as possibly next in the case where a parse fails.
int	getTokenCount()	Return the number of tokens parsed.
boolean	isAmbiguous()	Returns true if the parse was ambiguous.
boolean	isInfinitelyAmbiguous()	Returns true if the parse was infinitely ambiguous.
boolean	prefixSucceeded()	Returns true if the parser successfully processed a prefix of the input.
boolean	succeeded()	Returns true of the parse was successful.

Methods inherited from class java.lang.Object

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

Field Detail

success

public final boolean success

Constructor Detail

GllResult

public GllResult(GllParser parser,
                 BinarySubtree bsr)

Method Detail

continueParsing

public GearleyResult continueParsing()

Description copied from interface: GearleyResult

After a successful prefix parse, this method continues parsing.

Specified by:

continueParsing in interface GearleyResult

Returns:

The (next) parse result.

continueParsing

public GearleyResult continueParsing(GearleyParser parser)

Description copied from interface: GearleyResult

After a successful prefix parse, this method continues parsing with a new parser.

Specified by:

continueParsing in interface GearleyResult

Parameters:

parser - The (next) parser.

Returns:

The (next) parse result.

getForest

public ParseForest getForest()

Description copied from interface: GearleyResult

Return the parse forest created by the parser.

This method returns null if the parse was unsuccessful.

Specified by:

getForest in interface GearleyResult

Returns:

The parse forest.

getArborist

public Arborist getArborist()

Description copied from interface: GearleyResult

Get an arborist to extract trees from the forest.

The default arborist is created with Arborist.getArborist(ParseForest).

Specified by:

getArborist in interface GearleyResult

Returns:

the arborist

getArborist

public Arborist getArborist(Axe axe)

Description copied from interface: GearleyResult

Get an arborist to extract trees from the forest.

The arborist is created with Arborist.getArborist(ParseForest, Axe).

Specified by:

getArborist in interface GearleyResult

Parameters:

axe - the arborists axe

Returns:

the arborist

isAmbiguous

public boolean isAmbiguous()

Description copied from interface: GearleyResult

Returns true if the parse was ambiguous.

Specified by:

isAmbiguous in interface GearleyResult

Returns:

true if the parse was ambiguous.

isInfinitelyAmbiguous

public boolean isInfinitelyAmbiguous()

Description copied from interface: GearleyResult

Returns true if the parse was infinitely ambiguous.

The parse will only be infinitely ambiguous if the grqmmar contained a loop.

Specified by:

isInfinitelyAmbiguous in interface GearleyResult

Returns:

true if the parse was infinitely ambiguous.

getTokenCount

public int getTokenCount()

Description copied from interface: GearleyResult

Return the number of tokens parsed.

Specified by:

getTokenCount in interface GearleyResult

Returns:

the number of tokens.

getLastToken

public Token getLastToken()

Description copied from interface: GearleyResult

Return the last token parsed.

Specified by:

getLastToken in interface GearleyResult

Returns:

The last token.

getOffset

public int getOffset()

Description copied from interface: GearleyResult

Returns the last offset read by the parser.

Specified by:

getOffset in interface GearleyResult

Returns:

The offset.

getLineNumber

public int getLineNumber()

Description copied from interface: GearleyResult

Returns the line number of the last line read by the parser.

Specified by:

getLineNumber in interface GearleyResult

Returns:

The line number.

getColumnNumber

public int getColumnNumber()

Description copied from interface: GearleyResult

Returns the column number of the last character on the last line read by the parser.

Specified by:

getColumnNumber in interface GearleyResult

Returns:

The column number.

getPredictedTerminals

public java.util.Set<TerminalSymbol> getPredictedTerminals()

Description copied from interface: GearleyResult

Returns the symbols predicted as possibly next in the case where a parse fails.

Specified by:

getPredictedTerminals in interface GearleyResult

Returns:

The set of terminals.

getParser

public GearleyParser getParser()

Description copied from interface: GearleyResult

The parser used.

Specified by:

getParser in interface GearleyResult

Returns:

The parser.

prefixSucceeded

public boolean prefixSucceeded()

Description copied from interface: GearleyResult

Returns true if the parser successfully processed a prefix of the input.

Note that the GLL parser does not support prefix parsing.

Specified by:

prefixSucceeded in interface GearleyResult

Returns:

true if a prefix of the input was parsed successfully.

getParseTime

public long getParseTime()

Description copied from interface: GearleyResult

Returns the number of milliseconds spent parsing.

Specified by:

getParseTime in interface GearleyResult

Returns:

the number of milliseconds

succeeded

public boolean succeeded()

Description copied from interface: GearleyResult

Returns true of the parse was successful.

Specified by:

succeeded in interface GearleyResult

Returns:

true if the parse was successful.