com.jiowa.template.reader

Class TokenStateMachine

java.lang.Object

com.jiowa.template.reader.TokenStateMachine

public class TokenStateMachine
extends java.lang.Object

Simple state machine for the parsing process. It basically contains just the description of the transitions between the different tokens (or states) while parsing the data. The TokenReader uses this transition map in order to control the state-based parsing process. For a given state (Class) there is a set of transitions states, which are in represented as tokens.

Author:

Robert Mencl

Copyright (C) 2012-2014 JIOWA Business Solutions GmbH, Bettinastr. 30 , 60325 Frankfurt am Main, Germany
Homepage: www.jiowa.de
All rights reserved.

Download: www.jiowa.de/download.html
License: www.jiowa.de/license.html

Field Summary

Fields

Modifier and Type	Field and Description
protected SymbolToken	ARBITRARY
protected java.lang.Class<?>	currentState Start state for the state machine
protected java.lang.Class<?>	finalState End state for the state machine: null if there is none.
protected SymbolToken	INCLUDE
protected SymbolToken	NAME_QUALIFIER
protected SymbolToken	OR
protected SymbolToken	REDEF_END
protected SymbolToken	REDEF_POINTER
protected SymbolToken	REDEF_SEPARATOR
protected SymbolToken	REDEF_START
protected SymbolToken	SUBTEMPLATE_END
protected SymbolToken	SUBTEMPLATE_INDICATOR
protected SymbolToken	SUBTEMPLATE_START
protected SymbolToken	TAG_END
protected SymbolToken	TAG_START
protected TemplateNotation	templateNotation The given template notation
protected com.jiowa.util.map.Key2SortedValuesMap<java.lang.Class<?>,SymbolToken>	transitions Transition table

Constructor Summary

Constructors

Constructor and Description
TokenStateMachine(java.lang.Class<?> initialState, java.lang.Class<?> finalState, TemplateNotation templateNotation)
TokenStateMachine(TemplateNotation templateNotation)

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>	changeState(java.lang.Class<?> newState) Change the state.
void	changeTemplateNotation(TemplateNotation notation)
java.lang.Class<?>	getCurrentState() Returns the current state.
java.util.SortedSet<java.lang.Class<?>>	getTransitionStates(java.lang.Class<?> state) Returns the possible transition states.
java.util.SortedSet<SymbolToken>	getTransitionStatesAsTokens(java.lang.Class<?> state) Returns the transition states as tokens according to the given template notation.
protected void	initialize()

Methods inherited from class java.lang.Object

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

Field Detail

currentState

protected java.lang.Class<?> currentState

Start state for the state machine

finalState

protected java.lang.Class<?> finalState

End state for the state machine: null if there is none.

transitions

protected com.jiowa.util.map.Key2SortedValuesMap<java.lang.Class<?>,SymbolToken> transitions

Transition table

templateNotation

protected TemplateNotation templateNotation

The given template notation

TAG_START

protected SymbolToken TAG_START

TAG_END

protected SymbolToken TAG_END

INCLUDE

protected SymbolToken INCLUDE

NAME_QUALIFIER

protected SymbolToken NAME_QUALIFIER

SUBTEMPLATE_START

protected SymbolToken SUBTEMPLATE_START

SUBTEMPLATE_END

protected SymbolToken SUBTEMPLATE_END

SUBTEMPLATE_INDICATOR

protected SymbolToken SUBTEMPLATE_INDICATOR

ARBITRARY

protected SymbolToken ARBITRARY

OR

protected SymbolToken OR

REDEF_START

protected SymbolToken REDEF_START

REDEF_POINTER

protected SymbolToken REDEF_POINTER

REDEF_SEPARATOR

protected SymbolToken REDEF_SEPARATOR

REDEF_END

protected SymbolToken REDEF_END

Constructor Detail

TokenStateMachine

public TokenStateMachine(java.lang.Class<?> initialState,
                         java.lang.Class<?> finalState,
                         TemplateNotation templateNotation)

TokenStateMachine

public TokenStateMachine(TemplateNotation templateNotation)

Method Detail

changeTemplateNotation

public void changeTemplateNotation(TemplateNotation notation)

getCurrentState

public java.lang.Class<?> getCurrentState()

Returns the current state.

getTransitionStatesAsTokens

public java.util.SortedSet<SymbolToken> getTransitionStatesAsTokens(java.lang.Class<?> state)

Returns the transition states as tokens according to the given template notation. The tokens (template notation dependent) are used to control the parsing process within the TokenReader.

getTransitionStates

public java.util.SortedSet<java.lang.Class<?>> getTransitionStates(java.lang.Class<?> state)

Returns the possible transition states.

Parameters:

state -

Returns:

set of possible transition states for the given state

changeState

public java.lang.Class<?> changeState(java.lang.Class<?> newState)

Change the state. If the transition is not allowed than just log an error. That's enough because this case should never happen, that the transition to be performed is not allowed. The transitions is always initiated by the TokenReader and the reader always knows in which state it is and which transition can be executed.

Parameters:

newState -

Returns:

the new state if this transition was possible

initialize

protected void initialize()