Update README, fix issue caused by automerge

Author: 6b6279

README.md

@@ -1,14 +1,33 @@
-# TraVarT Core
+# TraVarT: Core library
 
-This directory contains the core interfaces / classes to be used across the TraVarT Ecosystem.
+This repository contains the TraVarT core module which can be extended with plugins. The core module itself only provides support
+for UVL models, which is the pivot metamodel. Additionally, the core module has a CLI to invoke transformations, list benchmarks etc.
 
-## CheckStyle
+To get started, copy over TraVarT plugins (as JAR archives) into the `plugins` folder in this repository (if this folder does not
+exist, create it, the path should be ignored by Git).
 
-Configure IntelliJ as follows:
+The command-line interface provides three subcommands: `plugin`, `benchmark` and `transform'. An exhaustive list of possible
+options and flags for individual subcommands can be viewed by invoking the respective subcommand as a sub-subcommand of `help` i.e., `help plugin`.
+If you want to start TraVarT directly off this repository (and not over a compiled JAR file independent from the repository), invoke
+the Maven exection plugin over `mvn exec:java`. You can provide command-line arguments while using `exec:java` with `-Dexec.args`.
 
-1. Install Checkstyle plugin
-1. Go to Settings|Editor|Code Style, choose a code style you want to import CheckStyle configuration to.
-1. Click Manage...|Import.., choose "CheckStyle Configuration" and select a corresponding CheckStyle configuration file.
-   Click OK
+For clarity, we will shortly introduce the subcommands here:
 
-[credit](http://biercoff.com/how-to-import-checkstyle-rules-into-intellij-idea-code-format-rules/)
+- `plugin`: This subcommand lists currently detected plugins. There are no flags or sub-subcommands of this subcommand.
+- `benchmark`: This subcommand lists currently known benchmarks. There are no flags or sub-subcommands of this subcommand.
+- `transform`: This subcommand allows invocation of installed plugins to transform models. It has four mandatory parameters and several optional flags:
+    - First command-line parameter should be the path to the source model (model to be transformed).
+    - Second command-line parameter should be the path to the target model (this will be created by the end of the transformation).
+    - Two mandatory flags are `-st` and `-tt` (or respectively `--source-type` and `--target-type`). These should correspond to the source and target model types, else transformation is not possible.
+    - The flag `--benchmark` can be used to activate any number of benchmarks during transformation. The argument to this option should be comma-seperated list of benchmark names, as shown over the `benchmark` subcommand.
+    - The flag `--write-benchmarks` can be used to write benchmark results automatically into some given file. The given file will be concatenated, the output format is CSV.
+    - The flag `--blacklist-file` can be used to include some blacklist file while transforming. Blacklisted models (matching by name) won't be transformed.
+    - The flag `--strategy` can be used to enforce a certain transformation strategy. By default, TraVarT attempts an one-way transformation. The two possible values here are `ONE\_WAY` or `ROUNDTRIP`.
+    - The flag `--inplace-roundtrip` can be used alongside `--strategy=ROUNDTRIP`. In-place roundtrip transformation means that the forward transformation is immediately followed by a reverse transformation; i.e. the resulting model is in source type.
+    - The flag `--no-serialize` can be used to skip serialization after transformation. This is especially useful if the user is only interested in benchmarking results. When serialization is skipped, the target model is not persisted.
+    - The flag `--strict` can be used when working in batch mode (source path is a folder with multiple models). If in strict mode, transformation is aborted after the first timeout/transformation failure.
+    - As just mentioned, TraVarT has a default transformation timeout; this is 5 seconds by default. It can be optionally changed to some arbitrary number of seconds over the `--timeout` option.
+
+All subcommands also support the `--verbose` flag.
+
+More regarding the architecture of TraVarT and related tools can be found in the publications regarding TraVarT.

src/main/java/at/jku/cps/travart/core/FeatureModelStatistics.java

@@ -15,8 +15,6 @@
  *******************************************************************************/
 package at.jku.cps.travart.core;
 
-import java.util.Objects;
-
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.Logger;
 
@@ -34,35 +32,46 @@ public int getVariabilityElementsCount(final FeatureModel fm) {
 	}
 
 	@Override
-	public long getConstraintsCount(final FeatureModel fm) {
-		return (long) TraVarTUtils.getFeatureConstraints(fm).size() + TraVarTUtils.getGlobalConstraints(fm).size()
-				+ TraVarTUtils.getLiteralConstraints(fm).size() + TraVarTUtils.getOwnConstraints(fm).size();
+	public int getConstraintsCount(final FeatureModel fm) {
+		return TraVarTUtils.getFeatureConstraints(fm).size()
+				+ TraVarTUtils.getGlobalConstraints(fm).size()
+				+ TraVarTUtils.getLiteralConstraints(fm).size()
+				+ TraVarTUtils.getOwnConstraints(fm).size();
 	}
 
 	@Override
 	public void logModelStatistics(final Logger logger, final FeatureModel fm) {
-		logger.log(Level.INFO, "Root Name: {}", fm.getRootFeature().getFeatureName());
-		logger.log(Level.INFO, "#Features: {}", getVariabilityElementsCount(fm));
-		logger.log(Level.INFO, "#Abstract Features: {}", countAbstractFeatures(fm));
-		logger.log(Level.INFO, "#Mandatory Features: {}", countMandatoryFeatures(fm));
-		logger.log(Level.INFO, "#Optional Features: {}", countOptionalFeatures(fm));
+		logger.log(Level.INFO, "Root Name: {}",
+				fm.getRootFeature().getFeatureName());
+		logger.log(Level.INFO, "#Features: {}",
+				getVariabilityElementsCount(fm));
+		logger.log(Level.INFO, "#Abstract Features: {}",
+				countAbstractFeatures(fm));
+		logger.log(Level.INFO, "#Mandatory Features: {}",
+				countMandatoryFeatures(fm));
+		logger.log(Level.INFO, "#Optional Features: {}",
+				countOptionalFeatures(fm));
 		logger.log(Level.INFO, "#Or groups: {}", countOrGroups(fm));
 		logger.log(Level.INFO, "#Xor groups: {}", countXorGroups(fm));
 		logger.log(Level.INFO, "#Constraints: {}", getConstraintsCount(fm));
-		logger.log(Level.INFO, "Tree height: {}", computeFMHeight(TraVarTUtils.getRoot(fm)));
+		logger.log(Level.INFO, "Tree height: {}",
+				computeFMHeight(TraVarTUtils.getRoot(fm)));
 	}
 
 	private static int countAbstractFeatures(final FeatureModel fm) {
-		return (int) TraVarTUtils.getFeatures(fm).stream().filter(TraVarTUtils::isAbstract).count();
+		return (int) TraVarTUtils.getFeatures(fm).stream()
+				.filter(TraVarTUtils::isAbstract).count();
 	}
 
 	private static int countMandatoryFeatures(final FeatureModel fm) {
-		return (int) TraVarTUtils.getFeatures(fm).stream().filter(TraVarTUtils::isMandatory).count();
+		return (int) TraVarTUtils.getFeatures(fm).stream()
+				.filter(TraVarTUtils::isMandatory).count();
 	}
 
 	private static int countOptionalFeatures(final FeatureModel fm) {
-		return (int) TraVarTUtils.getFeatures(fm).stream()
-				.filter(f -> TraVarTUtils.checkGroupType(f, Group.GroupType.OPTIONAL)).count();
+		return (int) TraVarTUtils.getFeatures(fm).stream().filter(
+				f -> TraVarTUtils.checkGroupType(f, Group.GroupType.OPTIONAL))
+				.count();
 	}
 
 	private static int countOrGroups(final FeatureModel fm) {
@@ -73,7 +82,8 @@ private static int countXorGroups(final FeatureModel fm) {
 		return countGroupType(fm, Group.GroupType.ALTERNATIVE);
 	}
 
-	private static int countGroupType(final FeatureModel fm, final Group.GroupType grouptype) {
+	private static int countGroupType(final FeatureModel fm,
+			final Group.GroupType grouptype) {
 		int count = 0;
 		for (Feature feature : TraVarTUtils.getFeatures(fm)) {
 			count += TraVarTUtils.countGroup(feature, grouptype);

src/main/java/at/jku/cps/travart/core/cli/TraVarTCommand.java

@@ -21,12 +21,13 @@
 import at.jku.cps.travart.core.helpers.TraVarTPluginManager;
 import picocli.CommandLine; // Re-implement CLI with Commons CLI framework?
 import picocli.CommandLine.Command;
+import picocli.CommandLine.HelpCommand;
 import picocli.CommandLine.Option;
 import picocli.CommandLine.ScopeType;
 
 @Command(name = "travart", subcommands = {TransformCommand.class,
-		PluginCommand.class,
-		BenchmarkCommand.class}, mixinStandardHelpOptions = true, version = "0.0.1", description = "TraVarT main command to transform and validate variability artifacts.")
+		PluginCommand.class, BenchmarkCommand.class,
+		HelpCommand.class}, mixinStandardHelpOptions = true, version = "0.0.1", description = "TraVarT main command to transform and validate variability artifacts.")
 public class TraVarTCommand {
 
 	static {
@@ -46,7 +47,7 @@ public static void main(final String[] args) {
 			arg = args;
 		}
 		int exitCode = new CommandLine(new TraVarTCommand()).execute(arg);
-		TraVarTPluginManager.stopPlugins();
+		// TraVarTPluginManager.stopPlugins();
 		System.exit(exitCode);
 	}
 }

src/main/java/at/jku/cps/travart/core/cli/TransformCommand.java

@@ -95,12 +95,12 @@ private static String toStringList(final Iterable<String> fileExtensions) {
 	@Parameters(index = "1", description = "The output path to which the variability artifact is transformed. If the source is given as a folder, this parameter must be a folder too.")
 	private Path targetPath;
 
-	@Option(names = {"-st", "-sourceType", "--st",
-			"--sourceType"}, required = true, description = "The mandatory type of the source variability artifacts, as listed in the plugin command.")
+	@Option(names = {"-st", "-sourceType", "--st", "--sourceType",
+			"--source-type"}, required = true, description = "The mandatory type of the source variability artifacts, as listed in the plugin command.")
 	private String sourceType;
 
-	@Option(names = {"-tt", "-targetType", "--tt",
-			"--targetType"}, required = true, description = "The mandatory target type of the transformed variability artifacts, as listed by the plugin command.")
+	@Option(names = {"-tt", "-targetType", "--tt", "--targetType",
+			"--target-type"}, required = true, description = "The mandatory target type of the transformed variability artifacts, as listed by the plugin command.")
 	private String targetType;
 
 	@Option(names = {"-b",