Package org.nineml.coffeefilter

Class InvisibleXmlFailureDocument

java.lang.Object

org.nineml.coffeefilter.InvisibleXmlDocument

org.nineml.coffeefilter.InvisibleXmlFailureDocument

public class InvisibleXmlFailureDocument
extends InvisibleXmlDocument

A failure document represents the results of a failed parse. This is a subclass of the InvisibleXmlDocument that generates the result document for a failed parse.

Method Summary

Modifier and Type	Method	Description
long	getNumberOfParses()	Return the number of available parses of this document.
String	getTree()	Return an XML representation of the current parse.
void	getTree(PrintStream output)	Write an XML representation of the current parse to the stream.
void	getTree(org.nineml.coffeegrinder.trees.TreeBuilder builder)	Process the result with your own TreeBuilder.
void	getTree(ContentHandler handler)	Write an XML representation of the current parse to a SAX ContentHandler.
void	getTree(ContentHandler handler, ParserOptions options)	Write an XML representation of the current parse to a SAX ContentHandler using a different set of options.
boolean	succeeded()	Did the parse succeed?

Methods inherited from class org.nineml.coffeefilter.InvisibleXmlDocument

getAdapter, getColumnNumber, getLineNumber, getOffset, getOptions, getParserType, getParserVersion, getResult, isAmbiguous, isInfinitelyAmbiguous, parseTime

Methods inherited from class java.lang.Object

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

Method Details

succeeded

public boolean succeeded()

Description copied from class: InvisibleXmlDocument

Did the parse succeed?

Overrides:

succeeded in class InvisibleXmlDocument

Returns:

true if the parse was successful

getNumberOfParses

public long getNumberOfParses()

Description copied from class: InvisibleXmlDocument

Return the number of available parses of this document.

Will return 0 if there are no successful parses.

Overrides:

getNumberOfParses in class InvisibleXmlDocument

Returns:

The number of parses.

getTree

public String getTree()

Description copied from class: InvisibleXmlDocument

Return an XML representation of the current parse.

Overrides:

getTree in class InvisibleXmlDocument

Returns:

the XML.

getTree

public void getTree(PrintStream output)

Description copied from class: InvisibleXmlDocument

Write an XML representation of the current parse to the stream.

Overrides:

getTree in class InvisibleXmlDocument

Parameters:

output - the output stream.

getTree

public void getTree(ContentHandler handler)

Description copied from class: InvisibleXmlDocument

Write an XML representation of the current parse to a SAX ContentHandler.

Overrides:

getTree in class InvisibleXmlDocument

Parameters:

handler - the content handler.

getTree

public void getTree(ContentHandler handler,
 ParserOptions options)

Description copied from class: InvisibleXmlDocument

Write an XML representation of the current parse to a SAX ContentHandler using a different set of options.

Overrides:

getTree in class InvisibleXmlDocument

Parameters:

handler - the content handler.

options - the options.

getTree

public void getTree(org.nineml.coffeegrinder.trees.TreeBuilder builder)

Description copied from class: InvisibleXmlDocument

Process the result with your own TreeBuilder.

This API needs work.

Overrides:

getTree in class InvisibleXmlDocument

Parameters:

builder - the tree builder.