Package net.automatalib.serialization.fsm.parser

Class AbstractFSMParser<I>

java.lang.Object

net.automatalib.serialization.fsm.parser.AbstractFSMParser<I>

Direct Known Subclasses:

AbstractFSM2MealyParser, FSM2DFAParser

public abstract class AbstractFSMParser<I>
extends Object

This class provides methods to parse automata in FSM format.

The FSM is parsed by means of a tokenizer (a grammar is not used).

See Also:

the FSM format

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractFSMParser.Part	An enumeration for the three parts in the FSM file.

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXPECT_CHAR
static String	EXPECT_IDENTIFIER
static String	EXPECT_NUMBER
static String	EXPECT_STRING
static String	NO_SUCH_STATE
static String	NON_DETERMINISM_DETECTED
protected @Nullable Collection<? extends I>	targetInputs	The set that contains all inputs that end up in the input alphabet (provided by the user, may be null).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFSMParser(@Nullable Collection<? extends I> targetInputs, Function<String,I> inputParser)	Constructs a new AbstractFSMParser and defines all possible tokens.

Method Summary

Modifier and Type	Method	Description
protected abstract void	checkDataDefinitions(StreamTokenizer streamTokenizer)	Perform some actions after all data definitions have been parsed.
protected abstract void	checkStateVectors(StreamTokenizer streamTokenizer)	Perform some actions after all state vectors have been parsed.
protected abstract void	checkTransitions(StreamTokenizer streamTokenizer)	Perform some actions after all transitions have been parsed.
protected Function<String,I>	getInputParser()	Gets the function that transforms strings in the FSM file to input.
protected Set<I>	getInputs()	Gets the set that contains all inputs that end up in the input alphabet.
protected int	getPartLineNumber()	Returns the line number that is being parsed in the current part.
protected StreamTokenizer	getStreamTokenizer(Reader reader)	Gets the StreamTokenizer, that tokenizes tokens in the FSM file.
protected void	parse(Reader reader)	Parsed the FSM file line-by-line.
protected abstract void	parseDataDefinition(StreamTokenizer streamTokenizer)	Parse a data definition.
protected abstract void	parseStateVector(StreamTokenizer streamTokenizer)	Parse a state vector.
protected abstract void	parseTransition(StreamTokenizer streamTokenizer)	Parse a transition.

Methods inherited from class java.lang.Object

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

Field Detail

NO_SUCH_STATE

public static final String NO_SUCH_STATE

See Also:

Constant Field Values

NON_DETERMINISM_DETECTED

public static final String NON_DETERMINISM_DETECTED

See Also:

Constant Field Values

EXPECT_CHAR

public static final String EXPECT_CHAR

See Also:

Constant Field Values

EXPECT_NUMBER

public static final String EXPECT_NUMBER

See Also:

Constant Field Values

EXPECT_IDENTIFIER

public static final String EXPECT_IDENTIFIER

See Also:

Constant Field Values

EXPECT_STRING

public static final String EXPECT_STRING

See Also:

Constant Field Values

targetInputs

protected final @Nullable Collection<? extends I> targetInputs

The set that contains all inputs that end up in the input alphabet (provided by the user, may be null).

Constructor Detail

AbstractFSMParser

protected AbstractFSMParser(@Nullable Collection<? extends I> targetInputs,
                            Function<String,I> inputParser)

Constructs a new AbstractFSMParser and defines all possible tokens.

Parameters:

targetInputs - A collection containing the inputs which should constitute the input alphabet of the parsed automaton. If null, the inputs will be automatically gathered from the read FSM file.

inputParser - the Function that parses strings in the FSM file to input.

Method Detail

getInputParser

protected Function<String,I> getInputParser()

Gets the function that transforms strings in the FSM file to input.

Returns:

the function.

getPartLineNumber

protected int getPartLineNumber()

Returns the line number that is being parsed in the current part.

Returns:

the line number.

getStreamTokenizer

protected StreamTokenizer getStreamTokenizer(Reader reader)

Gets the StreamTokenizer, that tokenizes tokens in the FSM file.

Parameters:

reader - the source of the FSM file

Returns:

the StreamTokenizer.

getInputs

protected Set<I> getInputs()

Gets the set that contains all inputs that end up in the input alphabet.

Returns:

the set of inputs.

parseDataDefinition

protected abstract void parseDataDefinition(StreamTokenizer streamTokenizer)
                                     throws IOException

Parse a data definition.

Parameters:

streamTokenizer - tokenizer containing the input

Throws:

FSMFormatException - when the FSM source is invalid.

IOException - when FSM source could not be read.

checkDataDefinitions

protected abstract void checkDataDefinitions(StreamTokenizer streamTokenizer)
                                      throws IOException

Perform some actions after all data definitions have been parsed.

Parameters:

streamTokenizer - tokenizer containing the input

Throws:

FSMFormatException - when the FSM source is invalid.

IOException - when FSM source could not be read.

parseStateVector

protected abstract void parseStateVector(StreamTokenizer streamTokenizer)
                                  throws IOException

Parse a state vector.

Parameters:

streamTokenizer - tokenizer containing the input

Throws:

FSMFormatException - when the FSM source is invalid.

IOException - when FSM source could not be read.

checkStateVectors

protected abstract void checkStateVectors(StreamTokenizer streamTokenizer)
                                   throws IOException

Perform some actions after all state vectors have been parsed.

Parameters:

streamTokenizer - tokenizer containing the input

Throws:

FSMFormatException - when the FSM source is invalid.

IOException - when FSM source could not be read.

parseTransition

protected abstract void parseTransition(StreamTokenizer streamTokenizer)
                                 throws IOException

Parse a transition.

Parameters:

streamTokenizer - tokenizer containing the input

Throws:

FSMFormatException - when the FSM source is invalid.

IOException - when FSM source could not be read.

checkTransitions

protected abstract void checkTransitions(StreamTokenizer streamTokenizer)
                                  throws IOException

Perform some actions after all transitions have been parsed.

Parameters:

streamTokenizer - tokenizer containing the input

Throws:

FSMFormatException - when the FSM source is invalid.

IOException - when FSM source could not be read.

parse

protected void parse(Reader reader)
              throws IOException

Parsed the FSM file line-by-line. At first this method expects to parse data definitions, and calls parseDataDefinition(StreamTokenizer) for each data definition. After "---" is encountered checkDataDefinitions(StreamTokenizer) is called, and this method expects to parse state vectors. The behavior is similar for state vectors and transitions. For each line this method will increment partLineNumber, and reset it when a new part in the FSM file begins.

Note that StreamTokenizer allows one to push back tokens. This is used whenever we have checked the type of token we are going to read.

Parameters:

reader - the source of the FSM file

Throws:

FSMFormatException - when the FSM source is invalid.

IOException - when FSM source could not be read.