Unit test ComputeFormula

src/main/java/de/featjar/feature/model/FeatureTree.java

@@ -134,6 +134,7 @@ protected FeatureTree(FeatureTree otherFeatureTree) {
         feature = otherFeatureTree.feature;
         parentGroupID = otherFeatureTree.parentGroupID;
         cardinality = otherFeatureTree.cardinality.clone();
+        childrenGroups = new ArrayList<>(otherFeatureTree.childrenGroups.size());
         otherFeatureTree.childrenGroups.stream().map(Group::clone).forEach(childrenGroups::add);
         attributeValues = otherFeatureTree.cloneAttributes();
     }

src/main/java/de/featjar/feature/model/Features.java

@@ -0,0 +1,36 @@
+package de.featjar.feature.model;
+
+import de.featjar.formula.structure.Expressions;
+import de.featjar.formula.structure.IFormula;
+import de.featjar.formula.structure.predicate.NotEquals;
+import de.featjar.formula.structure.term.value.Constant;
+import de.featjar.formula.structure.term.value.Variable;
+
+/**
+ * Defines useful methods to wrap a bool or numeric feature into a IFormula:
+ *      bool: {@link de.featjar.formula.structure.predicate.Literal}
+ *      int: {@link NotEquals 0}
+ *      float: {@link NotEquals 0}
+ *
+ * Numeric features are therefore selected, if there value is not 0.
+ *
+ * @author Jonas Hanke
+ */
+public class Features {
+
+    public static IFormula createFeatureFormel(IFeature feature) {
+        return createFeatureFormel(feature, feature.getName().orElse(""));
+    }
+
+    public static IFormula createFeatureFormel(IFeature feature, String featureName) {
+        if (feature.getType().equals(Boolean.class)) {
+            return Expressions.literal(featureName);
+        } else if (feature.getType().equals(Integer.class)) {
+            return new NotEquals(new Variable(featureName, feature.getType()), new Constant(0));
+        } else if(feature.getType().equals(Float.class)) {
+            return new NotEquals(new Variable(featureName, feature.getType()), new Constant(0.0f));
+        } else {
+            throw new UnsupportedOperationException("Unsupported feature type: " + feature.getType());
+        }
+    }
+}

src/main/java/de/featjar/feature/model/io/tikz/TikzGraphicalFeatureModelFormat.java

@@ -0,0 +1,81 @@
+package de.featjar.feature.model.io.tikz;
+
+import de.featjar.base.data.Problem;
+import de.featjar.base.data.Result;
+import de.featjar.base.io.format.IFormat;
+import de.featjar.feature.model.IFeatureModel;
+import de.featjar.feature.model.IFeatureTree;
+import de.featjar.feature.model.io.tikz.format.TikzHeadFormat;
+import de.featjar.feature.model.io.tikz.format.TikzMainFormat;
+import de.featjar.feature.model.io.tikz.helper.TikzAttributeHelper;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * This class is moved from FeatureIDE to FeatJAR. The former class was written by Simon Wenk and Yang Liu.
+ * We did some changes, moved in different classes, and we rewrote some code and added new functions.
+ *
+ * @author Felix Behme
+ * @author Lara Merza
+ * @author Jonas Hanke
+ */
+public class TikzGraphicalFeatureModelFormat implements IFormat<IFeatureModel> {
+
+    public static String LINE_SEPERATOR  = System.lineSeparator();
+
+    private TikzAttributeHelper.FilterType filterType = TikzAttributeHelper.FilterType.WITH_OUT; // default
+    private List<String> filterValues = new ArrayList<>(); // default
+
+    public TikzGraphicalFeatureModelFormat() {} // default
+
+    public TikzGraphicalFeatureModelFormat(TikzAttributeHelper.FilterType filterType, List<String> filterValues) {
+        this.filterType = filterType;
+        this.filterValues = filterValues;
+    }
+
+    @Override
+    public Result<String> serialize(IFeatureModel featureModel) {
+        StringBuilder stringBuilder = new StringBuilder();
+        List<Problem> problemList = new ArrayList<>();
+
+        stringBuilder.append("\\documentclass[border=5pt]{standalone}").append(LINE_SEPERATOR);
+        TikzHeadFormat.header(stringBuilder, problemList, false);
+
+        stringBuilder
+                .append("\\begin{document}").append(LINE_SEPERATOR)
+                .append("	%---The Feature Diagram-----------------------------------------------------").append(LINE_SEPERATOR);
+        for (IFeatureTree featureTree : featureModel.getRoots()) {
+            new TikzMainFormat(featureModel, featureTree, stringBuilder, filterType, filterValues).printForest();
+        }
+        stringBuilder
+                .append(LINE_SEPERATOR)
+                .append("\t%---------------------------------------------------------------------------").append(LINE_SEPERATOR)
+                .append("\\end{document}");
+
+        return Result.of(stringBuilder.toString(), problemList);
+    }
+
+    public void setFilterType(TikzAttributeHelper.FilterType filterType) {
+        this.filterType = filterType;
+    }
+
+    public void setFilterValues(List<String> filterValues) {
+        this.filterValues = filterValues;
+    }
+
+    @Override
+    public boolean supportsWrite() {
+        return true;
+    }
+
+    @Override
+    public String getFileExtension() {
+        return ".tex";
+    }
+
+    @Override
+    public String getName() {
+        return "LaTeX-Document with TikZ";
+    }
+}

src/main/java/de/featjar/feature/model/io/tikz/color/TikzFeatureColor.java

@@ -0,0 +1,42 @@
+package de.featjar.feature.model.io.tikz.color;
+
+/**
+ * Color in tikz for later implemntation (colors doesnt exists in features in the moment)
+ *
+ * @author Felix Behme
+ * @author Lara Merza
+ * @author Jonas Hanke
+ */
+public enum TikzFeatureColor {
+
+    RED("redColor"),
+    ORANGE("orangeColor"),
+    YELLOW("yellowColor"),
+    DARK_GREEN("darkGreenColor"),
+    LIGHT_GREEN("lightGreenColor"),
+    CYAN("cyanColor"),
+    LIGHT_GRAY("lightGrayColor"),
+    BLUE("blueColor"),
+    MAGENTA("magentaColor"),
+    PINK("pinkColor"),
+    NO_COLOR("");
+
+    public static String color(String tikzFeatureColor) {
+        for (TikzFeatureColor tikzFeatureColors : values()) {
+            if (tikzFeatureColors.getColor().equalsIgnoreCase(tikzFeatureColor)) {
+                return tikzFeatureColors.getColor();
+            }
+        }
+        return NO_COLOR.getColor();
+    }
+
+    final String color;
+
+    TikzFeatureColor(String color) {
+        this.color = color;
+    }
+
+    public String getColor() {
+        return color;
+    }
+}

src/main/java/de/featjar/feature/model/io/tikz/format/TikzHeadFormat.java

@@ -0,0 +1,49 @@
+package de.featjar.feature.model.io.tikz.format;
+
+import de.featjar.base.data.Problem;
+import java.io.*;
+import java.nio.charset.StandardCharsets;
+import java.util.List;
+
+/**
+ * This class prints the header of a LaTex document containing the Tikz definitions.
+ *
+ * @author Felix Behme
+ * @author Lara Merza
+ * @author Jonas Hanke
+ */
+public class TikzHeadFormat {
+
+    public static void header(StringBuilder stringBuilder, List<Problem> problemList, boolean hasVerticalLayout) {
+        String replacement = String.format( //
+                "			parent anchor = %s," + System.lineSeparator() //
+                        + "			child anchor = %s," + System.lineSeparator() //
+                        + "%s" //
+                        + "			l sep = 2em," + System.lineSeparator() //
+                        + "			s sep = 1em," //
+                        + "%s", //
+                hasVerticalLayout ? "east" : "south", //
+                hasVerticalLayout ? "west" : "north", //
+                hasVerticalLayout ? "			grow' = east," + System.lineSeparator() : "", //
+                hasVerticalLayout ? "			tier/.pgfmath=level()," : "");
+
+        InputStream inputStream = TikzHeadFormat.class.getClassLoader().getResourceAsStream("head.tex");
+
+        if (inputStream == null) {
+            problemList.add(new Problem("InputStream in header is null / not found"));
+            return;
+        }
+
+        try (BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8))) {
+            String line;
+            while (((line = bufferedReader.readLine()) != null)) {
+                if (line.contains("{replaceWithVerticalSetting}")) {
+                    line = replacement;
+                }
+                stringBuilder.append(line).append("\n");
+            }
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+}

src/main/java/de/featjar/feature/model/io/tikz/format/TikzMainFormat.java

@@ -0,0 +1,126 @@
+package de.featjar.feature.model.io.tikz.format;
+
+import de.featjar.base.tree.Trees;
+import de.featjar.feature.model.IConstraint;
+import de.featjar.feature.model.IFeatureModel;
+import de.featjar.feature.model.IFeatureTree;
+import de.featjar.feature.model.io.tikz.TikzGraphicalFeatureModelFormat;
+import de.featjar.feature.model.io.tikz.helper.TikzAttributeHelper;
+import de.featjar.feature.model.io.tikz.helper.TikzMatrixHelper;
+import de.featjar.feature.model.io.tikz.helper.TikzMatrixType;
+import de.featjar.feature.model.io.tikz.helper.PrintVisitor;
+import de.featjar.formula.io.textual.ExpressionSerializer;
+import de.featjar.formula.io.textual.LaTexSymbols;
+
+import java.util.List;
+
+/**
+ * This class generates the Tikz representation of a {@link IFeatureModel} including all constraints ({@link IConstraint}).
+ *
+ * @author Felix Behme
+ * @author Lara Merza
+ * @author Jonas Hanke
+ */
+public class TikzMainFormat {
+
+    private final IFeatureModel featureModel;
+    private final IFeatureTree featureTree;
+    private final StringBuilder stringBuilder;
+    private final TikzAttributeHelper.FilterType filterType;
+    private final List<String> filterValues;
+
+    public TikzMainFormat(IFeatureModel featureModel , IFeatureTree featureTree, StringBuilder stringBuilder, TikzAttributeHelper.FilterType filterType, List<String> filterValues) {
+        this.featureModel = featureModel;
+        this.featureTree = featureTree;
+        this.stringBuilder = stringBuilder;
+        this.filterType = filterType;
+        this.filterValues = filterValues;
+    }
+
+    /**
+     * Build the complete tree of the FeatureModel.
+     */
+    public void printForest() {
+        stringBuilder
+                .append("\\begin{forest}").append(TikzGraphicalFeatureModelFormat.LINE_SEPERATOR)
+                .append("\tfeatureDiagram").append(TikzGraphicalFeatureModelFormat.LINE_SEPERATOR).append("\t");
+
+        PrintVisitor printVisitor = new PrintVisitor(filterType, filterValues);
+        Trees.traverse(featureTree, printVisitor);
+        stringBuilder.append(printVisitor.getResult().get());
+
+        postProcessing();
+        stringBuilder.append("\t").append(TikzGraphicalFeatureModelFormat.LINE_SEPERATOR);
+        if (!featureTree.getFeature().isHidden()) {
+            printLegend();
+        }
+        if(!featureModel.getConstraints().isEmpty()) {
+            printConstraints();
+        }
+        stringBuilder.append("\\end{forest}").append(TikzGraphicalFeatureModelFormat.LINE_SEPERATOR);
+    }
+
+    /**
+     * Processes a String to make special symbols LaTeX compatible.
+     */
+    private void postProcessing() {
+        stringBuilder.replace(0, stringBuilder.length(), stringBuilder.toString().replace("_", "\\_"));
+    }
+
+    private void printLegend() {
+        TikzMatrixHelper tikzMatrixHelper = new TikzMatrixHelper(TikzMatrixType.LEGEND);
+
+        if (stringBuilder.indexOf(",abstract") != -1 && stringBuilder.indexOf(",concrete") != -1) {
+            tikzMatrixHelper.writeNode("[abstract,label=right:Abstract Feature] {}");
+            tikzMatrixHelper.writeNode("[concrete,label=right:Concrete Feature] {}");
+        } else if (stringBuilder.indexOf(",abstract") != -1) {
+            tikzMatrixHelper.writeNode("[abstract,label=right:Feature] {}");
+        } else if (stringBuilder.indexOf(",concrete") != -1) {
+            tikzMatrixHelper.writeNode("[concrete,label=right:Feature] {}");
+        }
+
+        if (stringBuilder.indexOf(",mandatory") != -1) {
+            tikzMatrixHelper.writeNode("[mandatory,label=right:Mandatory] {}");
+        }
+
+        if (stringBuilder.indexOf(",optional") != -1) {
+            tikzMatrixHelper.writeNode("[optional,label=right:Optional] {}");
+        }
+
+        if (stringBuilder.indexOf(",or") != -1) {
+            tikzMatrixHelper
+                    .writeFillDraw("(0.1,0) - +(-0,-0.2) - +(0.2,-0.2)- +(0.1,0)")
+                    .writeDraw("(0.1,0) -- +(-0.2, -0.4)")
+                    .writeDraw("(0.1,0) -- +(0.2,-0.4)")
+                    .writeFill("(0,-0.2) arc (240:300:0.2)")
+                    .writeNode("[label=right:Or Group] {}");
+        }
+
+        if (stringBuilder.indexOf(",alternative") != -1) {
+            tikzMatrixHelper
+                    .writeDraw("(0.1,0) -- +(-0.2, -0.4)")
+                    .writeDraw("(0.1,0) -- +(0.2,-0.4)")
+                    .writeDraw("(0,-0.2) arc (240:300:0.2)")
+                    .writeNode("[label=right:Alternative Group] {}");
+        }
+
+        stringBuilder.append(tikzMatrixHelper.build());
+    }
+
+    private void printConstraints() {
+        ExpressionSerializer expressionSerializer = new ExpressionSerializer();
+        expressionSerializer.setEnquoteAlways(true);
+        expressionSerializer.setSymbols(LaTexSymbols.INSTANCE);
+
+        stringBuilder.append("	\\matrix [below=1mm of current bounding box] {").append(TikzGraphicalFeatureModelFormat.LINE_SEPERATOR);
+        for (IConstraint constraint : featureModel.getConstraints()) {
+            String text = constraint.getFormula().traverse(expressionSerializer).get();
+            text = text.replaceAll("\"([\\w\" ]+)\"", " \\\\text\\{$1\\} "); // wrap all words in \text{} // replace with $2
+            text = text.replaceAll("\\s+", " "); // remove unnecessary whitespace characters
+            stringBuilder.append("	\\node {\\(").append(text).append("\\)}; \\\\").append(TikzGraphicalFeatureModelFormat.LINE_SEPERATOR);
+
+            expressionSerializer.reset();
+        }
+        stringBuilder.append("	};").append(TikzGraphicalFeatureModelFormat.LINE_SEPERATOR);
+    }
+}