The Jacaranda Framework

The Jacaranda Framework is a Java framework realized with the intention to provide an easy and customizable design for the implementation of different finite-state machines (FSM). The added value in respect to other implementations is the framework character of the system, which offers different flexible and customizable parts (hot spots) through which the user not only can change, as usual, the content of the finite-state machine updating the input document with different states and arcs relations, but also customize it in different ways, including type of arcs, kind of output, way of traversing, etc., creating its own instance of the desired FSM.

Documentation

Brief introduction to the project in general,  finite-state machines and motivations for the framework.

Framework architecture overview, with some insides into the implementation

How to write an application. Cookbook for the application developer, including the explanations of two different delivered applications.

How to use an application. Quick guide for the application user, i.e. the user who needs to embed a Jacaranda application within its own application code.

Advanced features of the framework. Explanations on how the application developer can extend some functionalities of the framework.

For test infected only. A brief explanation on how the tests have been conceived and how they can be extended.

References. A list of references used for the design and implementation of the system, not cited in the rest of the documentation.

The Jacaranda Picture Show  (59 K). An informal explanation of the "shaken Jacaranda" algorithm.

Download Contents

• documentation    various documents, including explanations,  architecture overview and cookbook.
• javadoc                Java internal documentation
• jacaranda.jar        a jar file containing the framework and two described applications
• src.zip                 source code of the framework
• dfa-doc                directory of documents for the first delivered example application (DFA)
• trans-doc             directory of documents for the second delivered example application (FST)

Installation

1. Decide where you want the directory to live. It can be anywhere in your file system.
2. Unzip the downloaded file jacaranda.zip into your chosen directory (the framework untars itself into the sub directory "jacaranda").
3. Add jacaranda.jar to the CLASSPATH of your system
•  example for bash shell Linux:  export CLASSPATH=/home/sandro/jacaranda/jacaranda.jar:$CLASSPATH, where "/home/sandro/ must be substituted with your own path
• example for windows: set CLASSPATH=%CLASSPATH%;C:\sandro\jacaranda\jacaranda.jar, where C:\sandro\ must be substituted with your own path
4. Test if everything is ok loading one of the delivered input documents:
• move into the directory dfa-doc and type:  java jacaranda.dfa.Run Even10.tra

The program will show a prompt where you can enter sequences of bits (001100) ended by an enter. The DFA accepts only sequences with even 1s and 0s.

Download

jacaranda.zip

Todo List

Extend the use of Exceptions within the framework

Add new test cases to the Infect files

Test with different JREs

Add new documents

Contact

For any problem, comment or suggestion, feel free to contact me at the following address:
sandro.pedrazzini@canoo.com