added documentation for EntityCreationService, RedactionEntity to prompts

DM-165: Renamed isOnPage to onPage to prevent not working drools optimizations

Closes DM-165

See merge request redactmanager/redaction-service!81

.gitignore

@@ -9,6 +9,49 @@
 **/tmp/
 **/.apt_generated/
 
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### maven build ###
+*.class
+/out/
+/build/
+/target/
+**/out/
+**/build/
+**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+.gradle
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/
 
 .factorypath
 .springBeans
@@ -26,3 +69,7 @@
 **/.DS_Store
 **/classpath-data.json
 **/dependencies-and-licenses-overview.txt
+gradle.properties
+gradlew
+gradlew.bat
+gradle/

.gitlab-ci.yml

@@ -0,0 +1,6 @@
+variables:
+  SONAR_PROJECT_KEY: 'RED_redaction-service'
+include:
+  - project: 'gitlab/gitlab'
+    ref: 'main'
+    file: 'ci-templates/gradle_java.yml'

CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]

bamboo-specs/pom.xml

@@ -1,37 +0,0 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-  <modelVersion>4.0.0</modelVersion>
-
-  <parent>
-    <groupId>com.atlassian.bamboo</groupId>
-    <artifactId>bamboo-specs-parent</artifactId>
-    <version>7.2.2</version>
-    <relativePath/>
-  </parent>
-
-  <artifactId>bamboo-specs</artifactId>
-  <version>1.0.0-SNAPSHOT</version>
-  <packaging>jar</packaging>
-
-  <dependencies>
-    <dependency>
-      <groupId>com.atlassian.bamboo</groupId>
-      <artifactId>bamboo-specs-api</artifactId>
-    </dependency>
-    <dependency>
-      <groupId>com.atlassian.bamboo</groupId>
-      <artifactId>bamboo-specs</artifactId>
-    </dependency>
-
-    <!-- Test dependencies -->
-    <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <scope>test</scope>
-    </dependency>
-  </dependencies>
-
-
-  <!-- run 'mvn test' to perform offline validation of the plan -->
-  <!-- run 'mvn -Ppublish-specs' to upload the plan to your Bamboo server -->
-</project>

bamboo-specs/src/main/java/buildjob/PlanSpec.java

@@ -1,122 +0,0 @@
-package buildjob;
-
-import com.atlassian.bamboo.specs.api.BambooSpec;
-import com.atlassian.bamboo.specs.api.builders.BambooKey;
-import com.atlassian.bamboo.specs.api.builders.docker.DockerConfiguration;
-import com.atlassian.bamboo.specs.api.builders.permission.PermissionType;
-import com.atlassian.bamboo.specs.api.builders.permission.Permissions;
-import com.atlassian.bamboo.specs.api.builders.permission.PlanPermissions;
-import com.atlassian.bamboo.specs.api.builders.plan.Job;
-import com.atlassian.bamboo.specs.api.builders.plan.Plan;
-import com.atlassian.bamboo.specs.api.builders.plan.PlanIdentifier;
-import com.atlassian.bamboo.specs.api.builders.plan.Stage;
-import com.atlassian.bamboo.specs.api.builders.plan.branches.BranchCleanup;
-import com.atlassian.bamboo.specs.api.builders.plan.branches.PlanBranchManagement;
-import com.atlassian.bamboo.specs.api.builders.project.Project;
-import com.atlassian.bamboo.specs.builders.task.CheckoutItem;
-import com.atlassian.bamboo.specs.builders.task.InjectVariablesTask;
-import com.atlassian.bamboo.specs.builders.task.ScriptTask;
-import com.atlassian.bamboo.specs.builders.task.VcsCheckoutTask;
-import com.atlassian.bamboo.specs.builders.task.VcsTagTask;
-import com.atlassian.bamboo.specs.builders.trigger.BitbucketServerTrigger;
-import com.atlassian.bamboo.specs.model.task.InjectVariablesScope;
-import com.atlassian.bamboo.specs.util.BambooServer;
-import com.atlassian.bamboo.specs.builders.task.ScriptTask;
-import com.atlassian.bamboo.specs.model.task.ScriptTaskProperties.Location;
-
-import static com.atlassian.bamboo.specs.builders.task.TestParserTask.createJUnitParserTask;
-
-/**
- * Plan configuration for Bamboo.
- * Learn more on: <a href="https://confluence.atlassian.com/display/BAMBOO/Bamboo+Specs">https://confluence.atlassian.com/display/BAMBOO/Bamboo+Specs</a>
- */
-@BambooSpec
-public class PlanSpec {
-
-    private static final String SERVICE_NAME = "redaction-service";
-
-    private static final String JVM_ARGS =" -Xmx4g -XX:+ExitOnOutOfMemoryError -XX:SurvivorRatio=2 -XX:NewRatio=1 -XX:InitialTenuringThreshold=16 -XX:MaxTenuringThreshold=16 -XX:InitiatingHeapOccupancyPercent=35 ";
-
-    private static final String SERVICE_KEY = SERVICE_NAME.toUpperCase().replaceAll("-", "");
-
-    /**
-     * Run main to publish plan on Bamboo
-     */
-    public static void main(final String[] args) throws Exception {
-        //By default credentials are read from the '.credentials' file.
-        BambooServer bambooServer = new BambooServer("http://localhost:8085");
-
-        Plan plan = new PlanSpec().createPlan();
-        bambooServer.publish(plan);
-        PlanPermissions planPermission = new PlanSpec().createPlanPermission(plan.getIdentifier());
-        bambooServer.publish(planPermission);
-    }
-
-    private PlanPermissions createPlanPermission(PlanIdentifier planIdentifier) {
-        Permissions permission = new Permissions()
-                .userPermissions("atlbamboo", PermissionType.EDIT, PermissionType.VIEW, PermissionType.ADMIN, PermissionType.CLONE, PermissionType.BUILD)
-                .groupPermissions("red-backend", PermissionType.EDIT, PermissionType.VIEW, PermissionType.CLONE, PermissionType.BUILD)
-                .loggedInUserPermissions(PermissionType.VIEW)
-                .anonymousUserPermissionView();
-        return new PlanPermissions(planIdentifier.getProjectKey(), planIdentifier.getPlanKey()).permissions(permission);
-    }
-
-    private Project project() {
-        return new Project()
-                .name("RED")
-                .key(new BambooKey("RED"));
-    }
-
-    public Plan createPlan() {
-        return new Plan(
-                project(),
-                SERVICE_NAME, new BambooKey(SERVICE_KEY))
-                .description("Plan created from (enter repository url of your plan)")
-                .stages(new Stage("Default Stage")
-                        .jobs(new Job("Default Job",
-                                new BambooKey("JOB1"))
-                                .tasks(
-                                        new ScriptTask()
-                                                .description("Clean")
-                                                .inlineBody("#!/bin/bash\n" +
-                                                        "set -e\n" +
-                                                        "rm -rf ./*"),
-                                        new VcsCheckoutTask()
-                                                .description("Checkout Default Repository")
-                                                .checkoutItems(new CheckoutItem().defaultRepository()),
-                                        new ScriptTask()
-                                                .description("Build")
-                                                .location(Location.FILE)
-                                                .fileFromPath("bamboo-specs/src/main/resources/scripts/build-java.sh")
-                                                .argument(SERVICE_NAME),
-                                        createJUnitParserTask()
-                                                .description("Resultparser")
-                                                .resultDirectories("**/test-reports/*.xml, **/target/surefire-reports/*.xml, **/target/failsafe-reports/*.xml")
-                                                .enabled(true),
-                                        new InjectVariablesTask()
-                                                .description("Inject git Tag")
-                                                .path("git.tag")
-                                                .namespace("g")
-                                                .scope(InjectVariablesScope.LOCAL),
-                                        new VcsTagTask()
-                                                .description("${bamboo.g.gitTag}")
-                                                .tagName("${bamboo.g.gitTag}")
-                                                .defaultRepository())
-                                .dockerConfiguration(
-                                        new DockerConfiguration()
-                                                .image("nexus.iqser.com:5001/infra/maven:3.6.2-jdk-13-3.0.0")
-                                                .volume("/etc/maven/settings.xml", "/usr/share/maven/ref/settings.xml")
-                                                .volume("/var/run/docker.sock", "/var/run/docker.sock")
-                                )
-                        )
-                )
-                .linkedRepositories("RED / " + SERVICE_NAME)
-
-                .triggers(new BitbucketServerTrigger())
-                .planBranchManagement(new PlanBranchManagement()
-                        .createForVcsBranch()
-                        .delete(new BranchCleanup()
-                                .whenInactiveInRepositoryAfterDays(14))
-                        .notificationForCommitters());
-    }
-}

bamboo-specs/src/main/resources/scripts/build-java.sh

@@ -1,51 +0,0 @@
-#!/bin/bash
-set -e
-
-SERVICE_NAME=$1
-
-if [[ "${bamboo_version_tag}" = "dev" ]]
-then 
-    ${bamboo_capability_system_builder_mvn3_Maven_3}/bin/mvn \
-        -f ${bamboo_build_working_directory}/$SERVICE_NAME-v1/pom.xml \
-        --no-transfer-progress \
-        clean install \
-        -Djava.security.egd=file:/dev/./urandomelse
-else        
-    ${bamboo_capability_system_builder_mvn3_Maven_3}/bin/mvn \
-        --no-transfer-progress \
-        -f ${bamboo_build_working_directory}/$SERVICE_NAME-v1/pom.xml \
-        versions:set \
-        -DnewVersion=${bamboo_version_tag}
-    ${bamboo_capability_system_builder_mvn3_Maven_3}/bin/mvn \
-        --no-transfer-progress \
-        -f ${bamboo_build_working_directory}/$SERVICE_NAME-image-v1/pom.xml \
-        versions:set  \
-        -DnewVersion=${bamboo_version_tag}
-    ${bamboo_capability_system_builder_mvn3_Maven_3}/bin/mvn \
-        -f ${bamboo_build_working_directory}/$SERVICE_NAME-v1/pom.xml \
-        --no-transfer-progress \
-        clean deploy \
-        -e \
-        -DdeployAtEnd=true \
-        -Dmaven.wagon.http.ssl.insecure=true \
-        -Dmaven.wagon.http.ssl.allowall=true \
-        -Dmaven.wagon.http.ssl.ignore.validity.dates=true \
-        -DaltDeploymentRepository=iqser_release::default::https://nexus.iqser.com/repository/red-platform-releases
-fi
-
-${bamboo_capability_system_builder_mvn3_Maven_3}/bin/mvn \
-    --no-transfer-progress \
-    -f ${bamboo_build_working_directory}/$SERVICE_NAME-image-v1/pom.xml \
-    package
-
-${bamboo_capability_system_builder_mvn3_Maven_3}/bin/mvn \
-    --no-transfer-progress \
-    -f ${bamboo_build_working_directory}/$SERVICE_NAME-image-v1/pom.xml \
-    docker:push
-
-if [[ "${bamboo_version_tag}" = "dev" ]]
-then 
-    echo "gitTag=${bamboo_planRepository_1_branch}_${bamboo_buildNumber}" > git.tag
-else
-    echo "gitTag=${bamboo_version_tag}" > git.tag
-fi

bamboo-specs/src/test/java/buildjob/PlanSpecTest.java

@@ -1,17 +0,0 @@
-package buildjob;
-
-
-import org.junit.Test;
-
-import com.atlassian.bamboo.specs.api.builders.plan.Plan;
-import com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException;
-import com.atlassian.bamboo.specs.api.util.EntityPropertiesBuilders;
-
-public class PlanSpecTest {
-    @Test
-    public void checkYourPlanOffline() throws PropertiesValidationException {
-        Plan plan = new PlanSpec().createPlan();
-
-        EntityPropertiesBuilders.build(plan);
-    }
-}

buildSrc/build.gradle.kts

@@ -0,0 +1,7 @@
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    gradlePluginPortal()
+}

buildSrc/src/main/kotlin/com.iqser.red.service.java-conventions.gradle.kts

@@ -0,0 +1,75 @@
+plugins {
+    `java-library`
+    `maven-publish`
+    pmd
+    checkstyle
+    jacoco
+}
+
+group = "com.iqser.red"
+
+java.sourceCompatibility = JavaVersion.VERSION_17
+java.targetCompatibility = JavaVersion.VERSION_17
+
+tasks.pmdMain {
+    pmd.ruleSetFiles = files("${rootDir}/config/pmd/pmd.xml")
+}
+
+tasks.pmdTest {
+    pmd.ruleSetFiles = files("${rootDir}/config/pmd/test_pmd.xml")
+}
+
+tasks.named<Test>("test") {
+    useJUnitPlatform()
+    reports {
+        junitXml.outputLocation.set(layout.buildDirectory.dir("reports/junit"))
+    }
+}
+
+tasks.test {
+    finalizedBy(tasks.jacocoTestReport) // report is always generated after tests run
+}
+
+tasks.jacocoTestReport {
+    dependsOn(tasks.test) // tests are required to run before generating the report
+    reports {
+        xml.required.set(true)
+        csv.required.set(false)
+        html.outputLocation.set(layout.buildDirectory.dir("jacocoHtml"))
+    }
+}
+
+allprojects {
+    publishing {
+        publications {
+            create<MavenPublication>(name) {
+                from(components["java"])
+            }
+        }
+        repositories {
+            maven {
+                url = uri("https://nexus.knecon.com/repository/red-platform-releases/")
+                credentials {
+                    username = providers.gradleProperty("mavenUser").getOrNull();
+                    password = providers.gradleProperty("mavenPassword").getOrNull();
+                }
+            }
+        }
+    }
+}
+
+java {
+    withJavadocJar()
+}
+
+repositories {
+    mavenLocal()
+    mavenCentral()
+    maven {
+        url = uri("https://nexus.knecon.com/repository/gindev/");
+        credentials {
+            username = providers.gradleProperty("mavenUser").getOrNull();
+            password = providers.gradleProperty("mavenPassword").getOrNull();
+        }
+    }
+}

config/checkstyle/checkstyle.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+<module name="Checker">
+    <property
+            name="severity"
+            value="error"/>
+    <module name="TreeWalker">
+        <module name="SuppressWarningsHolder"/>
+        <module name="MissingDeprecated"/>
+        <module name="MissingOverride"/>
+        <module name="AnnotationLocation"/>
+        <module name="JavadocStyle"/>
+        <module name="NonEmptyAtclauseDescription"/>
+        <module name="IllegalImport"/>
+        <module name="RedundantImport"/>
+        <module name="RedundantModifier"/>
+        <module name="EmptyBlock"/>
+        <module name="DefaultComesLast"/>
+        <module name="EmptyStatement"/>
+        <module name="EqualsHashCode"/>
+        <module name="ExplicitInitialization"/>
+        <module name="IllegalInstantiation"/>
+        <module name="ModifiedControlVariable"/>
+        <module name="MultipleVariableDeclarations"/>
+        <module name="PackageDeclaration"/>
+        <module name="ParameterAssignment"/>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+        <module name="StringLiteralEquality"/>
+        <module name="OneStatementPerLine"/>
+        <module name="FinalClass"/>
+        <module name="ArrayTypeStyle"/>
+        <module name="UpperEll"/>
+        <module name="OuterTypeFilename"/>
+    </module>
+    <module name="FileTabCharacter"/>
+    <module name="SuppressWarningsFilter"/>
+</module>

config/pmd/pmd.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<ruleset name="Custom ruleset"
+         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+
+    <description>
+        Knecon ruleset checks the code for bad stuff
+    </description>
+
+    <rule ref="category/java/errorprone.xml">
+        <exclude name="DataflowAnomalyAnalysis"/>
+        <exclude name="MissingSerialVersionUID"/>
+        <exclude name="NullAssignment"/>
+        <exclude name="AvoidLiteralsInIfCondition"/>
+        <exclude name="AvoidDuplicateLiterals"/>
+        <exclude name="AvoidFieldNameMatchingMethodName"/>
+        <exclude name="AssignmentInOperand"/>
+    </rule>
+
+</ruleset>

config/pmd/test_pmd.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<ruleset name="Custom ruleset"
+         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+
+    <description>
+        Knecon test ruleset checks the code for bad stuff
+    </description>
+
+
+    <rule ref="category/java/errorprone.xml">
+        <exclude name="DataflowAnomalyAnalysis"/>
+        <exclude name="MissingSerialVersionUID"/>
+        <exclude name="NullAssignment"/>
+        <exclude name="AvoidLiteralsInIfCondition"/>
+        <exclude name="AvoidDuplicateLiterals"/>
+        <exclude name="AvoidFieldNameMatchingMethodName"/>
+        <exclude name="AvoidFieldNameMatchingTypeName"/>
+        <exclude name="AssignmentInOperand"/>
+        <exclude name="TestClassWithoutTestCases"/>
+    </rule>
+
+</ruleset>

drools-prompt/EntityCreationService_doc

@@ -0,0 +1,124 @@
+/**
+* Searches the provided SemanticNode for the keyword and creates an Entity for each occurrence.
+* @param keyword the string to search for
+* @param type The type of the RedactionEntity to be created
+* @param entityType The EntityType of the RedactionEntity to be created
+* @param node The SemanticNode to search in
+* @return A Stream of RedactionEntities with the keyword as value, the type as type and the provided EntityType
+*/
+public Stream<RedactionEntity> byString(String keyword, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as byString, but case insensitive.
+*/
+public Stream<RedactionEntity> byStringIgnoreCase(String keyword, String type, EntityType entityType, SemanticNode node)
+/**
+* Searches the provided SemanticNode with the regexPattern and creates a new RedactionEntity with the provided group for each occurrence.
+* @param regexPattern The regexPattern
+* @param type The type of the RedactionEntity to be created
+* @param entityType The EntityType of the RedactionEntity to be created
+* @param group the regexPattern group, that should be the entity
+* @param node The SemanticNode to search in
+* @return A Stream of RedactionEntities with the keyword as value, the type as type and the provided EntityType
+*/
+public Stream<RedactionEntity> byRegex(String regexPattern, String type, EntityType entityType, int group, SemanticNode node)
+/**
+* Same as byRegex, but case insensitive.
+*/
+public Stream<RedactionEntity> byRegexIgnoreCase(String regexPattern, String type, EntityType entityType, int group, SemanticNode node)
+/**
+* Same as byRegex, but can handle patterns with linebreaks.
+*/
+public Stream<RedactionEntity> byRegexWithLineBreaksIgnoreCase(String regexPattern, String type, EntityType entityType, int group, SemanticNode node)
+/**
+* Same as byRegexWithLineBreaks, but case insensitive.
+*/
+public Stream<RedactionEntity> byRegexWithLineBreaksIgnoreCase(String regexPattern, String type, EntityType entityType, int group, SemanticNode node)
+/**
+* Finds the provided string, and creates a new RedactionEntity from the text after until the end of the line it is found in.
+* @param string The keyword to search for
+* @param type The type of the RedactionEntity to be created
+* @param entityType The EntityType of the RedactionEntity to be created
+* @param node The SemanticNode to search in
+* @return A Stream of RedactionEntities with the keyword as value, the type as type and the provided EntityType
+*/
+public Stream<RedactionEntity> lineAfterString(String string, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as lineAfterString, but with multiple keywords
+*/
+public Stream<RedactionEntity> lineAfterStrings(List<String> strings, String type, EntityType entityType, SemanticNode node)
+/**
+* Finds the provided string in a TableCell, and creates a new RedactionEntity in the same line but adjacent table cells to the right.
+* @param string The keyword to search for
+* @param type The type of the RedactionEntity to be created
+* @param entityType The EntityType of the RedactionEntity to be created
+* @param table The TableNode to search in
+* @return A Stream of RedactionEntities with the keyword as value, the type as type and the provided EntityType
+*/
+public Stream<RedactionEntity> lineAfterStringAcrossColumns(String string, String type, EntityType entityType, TableNode table)
+/**
+* Creates a redaction entity based on the given boundary, type, entity type, and semantic node.
+*
+* @param boundary   The boundary of the redaction entity.
+* @param type       The type of the redaction entity.
+* @param entityType The entity type of the redaction entity.
+* @param node       The semantic node where the boundary is.
+* @return An Optional containing the new redaction entity.
+*/
+public Optional<RedactionEntity> byBoundary(Boundary boundary, String type, EntityType entityType, SemanticNode node)
+/**
+* Creates new RedactionEntities between the provided start and stop boundaries. The start and stop boundaries are excluded.
+* If any boundaries of the new RedactionEntities overlap, only the shortest boundary will be used.
+* @param startBoundaries List of start boundaries
+* @param stopBoundaries List of stop boundaries
+* @param type       The type of the redaction entity.
+* @param entityType The entity type of the redaction entity.
+* @param node       The semantic node where the boundaries are.
+* @return A Stream of new RedactionEntities between the start and stop boundaries
+*/
+public Stream<RedactionEntity> betweenBoundaries(List<Boundary> startBoundaries, List<Boundary> stopBoundaries, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as betweenBoundaries, but it creates the start and stop boundaries by performing a text search on the provided SemanticNode.
+*/
+public Stream<RedactionEntity> betweenStrings(String start, String stop, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as betweenStrings, but case insensitive.
+*/
+public Stream<RedactionEntity> betweenStringsIgnoreCase(String start, String stop, String type, EntityType entityType, SemanticNode node)
+/**
+* These 6 functions work the same as betweenStrings, but they also include the start and/or stop strings or are case insensitive, depending on their name.
+*/
+public Stream<RedactionEntity> betweenStringsIncludeStart(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeStartIgnoreCase(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeEnd(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeEndIgnoreCase(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeStartAndEnd(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeStartAndEndIgnoreCase(String start, String stop, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as betweenBoundaries, but it creates the start and stop boundaries by performing a regex search on the provided SemanticNode.
+*/
+public Stream<RedactionEntity> betweenRegexes(String regexStart, String regexStop, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as betweenRegexes, but case insensitive.
+*/
+public Stream<RedactionEntity> betweenRegexesIgnoreCase(String regexStart, String regexStop, String type, EntityType entityType, SemanticNode node)
+/**
+* Creates a new RedactionEntity which has the same boundary as the provided SemanticNode.
+* @param node The SemanticNode to create a new RedactionEntity from.
+* @param type       The type of the redaction entity.
+* @param entityType The entity type of the redaction entity.
+* @return An optional RedactionEntity. Is empty, if the provided SemanticNode is empty.
+*/
+public Optional<RedactionEntity> bySemanticNode(SemanticNode node, String type, EntityType entityType)
+/**
+* Same as bySemanticNode, but ignores the SemanticNode, if its not a Paragraph and all its child SemanticNodes, that are not Paragraphs.
+*/
+public Stream<RedactionEntity> bySemanticNodeParagraphsOnly(SemanticNode node, String type, EntityType entityType)
+/**
+* Searches the provided SemanticNode for the provided string, and creates a new RedactionEntity, from the end of the first occurrence of the string until the end of the SemanticNode.
+* @param string The string to search for
+* @param type       The type of the redaction entity.
+* @param entityType The entity type of the redaction entity.
+* @param node The SemanticNode to use and search in
+* @return An optional RedactionEntity, is empty, if the SemanticNode is empty, or the string isn't found in the SemanticNode.
+*/
+public Optional<RedactionEntity> semanticNodeAfterString(String string, String type, EntityType entityType, SemanticNode node)

drools-prompt/Page_doc

@@ -0,0 +1,18 @@
+/**
+ * Retrieves the main body text block.
+ *
+ * @return The text block representing the main body of the document.
+ */
+public TextBlock getMainBodyTextBlock()
+/**
+* Gets all Entities located on the page
+*
+* @return Set of all Entities associated with this Page
+*/
+Set<RedactionEntity> getEntities();
+/**
+* Returns the Page Number
+*
+* @return The number of this page
+*/
+Integer getPageNumber();

drools-prompt/RedactionEntity_doc

@@ -0,0 +1,33 @@
+/**
+* Sets the Entity to applied, this is the default.
+* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
+* @param reason Should describe the intention of the rule in a few words
+* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
+*/
+void apply(String ruleIdentifier, String reason, String legalBasis)
+/**
+* Same as apply, but legalBasis can be null.
+*/
+void force(String ruleIdentifier, String reason, String legalBasis)
+/**
+* Sets the Entity to not applied.
+* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
+* @param reason Should describe the intention of the rule in a few words
+* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
+*/
+void skip(String ruleIdentifier, String reason, String legalBasis)
+/**
+* Sets the Entity to ignored, is preferred to remove in most cases.
+* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
+* @param reason Should describe the intention of the rule in a few words
+* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
+*/
+void ignore(String ruleIdentifier, String reason, String legalBasis)
+/**
+* Removes the entity entirely, also removes it from all EntitySets and sets intersectingNodes and deepestFullyContainingNode to null.
+* Should only be used in a few cases!
+* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
+* @param reason Should describe the intention of the rule in a few words
+* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
+*/
+void remove(String ruleIdentifier, String reason, String legalBasis)

drools-prompt/RedactionEntity_properties_doc

@@ -0,0 +1,39 @@
+/**
+* A boundary has a start and end property accessible by start() and end() respectively. It marks the start and end offset in String offsets.
+*/
+Boundary boundary
+/**
+* The type of an Entity identifies groups of Entities. Examples for Entites we want to find are "CBI_author" for authors, "CBI_address" for addresses or "PII" for personally identifiable information.
+* Other types include helper types, which interact with the main Entities, for example "published_information" or "vertebrate". These Entities are used to modify the main Entities, if they occur in the same Section.
+* A typical example would be to ignore Entities of type "CBI_author", if they occur in the same Section as "published_information" entities.
+*/
+String type
+/**
+* The EntityType can be one of four different values: ENTITY, RECOMMENDATION, FALSE_POSITIVE, FALSE_RECOMMENDATION.
+* If an ENTITY is overlapped by a FALSE_POSITIVE, the ENTITY is removed. If a RECOMMENDATION is overlapped by either an ENTITY or FALSE_RECOMMENDATION, it is removed.
+*/
+EntityType entityType
+/**
+* The text the Entity represents.
+*/
+String value
+/**
+* Up to three words after the Entity in the text.
+*/
+String textAfter
+/**
+* Up to three words before the Entity in the text.
+*/
+String textBefore
+/**
+* All pages whose TextBlock intersects the boundary of this entity. Is always equal to the Pages which have this RedactionEntity in their EntitySet.
+*/
+Set<Page> pages
+/**
+* All SemanticNodes whose TextBlock intersects the boundary of this entity. Is always equal to the SemanticNodes which have this RedactionEntity in their EntitySet.
+*/
+List<SemanticNode> intersectingNodes
+/**
+* The SemanticNode which is the deepest in the Tree structure and whose TextBlock fully contains the boundary of this Node.
+*/
+SemanticNode deepestFullyContainingNode

drools-prompt/Section_doc

@@ -0,0 +1,6 @@
+/**
+* Determines whether this Section has any tables.
+*
+* @return {@code true} if there are tables, {@code false} otherwise
+*/
+public boolean hasTables()

drools-prompt/SemanticNode_doc

@@ -0,0 +1,181 @@
+/**
+* Returns the type of this node, such as NodeType.SECTION, NodeType.PARAGRAPH, etc.
+*
+* @return NodeType of this node
+*/
+NodeType getType();
+/**
+* Any Node maintains its own Set of Entities.
+* This Set contains all Entities whose boundary intersects the boundary of this node.
+* The Entities might overlap with the Entities in other Sets
+*
+* @return Set of all Entities associated with this Node
+*/
+Set<RedactionEntity> getEntities();
+/**
+* Returns all Pages this SemanticNode is associated with.
+*
+* @return Set of Pages this node appears on.
+*/
+Set<Page> getPages()
+/**
+* Checks if this node appears on the specified page number.
+*
+* @param pageNumber The page number to check.
+* @return True if this node is found on the specified page number, false otherwise.
+*/
+boolean isOnPage(int pageNumber)
+/**
+* Returns the closest Headline associated with this SemanticNode
+*
+* @return First Headline found.
+*/
+Headline getHeadline()
+/**
+* @return The SemanticNode representing the Parent in the DocumentTree
+* throws NotFoundException, when no parent is present
+*/
+SemanticNode getParent()
+/**
+* Checks whether this SemanticNode has any Entity of the provided type.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param type string representing the type of entity to check for
+* @return true, if this SemanticNode has at least one Entity of the provided type
+*/
+boolean hasEntitiesOfType(String type)
+/**
+* Checks whether this SemanticNode has any Entity of the provided types.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types an array of strings representing the types of entities to check for
+* @return true, if this SemanticNode has at least one Entity of any of the provided types
+*/
+boolean hasEntitiesOfAnyType(String... types)
+/**
+* Checks whether this SemanticNode has at least one Entity of each of the provided types.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types an array of strings representing the types of entities to check for
+* @return true, if this SemanticNode has at least one Entity of each of the provided types
+*/
+boolean hasEntitiesOfAllTypes(String... types)
+/**
+* Returns a List of Entities in this SemanticNode which are of the provided type such as "CBI_author".
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param type string representing the type of entities to return
+* @return List of RedactionEntities of any the type
+*/
+List<RedactionEntity> getEntitiesOfType(String type)
+/**
+* Returns a List of Entities in this SemanticNode which have any of the provided types such as "CBI_author".
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types A list of strings representing the types of entities to return
+* @return List of RedactionEntities of any provided type
+*/
+List<RedactionEntity> getEntitiesOfType(List<String> types)
+/**
+* Returns a List of Entities in this SemanticNode which have any of the provided types.
+* Ignores Entity with the ignored flag set to true or the removed flag set to true.
+*
+* @param types A list of strings representing the types of entities to return
+* @return List of RedactionEntities that match any of the provided types
+*/
+List<RedactionEntity> getEntitiesOfType(String... types)
+/**
+* Checks whether this SemanticNode contains the provided String.
+*
+* @param string A String which the TextBlock might contain
+* @return true, if this node's TextBlock contains the string
+*/
+boolean containsString(String string)
+/**
+* Checks whether this SemanticNode contains all the provided Strings.
+*
+* @param strings A List of Strings which the TextBlock might contain
+* @return true, if this node's TextBlock contains all strings
+*/
+boolean containsAllStrings(String... strings)
+/**
+* Checks whether this SemanticNode contains any of the provided Strings.
+*
+* @param strings A List of Strings to check if they are contained in the TextBlock
+* @return true, if this node's TextBlock contains any of the provided strings
+*/
+boolean containsAnyString(String... strings)
+/**
+* Checks whether this SemanticNode contains all the provided Strings ignoring case.
+*
+* @param string A String which the TextBlock might contain
+* @return true, if this node's TextBlock contains the string ignoring case
+*/
+boolean containsStringIgnoreCase(String string)
+/**
+* Checks whether this SemanticNode contains any of the provided Strings ignoring case.
+*
+* @param strings A List of Strings which the TextBlock might contain
+* @return true, if this node's TextBlock contains any of the strings
+*/
+boolean containsAnyStringIgnoreCase(String... strings)
+/**
+* Checks whether this SemanticNode contains any of the provided Strings ignoring case.
+*
+* @param strings A List of Strings which the TextBlock might contain
+* @return true, if this node's TextBlock contains any of the strings
+*/
+boolean containsAllStringsIgnoreCase(String... strings)
+/**
+* Checks whether this SemanticNode matches the provided regex pattern.
+*
+* @param regexPattern A String representing a regex pattern, which the TextBlock might contain
+* @return true, if this node's TextBlock contains the regex pattern
+*/
+boolean matchesRegex(String regexPattern)
+/**
+* Checks whether this SemanticNode matches the provided regex pattern ignoring case.
+*
+* @param regexPattern A String representing a regex pattern, which the TextBlock might contain
+* @return true, if this node's TextBlock contains the regex pattern ignoring case
+*/
+boolean matchesRegexIgnoreCase(String regexPattern)
+/**
+* Streams all children located directly underneath this node in the DocumentTree.
+*
+* @return Stream of all children
+*/
+Stream<SemanticNode> streamChildren()
+/**
+* Streams all children located directly underneath this node in the DocumentTree of the provided type.
+*
+* @param nodeType the type of nodes to stream
+* @return Stream of all children of the provided type
+*/
+Stream<SemanticNode> streamChildrenOfType(NodeType nodeType)
+/**
+* Recursively streams all SemanticNodes located underneath this node in the DocumentTree in order.
+*
+* @return Stream of all SubNodes
+*/
+Stream<SemanticNode> streamAllSubNodes()
+/**
+* Recursively streams all SemanticNodes of a specified type located underneath this node in the DocumentTree in order.
+*
+* @param nodeType the type of nodes to be streamed
+* @return a Stream of all SubNodes of the specified type
+*/
+Stream<SemanticNode> streamAllSubNodesOfType(NodeType nodeType)
+/**
+* The Boundary is the start and end string offsets in the reading order of the document.
+*
+* @return Boundary of this Node's TextBlock
+*/
+Boundary getBoundary()
+/**
+ * The SectionIdentifier uses the numeric identifiers of Headlines to infer a tree structure.
+ * It implements functions such as sectionIdentifier.isChildOf(otherSectionIdentifier) and sectionIdentifier.isParentOf(otherSectionIdentifier)
+ *
+ * @return The SectionIdentifier from the first Headline.
+ */
+SectionIdentifier getSectionIdentifier()

drools-prompt/Table_doc

@@ -0,0 +1,77 @@
+/**
+* Streams all entities in this table, that appear in a row, which contains any of the provided strings.
+*
+* @param strings Strings to check whether a row contains them
+* @return Stream of all entities in this table, that appear in a row, which contains any of the provided strings
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowContainsStringsIgnoreCase(List<String> strings) 
+/**
+* Checks whether the specified row contains all the provided strings.
+*
+* @param row     the row to check as an Integer, must be smaller than numberOfRows
+* @param strings a list of strings to check for
+* @return true, if all strings appear in the provided row
+*/
+boolean rowContainsStringsIgnoreCase(Integer row, List<String> strings) 
+/**
+* Streams all entities which appear in a row where at least one cell has the provided header and the provided value.
+*
+* @param header the header value to search for
+* @param value  the string which the table cell should contain
+* @return a stream of all entities, which appear in a row where at least one cell has the provided header and the provided value.
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowHasHeaderAndValue(String header, String value) 
+/**
+* Streams all entities which appear in a row where at least one cell has the provided header and any provided value.
+*
+* @param header the header value to search for
+* @param values the strings which the table cell should contain
+* @return a stream of all entities, which appear in a row where at least one cell has the provided header and any provided value.
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowHasHeaderAndAnyValue(String header, List<String> values) 
+/**
+* Streams all entities in this table, that appear in a row, which contains at least one entity with any of the provided types.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types type strings to check whether a row contains an entity like them
+* @return Stream of all entities in this table, that appear in a row, which contains at least one entity with any of the provided types.
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowContainsEntitiesOfType(List<String> types) 
+/**
+* Streams all entities in this table, that appear in a row, which contains no entity of any of the provided types.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types type strings to check whether a row contains an entity like them
+* @return Stream of all entities in this table, that appear in a row, which contains at least one entity with any of the provided types.
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowContainsNoEntitiesOfType(List<String> types) 
+/**
+* Streams all TableCells in this Table which have the provided header row-wise.
+*
+* @return Stream of all TableCells which have the provided header
+*/
+Stream<TableCell> streamTableCellsWithHeader(String header) 
+/**
+* Streams all Headers and checks if any equal the provided string.
+*
+* @param header string to check the headers for
+* @return true, if at least one header equals the provided string
+*/
+boolean hasHeader(String header) 
+/**
+* Checks if this table has a column with the provided header and any of the table cells in that column contain the provided value.
+*
+* @param header string to find header cells
+* @param value  string to check cells with provided header
+* @return true, if this table has a column with the provided header and any of the table cells in that column contain the provided value
+*/
+boolean hasRowWithHeaderAndValue(String header, String value) 
+/**
+* Finds all entities of the provided type, which appear in the same row that the provided entity appears in.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param type            the type of entities to search for
+* @param redactionEntity the entity, which appears in the row to search
+* @return List of all entities of the provided type, which appear in the same row that the provided entity appears in.
+*/
+List<RedactionEntity> getEntitiesOfTypeInSameRow(String type, RedactionEntity redactionEntity) 

drools-prompt/drools-prompt

@@ -0,0 +1,591 @@
+From now on, you are a Drools rule generator.
+
+You have a Document data structure written in Java with the following objects:
+
+- Section
+- Table
+- TableCell
+- Paragraph
+- Headline
+- Page
+- RedactionEntity
+- EntityCreationService
+
+The Section, Table, TableCell, Paragraph, and Headline implement a common interface called SemanticNode. SemanticNodes are arranged in a tree-like fashion, where any SemanticNode can have multiple SemanticNodes as children. The arrangement is as follows:
+- Tables only have TableCells as children.
+- TableCells may have any child, except TableCells.
+- Paragraphs and Headlines have no children.
+- Sections may have any child except TableCells, but if it contains Paragraphs as well as Tables, it is split into a Section with multiple Sections as children, where any child Section only contains either Tables or Paragraphs.
+   Further, if the first SemanticNode is a Headline it remains the first child in the Parent Section, before any subsections.
+
+The goal of the Software is to find pieces of Text that are relevant. Each piece of text is represented by a RedactionEntity.
+The main pieces of relevant text are Text we want to redact. For example, we want to redact all Authors of a dossier. Or all personally identifiable information, such as E-Mails and Telephone Numbers.
+RedactionEntities may also represent other pieces of text, such as published information, or certain species of vertebrates.
+The RedactionEntities are part of the document structure, such that they are referenced in each SemanticNode and Page, which contains it, and further, the RedactionEntity references each Page and SemanticNode it occurs in.
+So the same RedactionEntity occurs in the paragraph it is located, as well as all its parent Sections.
+
+Previous to the execution of rules, the Document structure is assembled and a text search is performed to create initial Entities of different types. They are then inserted into the document structure.
+Then the KieSession is created and each SemanticNode and Entity is inserted into its working memory.
+----------------------------------------------------------------
+The relevant functions for SemanticNode:
+/**
+* Returns the type of this node, such as NodeType.SECTION, NodeType.PARAGRAPH, etc.
+*
+* @return NodeType of this node
+*/
+NodeType getType();
+
+/**
+* Any Node maintains its own Set of Entities.
+* This Set contains all Entities whose boundary intersects the boundary of this node.
+* The Entities might overlap with the Entities in other Sets
+*
+* @return Set of all Entities associated with this Node
+*/
+Set<RedactionEntity> getEntities();
+
+/**
+* Returns all Pages this SemanticNode is associated with.
+*
+* @return Set of Pages this node appears on.
+*/
+Set<Page> getPages()
+
+/**
+* Checks if this node appears on the specified page number.
+*
+* @param pageNumber The page number to check.
+* @return True if this node is found on the specified page number, false otherwise.
+*/
+boolean onPage(int pageNumber)
+
+/**
+* For Sections it searches its children and returns the first Headline.
+* For Paragraphs, Tables, and TableCells it returns getHeadline() of getParent()
+* For Headline it returns itself and for Headers or Footers it returns an empty dummy Headline.
+*
+* @return First Headline found.
+*/
+Headline getHeadline()
+
+/**
+* @return The SemanticNode representing the Parent in the DocumentTree
+* When no parent is present, the Document is returned. And for the Document itself it throws an UnsupportedOperationException.
+*/
+SemanticNode getParent()
+
+/**
+* Checks whether this SemanticNode has any Entity of the provided type.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param type string representing the type of entity to check for
+* @return true, if this SemanticNode has at least one Entity of the provided type
+*/
+boolean hasEntitiesOfType(String type)
+
+/**
+* Checks whether this SemanticNode has any Entity of the provided types.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types an array of strings representing the types of entities to check for
+* @return true, if this SemanticNode has at least one Entity of any of the provided types
+*/
+boolean hasEntitiesOfAnyType(String... types)
+
+/**
+* Checks whether this SemanticNode has at least one Entity of each of the provided types.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types an array of strings representing the types of entities to check for
+* @return true, if this SemanticNode has at least one Entity of each of the provided types
+*/
+boolean hasEntitiesOfAllTypes(String... types)
+
+/**
+* Returns a List of Entities in this SemanticNode which are of the provided type such as "CBI_author".
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param type string representing the type of entities to return
+* @return List of RedactionEntities of any the type
+*/
+List<RedactionEntity> getEntitiesOfType(String type)
+
+/**
+* Returns a List of Entities in this SemanticNode which have any of the provided types such as "CBI_author".
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types A list of strings representing the types of entities to return
+* @return List of RedactionEntities of any provided type
+*/
+List<RedactionEntity> getEntitiesOfType(List<String> types)
+
+/**
+* Returns a List of Entities in this SemanticNode which have any of the provided types.
+* Ignores Entity with the ignored flag set to true or the removed flag set to true.
+*
+* @param types A list of strings representing the types of entities to return
+* @return List of RedactionEntities that match any of the provided types
+*/
+List<RedactionEntity> getEntitiesOfType(String... types)
+
+/**
+* Checks whether this SemanticNode contains the provided String.
+*
+* @param string A String which the TextBlock might contain
+* @return true, if this node's TextBlock contains the string
+*/
+boolean containsString(String string)
+
+/**
+* Checks whether this SemanticNode contains all the provided Strings.
+*
+* @param strings A List of Strings which the TextBlock might contain
+* @return true, if this node's TextBlock contains all strings
+*/
+boolean containsAllStrings(String... strings)
+
+/**
+* Checks whether this SemanticNode contains any of the provided Strings.
+*
+* @param strings A List of Strings to check if they are contained in the TextBlock
+* @return true, if this node's TextBlock contains any of the provided strings
+*/
+boolean containsAnyString(String... strings)
+/**
+* Checks whether this SemanticNode contains all the provided Strings ignoring case.
+*
+* @param string A String which the TextBlock might contain
+* @return true, if this node's TextBlock contains the string ignoring case
+*/
+boolean containsStringIgnoreCase(String string)
+
+/**
+* Checks whether this SemanticNode contains any of the provided Strings ignoring case.
+*
+* @param strings A List of Strings which the TextBlock might contain
+* @return true, if this node's TextBlock contains any of the strings
+*/
+boolean containsAnyStringIgnoreCase(String... strings)
+
+/**
+* Checks whether this SemanticNode contains any of the provided Strings ignoring case.
+*
+* @param strings A List of Strings which the TextBlock might contain
+* @return true, if this node's TextBlock contains any of the strings
+*/
+boolean containsAllStringsIgnoreCase(String... strings)
+
+/**
+* Checks whether this SemanticNode matches the provided regex pattern.
+*
+* @param regexPattern A String representing a regex pattern, which the TextBlock might contain
+* @return true, if this node's TextBlock contains the regex pattern
+*/
+boolean matchesRegex(String regexPattern)
+
+/**
+* Checks whether this SemanticNode matches the provided regex pattern ignoring case.
+*
+* @param regexPattern A String representing a regex pattern, which the TextBlock might contain
+* @return true, if this node's TextBlock contains the regex pattern ignoring case
+*/
+boolean matchesRegexIgnoreCase(String regexPattern)
+
+/**
+* Streams all children located directly underneath this node in the DocumentTree.
+*
+* @return Stream of all children
+*/
+Stream<SemanticNode> streamChildren()
+
+/**
+* Streams all children located directly underneath this node in the DocumentTree of the provided type.
+*
+* @param nodeType the type of nodes to stream
+* @return Stream of all children of the provided type
+*/
+Stream<SemanticNode> streamChildrenOfType(NodeType nodeType)
+
+/**
+* Recursively streams all SemanticNodes located underneath this node in the DocumentTree in order.
+*
+* @return Stream of all SubNodes
+*/
+Stream<SemanticNode> streamAllSubNodes()
+
+/**
+* Recursively streams all SemanticNodes of a specified type located underneath this node in the DocumentTree in order.
+*
+* @param nodeType the type of nodes to be streamed
+* @return a Stream of all SubNodes of the specified type
+*/
+Stream<SemanticNode> streamAllSubNodesOfType(NodeType nodeType)
+
+/**
+* The Boundary is the start and end string offsets in the reading order of the document.
+*
+* @return Boundary of this Node's TextBlock
+*/
+Boundary getBoundary()
+
+/**
+ * The SectionIdentifier uses the numeric identifiers of Headlines to infer a tree structure.
+ * It implements functions such as sectionIdentifier.isChildOf(otherSectionIdentifier) and sectionIdentifier.isParentOf(otherSectionIdentifier)
+ *
+ * @return The SectionIdentifier from the first Headline.
+ */
+SectionIdentifier getSectionIdentifier()
+
+----------------------------------------------------------------
+The Table has the additional functions:
+/**
+* Streams all entities in this table, that appear in a row, which contains any of the provided strings.
+*
+* @param strings Strings to check whether a row contains them
+* @return Stream of all entities in this table, that appear in a row, which contains any of the provided strings
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowContainsStringsIgnoreCase(List<String> strings)
+
+/**
+* Checks whether the specified row contains all the provided strings.
+*
+* @param row     the row to check as an Integer, must be smaller than numberOfRows
+* @param strings a list of strings to check for
+* @return true, if all strings appear in the provided row
+*/
+boolean rowContainsStringsIgnoreCase(Integer row, List<String> strings)
+
+/**
+* Streams all entities which appear in a row where at least one cell has the provided header and the provided value.
+*
+* @param header the header value to search for
+* @param value  the string which the table cell should contain
+* @return a stream of all entities, which appear in a row where at least one cell has the provided header and the provided value.
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowHasHeaderAndValue(String header, String value)
+
+/**
+* Streams all entities which appear in a row where at least one cell has the provided header and any provided value.
+*
+* @param header the header value to search for
+* @param values the strings which the table cell should contain
+* @return a stream of all entities, which appear in a row where at least one cell has the provided header and any provided value.
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowHasHeaderAndAnyValue(String header, List<String> values)
+
+/**
+* Streams all entities in this table, that appear in a row, which contains at least one entity with any of the provided types.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types type strings to check whether a row contains an entity like them
+* @return Stream of all entities in this table, that appear in a row, which contains at least one entity with any of the provided types.
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowContainsEntitiesOfType(List<String> types)
+
+/**
+* Streams all entities in this table, that appear in a row, which contains no entity of any of the provided types.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param types type strings to check whether a row contains an entity like them
+* @return Stream of all entities in this table, that appear in a row, which contains at least one entity with any of the provided types.
+*/
+Stream<RedactionEntity> streamEntitiesWhereRowContainsNoEntitiesOfType(List<String> types)
+
+/**
+* Streams all TableCells in this Table which have the provided header row-wise.
+*
+* @return Stream of all TableCells which have the provided header
+*/
+Stream<TableCell> streamTableCellsWithHeader(String header)
+
+/**
+* Streams all Headers and checks if any equal the provided string.
+*
+* @param header string to check the headers for
+* @return true, if at least one header equals the provided string
+*/
+boolean hasHeader(String header)
+
+/**
+* Checks if this table has a column with the provided header and any of the table cells in that column contain the provided value.
+*
+* @param header string to find header cells
+* @param value  string to check cells with provided header
+* @return true, if this table has a column with the provided header and any of the table cells in that column contain the provided value
+*/
+boolean hasRowWithHeaderAndValue(String header, String value)
+
+/**
+* Finds all entities of the provided type, which appear in the same row that the provided entity appears in.
+* Ignores Entity with ignored == true or removed == true.
+*
+* @param type            the type of entities to search for
+* @param redactionEntity the entity, which appears in the row to search
+* @return List of all entities of the provided type, which appear in the same row that the provided entity appears in.
+*/
+List<RedactionEntity> getEntitiesOfTypeInSameRow(String type, RedactionEntity redactionEntity)
+----------------------------------------------------------------
+The Section has these additional Rules:
+/**
+* Determines whether this Section has any tables.
+*
+* @return {@code true} if there are tables, {@code false} otherwise
+*/
+boolean hasTables()
+----------------------------------------------------------------
+The Page Object has the following functions:
+/**
+* Retrieves the main body text block.
+* @return The text block representing the main body of the document.
+*/
+public TextBlock getMainBodyTextBlock()
+/**
+* @return All SemanticNodes that occur on the page, except Header and Footer
+*/
+public List<SemanticNode> getMainBody()
+/**
+* Gets all Entities located on the page
+* @return Set of all Entities associated with this Page
+*/
+Set<RedactionEntity> getEntities();
+/**
+* Returns the Page Number
+*
+* @return The number of this page
+*/
+Integer getPageNumber();
+----------------------------------------------------------------
+
+----------------------------------------------------------------
+The RedactionEntity has the following properties:
+/**
+* A boundary has a start and end property accessible by start() and end() respectively. It marks the start and end offset in String offsets.
+*/
+Boundary boundary
+/**
+* The type of an Entity identifies groups of Entities. Examples for Entites we want to find are "CBI_author" for authors, "CBI_address" for addresses or "PII" for personally identifiable information.
+* Other types include helper types, which interact with the main Entities, for example "published_information" or "vertebrate". These Entities are used to modify the main Entities, if they occur in the same Section.
+* A typical example would be to ignore Entities of type "CBI_author", if they occur in the same Section as "published_information" entities.
+*/
+String type
+/**
+* The EntityType can be one of four different values: ENTITY, RECOMMENDATION, FALSE_POSITIVE, FALSE_RECOMMENDATION.
+* If an ENTITY is overlapped by a FALSE_POSITIVE, the ENTITY is removed. If a RECOMMENDATION is overlapped by either an ENTITY or FALSE_RECOMMENDATION, it is removed.
+*/
+EntityType entityType
+/**
+* The text the Entity represents.
+*/
+String value
+/**
+* Up to three words after the Entity in the text.
+*/
+String textAfter
+/**
+* Up to three words before the Entity in the text.
+*/
+String textBefore
+/**
+* All pages whose TextBlock intersects the boundary of this entity. Is always equal to the Pages which have this RedactionEntity in their EntitySet.
+*/
+Set<Page> pages
+/**
+* All SemanticNodes whose TextBlock intersects the boundary of this entity. Is always equal to the SemanticNodes which have this RedactionEntity in their EntitySet.
+*/
+List<SemanticNode> intersectingNodes
+/**
+* The SemanticNode which is the deepest in the Tree structure and whose TextBlock fully contains the boundary of this Node.
+*/
+SemanticNode deepestFullyContainingNode
+
+The RedactionEntity also has the following methods:
+/**
+* Sets the Entity to applied, this is the default.
+* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
+* @param reason Should describe the intention of the rule in a few words
+* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
+*/
+void apply(String ruleIdentifier, String reason, String legalBasis)
+/**
+* Same as apply, but legalBasis can be null.
+*/
+void force(String ruleIdentifier, String reason, String legalBasis)
+/**
+* Sets the Entity to not applied.
+* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
+* @param reason Should describe the intention of the rule in a few words
+* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
+*/
+void skip(String ruleIdentifier, String reason, String legalBasis)
+/**
+* Sets the Entity to ignored, is preferred to remove in most cases.
+* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
+* @param reason Should describe the intention of the rule in a few words
+* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
+*/
+void ignore(String ruleIdentifier, String reason, String legalBasis)
+/**
+* Removes the entity entirely, also removes it from all EntitySets and sets intersectingNodes and deepestFullyContainingNode to null.
+* Should only be used in a few cases!
+* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
+* @param reason Should describe the intention of the rule in a few words
+* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
+*/
+void remove(String ruleIdentifier, String reason, String legalBasis)
+----------------------------------------------------------------
+The EntityCreationService offers the following functions:
+/**
+* Searches the provided SemanticNode for the keyword and creates an Entity for each occurrence.
+* @param keyword the string to search for
+* @param type The type of the RedactionEntity to be created
+* @param entityType The EntityType of the RedactionEntity to be created
+* @param node The SemanticNode to search in
+* @return A Stream of RedactionEntities with the keyword as value, the type as type and the provided EntityType
+*/
+public Stream<RedactionEntity> byString(String keyword, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as byString, but case insensitive.
+*/
+public Stream<RedactionEntity> byStringIgnoreCase(String keyword, String type, EntityType entityType, SemanticNode node)
+/**
+* Searches the provided SemanticNode with the regexPattern and creates a new RedactionEntity with the provided group for each occurrence.
+* @param regexPattern The regexPattern
+* @param type The type of the RedactionEntity to be created
+* @param entityType The EntityType of the RedactionEntity to be created
+* @param group the regexPattern group, that should be the entity
+* @param node The SemanticNode to search in
+* @return A Stream of RedactionEntities with the keyword as value, the type as type and the provided EntityType
+*/
+public Stream<RedactionEntity> byRegex(String regexPattern, String type, EntityType entityType, int group, SemanticNode node)
+/**
+* Same as byRegex, but case insensitive.
+*/
+public Stream<RedactionEntity> byRegexIgnoreCase(String regexPattern, String type, EntityType entityType, int group, SemanticNode node)
+/**
+* Same as byRegex, but can handle patterns with linebreaks.
+*/
+public Stream<RedactionEntity> byRegexWithLineBreaksIgnoreCase(String regexPattern, String type, EntityType entityType, int group, SemanticNode node)
+/**
+* Same as byRegexWithLineBreaks, but case insensitive.
+*/
+public Stream<RedactionEntity> byRegexWithLineBreaksIgnoreCase(String regexPattern, String type, EntityType entityType, int group, SemanticNode node)
+/**
+* Finds the provided string, and creates a new RedactionEntity from the text after until the end of the line it is found in.
+* @param string The keyword to search for
+* @param type The type of the RedactionEntity to be created
+* @param entityType The EntityType of the RedactionEntity to be created
+* @param node The SemanticNode to search in
+* @return A Stream of RedactionEntities with the keyword as value, the type as type and the provided EntityType
+*/
+public Stream<RedactionEntity> lineAfterString(String string, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as lineAfterString, but with multiple keywords
+*/
+public Stream<RedactionEntity> lineAfterStrings(List<String> strings, String type, EntityType entityType, SemanticNode node)
+/**
+* Finds the provided string in a TableCell, and creates a new RedactionEntity in the same line but adjacent table cells to the right.
+* @param string The keyword to search for
+* @param type The type of the RedactionEntity to be created
+* @param entityType The EntityType of the RedactionEntity to be created
+* @param table The TableNode to search in
+* @return A Stream of RedactionEntities with the keyword as value, the type as type and the provided EntityType
+*/
+public Stream<RedactionEntity> lineAfterStringAcrossColumns(String string, String type, EntityType entityType, TableNode table)
+/**
+* Creates a redaction entity based on the given boundary, type, entity type, and semantic node.
+*
+* @param boundary   The boundary of the redaction entity.
+* @param type       The type of the redaction entity.
+* @param entityType The entity type of the redaction entity.
+* @param node       The semantic node where the boundary is.
+* @return An Optional containing the new redaction entity.
+*/
+public Optional<RedactionEntity> byBoundary(Boundary boundary, String type, EntityType entityType, SemanticNode node)
+/**
+* Creates new RedactionEntities between the provided start and stop boundaries. The start and stop boundaries are excluded.
+* If any boundaries of the new RedactionEntities overlap, only the shortest boundary will be used.
+* @param startBoundaries List of start boundaries
+* @param stopBoundaries List of stop boundaries
+* @param type       The type of the redaction entity.
+* @param entityType The entity type of the redaction entity.
+* @param node       The semantic node where the boundaries are.
+* @return A Stream of new RedactionEntities between the start and stop boundaries
+*/
+public Stream<RedactionEntity> betweenBoundaries(List<Boundary> startBoundaries, List<Boundary> stopBoundaries, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as betweenBoundaries, but it creates the start and stop boundaries by performing a text search on the provided SemanticNode.
+*/
+public Stream<RedactionEntity> betweenStrings(String start, String stop, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as betweenStrings, but case insensitive.
+*/
+public Stream<RedactionEntity> betweenStringsIgnoreCase(String start, String stop, String type, EntityType entityType, SemanticNode node)
+/**
+* These 6 functions work the same as betweenStrings, but they also include the start and/or stop strings or are case insensitive, depending on their name.
+*/
+public Stream<RedactionEntity> betweenStringsIncludeStart(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeStartIgnoreCase(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeEnd(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeEndIgnoreCase(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeStartAndEnd(String start, String stop, String type, EntityType entityType, SemanticNode node)
+public Stream<RedactionEntity> betweenStringsIncludeStartAndEndIgnoreCase(String start, String stop, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as betweenBoundaries, but it creates the start and stop boundaries by performing a regex search on the provided SemanticNode.
+*/
+public Stream<RedactionEntity> betweenRegexes(String regexStart, String regexStop, String type, EntityType entityType, SemanticNode node)
+/**
+* Same as betweenRegexes, but case insensitive.
+*/
+public Stream<RedactionEntity> betweenRegexesIgnoreCase(String regexStart, String regexStop, String type, EntityType entityType, SemanticNode node)
+/**
+* Creates a new RedactionEntity which has the same boundary as the provided SemanticNode.
+* @param node The SemanticNode to create a new RedactionEntity from.
+* @param type       The type of the redaction entity.
+* @param entityType The entity type of the redaction entity.
+* @return An optional RedactionEntity. Is empty, if the provided SemanticNode is empty.
+*/
+public Optional<RedactionEntity> bySemanticNode(SemanticNode node, String type, EntityType entityType)
+/**
+* Same as bySemanticNode, but ignores the SemanticNode, if its not a Paragraph and all its child SemanticNodes, that are not Paragraphs.
+*/
+public Stream<RedactionEntity> bySemanticNodeParagraphsOnly(SemanticNode node, String type, EntityType entityType)
+/**
+* Searches the provided SemanticNode for the provided string, and creates a new RedactionEntity, from the end of the first occurrence of the string until the end of the SemanticNode.
+* @param string The string to search for
+* @param type       The type of the redaction entity.
+* @param entityType The entity type of the redaction entity.
+* @param node The SemanticNode to use and search in
+* @return An optional RedactionEntity, is empty, if the SemanticNode is empty, or the string isn't found in the SemanticNode.
+*/
+public Optional<RedactionEntity> semanticNodeAfterString(String string, String type, EntityType entityType, SemanticNode node)
+----------------------------------------------------------------
+Rules may be grouped into two categories.
+The first category changes existing RedactionEntities, and the second creates new RedactionEntities.
+
+There are two different types of rules, one you create new Entities and in the other you change or remove existing Entities.
+An Entity is any piece of text, uniquely identified in the Document by its Boundary, its Type and its EntityType. The Boundary consists of a start and stop index in the text of the document.
+The Type is a String like "PII", which stands for
+The goal is to find entities that fulfill certain conditions. Each SemanticNode has its own set of entities, but these sets may have intersections.
+For example, a Section contains all the entities in any of its children. Additionally, if an entity overlaps two SemanticNodes, both paragraphs have this entity in their sets.
+
+To generate Drools rules for the scenario of changing or updating Entities, consider the following information:
+
+1. Conditions: Specify the conditions that must be met for an entity to be selected. For example:
+- The entity has a specific attribute value.
+- The entity is within a certain range of values.
+- The entity satisfies a complex combination of conditions.
+
+2. Actions: Define the actions to be performed when an entity fulfills the conditions. This could include:
+- Adding the entity to a result set.
+- Modifying the entity's attributes.
+- Triggering some other behavior or logic.
+
+3. Rule Structure: Determine the structure of the Drools rules. This typically consists of:
+- Rule names: Choose meaningful names for your rules.
+- Rule attributes: Set the salience (priority) of rules if necessary.
+- Conditions: Define the conditions based on the requirements.
+- Actions: Specify the actions to be performed when the conditions are met.
+
+Remember to provide specific examples, use case scenarios, and any additional requirements you have for the Drools rules.
+
+Please provide any specific conditions, actions, or examples that you would like to be incorporated into the Drools rules.

gradle.properties.kts

@@ -0,0 +1 @@
+version = 4.0-SNAPSHOT

pom.xml

@@ -1,21 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-
-    <modelVersion>4.0.0</modelVersion>
-
-    <artifactId>redaction-service</artifactId>
-    <groupId>com.iqser.red.service</groupId>
-    <version>1.0-SNAPSHOT</version>
-
-
-    <packaging>pom</packaging>
-
-    <modules>
-        <module>bamboo-specs</module>
-        <module>redaction-service-v1</module>
-        <module>redaction-service-image-v1</module>
-    </modules>
-
-</project>

redaction-service-image-v1/pom.xml

@@ -1,97 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <parent>
-        <groupId>com.iqser.red</groupId>
-        <artifactId>platform-docker-dependency</artifactId>
-        <version>1.0.0</version>
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-
-    <artifactId>redaction-service-image-v1</artifactId>
-    <groupId>com.iqser.red.service</groupId>
-    <version>1.0-SNAPSHOT</version>
-    <packaging>pom</packaging>
-
-
-    <properties>
-        <service.server>redaction-service-server-v1</service.server>
-        <platform.jar>${service.server}.jar</platform.jar>
-        <docker.skip.push>false</docker.skip.push>
-        <docker.image.name>${docker.image.prefix}/${service.server}</docker.image.name>
-    </properties>
-
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-dependency-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-resources-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>exec-maven-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>io.fabric8</groupId>
-                <artifactId>docker-maven-plugin</artifactId>
-            </plugin>
-        </plugins>
-        
-        <pluginManagement>
-            <plugins>
-                <plugin>
-                    <groupId>org.apache.maven.plugins</groupId>
-                    <artifactId>maven-dependency-plugin</artifactId>
-                    <executions>
-                        <execution>
-                            <id>download-platform-jar</id>
-                            <phase>prepare-package</phase>
-                            <goals>
-                                <goal>copy</goal>
-                            </goals>
-                            <configuration>
-                                <artifactItems>
-                                    <dependency>
-                                        <groupId>${project.groupId}</groupId>
-                                        <artifactId>${service.server}</artifactId>
-                                        <version>${project.version}</version>
-                                        <type>jar</type>
-                                        <overWrite>true</overWrite>
-                                        <destFileName>${platform.jar}</destFileName>
-                                    </dependency>
-                                </artifactItems>
-                                <outputDirectory>${docker.build.directory}</outputDirectory>
-                            </configuration>
-                        </execution>
-                    </executions>
-                </plugin>
-                <plugin>
-                    <groupId>io.fabric8</groupId>
-                    <artifactId>docker-maven-plugin</artifactId>
-                    <configuration>
-                        <images>
-                            <image>
-                                <name>${docker.image.name}</name>
-                                <build>
-                                    <dockerFileDir>${docker.build.directory}</dockerFileDir>
-                                    <args>
-                                        <PLATFORM_JAR>${platform.jar}</PLATFORM_JAR>
-                                    </args>
-                                    <tags>
-                                        <tag>${docker.image.version}</tag>
-                                        <tag>latest</tag>
-                                    </tags>
-                                </build>
-                            </image>
-                        </images>
-                    </configuration>
-                </plugin>
-            </plugins>
-        </pluginManagement>
-    </build>
-</project>

redaction-service-image-v1/src/main/docker/Dockerfile

@@ -1,18 +0,0 @@
-FROM red/base-image:1.0.0
-
-ARG PLATFORM_JAR
-
-ENV PLATFORM_JAR ${PLATFORM_JAR}
-
-ENV USES_ELASTICSEARCH false
-
-COPY ["${PLATFORM_JAR}", "/"]
-
-RUN apt-get update \
- && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
-    wget cabextract xfonts-utils fonts-liberation \
- && rm -rf /var/lib/apt/lists/*
-
-RUN curl http://ftp.br.debian.org/debian/pool/contrib/m/msttcorefonts/ttf-mscorefonts-installer_3.8_all.deb -o /tmp/ttf-mscorefonts-installer_3.8_all.deb \
- && dpkg -i /tmp/ttf-mscorefonts-installer_3.8_all.deb \
- && rm /tmp/ttf-mscorefonts-installer_3.8_all.deb \

redaction-service-v1/pom.xml

@@ -1,55 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <parent>
-        <artifactId>platform-dependency</artifactId>
-        <groupId>com.iqser.red</groupId>
-        <version>1.1.3</version>
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-
-    <artifactId>redaction-service-v1</artifactId>
-    <groupId>com.iqser.red.service</groupId>
-    <version>1.0-SNAPSHOT</version>
-
-
-    <packaging>pom</packaging>
-
-    <modules>
-        <module>redaction-service-api-v1</module>
-        <module>redaction-service-server-v1</module>
-    </modules>
-
-    <properties>
-        <pdfbox.version>2.0.21</pdfbox.version>
-    </properties>
-
-
-    <dependencyManagement>
-
-        <dependencies>
-            <dependency>
-                <groupId>com.iqser.red</groupId>
-                <artifactId>platform-commons-dependency</artifactId>
-                <version>1.3.6</version>
-                <scope>import</scope>
-                <type>pom</type>
-            </dependency>
-
-            <dependency>
-                <groupId>org.apache.pdfbox</groupId>
-                <artifactId>pdfbox</artifactId>
-                <version>${pdfbox.version}</version>
-            </dependency>
-            <dependency>
-                <groupId>org.apache.pdfbox</groupId>
-                <artifactId>pdfbox-tools</artifactId>
-                <version>${pdfbox.version}</version>
-            </dependency>
-
-        </dependencies>
-
-    </dependencyManagement>
-
-</project>

redaction-service-v1/redaction-service-api-v1/build.gradle.kts

@@ -0,0 +1,14 @@
+
+plugins {
+    id("com.iqser.red.service.java-conventions")
+    id("io.freefair.lombok") version "8.1.0"
+}
+
+description = "redaction-service-api-v1"
+
+dependencies {
+    implementation("org.springframework:spring-web:6.0.11")
+    implementation("com.iqser.red.service:persistence-service-internal-api-v1:RED-6725")
+}
+
+

redaction-service-v1/redaction-service-api-v1/pom.xml

@@ -1,32 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <modelVersion>4.0.0</modelVersion>
-    <parent>
-        <artifactId>redaction-service-v1</artifactId>
-        <groupId>com.iqser.red.service</groupId>
-        <version>1.0-SNAPSHOT</version>
-    </parent>
-
-    <artifactId>redaction-service-api-v1</artifactId>
-
-    <dependencies>
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-web</artifactId>
-            <optional>true</optional>
-        </dependency>
-        <dependency>
-            <groupId>com.iqser.red.service</groupId>
-            <artifactId>configuration-service-api-v1</artifactId>
-            <version>2.11.0</version>
-            <exclusions>
-                <exclusion>
-                    <groupId>com.iqser.red.service</groupId>
-                    <artifactId>file-management-service-api-v1</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
-    </dependencies>
-</project>

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/AnalyzeRequest.java

@@ -1,36 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.time.OffsetDateTime;
-import java.util.ArrayList;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-
-@Data
-@Builder
-@NoArgsConstructor
-@AllArgsConstructor
-public class AnalyzeRequest {
-
-    private String dossierId;
-    private String fileId;
-    private String dossierTemplateId;
-    private boolean reanalyseOnlyIfPossible;
-    private ManualRedactions manualRedactions;
-    private OffsetDateTime lastProcessed;
-
-    @Builder.Default
-    private Set<Integer> excludedPages = new HashSet<>();
-    @Builder.Default
-    private Set<Integer> sectionsToReanalyse = new HashSet<>();
-
-    @Builder.Default
-    private List<FileAttribute> fileAttributes = new ArrayList<>();
-
-}
-

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/AnalyzeResult.java

@@ -1,34 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-@Data
-@Builder
-@NoArgsConstructor
-@AllArgsConstructor
-public class AnalyzeResult {
-
-    private String dossierId;
-    private String fileId;
-    private long duration;
-    private int numberOfPages;
-    private boolean hasHints;
-    private boolean hasRequests;
-    private boolean hasRedactions;
-    private boolean hasImages;
-    private boolean hasUpdates;
-    private long dictionaryVersion;
-    private long dossierDictionaryVersion;
-    private long rulesVersion;
-    private long legalBasisVersion;
-
-    private boolean wasReanalyzed;
-
-    private int analysisVersion;
-
-
-}
-

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/Argument.java

@@ -5,11 +5,11 @@ import lombok.Data;
 import lombok.NoArgsConstructor;
 
 @Data
-@AllArgsConstructor
 @NoArgsConstructor
-public class Point {
+@AllArgsConstructor
+public class Argument {
 
-    private float x;
-    private float y;
+    private String name;
+    private ArgumentType type;
 
 }

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/ArgumentType.java

@@ -0,0 +1,15 @@
+package com.iqser.red.service.redaction.v1.model;
+
+public enum ArgumentType {
+
+    INTEGER,
+    BOOLEAN,
+    STRING,
+    FILE_ATTRIBUTE,
+    REGEX,
+    TYPE,
+    RULE_NUMBER,
+    LEGAL_BASIS,
+    REFERENCE_TYPE
+
+}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/CellRectangle.java

@@ -1,16 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-@Data
-@AllArgsConstructor
-@NoArgsConstructor
-public class CellRectangle {
-
-    private Point topLeft;
-    private float width;
-    private float height;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/ChangeType.java

@@ -1,5 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-public enum ChangeType {
-    ADDED, REMOVED
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/Comment.java

@@ -1,21 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.time.OffsetDateTime;
-
-@Data
-@Builder
-@AllArgsConstructor
-@NoArgsConstructor
-public class Comment {
-
-    private String id;
-    private OffsetDateTime date;
-    private String text;
-    private String user;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/IdRemoval.java

@@ -1,25 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.time.OffsetDateTime;
-
-@Data
-@Builder
-@AllArgsConstructor
-@NoArgsConstructor
-public class IdRemoval {
-
-    private String id;
-    private String user;
-    private Status status;
-    private boolean removeFromDictionary;
-
-    private OffsetDateTime requestDate;
-    private OffsetDateTime processedDate;
-    private OffsetDateTime softDeletedTime;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/ManualForceRedact.java

@@ -1,25 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.time.OffsetDateTime;
-
-@Data
-@Builder
-@AllArgsConstructor
-@NoArgsConstructor
-public class ManualForceRedact {
-
-    private String id;
-    private String user;
-    private Status status;
-    private String legalBasis;
-
-    private OffsetDateTime requestDate;
-    private OffsetDateTime processedDate;
-    private OffsetDateTime softDeletedTime;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/ManualImageRecategorization.java

@@ -1,25 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.time.OffsetDateTime;
-
-@Data
-@Builder
-@AllArgsConstructor
-@NoArgsConstructor
-public class ManualImageRecategorization {
-
-    private String id;
-    private String user;
-    private Status status;
-    private String type;
-
-    private OffsetDateTime requestDate;
-    private OffsetDateTime processedDate;
-    private OffsetDateTime softDeletedTime;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/ManualLegalBasisChange.java

@@ -1,25 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.time.OffsetDateTime;
-
-@Data
-@Builder
-@AllArgsConstructor
-@NoArgsConstructor
-public class ManualLegalBasisChange {
-
-    private String id;
-    private String user;
-    private Status status;
-    private String legalBasis;
-
-    private OffsetDateTime requestDate;
-    private OffsetDateTime processedDate;
-    private OffsetDateTime softDeletedTime;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/ManualRedactionEntry.java

@@ -1,34 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.time.OffsetDateTime;
-import java.util.ArrayList;
-import java.util.List;
-
-@Data
-@Builder
-@AllArgsConstructor
-@NoArgsConstructor
-public class ManualRedactionEntry {
-
-    private String id;
-    private String user;
-    private String type;
-    private String value;
-    private String reason;
-    private String legalBasis;
-    private List<Rectangle> positions = new ArrayList<>();
-    private Status status;
-
-    private boolean addToDictionary;
-    private boolean addToDossierDictionary;
-
-    private OffsetDateTime requestDate;
-    private OffsetDateTime processedDate;
-    private OffsetDateTime softDeletedTime;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/ManualRedactionType.java

@@ -1,5 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-public enum ManualRedactionType {
-    ADD, REMOVE, FORCE_REDACT, RECATEGORIZE, LEGAL_BASIS_CHANGE
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/ManualRedactions.java

@@ -1,38 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-@Data
-@Builder
-@AllArgsConstructor
-@NoArgsConstructor
-public class ManualRedactions {
-
-    @Builder.Default
-    private Set<IdRemoval> idsToRemove = new HashSet<>();
-
-    @Builder.Default
-    private Set<ManualForceRedact> forceRedacts = new HashSet<>();
-
-    @Builder.Default
-    private Set<ManualRedactionEntry> entriesToAdd = new HashSet<>();
-
-    @Builder.Default
-    private Set<ManualImageRecategorization> imageRecategorizations = new HashSet<>();
-
-    @Builder.Default
-    private Set<ManualLegalBasisChange> manualLegalBasisChanges = new HashSet<>();
-
-    @Builder.Default
-    private Map<String, List<Comment>> comments = new HashMap<>();
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/ReanalyzeResult.java

@@ -1,15 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-@Data
-@Builder
-@NoArgsConstructor
-@AllArgsConstructor
-public class ReanalyzeResult {
-
-    private RedactionLog redactionLog;
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/Rectangle.java

@@ -1,17 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-@Data
-@AllArgsConstructor
-@NoArgsConstructor
-public class Rectangle {
-
-    private Point topLeft;
-    private float width;
-    private float height;
-
-    private int page;
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/RedactionChangeLog.java

@@ -1,22 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.util.ArrayList;
-import java.util.List;
-
-@Data
-@AllArgsConstructor
-@NoArgsConstructor
-public class RedactionChangeLog {
-
-    private List<RedactionChangeLogEntry> redactionLogEntry = new ArrayList<>();
-
-    private long dictionaryVersion = -1;
-    private long dossierDictionaryVersion = -1;
-    private long rulesVersion = -1;
-    private long legalBasisVersion = -1;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/RedactionChangeLogEntry.java

@@ -1,49 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.util.ArrayList;
-import java.util.List;
-
-@Data
-@Builder
-@NoArgsConstructor
-@AllArgsConstructor
-public class RedactionChangeLogEntry {
-
-    private String id;
-    private String type;
-    private String value;
-    private String reason;
-    private int matchedRule;
-    private String legalBasis;
-    private boolean redacted;
-    private boolean isHint;
-    private boolean isRecommendation;
-    private String section;
-    private float[] color;
-
-    @Builder.Default
-    private List<Rectangle> positions = new ArrayList<>();
-    private int sectionNumber;
-    private boolean manual;
-    private Status status;
-    private ManualRedactionType manualRedactionType;
-    private boolean isDictionaryEntry;
-
-    private String textBefore;
-    private String textAfter;
-
-    @Builder.Default
-    private List<Comment> comments = new ArrayList<>();
-
-    private ChangeType changeType;
-
-    private boolean isDossierDictionaryEntry;
-
-    private boolean excluded;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/RedactionLog.java

@@ -1,28 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import com.iqser.red.service.configuration.v1.api.model.LegalBasisMapping;
-import lombok.AllArgsConstructor;
-import lombok.Data;
-
-import java.util.List;
-
-@Data
-@AllArgsConstructor
-public class RedactionLog {
-
-
-    /**
-     * Version 0 Redaction Logs have manual redactions merged inside them
-     * Version 1 Redaction Logs only contain system ( rule/dictionary ) redactions. Manual Redactions are merged in at runtime.
-     */
-    private long analysisVersion;
-
-    private List<RedactionLogEntry> redactionLogEntry;
-    private List<LegalBasisMapping> legalBasis;
-
-    private long dictionaryVersion = -1;
-    private long dossierDictionaryVersion = -1;
-    private long rulesVersion = -1;
-    private long legalBasisVersion = -1;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/RedactionLogEntry.java

@@ -1,61 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.EqualsAndHashCode;
-import lombok.NoArgsConstructor;
-
-import java.util.ArrayList;
-import java.util.List;
-
-
-
-@Data
-@Builder
-@NoArgsConstructor
-@AllArgsConstructor
-@EqualsAndHashCode
-public class RedactionLogEntry {
-
-    private String id;
-    private String type;
-    private String value;
-    private String reason;
-    private int matchedRule;
-    private String legalBasis;
-    private boolean redacted;
-    private boolean isHint;
-    private boolean isRecommendation;
-    private String section;
-    private float[] color;
-
-    @Builder.Default
-    private List<Rectangle> positions = new ArrayList<>();
-    private int sectionNumber;
-    private boolean manual;
-    private Status status;
-    private ManualRedactionType manualRedactionType;
-    private String manualRedactionUserId;
-    private boolean isDictionaryEntry;
-
-    private String textBefore;
-    private String textAfter;
-
-    @Builder.Default
-    private List<Comment> comments = new ArrayList<>();
-
-    private int startOffset;
-    private int endOffset;
-
-    private boolean isImage;
-    private boolean imageHasTransparency;
-
-    private boolean isDossierDictionaryEntry;
-
-    private boolean excluded;
-
-    private String recategorizationType;
-    private String legalBasisChangeValue;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/RedactionRequest.java

@@ -1,18 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-@Data
-@Builder
-@NoArgsConstructor
-@AllArgsConstructor
-public class RedactionRequest {
-
-    private String dossierId;
-    private String fileId;
-    private String dossierTemplateId;
-    private ManualRedactions manualRedactions;
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/RuleBuilderModel.java

@@ -0,0 +1,14 @@
+package com.iqser.red.service.redaction.v1.model;
+
+import lombok.Data;
+
+import java.util.ArrayList;
+import java.util.List;
+
+@Data
+public class RuleBuilderModel {
+
+    private List<RuleElement> whenClauses = new ArrayList<>();
+    private List<RuleElement> thenConditions = new ArrayList<>();
+
+}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/RuleElement.java

@@ -4,15 +4,15 @@ import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
-import java.util.HashMap;
+import java.util.ArrayList;
 import java.util.List;
-import java.util.Map;
 
 @Data
-@AllArgsConstructor
 @NoArgsConstructor
-public class SectionGrid {
+@AllArgsConstructor
+public class RuleElement {
 
-    private Map<Integer, List<SectionRectangle>> rectanglesPerPage = new HashMap<>();
+    private String conditionName;
+    private List<Argument> arguments = new ArrayList<>();
 
 }

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/SectionArea.java

@@ -1,33 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-import lombok.NonNull;
-import lombok.RequiredArgsConstructor;
-
-@Data
-@RequiredArgsConstructor
-@NoArgsConstructor
-@AllArgsConstructor
-public class SectionArea {
-
-    @NonNull
-    private Point topLeft;
-
-    @NonNull
-    private float width;
-
-    @NonNull
-    private float height;
-
-    @NonNull
-    private int page;
-
-    private String header;
-
-    public boolean contains(Rectangle other) {
-        return page == other.getPage() && this.topLeft.getX() <= other.getTopLeft().getX() && this.topLeft.getX() + this.getWidth() >= other.getTopLeft().getX() + other.getWidth() && this.getTopLeft().getY() <= other.getTopLeft().getY() && this.getTopLeft().getY() + this.getHeight() >= other.getTopLeft().getY() + other.getHeight();
-    }
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/SectionRectangle.java

@@ -1,34 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-import lombok.NonNull;
-import lombok.RequiredArgsConstructor;
-
-import java.util.List;
-
-@Data
-@AllArgsConstructor
-@NoArgsConstructor
-@RequiredArgsConstructor
-public class SectionRectangle {
-
-    @NonNull
-    private Point topLeft;
-
-    @NonNull
-    private float width;
-
-    @NonNull
-    private float height;
-
-    @NonNull
-    private int part;
-
-    @NonNull
-    private int numberOfParts;
-
-    private List<CellRectangle> tableCells;
-
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/Status.java

@@ -1,5 +0,0 @@
-package com.iqser.red.service.redaction.v1.model;
-
-public enum Status {
-    REQUESTED, APPROVED, DECLINED
-}

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/model/StructureAnalyzeRequest.java

@@ -9,9 +9,10 @@ import lombok.NoArgsConstructor;
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
-public class AnnotateRequest {
+public class StructureAnalyzeRequest {
 
     private String dossierId;
-    private String dossierTemplateId;
     private String fileId;
+
 }
+

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/resources/RedactionResource.java

@@ -1,29 +1,12 @@
 package com.iqser.red.service.redaction.v1.resources;
 
-import com.iqser.red.service.redaction.v1.model.*;
 import org.springframework.http.MediaType;
-import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 
 public interface RedactionResource {
 
-    @PostMapping(value = "/annotate", produces = MediaType.APPLICATION_JSON_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
-    AnnotateResponse annotate(@RequestBody AnnotateRequest annotateRequest);
-
-    @PostMapping(value = "/debug/classifications", produces = MediaType.APPLICATION_JSON_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
-    RedactionResult classify(@RequestBody RedactionRequest redactionRequest);
-
-    @PostMapping(value = "/debug/sections", produces = MediaType.APPLICATION_JSON_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
-    RedactionResult sections(@RequestBody RedactionRequest redactionRequest);
-
-    @PostMapping(value = "/debug/htmlTables", produces = MediaType.APPLICATION_JSON_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
-    RedactionResult htmlTables(@RequestBody RedactionRequest redactionRequest);
-
     @PostMapping(value = "/rules/test", consumes = MediaType.APPLICATION_JSON_VALUE)
     void testRules(@RequestBody String rules);
 
-    @PostMapping(value = "/redaction-log/preview", consumes = MediaType.APPLICATION_JSON_VALUE)
-    RedactionLog getRedactionLog(@RequestBody RedactionRequest redactionRequest);
-
 }

redaction-service-v1/redaction-service-api-v1/src/main/java/com/iqser/red/service/redaction/v1/resources/RuleBuilderResource.java

@@ -0,0 +1,13 @@
+package com.iqser.red.service.redaction.v1.resources;
+
+import com.iqser.red.service.redaction.v1.model.RuleBuilderModel;
+
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.PostMapping;
+
+public interface RuleBuilderResource {
+
+    @PostMapping(value = "/rule-builder-model", produces = MediaType.APPLICATION_JSON_VALUE)
+    RuleBuilderModel getRuleBuilderModel();
+
+}

redaction-service-v1/redaction-service-server-v1/build.gradle.kts

@@ -0,0 +1,90 @@
+import org.springframework.boot.gradle.tasks.bundling.BootBuildImage
+
+plugins {
+    application
+    id("com.iqser.red.service.java-conventions")
+    id("org.springframework.boot") version "3.1.2"
+    id("io.spring.dependency-management") version "1.1.2"
+    id("org.sonarqube") version "4.3.0.3225"
+    id("io.freefair.lombok") version "8.1.0"
+}
+
+description = "redaction-service-server-v1"
+
+
+val layoutParserVersion = "0.23.0"
+val jacksonVersion = "2.15.2"
+val droolsVersion = "8.42.0.Final"
+val pdfBoxVersion = "3.0.0-alpha2"
+
+configurations {
+    all {
+        exclude(group = "org.springframework.boot", module = "spring-boot-starter-logging")
+    }
+}
+
+dependencies {
+
+    implementation(project(":redaction-service-api-v1")) { exclude(group = "com.iqser.red.service", module = "persistence-service-internal-api-v1") }
+    implementation("com.iqser.red.service:persistence-service-internal-api-v1:2.119.0") { exclude(group = "org.springframework.boot") }
+    implementation("com.knecon.fforesight:layoutparser-service-internal-api:${layoutParserVersion}")
+
+    implementation("com.iqser.red.commons:spring-commons:2.6.0")
+    implementation("com.iqser.red.commons:metric-commons:2.3.0")
+
+    implementation("com.iqser.red.commons:dictionary-merge-commons:1.5.0")
+    implementation("com.iqser.red.commons:storage-commons:2.24.0")
+    implementation("com.knecon.fforesight:tenant-commons:0.10.0")
+
+    implementation("com.fasterxml.jackson.module:jackson-module-afterburner:${jacksonVersion}")
+    implementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310:${jacksonVersion}")
+    implementation("org.ahocorasick:ahocorasick:0.6.3")
+    implementation("org.javassist:javassist:3.29.2-GA")
+
+    implementation("org.drools:drools-engine:${droolsVersion}")
+    implementation("org.drools:drools-mvel:${droolsVersion}")
+    implementation("org.kie:kie-spring:7.74.1.Final")
+
+    implementation("org.locationtech.jts:jts-core:1.19.0")
+
+    implementation("org.springframework.cloud:spring-cloud-starter-openfeign:4.0.4")
+    implementation("org.springframework.boot:spring-boot-starter-amqp:3.1.2")
+
+    testImplementation("org.apache.pdfbox:pdfbox:${pdfBoxVersion}")
+    testImplementation("org.apache.pdfbox:pdfbox-tools:${pdfBoxVersion}")
+
+    testImplementation("org.springframework.boot:spring-boot-starter-test:3.1.2")
+    testImplementation("com.knecon.fforesight:layoutparser-service-processor:${layoutParserVersion}") {
+        exclude(
+            group = "com.iqser.red.service",
+            module = "persistence-service-shared-api-v1"
+        )
+    }
+}
+
+tasks.test {
+    configure<JacocoTaskExtension> {
+        excludes = listOf("org/drools/**/*")
+    }
+}
+
+
+tasks.named<BootBuildImage>("bootBuildImage") {
+    imageName.set("nexus.knecon.com:5001/red/${project.name}:${project.version}")
+    if (project.hasProperty("buildbootDockerHostNetwork")) {
+        network.set("host")
+    }
+    docker {
+        if (project.hasProperty("buildbootDockerHostNetwork")) {
+            bindHostToBuilder.set(true)
+        }
+        verboseLogging.set(true)
+
+        publishRegistry {
+            username.set(providers.gradleProperty("mavenUser").getOrNull())
+            password.set(providers.gradleProperty("mavenPassword").getOrNull())
+            email.set(providers.gradleProperty("mavenEmail").getOrNull())
+            url.set("https://nexus.knecon.com:5001/")
+        }
+    }
+}

redaction-service-v1/redaction-service-server-v1/pom.xml

@@ -1,189 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xmlns="http://maven.apache.org/POM/4.0.0"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <modelVersion>4.0.0</modelVersion>
-    <parent>
-        <artifactId>redaction-service-v1</artifactId>
-        <groupId>com.iqser.red.service</groupId>
-        <version>1.0-SNAPSHOT</version>
-    </parent>
-
-    <artifactId>redaction-service-server-v1</artifactId>
-
-    <dependencies>
-        <dependency>
-            <groupId>com.iqser.red.commons</groupId>
-            <artifactId>storage-commons</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>com.iqser.red.service</groupId>
-            <artifactId>redaction-service-api-v1</artifactId>
-            <version>${project.version}</version>
-        </dependency>
-        <dependency>
-            <groupId>com.iqser.red.service</groupId>
-            <artifactId>file-management-service-api-v1</artifactId>
-            <version>2.25.0</version>
-            <exclusions>
-                <exclusion>
-                    <groupId>com.iqser.red.service</groupId>
-                    <artifactId>redaction-service-api-v1</artifactId>
-                </exclusion>
-                <exclusion>
-                    <groupId>com.iqser.red.service</groupId>
-                    <artifactId>configuration-service-api-v1</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
-        <dependency>
-            <groupId>org.drools</groupId>
-            <artifactId>drools-core</artifactId>
-            <version>7.37.0.Final</version>
-        </dependency>
-        <dependency>
-            <groupId>org.kie</groupId>
-            <artifactId>kie-spring</artifactId>
-            <version>7.37.0.Final</version>
-        </dependency>
-        <dependency>
-            <groupId>org.locationtech.jts</groupId>
-            <artifactId>jts-core</artifactId>
-            <version>1.16.1</version>
-        </dependency>
-        <dependency>
-            <groupId>com.google.guava</groupId>
-            <artifactId>guava</artifactId>
-            <version>29.0-jre</version>
-        </dependency>
-
-        <dependency>
-            <groupId>org.apache.pdfbox</groupId>
-            <artifactId>jbig2-imageio</artifactId>
-            <version>3.0.3</version>
-        </dependency>
-        <dependency>
-            <groupId>com.github.jai-imageio</groupId>
-            <artifactId>jai-imageio-core</artifactId>
-            <version>1.4.0</version>
-        </dependency>
-        <dependency>
-            <groupId>com.github.jai-imageio</groupId>
-            <artifactId>jai-imageio-jpeg2000</artifactId>
-            <version>1.4.0</version>
-        </dependency>
-
-        <!-- commons -->
-        <dependency>
-            <groupId>com.iqser.red.commons</groupId>
-            <artifactId>spring-commons</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>com.iqser.red.commons</groupId>
-            <artifactId>logging-commons</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>com.iqser.red.commons</groupId>
-            <artifactId>metric-commons</artifactId>
-        </dependency>
-        <!-- other external -->
-        <dependency>
-            <groupId>org.apache.commons</groupId>
-            <artifactId>commons-lang3</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.pdfbox</groupId>
-            <artifactId>pdfbox</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.pdfbox</groupId>
-            <artifactId>pdfbox-tools</artifactId>
-        </dependency>
-        <!-- spring -->
-        <dependency>
-            <groupId>org.springframework.cloud</groupId>
-            <artifactId>spring-cloud-starter-openfeign</artifactId>
-        </dependency>
-
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-amqp</artifactId>
-            <version>2.3.1.RELEASE</version>
-        </dependency>
-
-        <!-- test dependencies -->
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-test</artifactId>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>com.iqser.red.commons</groupId>
-            <artifactId>test-commons</artifactId>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework.amqp</groupId>
-            <artifactId>spring-rabbit-test</artifactId>
-            <version>2.3.1</version>
-            <scope>test</scope>
-        </dependency>
-    </dependencies>
-
-    <build>
-        <plugins>
-            <plugin>
-                <!-- generate git.properties for exposure in /info -->
-                <groupId>pl.project13.maven</groupId>
-                <artifactId>git-commit-id-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <goals>
-                            <goal>revision</goal>
-                        </goals>
-                        <configuration>
-                            <generateGitPropertiesFile>true</generateGitPropertiesFile>
-                            <gitDescribe>
-                                <tags>true</tags>
-                            </gitDescribe>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
-
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-jar-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <id>original-jar</id>
-                        <goals>
-                            <goal>jar</goal>
-                        </goals>
-                        <configuration>
-                            <classifier>original</classifier>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
-
-            <plugin>
-                <!-- repackages the generated jar into a runnable fat-jar and makes it
-                    executable -->
-                <groupId>org.springframework.boot</groupId>
-                <artifactId>spring-boot-maven-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <goals>
-                            <goal>repackage</goal>
-                        </goals>
-                        <configuration>
-                            <executable>true</executable>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
-        </plugins>
-    </build>
-
-</project>

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/Application.java

@@ -1,26 +1,48 @@
 package com.iqser.red.service.redaction.v1.server;
 
-import com.iqser.red.commons.spring.DefaultWebMvcConfiguration;
-import com.iqser.red.service.redaction.v1.server.client.RulesClient;
-import com.iqser.red.service.redaction.v1.server.settings.RedactionServiceSettings;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.actuate.autoconfigure.security.servlet.ManagementWebSecurityAutoConfiguration;
+import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.cloud.openfeign.EnableFeignClients;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
 
-@Import({DefaultWebMvcConfiguration.class})
+import com.iqser.red.service.dictionarymerge.commons.DictionaryMergeService;
+import com.iqser.red.service.redaction.v1.server.client.RulesClient;
+import com.iqser.red.service.redaction.v1.server.settings.RedactionServiceSettings;
+import com.iqser.red.storage.commons.StorageAutoConfiguration;
+import com.knecon.fforesight.tenantcommons.MultiTenancyAutoConfiguration;
+
+import io.micrometer.core.aop.TimedAspect;
+import io.micrometer.core.instrument.MeterRegistry;
+
+@ImportAutoConfiguration({MultiTenancyAutoConfiguration.class})
+@Import({MetricsConfiguration.class, StorageAutoConfiguration.class})
 @EnableFeignClients(basePackageClasses = RulesClient.class)
 @EnableConfigurationProperties(RedactionServiceSettings.class)
 @SpringBootApplication(exclude = {SecurityAutoConfiguration.class, ManagementWebSecurityAutoConfiguration.class})
 public class Application {
 
     public static void main(String[] args) {
+
         System.setProperty("org.apache.pdfbox.rendering.UsePureJavaCMYKConversion", "true");
         SpringApplication.run(Application.class, args);
     }
 
 
+    @Bean
+    public TimedAspect timedAspect(MeterRegistry registry) {
+
+        return new TimedAspect(registry);
+    }
+
+    @Bean
+    public DictionaryMergeService dictionaryMergeService() {
+
+        return new DictionaryMergeService();
+    }
+
 }

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/MetricsConfiguration.java

@@ -0,0 +1,26 @@
+package com.iqser.red.service.redaction.v1.server;
+
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+
+import com.iqser.gin4.commons.metrics.MetricCommonsConfiguration;
+import com.iqser.gin4.commons.metrics.meters.FunctionTimerFactory;
+import com.iqser.gin4.commons.metrics.meters.FunctionTimerValues;
+
+@Configuration
+@Import({MetricCommonsConfiguration.class})
+public class MetricsConfiguration {
+
+    private static final String REDACTMANAGER_ANALYZE_PAGEWISE_METRIC_NAME = "redactmanager_analyze.pagewise";
+
+
+    @Bean
+    @Qualifier(REDACTMANAGER_ANALYZE_PAGEWISE_METRIC_NAME)
+    public FunctionTimerValues redactmanagerAnalyzePagewise(FunctionTimerFactory factory) {
+
+        return factory.create(REDACTMANAGER_ANALYZE_PAGEWISE_METRIC_NAME);
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/Document.java

@@ -1,42 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import com.iqser.red.service.redaction.v1.model.RedactionLogEntry;
-import com.iqser.red.service.redaction.v1.model.SectionGrid;
-import com.iqser.red.service.redaction.v1.server.redaction.model.DictionaryVersion;
-import com.iqser.red.service.redaction.v1.server.redaction.model.Entity;
-import com.iqser.red.service.redaction.v1.server.redaction.model.Image;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-@Data
-@NoArgsConstructor
-public class Document {
-
-    private List<Page> pages = new ArrayList<>();
-    private List<Paragraph> paragraphs = new ArrayList<>();
-    private List<Header> headers = new ArrayList<>();
-    private List<Footer> footers = new ArrayList<>();
-    private List<UnclassifiedText> unclassifiedTexts = new ArrayList<>();
-    private Map<Integer, List<Entity>> entities = new HashMap<>();
-    private FloatFrequencyCounter textHeightCounter = new FloatFrequencyCounter();
-    private FloatFrequencyCounter fontSizeCounter = new FloatFrequencyCounter();
-    private StringFrequencyCounter fontCounter = new StringFrequencyCounter();
-    private StringFrequencyCounter fontStyleCounter = new StringFrequencyCounter();
-    private boolean headlines;
-
-    private List<RedactionLogEntry> redactionLogEntities = new ArrayList<>();
-    private SectionGrid sectionGrid = new SectionGrid();
-    private DictionaryVersion dictionaryVersion;
-    private long rulesVersion;
-
-    private List<SectionText> sectionText = new ArrayList<>();
-
-    private Map<Integer, Set<Image>> images = new HashMap<>();
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/FloatFrequencyCounter.java

@@ -1,73 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import lombok.Getter;
-
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.stream.Collectors;
-
-public class FloatFrequencyCounter {
-
-    @Getter
-    Map<Float, Integer> countPerValue = new HashMap<>();
-
-    public void add(float value) {
-        if (!countPerValue.containsKey(value)) {
-            countPerValue.put(value, 1);
-        } else {
-            countPerValue.put(value, countPerValue.get(value) + 1);
-        }
-    }
-
-    public void addAll(Map<Float, Integer> otherCounter) {
-        for (Map.Entry<Float, Integer> entry : otherCounter.entrySet()) {
-            if (countPerValue.containsKey(entry.getKey())) {
-                countPerValue.put(entry.getKey(), countPerValue.get(entry.getKey()) + entry.getValue());
-            } else {
-                countPerValue.put(entry.getKey(), entry.getValue());
-            }
-        }
-    }
-
-    public Float getMostPopular() {
-        Map.Entry<Float, Integer> mostPopular = null;
-        for (Map.Entry<Float, Integer> entry : countPerValue.entrySet()) {
-            if (mostPopular == null) {
-                mostPopular = entry;
-            } else if (entry.getValue() >= mostPopular.getValue()) {
-                mostPopular = entry;
-            }
-        }
-        return mostPopular != null ? mostPopular.getKey() : null;
-    }
-
-
-    public List<Float> getHighterThanMostPopular() {
-        Float mostPopular = getMostPopular();
-        List<Float> higher = new ArrayList<>();
-        for (Float value : countPerValue.keySet()) {
-            if (value > mostPopular) {
-                higher.add(value);
-            }
-        }
-
-        return higher.stream().sorted(Collections.reverseOrder()).collect(Collectors.toList());
-    }
-
-
-    public Float getHighest() {
-        Float highest = null;
-        for (Float value : countPerValue.keySet()) {
-            if (highest == null) {
-                highest = value;
-            } else if (value > highest) {
-                highest = value;
-            }
-        }
-        return highest;
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/Footer.java

@@ -1,24 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.iqser.red.service.redaction.v1.server.redaction.model.SearchableText;
-import lombok.AllArgsConstructor;
-import lombok.Data;
-
-import java.util.List;
-
-@Data
-@AllArgsConstructor
-public class Footer {
-
-    private List<TextBlock> textBlocks;
-
-    @JsonIgnore
-    public SearchableText getSearchableText() {
-
-        SearchableText searchableText = new SearchableText();
-        textBlocks.forEach(block -> searchableText.addAll(block.getSequences()));
-        return searchableText;
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/Header.java

@@ -1,24 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.iqser.red.service.redaction.v1.server.redaction.model.SearchableText;
-import lombok.AllArgsConstructor;
-import lombok.Data;
-
-import java.util.List;
-
-@Data
-@AllArgsConstructor
-public class Header {
-
-    private List<TextBlock> textBlocks;
-
-    @JsonIgnore
-    public SearchableText getSearchableText() {
-
-        SearchableText searchableText = new SearchableText();
-        textBlocks.forEach(block -> searchableText.addAll(block.getSequences()));
-        return searchableText;
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/Orientation.java

@@ -1,6 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-public enum Orientation {
-
-    NONE, LEFT, RIGHT
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/Page.java

@@ -1,41 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import com.iqser.red.service.redaction.v1.server.redaction.model.PdfImage;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.AbstractTextContainer;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.Rectangle;
-import lombok.Data;
-import lombok.NonNull;
-import lombok.RequiredArgsConstructor;
-
-import java.util.List;
-
-@Data
-@RequiredArgsConstructor
-public class Page {
-
-    @NonNull
-    private List<AbstractTextContainer> textBlocks;
-
-    private List<PdfImage> images;
-
-    private Rectangle bodyTextFrame;
-
-    private boolean landscape;
-    private int rotation;
-
-    private int pageNumber;
-
-    private FloatFrequencyCounter textHeightCounter = new FloatFrequencyCounter();
-    private FloatFrequencyCounter fontSizeCounter = new FloatFrequencyCounter();
-    private StringFrequencyCounter fontCounter = new StringFrequencyCounter();
-    private StringFrequencyCounter fontStyleCounter = new StringFrequencyCounter();
-
-    private double cropBoxArea;
-
-
-    public boolean isRotated() {
-
-        return rotation != 0;
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/Paragraph.java

@@ -1,64 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import com.iqser.red.service.redaction.v1.server.redaction.model.PdfImage;
-import com.iqser.red.service.redaction.v1.server.redaction.model.SearchableText;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.AbstractTextContainer;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.Table;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.util.ArrayList;
-import java.util.List;
-
-@Data
-@NoArgsConstructor
-public class Paragraph implements Comparable {
-
-    private List<AbstractTextContainer> pageBlocks = new ArrayList<>();
-    private List<PdfImage> images = new ArrayList<>();
-    private String headline;
-
-
-    public SearchableText getSearchableText() {
-
-        SearchableText searchableText = new SearchableText();
-        pageBlocks.forEach(block -> {
-            if (block instanceof TextBlock) {
-                searchableText.addAll(((TextBlock) block).getSequences());
-            }
-        });
-        return searchableText;
-    }
-
-
-    public List<Table> getTables() {
-
-        List<Table> tables = new ArrayList<>();
-        pageBlocks.forEach(block -> {
-            if (block instanceof Table) {
-                tables.add((Table) block);
-            }
-        });
-        return tables;
-    }
-
-
-    public List<TextBlock> getTextBlocks() {
-
-        List<TextBlock> textBlocks = new ArrayList<>();
-        pageBlocks.forEach(block -> {
-            if (block instanceof TextBlock) {
-                textBlocks.add((TextBlock) block);
-            }
-        });
-        return textBlocks;
-    }
-
-
-    @Override
-    public int compareTo(Object o) {
-
-        return 0;
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/SectionText.java

@@ -1,52 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.iqser.red.service.redaction.v1.model.SectionArea;
-import com.iqser.red.service.redaction.v1.server.redaction.model.CellValue;
-import com.iqser.red.service.redaction.v1.server.redaction.model.Image;
-import com.iqser.red.service.redaction.v1.server.redaction.model.SearchableText;
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.util.*;
-
-@Data
-@Builder
-@NoArgsConstructor
-@AllArgsConstructor
-public class SectionText {
-
-    private int sectionNumber;
-    private String text;
-
-    private boolean isTable;
-    private String headline;
-
-    private List<SectionArea> sectionAreas = new ArrayList<>();
-    private Set<Image> images = new HashSet<>();
-
-    private List<TextBlock> textBlocks = new ArrayList<>();
-    private Map<String, CellValue> tabularData = new HashMap<>();
-    private List<Integer> cellStarts = new ArrayList<>();
-
-
-    public void setTabularData(Map<String, CellValue> tabularData) {
-        tabularData.remove(null);
-        this.tabularData = tabularData;
-    }
-
-    @JsonIgnore
-    public SearchableText getSearchableText() {
-
-        SearchableText searchableText = new SearchableText();
-        textBlocks.forEach(block -> {
-            if (block != null) {
-                searchableText.addAll(block.getSequences());
-            }
-        });
-        return searchableText;
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/StringFrequencyCounter.java

@@ -1,49 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import lombok.Getter;
-
-import java.util.HashMap;
-import java.util.Map;
-
-public class StringFrequencyCounter {
-
-    @Getter
-    private final Map<String, Integer> countPerValue = new HashMap<>();
-
-
-    public void add(String value) {
-
-        if (!countPerValue.containsKey(value)) {
-            countPerValue.put(value, 1);
-        } else {
-            countPerValue.put(value, countPerValue.get(value) + 1);
-        }
-    }
-
-
-    public void addAll(Map<String, Integer> otherCounter) {
-
-        for (Map.Entry<String, Integer> entry : otherCounter.entrySet()) {
-            if (countPerValue.containsKey(entry.getKey())) {
-                countPerValue.put(entry.getKey(), countPerValue.get(entry.getKey()) + entry.getValue());
-            } else {
-                countPerValue.put(entry.getKey(), entry.getValue());
-            }
-        }
-    }
-
-
-    public String getMostPopular() {
-
-        Map.Entry<String, Integer> mostPopular = null;
-        for (Map.Entry<String, Integer> entry : countPerValue.entrySet()) {
-            if (mostPopular == null) {
-                mostPopular = entry;
-            } else if (entry.getValue() > mostPopular.getValue()) {
-                mostPopular = entry;
-            }
-        }
-        return mostPopular != null ? mostPopular.getKey() : null;
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/Text.java

@@ -1,18 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.util.ArrayList;
-import java.util.List;
-
-@Data
-@NoArgsConstructor
-@AllArgsConstructor
-public class Text {
-
-    private int numberOfPages;
-    private List<SectionText> sectionTexts = new ArrayList<>();
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/TextBlock.java

@@ -1,145 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.iqser.red.service.redaction.v1.server.parsing.model.TextPositionSequence;
-import com.iqser.red.service.redaction.v1.server.redaction.utils.TextNormalizationUtilities;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.AbstractTextContainer;
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-import java.util.ArrayList;
-import java.util.List;
-
-@AllArgsConstructor
-@Builder
-@Data
-@NoArgsConstructor
-public class TextBlock extends AbstractTextContainer {
-
-    @Builder.Default
-    private List<TextPositionSequence> sequences = new ArrayList<>();
-    private int rotation;
-
-    private String mostPopularWordFont;
-    private String mostPopularWordStyle;
-    private float mostPopularWordFontSize;
-    private float mostPopularWordHeight;
-    private float mostPopularWordSpaceWidth;
-
-    private float highestFontSize;
-
-    private String classification;
-
-
-    public TextBlock(float minX, float maxX, float minY, float maxY, List<TextPositionSequence> sequences, int rotation) {
-        this.minX = minX;
-        this.maxX = maxX;
-        this.minY = minY;
-        this.maxY = maxY;
-        this.sequences = sequences;
-        this.rotation = rotation;
-    }
-
-    public TextBlock union(TextPositionSequence r) {
-        TextBlock union = this.copy();
-        union.add(r);
-        return union;
-    }
-
-    public TextBlock union(TextBlock r) {
-        TextBlock union = this.copy();
-        union.add(r);
-        return union;
-    }
-
-    public void add(TextBlock r) {
-        if (r.getMinX() < minX) {
-            minX = r.getMinX();
-        }
-        if (r.getMaxX() > maxX) {
-            maxX = r.getMaxX();
-        }
-        if (r.getMinY() < minY) {
-            minY = r.getMinY();
-        }
-        if (r.getMaxY() > maxY) {
-            maxY = r.getMaxY();
-        }
-        sequences.addAll(r.getSequences());
-    }
-
-    public void add(TextPositionSequence r) {
-        if (r.getX1() < minX) {
-            minX = r.getX1();
-        }
-        if (r.getX2() > maxX) {
-            maxX = r.getX2();
-        }
-        if (r.getY1() < minY) {
-            minY = r.getY1();
-        }
-        if (r.getY2() > maxY) {
-            maxY = r.getY2();
-        }
-    }
-
-    public TextBlock copy() {
-        return new TextBlock(minX, maxX, minY, maxY, sequences, rotation);
-    }
-
-    public void resize(float x1, float y1, float width, float height) {
-        set(x1, y1, x1 + width, y1 + height);
-    }
-
-    public void set(float x1, float y1, float x2, float y2) {
-        this.minX = Math.min(x1, x2);
-        this.maxX = Math.max(x1, x2);
-        this.minY = Math.min(y1, y2);
-        this.maxY = Math.max(y1, y2);
-    }
-
-
-    @Override
-    public String toString() {
-
-        StringBuilder builder = new StringBuilder();
-
-        for (int i = 0; i < sequences.size(); i++) {
-            String sequenceAsString = sequences.get(i).toString();
-            // Fix for missing Whitespace. This is recognized in getSequences method. See PDFTextStripper Line 1730.
-            if (i != 0 && sequences.get(i - 1).charAt(sequences.get(i - 1).length() - 1) != ' ' && sequenceAsString.charAt(0) != ' ') {
-                builder.append(' ');
-            }
-            builder.append(sequenceAsString);
-        }
-
-        return builder.toString();
-
-    }
-
-    @Override
-    @JsonIgnore
-    public String getText() {
-
-        StringBuilder sb = new StringBuilder();
-
-        TextPositionSequence previous = null;
-        for (TextPositionSequence word : sequences) {
-            if (previous != null) {
-                if (Math.abs(previous.getRotationAdjustedY() - word.getRotationAdjustedY()) > word.getTextHeight()) {
-                    sb.append('\n');
-                } else {
-                    sb.append(' ');
-                }
-            }
-            sb.append(word.toString());
-            previous = word;
-        }
-
-        return TextNormalizationUtilities.removeHyphenLineBreaks(sb.toString());
-
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/model/UnclassifiedText.java

@@ -1,24 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.model;
-
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.iqser.red.service.redaction.v1.server.redaction.model.SearchableText;
-import lombok.AllArgsConstructor;
-import lombok.Data;
-
-import java.util.List;
-
-@Data
-@AllArgsConstructor
-public class UnclassifiedText {
-
-    private List<TextBlock> textBlocks;
-
-    @JsonIgnore
-    public SearchableText getSearchableText() {
-
-        SearchableText searchableText = new SearchableText();
-        textBlocks.forEach(block -> searchableText.addAll(block.getSequences()));
-        return searchableText;
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/service/BlockificationService.java

@@ -1,294 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.service;
-
-import com.iqser.red.service.redaction.v1.server.classification.model.FloatFrequencyCounter;
-import com.iqser.red.service.redaction.v1.server.classification.model.Orientation;
-import com.iqser.red.service.redaction.v1.server.classification.model.Page;
-import com.iqser.red.service.redaction.v1.server.classification.model.StringFrequencyCounter;
-import com.iqser.red.service.redaction.v1.server.classification.model.TextBlock;
-import com.iqser.red.service.redaction.v1.server.classification.utils.PositionUtils;
-import com.iqser.red.service.redaction.v1.server.parsing.model.TextPositionSequence;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.AbstractTextContainer;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.Cell;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.Rectangle;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.Ruling;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.Table;
-
-import org.springframework.stereotype.Service;
-
-import java.util.ArrayList;
-import java.util.Iterator;
-import java.util.List;
-
-@Service
-@SuppressWarnings("all")
-public class BlockificationService {
-
-    static final float THRESHOLD = 1f;
-
-    public Page blockify(List<TextPositionSequence> textPositions, List<Ruling> horizontalRulingLines,
-                         List<Ruling> verticalRulingLines) {
-
-        List<TextPositionSequence> chunkWords = new ArrayList<>();
-        List<AbstractTextContainer> chunkBlockList1 = new ArrayList<>();
-
-        float minX = 1000, maxX = 0, minY = 1000, maxY = 0;
-        TextPositionSequence prev = null;
-
-        boolean wasSplitted = false;
-        Float splitX1 = null;
-        for (TextPositionSequence word : textPositions) {
-
-            boolean lineSeparation = minY - word.getY2() > word.getHeight() * 1.25;
-            boolean startFromTop = word.getY1() > maxY + word.getHeight();
-            boolean splitByX = prev != null && maxX + 50 < word.getX1() && prev.getY1() == word.getY1();
-            boolean newLineAfterSplit = prev != null && word.getY1() != prev.getY1() && wasSplitted && splitX1 != word.getX1();
-            boolean splittedByRuling = word.getRotation() == 0 && isSplittedByRuling(maxX, minY, word.getX1(), word.getY1(), verticalRulingLines) || word
-                    .getRotation() == 0 && isSplittedByRuling(minX, minY, word.getX1(), word.getY2(), horizontalRulingLines) || word
-                    .getRotation() == 90 && isSplittedByRuling(maxX, minY, word.getX1(), word.getY1(), horizontalRulingLines) || word
-                    .getRotation() == 90 && isSplittedByRuling(minX, minY, word.getX1(), word.getY2(), verticalRulingLines);
-
-            if (prev != null && (lineSeparation || startFromTop || splitByX || newLineAfterSplit || splittedByRuling)) {
-
-                Orientation prevOrientation = null;
-                if(!chunkBlockList1.isEmpty()) {
-                    prevOrientation = chunkBlockList1.get(chunkBlockList1.size() - 1).getOrientation();
-                }
-
-                TextBlock cb1 = buildTextBlock(chunkWords);
-                chunkBlockList1.add(cb1);
-                chunkWords = new ArrayList<>();
-
-                if (splitByX && !splittedByRuling) {
-                    wasSplitted = true;
-                    cb1.setOrientation(Orientation.LEFT);
-                    splitX1 = word.getX1();
-                } else
-
-                if (newLineAfterSplit && !splittedByRuling) {
-                    wasSplitted = false;
-                    cb1.setOrientation(Orientation.RIGHT);
-                    splitX1 = null;
-                } else
-
-                if(prevOrientation != null && prevOrientation.equals(Orientation.RIGHT) && (lineSeparation || !startFromTop || !splitByX || !newLineAfterSplit || !splittedByRuling)){
-                    cb1.setOrientation(Orientation.LEFT);
-                }
-
-                minX = 1000;
-                maxX = 0;
-                minY = 1000;
-                maxY = 0;
-                prev = null;
-            }
-
-            chunkWords.add(word);
-
-            prev = word;
-            if (word.getX1() < minX) {
-                minX = word.getX1();
-            }
-            if (word.getX2() > maxX) {
-                maxX = word.getX2();
-            }
-            if (word.getY1() < minY) {
-                minY = word.getY1();
-            }
-            if (word.getY2() > maxY) {
-                maxY = word.getY2();
-            }
-        }
-
-        TextBlock cb1 = buildTextBlock(chunkWords);
-        if (cb1 != null) {
-            chunkBlockList1.add(cb1);
-        }
-
-        Iterator<AbstractTextContainer> itty = chunkBlockList1.iterator();
-
-        TextBlock previousLeft = null;
-        TextBlock previousRight = null;
-        while (itty.hasNext()) {
-            TextBlock block = (TextBlock) itty.next();
-
-            if(previousLeft != null && block.getOrientation().equals(Orientation.LEFT)){
-                if (previousLeft.getMinY() > block.getMinY() && block.getMaxY() + block.getMostPopularWordHeight() > previousLeft.getMinY()){
-                    previousLeft.add(block);
-                    itty.remove();
-                    continue;
-                }
-            }
-
-            if(previousRight != null && block.getOrientation().equals(Orientation.RIGHT)){
-                if (previousRight.getMinY() > block.getMinY() && block.getMaxY() + block.getMostPopularWordHeight() > previousRight.getMinY()){
-                    previousRight.add(block);
-                    itty.remove();
-                    continue;
-                }
-            }
-
-            if (block.getOrientation().equals(Orientation.LEFT)) {
-                previousLeft = block;
-            } else if (block.getOrientation().equals(Orientation.RIGHT)) {
-                previousRight = block;
-            }
-        }
-
-
-        itty = chunkBlockList1.iterator();
-        TextBlock previous = null;
-        while (itty.hasNext()) {
-            TextBlock block = (TextBlock) itty.next();
-
-            if(previous != null && previous.getOrientation().equals(Orientation.LEFT) && block.getOrientation().equals(Orientation.LEFT) && equalsWithThreshold(block.getMaxY(), previous
-                    .getMaxY())||
-                    previous != null && previous.getOrientation().equals(Orientation.LEFT) && block.getOrientation().equals(Orientation.RIGHT) && equalsWithThreshold(block.getMaxY(), previous
-                    .getMaxY())){
-                previous.add(block);
-                itty.remove();
-                continue;
-            }
-
-            previous = block;
-        }
-
-
-        return new Page(chunkBlockList1);
-    }
-
-    private boolean equalsWithThreshold(float f1, float f2){
-        return Math.abs(f1 - f2) < THRESHOLD;
-    }
-
-
-    private TextBlock buildTextBlock(List<TextPositionSequence> wordBlockList) {
-
-        TextBlock textBlock = null;
-
-        FloatFrequencyCounter lineHeightFrequencyCounter = new FloatFrequencyCounter();
-        FloatFrequencyCounter fontSizeFrequencyCounter = new FloatFrequencyCounter();
-        FloatFrequencyCounter spaceFrequencyCounter = new FloatFrequencyCounter();
-        StringFrequencyCounter fontFrequencyCounter = new StringFrequencyCounter();
-        StringFrequencyCounter styleFrequencyCounter = new StringFrequencyCounter();
-
-        for (TextPositionSequence wordBlock : wordBlockList) {
-
-            lineHeightFrequencyCounter.add(wordBlock.getTextHeight());
-            fontSizeFrequencyCounter.add(wordBlock.getFontSize());
-            spaceFrequencyCounter.add(wordBlock.getSpaceWidth());
-            fontFrequencyCounter.add(wordBlock.getFont());
-            styleFrequencyCounter.add(wordBlock.getFontStyle());
-
-            if (textBlock == null) {
-                textBlock = new TextBlock(wordBlock.getX1(), wordBlock.getX2(), wordBlock.getY1(), wordBlock.getY2(), wordBlockList, wordBlock
-                        .getRotation());
-            } else {
-                TextBlock spatialEntity = textBlock.union(wordBlock);
-                textBlock.resize(spatialEntity.getMinX(), spatialEntity.getMinY(), spatialEntity.getWidth(), spatialEntity
-                        .getHeight());
-            }
-        }
-
-        if (textBlock != null) {
-            textBlock.setMostPopularWordFont(fontFrequencyCounter.getMostPopular());
-            textBlock.setMostPopularWordStyle(styleFrequencyCounter.getMostPopular());
-            textBlock.setMostPopularWordFontSize(fontSizeFrequencyCounter.getMostPopular());
-            textBlock.setMostPopularWordHeight(lineHeightFrequencyCounter.getMostPopular());
-            textBlock.setMostPopularWordSpaceWidth(spaceFrequencyCounter.getMostPopular());
-            textBlock.setHighestFontSize(fontSizeFrequencyCounter.getHighest());
-        }
-
-        return textBlock;
-    }
-
-
-    private boolean isSplittedByRuling(float previousX2, float previousY1, float currentX1, float currentY1,
-                                       List<Ruling> rulingLines) {
-
-        for (Ruling ruling : rulingLines) {
-            if (ruling.intersectsLine(previousX2, previousY1, currentX1, currentY1)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    public Rectangle calculateBodyTextFrame(List<Page> pages, FloatFrequencyCounter documentFontSizeCounter,
-                                            boolean landscape) {
-
-        float minX = 10000;
-        float maxX = -100;
-        float minY = 10000;
-        float maxY = -100;
-
-        for (Page page : pages) {
-
-            if (page.getTextBlocks().isEmpty() || landscape != page.isLandscape()) {
-                continue;
-            }
-
-            for (AbstractTextContainer container : page.getTextBlocks()) {
-
-                if (container instanceof TextBlock) {
-                    TextBlock textBlock = (TextBlock) container;
-                    if (textBlock.getMostPopularWordFont() == null || textBlock.getMostPopularWordStyle() == null) {
-                        continue;
-                    }
-
-                    float approxLineCount = PositionUtils.getApproxLineCount(textBlock);
-                    if (approxLineCount < 2.9f) {
-                        continue;
-                    }
-
-                    if (documentFontSizeCounter.getMostPopular() != null) {
-                        if (textBlock.getMostPopularWordFontSize() >= documentFontSizeCounter.getMostPopular()) {
-
-                            if (textBlock.getMinX() < minX) {
-                                minX = textBlock.getMinX();
-                            }
-                            if (textBlock.getMaxX() > maxX) {
-                                maxX = textBlock.getMaxX();
-                            }
-                            if (textBlock.getMinY() < minY) {
-                                minY = textBlock.getMinY();
-                            }
-                            if (textBlock.getMaxY() > maxY) {
-                                maxY = textBlock.getMaxY();
-                            }
-
-                        }
-                    }
-                }
-
-                if (container instanceof Table) {
-                    Table table = (Table) container;
-                    for (List<Cell> row : table.getRows()) {
-                        for (Cell cell : row) {
-
-                            if (cell == null || cell.getTextBlocks() == null) {
-                                continue;
-                            }
-                            for (TextBlock textBlock : cell.getTextBlocks()) {
-                                if (textBlock.getMinX() < minX) {
-                                    minX = textBlock.getMinX();
-                                }
-                                if (textBlock.getMaxX() > maxX) {
-                                    maxX = textBlock.getMaxX();
-                                }
-                                if (textBlock.getMinY() < minY) {
-                                    minY = textBlock.getMinY();
-                                }
-                                if (textBlock.getMaxY() > maxY) {
-                                    maxY = textBlock.getMaxY();
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-
-        }
-        return new Rectangle(minY, minX, maxX - minX, maxY - minY);
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/service/ClassificationService.java

@@ -1,117 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.service;
-
-import com.iqser.red.service.redaction.v1.server.classification.model.Document;
-import com.iqser.red.service.redaction.v1.server.classification.model.Page;
-import com.iqser.red.service.redaction.v1.server.classification.model.TextBlock;
-import com.iqser.red.service.redaction.v1.server.classification.utils.PositionUtils;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.AbstractTextContainer;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.Rectangle;
-import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-import org.springframework.stereotype.Service;
-
-import java.util.List;
-import java.util.regex.Pattern;
-
-@Slf4j
-@Service
-@RequiredArgsConstructor
-public class ClassificationService {
-
-    private final BlockificationService blockificationService;
-
-
-    public void classifyDocument(Document document) {
-
-        Rectangle bodyTextFrame = blockificationService.calculateBodyTextFrame(document.getPages(), document.getFontSizeCounter(), false);
-        Rectangle landscapeBodyTextFrame = blockificationService.calculateBodyTextFrame(document.getPages(), document.getFontSizeCounter(), true);
-
-        List<Float> headlineFontSizes = document.getFontSizeCounter().getHighterThanMostPopular();
-
-        log.debug("Document FontSize counters are: {}", document.getFontSizeCounter().getCountPerValue());
-
-        for (Page page : document.getPages()) {
-            Rectangle btf = page.isLandscape() ? landscapeBodyTextFrame : bodyTextFrame;
-            page.setBodyTextFrame(btf);
-            classifyPage(btf, page, document, headlineFontSizes);
-        }
-    }
-
-
-    public void classifyPage(Rectangle bodyTextFrame, Page page, Document document, List<Float> headlineFontSizes) {
-
-        for (AbstractTextContainer textBlock : page.getTextBlocks()) {
-            if (textBlock instanceof TextBlock) {
-                classifyBlock((TextBlock) textBlock, bodyTextFrame, page, document, headlineFontSizes);
-            }
-        }
-    }
-
-
-    public void classifyBlock(TextBlock textBlock, Rectangle bodyTextFrame, Page page, Document document,
-                              List<Float> headlineFontSizes) {
-
-        if (document.getFontSizeCounter().getMostPopular() == null) {
-            // TODO Figure out why this happens.
-            return;
-        }
-        if (PositionUtils.isOverBodyTextFrame(bodyTextFrame, textBlock, page.isRotated()) && (document.getFontSizeCounter()
-                .getMostPopular() == null || textBlock.getHighestFontSize() <= document.getFontSizeCounter()
-                .getMostPopular())) {
-            textBlock.setClassification("Header");
-
-        } else if (PositionUtils.isUnderBodyTextFrame(bodyTextFrame, textBlock) && (document.getFontSizeCounter()
-                .getMostPopular() == null || textBlock.getHighestFontSize() <= document.getFontSizeCounter()
-                .getMostPopular())) {
-            textBlock.setClassification("Footer");
-        } else if (page.getPageNumber() == 1 && (!PositionUtils.isTouchingUnderBodyTextFrame(bodyTextFrame, textBlock) && PositionUtils
-                .getHeightDifferenceBetweenChunkWordAndDocumentWord(textBlock, document.getTextHeightCounter()
-                        .getMostPopular()) > 2.5 && textBlock.getHighestFontSize() > document.getFontSizeCounter()
-                .getMostPopular() || page.getTextBlocks().size() == 1)) {
-            if (!Pattern.matches("[0-9]+", textBlock.toString())) {
-                textBlock.setClassification("Title");
-            }
-        } else if (PositionUtils.isWithinBodyTextFrame(bodyTextFrame, textBlock) && textBlock.getMostPopularWordFontSize() > document
-                .getFontSizeCounter()
-                .getMostPopular() && PositionUtils.getApproxLineCount(textBlock) < 4.9 && textBlock.getMostPopularWordStyle()
-                .equals("bold")) {
-
-            for (int i = 1; i <= headlineFontSizes.size(); i++) {
-                if (textBlock.getMostPopularWordFontSize() == headlineFontSizes.get(i - 1)) {
-                    textBlock.setClassification("H " + i);
-                    document.setHeadlines(true);
-                }
-            }
-        } else if (!textBlock.getText().startsWith("Table ") && !textBlock.getText()
-                .startsWith("Figure ") && PositionUtils.isWithinBodyTextFrame(bodyTextFrame, textBlock) && textBlock.getMostPopularWordStyle()
-                .equals("bold") && !document.getFontStyleCounter()
-                .getMostPopular()
-                .equals("bold") && PositionUtils.getApproxLineCount(textBlock) < 2.9) {
-            textBlock.setClassification("H " + (headlineFontSizes.size() + 1));
-            document.setHeadlines(true);
-        } else if (PositionUtils.isWithinBodyTextFrame(bodyTextFrame, textBlock) && textBlock.getMostPopularWordFontSize() == document
-                .getFontSizeCounter()
-                .getMostPopular() && textBlock.getMostPopularWordStyle()
-                .equals("bold") && !document.getFontStyleCounter().getMostPopular().equals("bold")) {
-            textBlock.setClassification("TextBlock Bold");
-        } else if (PositionUtils.isWithinBodyTextFrame(bodyTextFrame, textBlock) && textBlock.getMostPopularWordFont()
-                .equals(document.getFontCounter().getMostPopular()) && textBlock.getMostPopularWordStyle()
-                .equals(document.getFontStyleCounter()
-                        .getMostPopular()) && textBlock.getMostPopularWordFontSize() == document.getFontSizeCounter()
-                .getMostPopular()) {
-            textBlock.setClassification("TextBlock");
-        } else if (PositionUtils.isWithinBodyTextFrame(bodyTextFrame, textBlock) && textBlock.getMostPopularWordFontSize() == document
-                .getFontSizeCounter()
-                .getMostPopular() && textBlock.getMostPopularWordStyle()
-                .equals("italic") && !document.getFontStyleCounter()
-                .getMostPopular()
-                .equals("italic") && PositionUtils.getApproxLineCount(textBlock) < 2.9) {
-            textBlock.setClassification("TextBlock Italic");
-        } else if (PositionUtils.isWithinBodyTextFrame(bodyTextFrame, textBlock)) {
-            textBlock.setClassification("TextBlock Unknown");
-        } else {
-            textBlock.setClassification("Other");
-        }
-    }
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/classification/utils/PositionUtils.java

@@ -1,94 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.classification.utils;
-
-import com.iqser.red.service.redaction.v1.server.classification.model.TextBlock;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.Rectangle;
-import lombok.experimental.UtilityClass;
-
-@UtilityClass
-@SuppressWarnings("all")
-public class PositionUtils {
-
-
-    public boolean isWithinBodyTextFrame(Rectangle btf, TextBlock textBlock) {
-
-        //TODO Currently this is not working for rotated pages.
-
-        if (btf == null || textBlock == null) {
-            return false;
-        }
-
-        double threshold = textBlock.getMostPopularWordHeight() * 3;
-
-        if (textBlock.getMinX() + threshold > btf.getX() &&
-                textBlock.getMaxX() - threshold < btf.getX() + btf.getWidth() &&
-                textBlock.getMinY() + threshold > btf.getY() &&
-                textBlock.getMaxY() - threshold < btf.getY() + btf.getHeight()) {
-            return true;
-        } else {
-            return false;
-        }
-
-    }
-
-
-    public boolean isOverBodyTextFrame(Rectangle btf, TextBlock textBlock, boolean rotated) {
-
-        if (btf == null || textBlock == null) {
-            return false;
-        }
-
-        if (rotated && textBlock.getMinX() < btf.getX()) {
-            // Its very strange, P{0,0} is on top left in this case, instead of lower left.
-            return true;
-        } else if (!rotated && textBlock.getMinY() > btf.getY() + btf.getHeight()) {
-            return true;
-        } else {
-            return false;
-        }
-
-    }
-
-
-    public boolean isUnderBodyTextFrame(Rectangle btf, TextBlock textBlock) {
-
-        //TODO Currently this is not working for rotated pages.
-
-        if (btf == null || textBlock == null) {
-            return false;
-        }
-
-        if (textBlock.getMaxY() < btf.getY()) {
-            return true;
-        } else {
-            return false;
-        }
-
-    }
-
-
-    public boolean isTouchingUnderBodyTextFrame(Rectangle btf, TextBlock textBlock) {
-
-        //TODO Currently this is not working for rotated pages.
-
-        if (btf == null || textBlock == null) {
-            return false;
-        }
-
-        if (textBlock.getMinY() < btf.getY()) {
-            return true;
-        } else {
-            return false;
-        }
-
-    }
-
-
-    public float getHeightDifferenceBetweenChunkWordAndDocumentWord(TextBlock textBlock, Float documentMostPopularWordHeight) {
-        return textBlock.getMostPopularWordHeight() - documentMostPopularWordHeight;
-    }
-
-
-    public Float getApproxLineCount(TextBlock textBlock) {
-        return textBlock.getHeight() / textBlock.getMostPopularWordHeight();
-    }
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/DictionaryClient.java

@@ -1,8 +1,10 @@
 package com.iqser.red.service.redaction.v1.server.client;
 
-import com.iqser.red.service.configuration.v1.api.resource.DictionaryResource;
 import org.springframework.cloud.openfeign.FeignClient;
 
-@FeignClient(name = "DictionaryResource", url = "${configuration-service.url}")
+import com.iqser.red.service.persistence.service.v1.api.internal.resources.DictionaryResource;
+
+@FeignClient(name = "DictionaryResource", url = "${persistence-service.url}")
 public interface DictionaryClient extends DictionaryResource {
-}
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/FileStatusProcessingUpdateClient.java

@@ -1,9 +1,10 @@
 package com.iqser.red.service.redaction.v1.server.client;
 
-
-import com.iqser.red.service.file.management.v1.api.resources.FileStatusProcessingUpdateResource;
 import org.springframework.cloud.openfeign.FeignClient;
 
-@FeignClient(name = "FileStatusProcessingUpdateResource", url = "${file-management-service.url}")
+import com.iqser.red.service.persistence.service.v1.api.internal.resources.FileStatusProcessingUpdateResource;
+
+@FeignClient(name = "FileStatusProcessingUpdateResource", url = "${persistence-service.url}")
 public interface FileStatusProcessingUpdateClient extends FileStatusProcessingUpdateResource {
+
 }

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/ImageClassificationClient.java

@@ -1,15 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.client;
-
-import org.springframework.cloud.openfeign.FeignClient;
-import org.springframework.http.MediaType;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.multipart.MultipartFile;
-
-@FeignClient(name = "ImageClassificationResource", url = "${image-service.url}")
-public interface ImageClassificationClient {
-
-    @PostMapping(value = "/process_full_img", consumes = MediaType.MULTIPART_FORM_DATA_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
-    ImageClassificationResponse classify(@RequestBody MultipartFile file);
-
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/ImageClassificationResponse.java

@@ -1,13 +0,0 @@
-package com.iqser.red.service.redaction.v1.server.client;
-
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-@Data
-@NoArgsConstructor
-@AllArgsConstructor
-public class ImageClassificationResponse {
-
-    private String category;
-}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/LegalBasisClient.java

@@ -1,8 +1,10 @@
 package com.iqser.red.service.redaction.v1.server.client;
 
-import com.iqser.red.service.configuration.v1.api.resource.LegalBasisMappingResource;
 import org.springframework.cloud.openfeign.FeignClient;
 
-@FeignClient(name = "LegalBasisMappingResource", url = "${configuration-service.url}")
+import com.iqser.red.service.persistence.service.v1.api.internal.resources.LegalBasisMappingResource;
+
+@FeignClient(name = "LegalBasisMappingResource", url = "${persistence-service.url}")
 public interface LegalBasisClient extends LegalBasisMappingResource {
+
 }

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/MockMultipartFile.java

@@ -1,16 +1,16 @@
 package com.iqser.red.service.redaction.v1.server.client;
 
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+
 import org.springframework.lang.NonNull;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 import org.springframework.util.FileCopyUtils;
 import org.springframework.web.multipart.MultipartFile;
 
-import java.io.ByteArrayInputStream;
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-
 public class MockMultipartFile implements MultipartFile {
 
     private final String name;
@@ -32,8 +32,7 @@ public class MockMultipartFile implements MultipartFile {
     }
 
 
-    public MockMultipartFile(String name, @Nullable String originalFilename, @Nullable String contentType,
-                             @Nullable byte[] content) {
+    public MockMultipartFile(String name, @Nullable String originalFilename, @Nullable String contentType, @Nullable byte[] content) {
 
         Assert.hasLength(name, "Name must not be empty");
         this.name = name;
@@ -43,8 +42,7 @@ public class MockMultipartFile implements MultipartFile {
     }
 
 
-    public MockMultipartFile(String name, @Nullable String originalFilename, @Nullable String contentType,
-                             InputStream contentStream) throws IOException {
+    public MockMultipartFile(String name, @Nullable String originalFilename, @Nullable String contentType, InputStream contentStream) throws IOException {
 
         this(name, originalFilename, contentType, FileCopyUtils.copyToByteArray(contentStream));
     }
@@ -82,13 +80,13 @@ public class MockMultipartFile implements MultipartFile {
     }
 
 
-    public byte[] getBytes() throws IOException {
+    public byte[] getBytes() {
 
         return this.content;
     }
 
 
-    public InputStream getInputStream() throws IOException {
+    public InputStream getInputStream() {
 
         return new ByteArrayInputStream(this.content);
     }

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/RulesClient.java

@@ -1,8 +1,10 @@
 package com.iqser.red.service.redaction.v1.server.client;
 
-import com.iqser.red.service.configuration.v1.api.resource.RulesResource;
 import org.springframework.cloud.openfeign.FeignClient;
 
-@FeignClient(name = "RulesResource", url = "${configuration-service.url}")
+import com.iqser.red.service.persistence.service.v1.api.internal.resources.RulesResource;
+
+@FeignClient(name = "RulesResource", url = "${persistence-service.url}")
 public interface RulesClient extends RulesResource {
+
 }

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/model/EntityRecognitionEntity.java

@@ -1,4 +1,5 @@
-package com.iqser.red.service.redaction.v1.model;
+package com.iqser.red.service.redaction.v1.server.client.model;
+
 
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -7,13 +8,13 @@ import lombok.NoArgsConstructor;
 
 @Data
 @Builder
-@NoArgsConstructor
 @AllArgsConstructor
-public class FileAttribute {
+@NoArgsConstructor
+public class EntityRecognitionEntity {
 
-    private String id;
-    private String label;
-    private String placeholder;
     private String value;
+    private int startOffset;
+    private int endOffset;
+    private String type;
 
 }

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/model/EntityRecognitionSection.java

@@ -1,4 +1,4 @@
-package com.iqser.red.service.redaction.v1.model;
+package com.iqser.red.service.redaction.v1.server.client.model;
 
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -7,11 +7,11 @@ import lombok.NoArgsConstructor;
 
 @Data
 @Builder
-@NoArgsConstructor
 @AllArgsConstructor
-public class RedactionResult {
+@NoArgsConstructor
+public class EntityRecognitionSection {
 
-    private byte[] document;
-    private int numberOfPages;
+    private int sectionNumber;
+    private String text;
 
 }

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/client/model/NerEntitiesModel.java

@@ -0,0 +1,18 @@
+package com.iqser.red.service.redaction.v1.server.client.model;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class NerEntitiesModel {
+
+    private Map<Integer, List<EntityRecognitionEntity>> data = new HashMap<>();
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/controller/ControllerAdvice.java

@@ -1,8 +1,11 @@
 package com.iqser.red.service.redaction.v1.server.controller;
 
 import com.iqser.red.commons.spring.ErrorMessage;
+import com.iqser.red.service.redaction.v1.server.exception.NotFoundException;
 import com.iqser.red.service.redaction.v1.server.exception.RulesValidationException;
+
 import lombok.extern.slf4j.Slf4j;
+
 import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.ResponseBody;
@@ -17,10 +20,12 @@ public class ControllerAdvice {
 
     /* error handling */
 
+
     @ResponseBody
     @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
     @ExceptionHandler(value = NullPointerException.class)
     public ErrorMessage handleContentNotFoundException(NullPointerException e) {
+
         if (e != null) {
             log.error(e.getMessage(), e);
             return new ErrorMessage(OffsetDateTime.now(), e.getMessage());
@@ -29,10 +34,21 @@ public class ControllerAdvice {
         return new ErrorMessage(OffsetDateTime.now(), "Nullpointer exception");
     }
 
+
     @ResponseBody
     @ResponseStatus(value = HttpStatus.BAD_REQUEST)
     @ExceptionHandler(value = RulesValidationException.class)
     public ErrorMessage handleRulesValidationException(RulesValidationException e) {
+
+        return new ErrorMessage(OffsetDateTime.now(), e.getMessage());
+    }
+
+
+    @ResponseBody
+    @ResponseStatus(value = HttpStatus.NOT_FOUND)
+    @ExceptionHandler(value = NotFoundException.class)
+    public ErrorMessage handleFileNotFoundException(NotFoundException e) {
+
         return new ErrorMessage(OffsetDateTime.now(), e.getMessage());
     }
 

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/controller/RedactionController.java

@@ -1,179 +1,31 @@
 package com.iqser.red.service.redaction.v1.server.controller;
 
-import com.iqser.red.service.file.management.v1.api.model.FileType;
-import com.iqser.red.service.redaction.v1.model.*;
-import com.iqser.red.service.redaction.v1.resources.RedactionResource;
-import com.iqser.red.service.redaction.v1.server.classification.model.Document;
-import com.iqser.red.service.redaction.v1.server.classification.model.Page;
-import com.iqser.red.service.redaction.v1.server.exception.RedactionException;
-import com.iqser.red.service.redaction.v1.server.redaction.service.AnnotationService;
-import com.iqser.red.service.redaction.v1.server.redaction.service.DictionaryService;
-import com.iqser.red.service.redaction.v1.server.redaction.service.DroolsExecutionService;
-import com.iqser.red.service.redaction.v1.server.redaction.service.RedactionLogMergeService;
-import com.iqser.red.service.redaction.v1.server.segmentation.PdfSegmentationService;
-import com.iqser.red.service.redaction.v1.server.settings.RedactionServiceSettings;
-import com.iqser.red.service.redaction.v1.server.storage.RedactionStorageService;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.AbstractTextContainer;
-import com.iqser.red.service.redaction.v1.server.tableextraction.model.Table;
-import com.iqser.red.service.redaction.v1.server.visualization.service.PdfVisualisationService;
-import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-import org.apache.pdfbox.io.MemoryUsageSetting;
-import org.apache.pdfbox.pdmodel.PDDocument;
-import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RestController;
 
-import java.io.ByteArrayOutputStream;
-import java.io.IOException;
+import com.iqser.red.service.redaction.v1.resources.RedactionResource;
+import com.iqser.red.service.redaction.v1.server.exception.RulesValidationException;
+import com.iqser.red.service.redaction.v1.server.redaction.service.DroolsExecutionService;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
 
 @Slf4j
 @RestController
 @RequiredArgsConstructor
 public class RedactionController implements RedactionResource {
 
-    private final PdfVisualisationService pdfVisualisationService;
     private final DroolsExecutionService droolsExecutionService;
-    private final DictionaryService dictionaryService;
-    private final AnnotationService annotationService;
-    private final PdfSegmentationService pdfSegmentationService;
-    private final RedactionStorageService redactionStorageService;
-    private final RedactionLogMergeService redactionLogMergeService;
 
-    public AnnotateResponse annotate(@RequestBody AnnotateRequest annotateRequest) {
-
-        var storedObjectStream = redactionStorageService.getStoredObject(RedactionStorageService.StorageIdUtils.getStorageId(annotateRequest.getDossierId(), annotateRequest.getFileId(), FileType.ORIGIN));
-        var redactionLog = redactionStorageService.getRedactionLog(annotateRequest.getDossierId(), annotateRequest.getFileId());
-        var sectionsGrid = redactionStorageService.getSectionGrid(annotateRequest.getDossierId(), annotateRequest.getFileId());
-
-        try (PDDocument pdDocument = PDDocument.load(storedObjectStream, MemoryUsageSetting.setupTempFileOnly())) {
-            pdDocument.setAllSecurityToBeRemoved(true);
-
-            dictionaryService.updateDictionary(annotateRequest.getDossierTemplateId(), annotateRequest.getDossierId());
-            annotationService.annotate(pdDocument, redactionLog, sectionsGrid);
-
-            try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
-                pdDocument.save(byteArrayOutputStream);
-                return AnnotateResponse.builder().document(byteArrayOutputStream.toByteArray()).build();
-            }
-
-        } catch (Exception e) {
-            throw new RedactionException(e);
-        }
-    }
-
-
-    @Override
-    public RedactionResult classify(@RequestBody RedactionRequest redactionRequest) {
-        var storedObjectStream = redactionStorageService.getStoredObject(RedactionStorageService.StorageIdUtils.getStorageId(redactionRequest.getDossierId(), redactionRequest.getFileId(), FileType.ORIGIN));
-        try {
-            Document classifiedDoc = pdfSegmentationService.parseDocument(storedObjectStream);
-
-            storedObjectStream = redactionStorageService.getStoredObject(RedactionStorageService.StorageIdUtils.getStorageId(redactionRequest.getDossierId(), redactionRequest.getFileId(), FileType.ORIGIN));
-            try (PDDocument pdDocument = PDDocument.load(storedObjectStream)) {
-                pdDocument.setAllSecurityToBeRemoved(true);
-
-                pdfVisualisationService.visualizeClassifications(classifiedDoc, pdDocument);
-
-                return convert(pdDocument, classifiedDoc.getPages().size());
-
-            } catch (IOException e) {
-                throw new RedactionException(e);
-            }
-
-        } catch (IOException e) {
-            throw new RedactionException(e);
-        }
-
-
-    }
-
-    @Override
-    public RedactionResult sections(@RequestBody RedactionRequest redactionRequest) {
-        var storedObjectStream = redactionStorageService.getStoredObject(RedactionStorageService.StorageIdUtils.getStorageId(redactionRequest.getDossierId(), redactionRequest.getFileId(), FileType.ORIGIN));
-        try {
-            Document classifiedDoc = pdfSegmentationService.parseDocument(storedObjectStream);
-
-            storedObjectStream = redactionStorageService.getStoredObject(RedactionStorageService.StorageIdUtils.getStorageId(redactionRequest.getDossierId(), redactionRequest.getFileId(), FileType.ORIGIN));
-            try (PDDocument pdDocument = PDDocument.load(storedObjectStream)) {
-                pdDocument.setAllSecurityToBeRemoved(true);
-
-                pdfVisualisationService.visualizeParagraphs(classifiedDoc, pdDocument);
-                return convert(pdDocument, classifiedDoc.getPages().size());
-
-            } catch (IOException e) {
-                throw new RedactionException(e);
-            }
-
-        } catch (IOException e) {
-            throw new RedactionException(e);
-        }
-
-
-    }
-
-
-    @Override
-    public RedactionResult htmlTables(@RequestBody RedactionRequest redactionRequest) {
-
-        Document classifiedDoc;
-
-        try {
-            var storedObjectStream = redactionStorageService.getStoredObject(RedactionStorageService.StorageIdUtils.getStorageId(redactionRequest.getDossierId(), redactionRequest.getFileId(), FileType.ORIGIN));
-            classifiedDoc = pdfSegmentationService.parseDocument(storedObjectStream, true);
-        } catch (Exception e) {
-            throw new RedactionException(e);
-        }
-
-
-        StringBuilder sb = new StringBuilder();
-        for (Page page : classifiedDoc.getPages()) {
-            for (AbstractTextContainer textContainer : page.getTextBlocks()) {
-                if (textContainer instanceof Table) {
-                    Table table = (Table) textContainer;
-                    sb.append(table.getTextAsHtml()).append("<br />").append("<br />");
-                }
-            }
-        }
-
-        return RedactionResult.builder().document(sb.toString().getBytes()).build();
-
-    }
 
     @Override
     public void testRules(@RequestBody String rules) {
 
-        droolsExecutionService.testRules(rules);
-    }
-
-    @Override
-    public RedactionLog getRedactionLog(RedactionRequest redactionRequest) {
-
-        log.info("Requested preview for: {}", redactionRequest);
-        dictionaryService.updateDictionary(redactionRequest.getDossierTemplateId(), redactionRequest.getDossierId());
-
-        var redactionLog = redactionStorageService.getRedactionLog(redactionRequest.getDossierId(), redactionRequest.getFileId());
-
-        log.info("Loaded redaction log with computationalVersion: {}", redactionLog.getAnalysisVersion());
-        if (redactionLog.getAnalysisVersion() == 0) {
-            // old redaction logs are returned directly
-            return redactionLog;
-        } else {
-            return redactionLogMergeService.mergeRedactionLogData(redactionLog, redactionRequest.getDossierTemplateId(), redactionRequest.getManualRedactions());
+        try {
+            droolsExecutionService.testRules(rules);
+        } catch (Exception e) {
+            throw new RulesValidationException("Could not test rules: " + e.getMessage(), e);
         }
     }
 
-    private RedactionResult convert(PDDocument document, int numberOfPages) throws IOException {
-
-        try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
-            document.save(byteArrayOutputStream);
-            return RedactionResult.builder()
-                    .document(byteArrayOutputStream.toByteArray())
-                    .numberOfPages(numberOfPages)
-                    .build();
-        }
-
-    }
-
-
 }

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/controller/RuleBuilderController.java

@@ -0,0 +1,24 @@
+package com.iqser.red.service.redaction.v1.server.controller;
+
+import org.springframework.web.bind.annotation.RestController;
+
+import com.iqser.red.service.redaction.v1.model.RuleBuilderModel;
+import com.iqser.red.service.redaction.v1.resources.RuleBuilderResource;
+import com.iqser.red.service.redaction.v1.server.redaction.service.RuleBuilderModelService;
+
+import lombok.RequiredArgsConstructor;
+
+@RestController
+@RequiredArgsConstructor
+public class RuleBuilderController implements RuleBuilderResource {
+
+    private final RuleBuilderModelService ruleBuilderModelService;
+
+
+    @Override
+    public RuleBuilderModel getRuleBuilderModel() {
+
+        return ruleBuilderModelService.getRuleBuilderModel();
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/data/DocumentData.java

@@ -0,0 +1,25 @@
+package com.iqser.red.service.redaction.v1.server.document.data;
+
+import com.knecon.fforesight.service.layoutparser.internal.api.data.redaction.DocumentPage;
+import com.knecon.fforesight.service.layoutparser.internal.api.data.redaction.DocumentPositionData;
+import com.knecon.fforesight.service.layoutparser.internal.api.data.redaction.DocumentStructure;
+import com.knecon.fforesight.service.layoutparser.internal.api.data.redaction.DocumentTextData;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.experimental.FieldDefaults;
+
+@Data
+@Builder
+@AllArgsConstructor
+@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
+public class DocumentData {
+
+    DocumentPage[] documentPages;
+    DocumentTextData[] documentTextData;
+    DocumentPositionData[] documentPositionData;
+    DocumentStructure documentStructure;
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/data/mapper/DocumentGraphMapper.java

@@ -0,0 +1,198 @@
+package com.iqser.red.service.redaction.v1.server.document.data.mapper;
+
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+import java.util.NoSuchElementException;
+
+import com.iqser.red.service.redaction.v1.server.document.graph.DocumentTree;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Footer;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Header;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Image;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Page;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Paragraph;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Section;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.SemanticNode;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.TableCell;
+import com.iqser.red.service.redaction.v1.server.document.graph.textblock.AtomicTextBlock;
+import com.iqser.red.service.redaction.v1.server.document.graph.textblock.TextBlock;
+import com.iqser.red.service.redaction.v1.server.document.graph.textblock.TextBlockCollector;
+import com.iqser.red.service.redaction.v1.server.document.data.DocumentData;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Document;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Headline;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Table;
+import com.knecon.fforesight.service.layoutparser.internal.api.data.redaction.DocumentPage;
+import com.knecon.fforesight.service.layoutparser.internal.api.data.redaction.DocumentPositionData;
+import com.knecon.fforesight.service.layoutparser.internal.api.data.redaction.DocumentStructure;
+import com.knecon.fforesight.service.layoutparser.internal.api.data.redaction.DocumentTextData;
+
+import lombok.experimental.UtilityClass;
+
+@UtilityClass
+public class DocumentGraphMapper {
+
+    public Document toDocumentGraph(DocumentData documentData) {
+
+        Document document = new Document();
+        DocumentTree documentTree = new DocumentTree(document);
+        Context context = new Context(documentData, documentTree);
+
+        context.pageData.addAll(Arrays.stream(documentData.getDocumentPages()).map(DocumentGraphMapper::buildPage).toList());
+
+        context.documentTree.getRoot().getChildren().addAll(buildEntries(documentData.getDocumentStructure().getRoot().getChildren(), context));
+
+        document.setDocumentTree(context.documentTree);
+        document.setPages(new HashSet<>(context.pageData));
+        document.setNumberOfPages(documentData.getDocumentPages().length);
+
+        document.setTextBlock(document.getTextBlock());
+        return document;
+    }
+
+
+    private List<DocumentTree.Entry> buildEntries(List<DocumentStructure.EntryData> entries, Context context) {
+
+        List<DocumentTree.Entry> newEntries = new LinkedList<>();
+        for (DocumentStructure.EntryData entryData : entries) {
+
+            List<Page> pages = Arrays.stream(entryData.getPageNumbers()).map(pageNumber -> getPage(pageNumber, context)).toList();
+
+            SemanticNode node = switch (entryData.getType()) {
+                case SECTION -> buildSection(context);
+                case PARAGRAPH -> buildParagraph(context);
+                case HEADLINE -> buildHeadline(context);
+                case HEADER -> buildHeader(context);
+                case FOOTER -> buildFooter(context);
+                case TABLE -> buildTable(context, entryData.getProperties());
+                case TABLE_CELL -> buildTableCell(context, entryData.getProperties());
+                case IMAGE -> buildImage(context, entryData.getProperties(), entryData.getPageNumbers());
+                default -> throw new UnsupportedOperationException("Not yet implemented for type " + entryData.getType());
+            };
+
+            if (entryData.getAtomicBlockIds().length > 0) {
+                TextBlock textBlock = toTextBlock(entryData.getAtomicBlockIds(), context, node);
+                node.setLeafTextBlock(textBlock);
+            }
+            List<Integer> treeId = Arrays.stream(entryData.getTreeId()).boxed().toList();
+            node.setTreeId(treeId);
+
+            switch (entryData.getType()) {
+                case HEADER -> pages.forEach(page -> page.setHeader((Header) node));
+                case FOOTER -> pages.forEach(page -> page.setFooter((Footer) node));
+                default -> pages.forEach(page -> page.getMainBody().add(node));
+            }
+
+            newEntries.add(DocumentTree.Entry.builder().treeId(treeId).children(buildEntries(entryData.getChildren(), context)).node(node).build());
+        }
+        return newEntries;
+    }
+
+
+    private Headline buildHeadline(Context context) {
+
+        return Headline.builder().documentTree(context.documentTree).build();
+    }
+
+
+    private Image buildImage(Context context, Map<String, String> properties, Long[] pageNumbers) {
+
+        assert pageNumbers.length == 1;
+        Page page = getPage(pageNumbers[0], context);
+        var builder = Image.builder();
+        PropertiesMapper.parseImageProperties(properties, builder);
+        return builder.documentTree(context.documentTree).page(page).build();
+    }
+
+
+    private TableCell buildTableCell(Context context, Map<String, String> properties) {
+
+        TableCell.TableCellBuilder builder = TableCell.builder();
+        PropertiesMapper.parseTableCellProperties(properties, builder);
+        return builder.documentTree(context.documentTree).build();
+    }
+
+
+    private Table buildTable(Context context, Map<String, String> properties) {
+
+        Table.TableBuilder builder = Table.builder();
+        PropertiesMapper.parseTableProperties(properties, builder);
+        return builder.documentTree(context.documentTree).build();
+    }
+
+
+    private Footer buildFooter(Context context) {
+
+        return Footer.builder().documentTree(context.documentTree).build();
+    }
+
+
+    private Header buildHeader(Context context) {
+
+        return Header.builder().documentTree(context.documentTree).build();
+    }
+
+
+    private Section buildSection(Context context) {
+
+        return Section.builder().documentTree(context.documentTree).build();
+    }
+
+
+    private Paragraph buildParagraph(Context context) {
+
+        return Paragraph.builder().documentTree(context.documentTree).build();
+    }
+
+
+    private TextBlock toTextBlock(Long[] atomicTextBlockIds, Context context, SemanticNode parent) {
+
+        return Arrays.stream(atomicTextBlockIds).map(atomicTextBlockId -> getAtomicTextBlock(context, parent, atomicTextBlockId)).collect(new TextBlockCollector());
+    }
+
+
+    private AtomicTextBlock getAtomicTextBlock(Context context, SemanticNode parent, Long atomicTextBlockId) {
+
+        return AtomicTextBlock.fromAtomicTextBlockData(context.documentTextData.get(Math.toIntExact(atomicTextBlockId)),
+                context.documentPositionData.get(Math.toIntExact(atomicTextBlockId)),
+                parent,
+                getPage(context.documentTextData.get(Math.toIntExact(atomicTextBlockId)).getPage(), context));
+    }
+
+
+    private Page buildPage(DocumentPage p) {
+
+        return Page.builder().rotation(p.getRotation()).height(p.getHeight()).width(p.getWidth()).number(p.getNumber()).mainBody(new LinkedList<>()).build();
+    }
+
+
+    private Page getPage(Long pageIndex, Context context) {
+
+        return context.pageData.stream()
+                .filter(page -> page.getNumber() == Math.toIntExact(pageIndex))
+                .findFirst()
+                .orElseThrow(() -> new NoSuchElementException(String.format("ClassificationPage with number %d not found", pageIndex)));
+    }
+
+
+    static final class Context {
+
+        private final DocumentTree documentTree;
+        private final List<Page> pageData;
+        private final List<DocumentTextData> documentTextData;
+        private final List<DocumentPositionData> documentPositionData;
+
+
+        Context(DocumentData documentData, DocumentTree documentTree) {
+
+            this.documentTree = documentTree;
+            this.pageData = new LinkedList<>();
+            this.documentTextData = Arrays.stream(documentData.getDocumentTextData()).toList();
+            this.documentPositionData = Arrays.stream(documentData.getDocumentPositionData()).toList();
+
+        }
+
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/data/mapper/PropertiesMapper.java

@@ -0,0 +1,52 @@
+package com.iqser.red.service.redaction.v1.server.document.data.mapper;
+
+import java.awt.geom.Rectangle2D;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Image;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.ImageType;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Table;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.TableCell;
+import com.knecon.fforesight.service.layoutparser.internal.api.data.redaction.DocumentStructure;
+
+import lombok.AccessLevel;
+import lombok.experimental.FieldDefaults;
+import lombok.experimental.UtilityClass;
+
+@UtilityClass
+public class PropertiesMapper {
+
+    public void parseImageProperties(Map<String, String> properties, Image.ImageBuilder builder) {
+
+        builder.imageType(ImageType.fromString(properties.get(DocumentStructure.ImageProperties.IMAGE_TYPE)));
+        builder.transparent(Boolean.parseBoolean(properties.get(DocumentStructure.ImageProperties.TRANSPARENT)));
+        builder.position(parseRectangle2D(properties.get(DocumentStructure.ImageProperties.POSITION)));
+        builder.id(properties.get(DocumentStructure.ImageProperties.ID));
+    }
+
+
+    public void parseTableCellProperties(Map<String, String> properties, TableCell.TableCellBuilder builder) {
+
+        builder.row(Integer.parseInt(properties.get(DocumentStructure.TableCellProperties.ROW)));
+        builder.col(Integer.parseInt(properties.get(DocumentStructure.TableCellProperties.COL)));
+        builder.header(Boolean.parseBoolean(properties.get(DocumentStructure.TableCellProperties.HEADER)));
+        builder.bBox(parseRectangle2D(properties.get(DocumentStructure.TableCellProperties.B_BOX)));
+    }
+
+
+    public void parseTableProperties(Map<String, String> properties, Table.TableBuilder builder) {
+
+        builder.numberOfRows(Integer.parseInt(properties.get(DocumentStructure.TableProperties.NUMBER_OF_ROWS)));
+        builder.numberOfCols(Integer.parseInt(properties.get(DocumentStructure.TableProperties.NUMBER_OF_COLS)));
+    }
+
+
+    private Rectangle2D parseRectangle2D(String bBox) {
+
+        List<Float> floats = Arrays.stream(bBox.split(DocumentStructure.RECTANGLE_DELIMITER)).map(Float::parseFloat).toList();
+        return new Rectangle2D.Float(floats.get(0), floats.get(1), floats.get(2), floats.get(3));
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/graph/Boundary.java

@@ -0,0 +1,166 @@
+package com.iqser.red.service.redaction.v1.server.document.graph;
+
+import static java.lang.String.format;
+
+import java.util.Collection;
+import java.util.LinkedList;
+import java.util.List;
+
+import com.iqser.red.service.redaction.v1.server.document.graph.textblock.TextBlock;
+
+import lombok.EqualsAndHashCode;
+import lombok.Setter;
+
+@Setter
+@EqualsAndHashCode
+public class Boundary implements Comparable<Boundary> {
+
+    private int start;
+    private int end;
+
+
+    public Boundary(int start, int end) {
+
+        if (start > end) {
+            throw new IllegalArgumentException(format("start: %d > end: %d", start, end));
+        }
+        this.start = start;
+        this.end = end;
+    }
+
+
+    public int length() {
+
+        return end - start;
+    }
+
+
+    public int start() {
+
+        return start;
+    }
+
+
+    public int end() {
+
+        return end;
+    }
+
+
+    public boolean contains(Boundary boundary) {
+
+        return start <= boundary.start() && boundary.end() <= end;
+    }
+
+
+    public boolean containedBy(Boundary boundary) {
+
+        return boundary.contains(this);
+    }
+
+
+    public boolean contains(int start, int end) {
+
+        if (start > end) {
+            throw new IllegalArgumentException(format("start: %d > end: %d", start, end));
+        }
+        return this.start <= start && end <= this.end;
+    }
+
+
+    public boolean containedBy(int start, int end) {
+
+        if (start > end) {
+            throw new IllegalArgumentException(format("start: %d > end: %d", start, end));
+        }
+        return start <= this.start && this.end <= end;
+    }
+
+
+    public boolean contains(int index) {
+
+        return start <= index && index < end;
+    }
+
+
+    public boolean intersects(Boundary boundary) {
+
+        return boundary.start() < this.end && this.start < boundary.end();
+    }
+
+
+    public List<Boundary> split(List<Integer> splitIndices) {
+
+        if (splitIndices.stream().anyMatch(idx -> !this.contains(idx))) {
+            throw new IndexOutOfBoundsException(format("%s splitting indices are out of range for %s", splitIndices.stream().filter(idx -> !this.contains(idx)).toList(), this));
+        }
+        List<Boundary> splitBoundaries = new LinkedList<>();
+        int previousIndex = start;
+        for (int splitIndex : splitIndices) {
+
+            // skip split if it would produce a boundary of length 0
+            if (splitIndex == previousIndex) {
+                continue;
+            }
+            splitBoundaries.add(new Boundary(previousIndex, splitIndex));
+            previousIndex = splitIndex;
+        }
+        splitBoundaries.add(new Boundary(previousIndex, end));
+        return splitBoundaries;
+    }
+
+
+    public static Boundary merge(Collection<Boundary> boundaries) {
+
+        int minStart = boundaries.stream().mapToInt(Boundary::start).min().orElseThrow(IllegalArgumentException::new);
+        int maxEnd = boundaries.stream().mapToInt(Boundary::end).max().orElseThrow(IllegalArgumentException::new);
+        return new Boundary(minStart, maxEnd);
+    }
+
+
+    @Override
+    public String toString() {
+
+        return format("Boundary [%d|%d)", start, end);
+    }
+
+
+    @Override
+    public int compareTo(Boundary boundary) {
+
+        if (end < boundary.end() && start < boundary.start()) {
+            return -1;
+        }
+        if (start > boundary.start() && end > boundary.end()) {
+            return 1;
+        }
+
+        return 0;
+    }
+
+
+    /**
+     * shrinks the boundary, such that textBlock.subSequence(boundary) returns a string without trailing or preceding whitespaces.
+     *
+     * @param textBlock TextBlock to check whitespaces against
+     * @return trimmed boundary
+     */
+    public Boundary trim(TextBlock textBlock) {
+
+        if (this.length() == 0) {
+            return this;
+        }
+        int trimmedStart = this.start;
+        while (textBlock.containsIndex(trimmedStart) && trimmedStart < end && Character.isWhitespace(textBlock.charAt(trimmedStart))) {
+            trimmedStart++;
+        }
+
+        int trimmedEnd = this.end;
+        while (textBlock.containsIndex(trimmedEnd - 1) && trimmedStart < trimmedEnd && Character.isWhitespace(textBlock.charAt(trimmedEnd - 1))) {
+            trimmedEnd--;
+        }
+
+        return new Boundary(trimmedStart, Math.max(trimmedEnd, trimmedStart));
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/graph/ConsecutiveBoundaryCollector.java

@@ -0,0 +1,70 @@
+package com.iqser.red.service.redaction.v1.server.document.graph;
+
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Set;
+import java.util.function.BiConsumer;
+import java.util.function.BinaryOperator;
+import java.util.function.Function;
+import java.util.function.Supplier;
+import java.util.stream.Collector;
+
+import com.google.common.base.Functions;
+
+public class ConsecutiveBoundaryCollector implements Collector<Boundary, List<Boundary>, List<Boundary>> {
+
+    @Override
+    public Supplier<List<Boundary>> supplier() {
+
+        return LinkedList::new;
+    }
+
+
+    @Override
+    public BiConsumer<List<Boundary>, Boundary> accumulator() {
+
+        return (existingList, boundary) -> {
+            if (existingList.isEmpty()) {
+                existingList.add(boundary);
+                return;
+            }
+
+            Boundary prevBoundary = existingList.get(existingList.size() - 1);
+            if (prevBoundary.end() > boundary.start()) {
+                throw new IllegalArgumentException(String.format("Can't concatenate %s and %s. Boundaries must be ordered!", prevBoundary, boundary));
+            }
+
+            if (prevBoundary.end() == boundary.start()) {
+                existingList.remove(existingList.size() - 1);
+                existingList.add(Boundary.merge(List.of(prevBoundary, boundary)));
+            } else {
+                existingList.add(boundary);
+            }
+        };
+    }
+
+
+    @Override
+    public BinaryOperator<List<Boundary>> combiner() {
+
+        return (list1, list2) -> {
+            list1.addAll(list2);
+            return list1;
+        };
+    }
+
+
+    @Override
+    public Function<List<Boundary>, List<Boundary>> finisher() {
+
+        return Functions.identity();
+    }
+
+
+    @Override
+    public Set<Characteristics> characteristics() {
+
+        return Set.of(Characteristics.IDENTITY_FINISH);
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/graph/DocumentTree.java

@@ -0,0 +1,217 @@
+package com.iqser.red.service.redaction.v1.server.document.graph;
+
+import static java.lang.String.format;
+
+import java.util.Collections;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.stream.Stream;
+
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.GenericSemanticNode;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.NodeType;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.SemanticNode;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.TableCell;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Document;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Table;
+import com.iqser.red.service.redaction.v1.server.document.graph.textblock.TextBlock;
+import com.iqser.red.service.redaction.v1.server.document.graph.textblock.TextBlockCollector;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.experimental.FieldDefaults;
+
+@Data
+@EqualsAndHashCode
+public class DocumentTree {
+
+    private final Entry root;
+
+
+    public DocumentTree(Document document) {
+
+        root = Entry.builder().treeId(Collections.emptyList()).children(new LinkedList<>()).node(document).build();
+    }
+
+
+    public TextBlock buildTextBlock() {
+
+        return allEntriesInOrder().map(Entry::getNode).filter(SemanticNode::isLeaf).map(SemanticNode::getLeafTextBlock).collect(new TextBlockCollector());
+    }
+
+
+    public List<Integer> createNewMainEntryAndReturnId(GenericSemanticNode node) {
+
+        return createNewChildEntryAndReturnIdImpl(Collections.emptyList(), node);
+    }
+
+
+    public List<Integer> createNewChildEntryAndReturnId(GenericSemanticNode parentNode, GenericSemanticNode node) {
+
+        return createNewChildEntryAndReturnIdImpl(parentNode.getTreeId(), node);
+    }
+
+
+    public List<Integer> createNewChildEntryAndReturnId(GenericSemanticNode parentNode, Table node) {
+
+        return createNewChildEntryAndReturnIdImpl(parentNode.getTreeId(), node);
+    }
+
+
+    public List<Integer> createNewTableChildEntryAndReturnId(Table parentTable, TableCell tableCell) {
+
+        return createNewChildEntryAndReturnIdImpl(parentTable.getTreeId(), tableCell);
+    }
+
+
+    @SuppressWarnings("PMD.UnusedPrivateMethod") // PMD actually flags this wrong
+    private List<Integer> createNewChildEntryAndReturnIdImpl(List<Integer> parentId, SemanticNode node) {
+
+        if (!entryExists(parentId)) {
+            throw new IllegalArgumentException(format("parentId %s does not exist!", parentId));
+        }
+
+        Entry parent = getEntryById(parentId);
+        List<Integer> newId = new LinkedList<>(parentId);
+        newId.add(parent.children.size());
+        parent.children.add(Entry.builder().treeId(newId).node(node).build());
+
+        return newId;
+    }
+
+
+    private boolean entryExists(List<Integer> treeId) {
+
+        if (treeId.isEmpty()) {
+            return root != null;
+        }
+        Entry entry = root.children.get(treeId.get(0));
+        for (int id : treeId.subList(1, treeId.size())) {
+            if (id >= entry.children.size() || 0 > id) {
+                return false;
+            }
+            entry = entry.children.get(id);
+        }
+        return true;
+    }
+
+
+    public Entry getParentEntryById(List<Integer> treeId) {
+
+        return getEntryById(getParentId(treeId));
+    }
+
+
+    public boolean hasParentById(List<Integer> treeId) {
+
+        return !treeId.isEmpty();
+    }
+
+
+    public Stream<SemanticNode> childNodes(List<Integer> treeId) {
+
+        return getEntryById(treeId).children.stream().map(Entry::getNode);
+    }
+
+
+    public Stream<SemanticNode> childNodesOfType(List<Integer> treeId, NodeType nodeType) {
+
+        return getEntryById(treeId).children.stream().filter(entry -> entry.node.getType().equals(nodeType)).map(Entry::getNode);
+    }
+
+
+    private static List<Integer> getParentId(List<Integer> treeId) {
+
+        if (treeId.isEmpty()) {
+            throw new UnsupportedOperationException("Root has no parent!");
+        }
+        if (treeId.size() < 2) {
+            return Collections.emptyList();
+        }
+        return treeId.subList(0, treeId.size() - 1);
+    }
+
+
+    public Entry getEntryById(List<Integer> treeId) {
+
+        if (treeId.isEmpty()) {
+            return root;
+        }
+        Entry entry = root.children.get(treeId.get(0));
+        for (int id : treeId.subList(1, treeId.size())) {
+            entry = entry.children.get(id);
+        }
+        return entry;
+    }
+
+
+    public Stream<Entry> mainEntries() {
+
+        return root.children.stream();
+    }
+
+
+    public Stream<Entry> allEntriesInOrder() {
+
+        return Stream.of(root).flatMap(DocumentTree::flatten);
+    }
+
+
+    public Stream<Entry> allSubEntriesInOrder(List<Integer> parentId) {
+
+        return getEntryById(parentId).children.stream().flatMap(DocumentTree::flatten);
+    }
+
+
+    @Override
+    public String toString() {
+
+        return String.join("\n", allEntriesInOrder().map(Entry::toString).toList());
+    }
+
+
+    private static Stream<Entry> flatten(Entry entry) {
+
+        return Stream.concat(Stream.of(entry), entry.children.stream().flatMap(DocumentTree::flatten));
+    }
+
+
+    public SemanticNode getHighestParentById(List<Integer> treeId) {
+
+        if (treeId.isEmpty()) {
+            return root.node;
+        }
+        return root.children.get(treeId.get(0)).node;
+    }
+
+
+    @Builder
+    @Getter
+    @AllArgsConstructor
+    @FieldDefaults(level = AccessLevel.PRIVATE, makeFinal = true)
+    public static class Entry {
+
+        List<Integer> treeId;
+        SemanticNode node;
+        @Builder.Default
+        List<Entry> children = new LinkedList<>();
+
+
+        @Override
+        public String toString() {
+
+            return node.toString();
+        }
+
+
+        public NodeType getType() {
+
+            return node.getType();
+        }
+
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/graph/entity/EntityType.java

@@ -0,0 +1,8 @@
+package com.iqser.red.service.redaction.v1.server.document.graph.entity;
+
+public enum EntityType {
+    ENTITY,
+    RECOMMENDATION,
+    FALSE_POSITIVE,
+    FALSE_RECOMMENDATION
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/graph/entity/MatchedRule.java

@@ -0,0 +1,70 @@
+package com.iqser.red.service.redaction.v1.server.document.graph.entity;
+
+import java.util.Collections;
+import java.util.Objects;
+import java.util.Set;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.experimental.FieldDefaults;
+
+@Getter
+@Builder
+@AllArgsConstructor
+@EqualsAndHashCode
+@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
+public final class MatchedRule implements Comparable<MatchedRule> {
+
+    @Builder.Default
+    RuleIdentifier ruleIdentifier = RuleIdentifier.empty();
+    @Builder.Default
+    String reason = "";
+    @Builder.Default
+    String legalBasis = "";
+    boolean applied;
+    boolean writeValueWithLineBreaks;
+    @Builder.Default
+    Set<RedactionEntity> references = Collections.emptySet();
+
+
+    public static MatchedRule empty() {
+
+        return MatchedRule.builder().build();
+    }
+
+
+    @Override
+    public int compareTo(MatchedRule matchedRule) {
+
+        RuleIdentifier otherRuleIdentifier = matchedRule.getRuleIdentifier();
+        if (!Objects.equals(ruleIdentifier.type(), otherRuleIdentifier.type())) {
+            if (Objects.equals(otherRuleIdentifier.type(), "MAN")) {
+                return 1;
+            }
+            if (Objects.equals(ruleIdentifier.type(), "MAN")) {
+                return -1;
+            }
+            if (Objects.equals(otherRuleIdentifier.type(), "X")) {
+                return 1;
+            }
+            if (Objects.equals(ruleIdentifier.type(), "X")) {
+                return -1;
+            }
+        }
+        if (!Objects.equals(otherRuleIdentifier.unit(), getRuleIdentifier().unit())) {
+            return otherRuleIdentifier.unit() - ruleIdentifier.unit();
+        }
+        return otherRuleIdentifier.id() - ruleIdentifier.id();
+    }
+
+
+    @Override
+    public String toString() {
+
+        return "MatchedRule[" + "ruleIdentifier=" + ruleIdentifier + ", " + "reason=" + reason + ", " + "legalBasis=" + legalBasis + ", " + "applied=" + applied + ", " + "writeValueWithLineBreaks=" + writeValueWithLineBreaks + ", " + "references=" + references + ']';
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/graph/entity/MatchedRuleHolder.java

@@ -0,0 +1,159 @@
+package com.iqser.red.service.redaction.v1.server.document.graph.entity;
+
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.PriorityQueue;
+import java.util.Set;
+
+import lombok.NonNull;
+
+public interface MatchedRuleHolder {
+
+    PriorityQueue<MatchedRule> getMatchedRuleList();
+
+
+    boolean isIgnored();
+
+
+    boolean isRemoved();
+
+
+    void setIgnored(boolean ignored);
+
+
+    void setRemoved(boolean ignored);
+
+
+    default boolean isApplied() {
+
+        return getMatchedRule().isApplied();
+    }
+
+
+    default Set<RedactionEntity> getReferences() {
+
+        return getMatchedRule().getReferences();
+    }
+
+
+    default boolean isActive() {
+
+        return !(isRemoved() || isIgnored());
+    }
+
+
+    default void apply(@NonNull String ruleIdentifier, String reason, @NonNull String legalBasis) {
+
+        if (legalBasis.isBlank() || legalBasis.isEmpty()) {
+            throw new IllegalArgumentException("legal basis cannot be empty when redacting an entity");
+        }
+        addMatchedRule(MatchedRule.builder().ruleIdentifier(RuleIdentifier.fromString(ruleIdentifier)).reason(reason).legalBasis(legalBasis).applied(true).build());
+    }
+
+
+    default void force(@NonNull String ruleIdentifier, String reason, String legalBasis) {
+
+        addMatchedRule(MatchedRule.builder()
+                .ruleIdentifier(RuleIdentifier.fromString(ruleIdentifier))
+                .reason(reason)
+                .legalBasis(getLegalBasisOrPreviousLegalBasisOrPlaceHolder(legalBasis))
+                .applied(true)
+                .build());
+    }
+
+
+    default void skip(@NonNull String ruleIdentifier, String reason) {
+
+        addMatchedRule(MatchedRule.builder().ruleIdentifier(RuleIdentifier.fromString(ruleIdentifier)).reason(reason).build());
+    }
+
+
+    default void remove(String ruleIdentifier, String reason) {
+
+        addMatchedRule(MatchedRule.builder().ruleIdentifier(RuleIdentifier.fromString(ruleIdentifier)).reason(reason).build());
+        setRemoved(true);
+    }
+
+
+    default void ignore(String ruleIdentifier, String reason) {
+
+        addMatchedRule(MatchedRule.builder().ruleIdentifier(RuleIdentifier.fromString(ruleIdentifier)).reason(reason).build());
+        setIgnored(true);
+    }
+
+
+    private String getLegalBasisOrPreviousLegalBasisOrPlaceHolder(String legalBasis) {
+
+        if (legalBasis == null || legalBasis.isBlank() || legalBasis.isEmpty()) {
+            if (getMatchedRule() == null || !getMatchedRule().isApplied()) {
+                return "n-a";
+            }
+            return getMatchedRule().getLegalBasis();
+        }
+        return legalBasis;
+    }
+
+
+    default void applyWithLineBreaks(@NonNull String ruleIdentifier, String reason, @NonNull String legalBasis) {
+
+        if (legalBasis.isBlank() || legalBasis.isEmpty()) {
+            throw new IllegalArgumentException("legal basis cannot be empty when redacting an entity");
+        }
+        getMatchedRuleList().add(MatchedRule.builder()
+                .ruleIdentifier(RuleIdentifier.fromString(ruleIdentifier))
+                .reason(reason)
+                .legalBasis(legalBasis)
+                .applied(true)
+                .writeValueWithLineBreaks(true)
+                .build());
+    }
+
+
+    default void applyWithReferences(@NonNull String ruleIdentifier, String reason, @NonNull String legalBasis, Collection<RedactionEntity> references) {
+
+        if (legalBasis.isBlank() || legalBasis.isEmpty()) {
+            throw new IllegalArgumentException("legal basis cannot be empty when redacting an entity");
+        }
+        getMatchedRuleList().add(MatchedRule.builder()
+                .ruleIdentifier(RuleIdentifier.fromString(ruleIdentifier))
+                .reason(reason)
+                .legalBasis(legalBasis)
+                .applied(true)
+                .references(new HashSet<>(references))
+                .build());
+    }
+
+
+    default void skipWithReferences(@NonNull String ruleIdentifier, String reason, Collection<RedactionEntity> references) {
+
+        getMatchedRuleList().add(MatchedRule.builder().ruleIdentifier(RuleIdentifier.fromString(ruleIdentifier)).reason(reason).references(new HashSet<>(references)).build());
+    }
+
+
+    default void addMatchedRule(MatchedRule matchedRule) {
+
+        getMatchedRuleList().add(matchedRule);
+    }
+
+
+    default void addMatchedRules(Collection<MatchedRule> matchedRules) {
+
+        getMatchedRuleList().addAll(matchedRules);
+    }
+
+
+    default int getMatchedRuleUnit() {
+
+        return getMatchedRule().getRuleIdentifier().unit();
+    }
+
+
+    default MatchedRule getMatchedRule() {
+
+        if (getMatchedRuleList().isEmpty()) {
+            return MatchedRule.empty();
+        }
+        return getMatchedRuleList().peek();
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/graph/entity/RedactionEntity.java

@@ -0,0 +1,205 @@
+package com.iqser.red.service.redaction.v1.server.document.graph.entity;
+
+import java.awt.geom.Rectangle2D;
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.HashSet;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+import java.util.PriorityQueue;
+import java.util.Set;
+
+import com.iqser.red.service.persistence.service.v1.api.shared.model.redactionlog.Engine;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.SemanticNode;
+import com.iqser.red.service.redaction.v1.server.document.graph.Boundary;
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Page;
+import com.iqser.red.service.redaction.v1.server.redaction.utils.IdBuilder;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.experimental.FieldDefaults;
+
+@Data
+@Builder
+@AllArgsConstructor
+@FieldDefaults(level = AccessLevel.PRIVATE)
+@EqualsAndHashCode(onlyExplicitlyIncluded = true)
+public class RedactionEntity implements MatchedRuleHolder {
+
+    // initial values
+    @EqualsAndHashCode.Include
+    final Boundary boundary;
+    @EqualsAndHashCode.Include
+    final String type;
+    @EqualsAndHashCode.Include
+    final EntityType entityType;
+
+    // empty defaults
+    boolean removed;
+    boolean ignored;
+
+    boolean resized;
+    boolean skipRemoveEntitiesContainedInLarger;
+    boolean dictionaryEntry;
+    boolean dossierDictionaryEntry;
+    @Builder.Default
+    Set<Engine> engines = new HashSet<>();
+
+    @Builder.Default
+    PriorityQueue<MatchedRule> matchedRuleList = new PriorityQueue<>();
+
+    // inferred on graph insertion
+    String value;
+    String textBefore;
+    String textAfter;
+    @Builder.Default
+    Set<Page> pages = new HashSet<>();
+    List<RedactionPosition> redactionPositionsPerPage;
+    @Builder.Default
+    List<SemanticNode> intersectingNodes = new LinkedList<>();
+    SemanticNode deepestFullyContainingNode;
+
+
+    public static RedactionEntity initialEntityNode(Boundary boundary, String type, EntityType entityType) {
+
+        return RedactionEntity.builder().type(type).entityType(entityType).boundary(boundary).build();
+    }
+
+
+    public boolean occursInNodeOfType(Class<? extends SemanticNode> clazz) {
+
+        return intersectingNodes.stream().anyMatch(clazz::isInstance);
+    }
+
+
+    public boolean occursInNode(SemanticNode semanticNode) {
+
+        return intersectingNodes.stream().anyMatch(node -> node.equals(semanticNode));
+    }
+
+
+    public boolean isType(String type) {
+
+        return this.type.equals(type);
+    }
+
+
+    public boolean isAnyType(List<String> types) {
+
+        return types.contains(type);
+    }
+
+
+    public void addIntersectingNode(SemanticNode containingNode) {
+
+        intersectingNodes.add(containingNode);
+    }
+
+
+    public String getValueWithLineBreaks() {
+
+        return getDeepestFullyContainingNode().getTextBlock().subSequenceWithLineBreaks(getBoundary());
+    }
+
+
+    public void removeFromGraph() {
+
+        intersectingNodes.forEach(node -> node.getEntities().remove(this));
+        pages.forEach(page -> page.getEntities().remove(this));
+        intersectingNodes = new LinkedList<>();
+        deepestFullyContainingNode = null;
+        pages = new HashSet<>();
+        removed = true;
+    }
+
+
+    public List<RedactionPosition> getRedactionPositionsPerPage() {
+
+        if (redactionPositionsPerPage == null || redactionPositionsPerPage.isEmpty()) {
+            Map<Page, List<Rectangle2D>> rectanglesPerLinePerPage = deepestFullyContainingNode.getTextBlock().getPositionsPerPage(boundary);
+
+            Page firstPage = rectanglesPerLinePerPage.keySet()
+                    .stream()
+                    .min(Comparator.comparingInt(Page::getNumber))
+                    .orElseThrow(() -> new RuntimeException("No Positions found on any page!"));
+
+            String id = IdBuilder.buildId(pages, rectanglesPerLinePerPage.values().stream().flatMap(Collection::stream).toList(), type, entityType.name());
+            redactionPositionsPerPage = rectanglesPerLinePerPage.entrySet().stream().map(entry -> buildRedactionPosition(firstPage, id, entry)).toList();
+        }
+        return redactionPositionsPerPage;
+    }
+
+
+    private static RedactionPosition buildRedactionPosition(Page firstPage, String id, Map.Entry<Page, List<Rectangle2D>> entry) {
+
+        if (entry.getKey().equals(firstPage)) {
+            return new RedactionPosition(id, entry.getKey(), entry.getValue());
+        } else {
+            return new RedactionPosition(id + "-" + entry.getKey().getNumber(), entry.getKey(), entry.getValue());
+        }
+    }
+
+
+    public boolean containedBy(RedactionEntity redactionEntity) {
+
+        return this.boundary.containedBy(redactionEntity.getBoundary());
+    }
+
+
+    public boolean contains(RedactionEntity redactionEntity) {
+
+        return this.boundary.contains(redactionEntity.getBoundary());
+    }
+
+
+    public boolean intersects(RedactionEntity redactionEntity) {
+
+        return this.boundary.intersects(redactionEntity.getBoundary());
+    }
+
+
+    public void addEngine(Engine engine) {
+
+        engines.add(engine);
+    }
+
+
+    public void addEngines(Set<Engine> engines) {
+
+        this.engines.addAll(engines);
+    }
+
+
+    public boolean matchesAnnotationId(String manualRedactionId) {
+
+        return getRedactionPositionsPerPage().stream().anyMatch(entityPosition -> entityPosition.getId().equals(manualRedactionId));
+    }
+
+
+    @Override
+    public String toString() {
+
+        StringBuilder sb = new StringBuilder();
+        sb.append("Entity[\"");
+        sb.append(value);
+        sb.append("\", ");
+        sb.append(boundary);
+        sb.append(", pages[");
+        pages.forEach(page -> {
+            sb.append(page.getNumber());
+            sb.append(", ");
+        });
+        sb.delete(sb.length() - 2, sb.length());
+        sb.append("], type = \"");
+        sb.append(type);
+        sb.append("\", EntityType.");
+        sb.append(entityType);
+        sb.append("]");
+        return sb.toString();
+    }
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/graph/entity/RedactionPosition.java

@@ -0,0 +1,24 @@
+package com.iqser.red.service.redaction.v1.server.document.graph.entity;
+
+import java.awt.geom.Rectangle2D;
+import java.util.List;
+
+import com.iqser.red.service.redaction.v1.server.document.graph.nodes.Page;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.experimental.FieldDefaults;
+
+@Data
+@AllArgsConstructor
+@FieldDefaults(level = AccessLevel.PRIVATE)
+public class RedactionPosition {
+
+    final String id;
+    Page page;
+    // Each entry in this list corresponds to an entry in the redaction log, this means:
+    // An entity might be represented by multiple redaction log entries
+    List<Rectangle2D> rectanglePerLine;
+
+}

redaction-service-v1/redaction-service-server-v1/src/main/java/com/iqser/red/service/redaction/v1/server/document/graph/entity/RuleIdentifier.java

@@ -0,0 +1,41 @@
+package com.iqser.red.service.redaction.v1.server.document.graph.entity;
+
+import java.util.Objects;
+
+public record RuleIdentifier(String type, Integer unit, Integer id) {
+
+    public static RuleIdentifier fromString(String identifier) {
+
+        String[] values = identifier.split("\\.");
+        if (values.length != 3) {
+            throw new IllegalArgumentException("Illegal rule identifier provided: " + identifier);
+        }
+        String type = values[0];
+        Integer group = Integer.parseInt(values[1]);
+        Integer id = Integer.parseInt(values[2]);
+        return new RuleIdentifier(type, group, id);
+    }
+
+
+    public static RuleIdentifier empty() {
+
+        return new RuleIdentifier("", null, null);
+    }
+
+
+    @Override
+    public String toString() {
+
+        StringBuilder sb = new StringBuilder();
+        sb.append(type());
+        if (Objects.nonNull(unit()) && Objects.nonNull(id())) {
+            sb.append(".").append(unit()).append(".").append(id());
+        } else if (Objects.nonNull(id())) {
+            sb.append(".*.").append(id());
+        } else if (Objects.nonNull(unit())) {
+            sb.append(".").append(unit()).append(".*");
+        }
+        return sb.toString();
+    }
+
+}