net.sourceforge.anotherfsm.qfsm

Class Parser

java.lang.Object

net.sourceforge.anotherfsm.qfsm.Parser

public class Parser
extends java.lang.Object

Parser of Qfsm file format.

Author:

Michal Turek

Field Summary

Fields

Modifier and Type	Field and Description
private static FsmLogger	logger The logger.

Constructor Summary

Constructors

Constructor and Description
Parser()

Method Summary

Methods

Modifier and Type	Method and Description
static QfsmProject	parse(java.io.File file) Parse a Qfsm file.
static QfsmProject	parse(java.lang.String path) Parse a Qfsm file.
private static QfsmInitialTransition	parseInitialTransition(org.w3c.dom.Element itrEl)
private static QfsmMachine	parseMachine(org.w3c.dom.Element machineEl)
private static QfsmProject	parseProject(org.w3c.dom.Element projectEl)
private static java.util.List<QfsmState>	parseStates(java.util.List<org.w3c.dom.Element> elements)
private static java.util.List<QfsmTransition>	parseTransitions(java.util.List<org.w3c.dom.Element> elements)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final FsmLogger logger

The logger.

Constructor Detail

Parser

public Parser()

Method Detail

parse

public static QfsmProject parse(java.lang.String path)
                         throws QfsmException

Parse a Qfsm file.

Parameters:

path - the file system path

Returns:

the object representation of the Qfsm data file

Throws:

QfsmException - if parsing fails for any reason

See Also:

parse(File)

parse

public static QfsmProject parse(java.io.File file)
                         throws QfsmException

Parse a Qfsm file. Data files from Qfsm of 0.52 and 0.53 versions should be successfully parsed.

Limitations and differences from Qfsm

• QfsmMachine.startStateId attribute is optional in Qfsm, a warning will be logged if not defined.
• QfsmMachine.initialTransition element is optional in Qfsm, a warning will be logged if not defined.
• Several text parameters that contain multiple values (list) are not parsed to the smallest pieces.
• Parsing of file with broken transition - source and/or destination state is not connected - throws an exception and the file is not loaded. The file should be fixed first in such case.

Note Qfsm supports various state machine types, but not all of them were tested. Please report a bug if loading of your file fails and you believe the issue is in this library (patch appreciated). See Qfsm source code, Project.cpp, Project::getDomDocument().

Parameters:

file - the input file

Returns:

the object representation of the Qfsm data file

Throws:

QfsmException - if parsing fails for any reason

parseProject

private static QfsmProject parseProject(org.w3c.dom.Element projectEl)
                                 throws QfsmException

Throws:

QfsmException

parseMachine

private static QfsmMachine parseMachine(org.w3c.dom.Element machineEl)
                                 throws QfsmException

Throws:

QfsmException

parseStates

private static java.util.List<QfsmState> parseStates(java.util.List<org.w3c.dom.Element> elements)
                                              throws QfsmException

Throws:

QfsmException

parseTransitions

private static java.util.List<QfsmTransition> parseTransitions(java.util.List<org.w3c.dom.Element> elements)
                                                        throws QfsmException

Throws:

QfsmException

parseInitialTransition

private static QfsmInitialTransition parseInitialTransition(org.w3c.dom.Element itrEl)
                                                     throws QfsmException

Throws:

QfsmException