org.nineml.coffeegrinder.parser

Class ParserOptions

java.lang.Object

org.nineml.coffeegrinder.parser.ParserOptions

public class ParserOptions
extends java.lang.Object

Options to the parser.

This object is extended by other members of the NineML family to provide additional options. It started out as a collection of public fields, but changed to a more traditional collection of getters and setters when it began to develop options that were not entirely independent.

Constructor Summary

Constructors

Constructor and Description
ParserOptions() Create the parser options.
ParserOptions(Logger logger) Create the parser options with an explicit logger.
ParserOptions(ParserOptions copy) Create a new set of options from an existing set.

Method Summary

Modifier and Type	Method and Description
Logger	getLogger() The parser logger.
boolean	getMarkAmbiguities() Are individual ambiguities be marked?
boolean	getNormalizeLineEndings() Should line endings be normalized?
java.lang.String	getParserType() Return the default parser type.
boolean	getPrefixParsing() If a parse fails, but some prefix of the input was successfully parsed, make that available.
java.lang.String	getPriorityStyle() The priority style.
ProgressMonitor	getProgressMonitor() The progress monitor.
boolean	getReturnChart() Return the Earley chart even for a successful parse?
void	setLogger(Logger logger) Set the logger.
void	setMarkAmbiguities(boolean mark) Set ambiguity marking.
void	setNormalizeLineEndings(boolean normalize) Set normalize line endings
void	setParserType(java.lang.String parserType) Set the default parser type.
void	setPrefixParsing(boolean prefixParsing) Set the getPrefixParsing() property.
void	setPriorityStyle(java.lang.String style) Set the priority style.
void	setProgressMonitor(ProgressMonitor monitor) Set the progress monitor.
void	setReturnChart(boolean returnChart) Set the getReturnChart() property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParserOptions

public ParserOptions()

Create the parser options.

The initial logger will be a DefaultLogger initialized with readSystemProperties().

ParserOptions

public ParserOptions(Logger logger)

Create the parser options with an explicit logger.

Parameters:

logger - the logger.

ParserOptions

public ParserOptions(ParserOptions copy)

Create a new set of options from an existing set.

Beware that the logger and monitor are not copied, so the copied options have pointers to the same logger and monitor instances.

Parameters:

copy - the options to copy

Method Detail

getParserType

public java.lang.String getParserType()

Return the default parser type.

Returns:

The default parser type, "Earley" or "GLL"

setParserType

public void setParserType(java.lang.String parserType)

Set the default parser type.

Parameters:

parserType - the parser type, "Earley" or "GLL"

Throws:

java.lang.IllegalArgumentException - if the parser type is not recognized

getReturnChart

public boolean getReturnChart()

Return the Earley chart even for a successful parse?

Returns:

true if the Earley chart should be returned even for an unsuccessful parse

setReturnChart

public void setReturnChart(boolean returnChart)

Set the getReturnChart() property.

Parameters:

returnChart - return the chart?

getPrefixParsing

public boolean getPrefixParsing()

If a parse fails, but some prefix of the input was successfully parsed, make that available.

This is optional mostly because it requires internally buffering some of the input tokens. (Probably no more than two, but I haven't tried to prove that.)

Returns:

true if prefix parsing is enabled.

setPrefixParsing

public void setPrefixParsing(boolean prefixParsing)

Set the getPrefixParsing() property.

Parameters:

prefixParsing - prefix parsing?

getLogger

public Logger getLogger()

The parser logger.

The logger controls what messages are issued, and how. This component is also used by higher-level components such as CoffeeFilter, CoffeePot, and CoffeeSacks.

Returns:

the logger.

setLogger

public void setLogger(Logger logger)

Set the logger.

Parameters:

logger - the logger.

Throws:

java.lang.NullPointerException - if the logger is null.

getProgressMonitor

public ProgressMonitor getProgressMonitor()

The progress monitor.

If this option is not null, the monitor will be called before, during, and after the parse.

Returns:

the monitor

setProgressMonitor

public void setProgressMonitor(ProgressMonitor monitor)

Set the progress monitor.

Setting the monitor to null disables monitoring.

Parameters:

monitor - the monitor.

getPriorityStyle

public java.lang.String getPriorityStyle()

The priority style.

Priorities can be computed on one of two styles: "max" or "sum".

If the priority style is "max", the priority of any given node is the highest priority value in the subgraph rooted at the current node.

If the priority style is "sum", the priority of any given node is the sum of the priorities of the nodes in the subgraph rooted at the current node.

Returns:

the priority style

setPriorityStyle

public void setPriorityStyle(java.lang.String style)

Set the priority style.

The style can be "max" or "sum". The default is "max".

Parameters:

style - the priority style.

getNormalizeLineEndings

public boolean getNormalizeLineEndings()

Should line endings be normalized?

If line endings are normalized, all occurrences of #D, #D#A, #85, and #2028 in the input string are replaced with a single #A. This only applies to sequences of characters in the input.

Returns:

true if line endings will be normalized

setNormalizeLineEndings

public void setNormalizeLineEndings(boolean normalize)

Set normalize line endings

If line endings are normalized, all occurrences of #D, #D#A, #85, and #2028 in the input string are replaced with a single #A. This only applies to sequences of characters in the input.

Parameters:

normalize - true if line endings should be normalized

getMarkAmbiguities

public boolean getMarkAmbiguities()

Are individual ambiguities be marked?

Returns:

true if ambiguities will be normalized

setMarkAmbiguities

public void setMarkAmbiguities(boolean mark)

Set ambiguity marking.

Parameters:

mark - true if individual ambiguities should be marked.