LogicWeaver

Inspiration

INSPIRED BY BEHAVIOR TREE.
USED AS BEHAVIOR TREE.
MORE THAN BEHAVIOR TREE.
AND MAKE EVERYBODY HAPPY.

The most tedious part of software development must be the implementation of bussiness logic. Engineers used to waste a lot of time on those if-else logic. There must be a new way to accomplish those task. This framework aims at providing a visual and editable way to write those logic code. I call it "logic weaver".

Setup with maven

<dependencies>
	<dependency>
		<groupId>com.lvonce</groupId>
		<artifactId>logicweaver</artifactId>
		<version>1.0.0</version>
	</dependency>
</dependencies>

Examples

config -> action -> logic -> executor

import com.lvonce.logicweaver.LogicDebug;
import com.lvonce.logicweaver.concepts.LogicResult;
import com.lvonce.logicweaver.interfaces.ILogicNode;
import com.lvonce.logicweaver.interfaces.ILogicAction;
import com.lvonce.logicweaver.interfaces.ILogicExecutor;
import com.lvonce.logicweaver.executors.LogicExecutor;
import com.lvonce.logicweaver.annotations.LogicActionNode;
import static com.lvonce.logicweaver.builders.LogicWeaver.*;

public class App {

	static class PersonConfig {
		public final int x;
		public final String y;
		public PersonConfig(int x, String y) {
			this.x = x;
			this.y = y;
		}
	}

	static class Person {

		@LogicAction(index=1)
		public static ILogicAction<Person, PersonConfig> action1;

		@LogicAction(index=2)
		public static ILogicAction<Person, PersonConfig> action2;

		static {
			action1 = (Person person, ILogicExecutor e, PersonConfig config)->{
				LogicDebug.debug("action1(%s, %s)", config.x, config.y);
				return LogicResult.TRUE;
			};

			action2 = (Person person, ILogicExecutor e, PersonConfig config)->{
				LogicDebug.debug("action2(%s, %s)", config.x, config.y);
				return LogicResult.FALSE;
			};
		}
	}
	
	static final ILogicNode logic = defineStart(Person.class)
		.genSequenceFalse(
			genSequenceTrue(
				genNode(Person.action1, new PersonConfig(1, "config1")),
				genNode(Person.action2, new PersonConfig(1, "config1")),
				genNode(Person.action1, new PersonConfig(1, "config1"))
			),
			genParallelAnd(
				genNode(Person.action1, new PersonConfig(1, "config1")),
				genNode(Person.action2, new PersonConfig(1, "config1")),
				genNode(Person.action1, new PersonConfig(1, "config1"))
			)
		).defineFinish();

	public static void main( String[] args ) {
		Person person = new Person();
		LogicExecutor executor = new LogicExecutor(person, logic);
		executor.run();
	}
}

You can run this simple example under examples directory:

cd examples/helloworld
mvn packge
java -jar target/helloworld-1.0-SNAPSHOT-jar-with-dependencies.jar

Where amazing happens

GUI Json Editor -> Json -> Logic Definition Class

PM(production manager) | SE(software engineer) | QA(quality assurance)  
PM: edit the global loigc in a visual way and change it any time  
SE: implement the action node with simple and clear code  
QA: simply test the action node without worry about global logic  
AND MAKE EVERYBODY HAPPY.

Design Concepts

Node Status

Status	Description
Init	with no result
Waiting	result is a task, run the task will get the actual result
Null	result is meaningless, just ignore it
True	resutl is success
False	result is fail
Discard	result is fatal error, discard and restart

Basic Usage

Global View
1.Config class can be defined as any POJO.
2.Entity class can be defined without any limit.
3.Action node must be static ILogicAction type and annotated with LogicActionNode.
4.Logic definition must begin with defineStart and end with defineFinish.
5.Executor takes entity and logic as constructor parameters.

Action View
1.Action return LogicResult.TRUE to indicate success.
2.Action return LogicResult.FALSE to indicate fail.
3.Action return LogicResult.NULL to indicate ignore.
4.Action return LogicResult.DISCARD to indicate stop and clear.
5.Action return ILogicFunction to give an extra task.
6.Action can call any function of the entity, because entity passed by the first parameter.
7.Action can call functions on executor to affect the logic running flow.