Core reference

Reference examples accompanying user documentation

Introduction

The set of examples that accompany the documentation are located in the main fluxtion code repo here.

to build the examples regenerating the Fluxtion outputs use the following maven command:

cd examples/documentation-examples
mvn install

Project structure

The package structure of the example follows that of the documentation.

document section	Package
Event processing	com.fluxtion.example.core.events
Graph building	com.fluxtion.example.core.building
Dependency injection	com.fluxtion.example.core.dependencyinjection
Auditing	com.fluxtion.example.core.audit
Generation output control	com.fluxtion.example.core.outstyle

Maven pom

In the root of the project is the main maven pom file. The pom builds all the examples generating a SEP for each example, a section of the pom file is shown below:

        <profile>
            <id>build-examples</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-compiler-plugin</artifactId>
                        <version>3.8.0</version>
                        <configuration>
                            <compilerArgs>
                                <arg>-parameters</arg>
                            </compilerArgs>
                        </configuration>
                    </plugin>
                    <plugin>
                        <groupId>com.fluxtion</groupId>
                        <artifactId>fluxtion-maven-plugin</artifactId>
                        <version>${project.version}</version>
                        <executions>
                            <execution>
                                <id>filtering</id>
                                <goals>
                                    <goal>generate</goal>
                                </goals>
                                <configuration>
                                    <configClass>com.fluxtion.example.core.events.filtering.Builder</configClass>
                                    <packageName>com.fluxtion.example.core.events.filtering.generated</packageName>
                                    <className>SampleProcessor</className>
                                    <outputDirectory>src/main/java</outputDirectory>
                                    <generateDescription>false</generateDescription>
                                </configuration>
                            </execution>
                            <execution>
                                <id>single-handler</id>
                                <goals>
                                    <goal>generate</goal>
                                </goals>
                                <configuration>
                                    <configClass>com.fluxtion.example.core.events.singlehandler.Builder</configClass>
                                    <packageName>com.fluxtion.example.core.events.singlehandler.generated</packageName>
                                    <className>SampleProcessor</className>
                                    <outputDirectory>src/main/java</outputDirectory>
                                </configuration>
                            </execution>
                            .....
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

Notes

• A profile "build-examples" contains the Fluxtion plugin execution. This profile is enabled by default.

• The compiler plugin is specified with the parameters option.

• Multiple Fluxtion executions are defined, one for each example

• Most examples use an imperative form specifying the config class..