This is the root project for FeatJAR, a collection of Java libraries for feature-oriented software development, planned to replace the FeatureIDE library, starting with FeatureIDE 4.0.0. Please report feedback to sebastian.krieter@uni-ulm.de or kuiter@ovgu.de.
For developers who intend to push changes, we recommend to run git config --global url.ssh://git@github.com/.insteadOf https://github.com/ (do not forget the trailing slash) beforehand to push/pull repositories over SSH instead of HTTPS.
FeatJAR is still in active development. Thus, there can be test fails in some projects. Run gradle assemble instead of gradle build to skip tests.
Run the following in a shell:
sudo apt update
sudo apt install git openjdk-11-jdk
git clone https://github.com/FeatureIDE/FeatJAR.git && cd FeatJAR
scripts/clone.bat
./gradlew build
Installation on other Linux distributions may differ slightly, depending on the package manager.
Assuming Chocolatey is installed, run the following in cmd.exe:
choco install git openjdk11
git clone https://github.com/FeatureIDE/FeatJAR.git && cd FeatJAR
scripts\clone.bat
gradlew build
Alternatively, follow the steps for Ubuntu in a WSL shell.
Assuming Homebrew is installed, run the following in a shell:
brew update
brew install git openjdk@11
git clone https://github.com/FeatureIDE/FeatJAR.git && cd FeatJAR
scripts/clone.bat
./gradlew build
Assuming Git and Docker are installed, run the following in a shell (or, on Windows, in WSL):
git clone https://github.com/FeatureIDE/FeatJAR.git && cd FeatJAR
scripts/clone.bat
docker run -v "$(pwd)":/home/gradle gradle:8.0.2-jdk11 gradle build
Besides building and testing all modules, Gradle supports many commands to control the build process, including:
# assemble all modules as JARs and run all tests (= assemble + check)
./gradlew build
# assemble all modules as JARs, skipping all tests
./gradlew assemble
# run all tests for all modules, skipping JAR assembly
./gradlew check
# run the FeatJAR command-line interface with the specified arguments
./gradlew :cli:run --args "<arguments>"
# run a task (e.g., 'build') only for the specified module (e.g., 'base') and its dependencies
./gradlew :<module>:<task>
# print a comprehensive list of tasks
gradle :<module>:tasks
# count feature model solutions
java -jar all/build/libs/*-all.jar solution-count-sharpsat --input formula/src/testFixtures/resources/testFeatureModels/car.xml
# or, equivalently, using Gradle
./gradlew :all:run --args " solution-count-sharpsat --input ../formula/src/testFixtures/resources/testFeatureModels/car.xml"
In addition to the repositories under the FeatureIDE organization, several other tools and evaluations rely on FeatJAR as a library, for example:
- tseitin-or-not-tseitin: Automated evaluation of CNF transformations' impact on feature-model analyses
- variED-NG: A collaborative, real-time feature model editor
To use FeatJAR during FeatureIDE development, import the FeatJAR root folder as a Gradle project with default settings in Eclipse (File > Import... > Gradle > Existing Gradle project).
Then you can use any FeatJAR repository (e.g., base) in any Eclipse project by adding it to the project's build path (Right click project > Properties > Java Build Path > Projects > Add...).
You can get an overview of all commands by appending the --help flag. Here is an example with an executable:
java -jar all/build/libs/*-all.jar --help
When using the --help flag on the formula-analysis-sat4j package, the following output will be produced:
$ java -jar formula-analysis-sat4j/build/libs/formula-analysis-sat4j-0.1.1-SNAPSHOT-all.jar --help
Usage: java -jar feat.jar [<command> | --command <classpath>] [--<flag> | --<option> <value>]...
The following commands are available:
core-sat4j: Computes core and dead variables for a given formula using SAT4J.
(Classpath: de.featjar.formula.analysis.cli.CoreCommand)
atomic-sets-sat4j: Computes atomic sets for a given formula using SAT4J.
(Classpath: de.featjar.formula.analysis.cli.AtomicSetsCommand)
solutions-sat4j: Computes solutions for a given formula using SAT4J.
(Classpath: de.featjar.formula.analysis.cli.SolutionsCommand)
solution-count-sat4j: Computes number of solutions for a given formula using SAT4J.
(Classpath: de.featjar.formula.analysis.cli.SolutionCountCommand)
t-wise-sat4j: Computes solutions for a given formula using SAT4J
(Classpath: de.featjar.formula.analysis.cli.TWiseCommand)
projection-sat4j: Removes literals of a given formula using SAT4J.
(Classpath: de.featjar.formula.transform.cli.ProjectionCommand)
convert-cnf-format: Converts the format of a given formula into another CNF format.
(Classpath: de.featjar.formula.transform.cli.ConvertCNFFormatCommand)
convert-format: Converts the format of a given formula.
(Classpath: de.featjar.formula.transform.cli.ConvertFormatCommand)
print: Prints the formula in a readable format.
(Classpath: de.featjar.formula.visitor.cli.PrintCommand)
If you want more details of one specific command, you can again use the --help flag.
Here is an example:
$ java -jar formula-analysis-sat4j/build/libs/formula-analysis-sat4j-0.1.1-SNAPSHOT-all.jar print --help
Usage: java -jar feat.jar [<command> | --command <classpath>] [--<flag> | --<option> <value>]...
Help for de.featjar.formula.visitor.cli.PrintCommand
Prints the formula in a readable format.
General options:
--config <value1,value2,...>: The names of configuration files (default: [])
--config_dir <value>: The path to the configuration files
--command <value>: Classpath from command to execute
--help: Print usage information
--version: Print version information
--info-file <value>: Path to info log file
--error-file <value>: Path to error log file
--log-info <value1,value2,...>: Message types printed to the info stream (message, error, warning, info, debug, progress) (default: [MESSAGE, INFO, PROGRESS])
--log-error <value1,value2,...>: Message types printed to the error stream (message, error, warning, info, debug, progress) (default: [ERROR])
--log-info-file <value1,value2,...>: Message types printed to the info file (message, error, warning, info, debug, progress) (default: [MESSAGE, INFO, DEBUG])
--log-error-file <value1,value2,...>: Message types printed to the error file (message, error, warning, info, debug, progress) (default: [ERROR, WARNING])
Options of command de.featjar.formula.visitor.cli.PrintCommand:
--enforce-parentheses: Enforces parentheses.
--enquote-whitespace: Enquotes whitespace.
--format <value>: Defines the symbols.
--input <value>: Path to input file(s)
--newline <value>: Defines the new line string.
--notation <value>: Defines the notation. Possible options: [INFIX, PREFIX, POSTFIX, TREE]
--separator <value>: Defines the separator string.
--tab <value>: Defines the tab string.
If several libraries are imported that contain commands with the same name, FeatJAR does not know which command should be executed.
Therefore, it is possible to specify the classpath of the command class with the --command option.
You can get a list of all classpaths by using the --help flag as shown above.
For example, when executing the print-sat4j command, you could instead type:
java -jar formula-analysis-sat4j/build/libs/formula-analysis-sat4j-0.1.1-SNAPSHOT-all.jar --command de.featjar.formula.visitor.cli.PrintCommand ...
Every option and flag is specified in this example. You can get an overview of all options by using the --help flag as shown above.
java -jar formula-analysis-sat4j/build/libs/formula-analysis-sat4j-0.1.1-SNAPSHOT-all.jar print --input formula/src/testFixtures/resources/GPL/model.xml --tab tab --notation PREFIX --separator separator --format de.featjar.formula.io.textual.JavaSymbols --newline newline --enforce-parentheses --enquote-whitespace
The output will be printed in the console because no --output option was set:
&&(||(GPL) ||(Result{!, []}MainGpl GPL) ||(Result{!, []}HiddenGtp MainGpl) ||(Result{!, []}MainGpl HiddenGtp) ||(Result{!, []}DirectedWithEdges HiddenGtp) ||(Result{!, []}DirectedWithNeighbors HiddenGtp) ||(Result{!, []}DirectedOnlyVertices HiddenGtp) ||(Result{!, []}UndirectedWithEdges HiddenGtp) ||(Result{!, []}UndirectedWithNeighbors HiddenGtp) ||(Result{!, []}UndirectedOnlyVertices HiddenGtp) ||(Result{!, []}HiddenGtp DirectedWithEdges DirectedWithNeighbors DirectedOnlyVertices UndirectedWithEdges UndirectedWithNeighbors UndirectedOnlyVertices) ||(Result{!, []}DirectedWithEdges Result{!, []}DirectedWithNeighbors) ||(Result{!, []}DirectedWithEdges Result{!, []}DirectedOnlyVertices) ||(Result{!, []}DirectedWithEdges Result{!, []}UndirectedWithEdges) ||(Result{!, []}DirectedWithEdges Result{!, []}UndirectedWithNeighbors) ||(Result{!, []}DirectedWithEdges Result{!, []}UndirectedOnlyVertices) ||(Result{!, []}DirectedWithNeighbors Result{!, []}DirectedOnlyVertices) ||(Result{!, []}DirectedWithNeighbors Result{!, []}UndirectedWithEdges) ||(Result{!, []}DirectedWithNeighbors Result{!, []}UndirectedWithNeighbors) ||(Result{!, []}DirectedWithNeighbors Result{!, []}UndirectedOnlyVertices) ||(Result{!, []}DirectedOnlyVertices Result{!, []}UndirectedWithEdges) ||(Result{!, []}DirectedOnlyVertices Result{!, []}UndirectedWithNeighbors) ||(Result{!, []}DirectedOnlyVertices Result{!, []}UndirectedOnlyVertices) ||(Result{!, []}UndirectedWithEdges Result{!, []}UndirectedWithNeighbors) ||(Result{!, []}UndirectedWithEdges Result{!, []}UndirectedOnlyVertices) ||(Result{!, []}UndirectedWithNeighbors Result{!, []}UndirectedOnlyVertices) ||(Result{!, []}TestProg MainGpl) ||(Result{!, []}MainGpl TestProg) ||(Result{!, []}Alg MainGpl) ||(Result{!, []}MainGpl Alg) ||(Result{!, []}Number Alg) ||(Result{!, []}Connected Alg) ||(Result{!, []}StrongC Alg) ||(Result{!, []}StronglyConnected StrongC) ||(Result{!, []}StrongC StronglyConnected) ||(Result{!, []}Transpose StrongC) ||(Result{!, []}StrongC Transpose) ||(Result{!, []}Cycle Alg) ||(Result{!, []}MSTPrim Alg) ||(Result{!, []}MSTKruskal Alg) ||(Result{!, []}Alg Number Connected StrongC Cycle MSTPrim MSTKruskal) ||(Result{!, []}Src MainGpl) ||(Result{!, []}MainGpl Src) ||(Result{!, []}BFS Src) ||(Result{!, []}DFS Src) ||(Result{!, []}Src BFS DFS) ||(Result{!, []}BFS Result{!, []}DFS) ||(Result{!, []}HiddenWgt MainGpl) ||(Result{!, []}MainGpl HiddenWgt) ||(Result{!, []}WeightOptions HiddenWgt) ||(Result{!, []}HiddenWgt WeightOptions) ||(Result{!, []}WeightedWithEdges WeightOptions) ||(Result{!, []}WeightedWithNeighbors WeightOptions) ||(Result{!, []}WeightedOnlyVertices WeightOptions) ||(Result{!, []}Wgt MainGpl) ||(Result{!, []}MainGpl Wgt) ||(Result{!, []}Weighted Wgt) ||(Result{!, []}Unweighted Wgt) ||(Result{!, []}Wgt Weighted Unweighted) ||(Result{!, []}Weighted Result{!, []}Unweighted) ||(Result{!, []}Gtp MainGpl) ||(Result{!, []}MainGpl Gtp) ||(Result{!, []}Directed Gtp) ||(Result{!, []}Undirected Gtp) ||(Result{!, []}Gtp Directed Undirected) ||(Result{!, []}Directed Result{!, []}Undirected) ||(Result{!, []}Implementation MainGpl) ||(Result{!, []}MainGpl Implementation) ||(Result{!, []}OnlyVertices Implementation) ||(Result{!, []}WithNeighbors Implementation) ||(Result{!, []}WithEdges Implementation) ||(Result{!, []}Implementation OnlyVertices WithNeighbors WithEdges) ||(Result{!, []}OnlyVertices Result{!, []}WithNeighbors) ||(Result{!, []}OnlyVertices Result{!, []}WithEdges) ||(Result{!, []}WithNeighbors Result{!, []}WithEdges) ||(Result{!, []}Base MainGpl) ||(Result{!, []}MainGpl Base) ||(Result{!, []}GPL MainGpl) ||(Result{!, []}Number Src) ||(Result{!, []}Number Gtp) ||(Result{!, []}Connected Src) ||(Result{!, []}Connected Undirected) ||(Result{!, []}StrongC DFS) ||(Result{!, []}StrongC Directed) ||(Result{!, []}Cycle DFS) ||(Result{!, []}Cycle Gtp) ||(Weighted Result{!, []}MSTPrim) ||(Weighted Result{!, []}MSTKruskal) ||(Undirected Result{!, []}MSTPrim) ||(Undirected Result{!, []}MSTKruskal) ||(Result{!, []}MSTPrim Result{!, []}MSTKruskal) ||(Result{!, []}MSTKruskal WithEdges) ||(Result{!, []}OnlyVertices Result{!, []}Weighted WeightedOnlyVertices) ||(Result{!, []}WeightedOnlyVertices Weighted) ||(Result{!, []}WeightedOnlyVertices OnlyVertices) ||(Result{!, []}WithNeighbors Result{!, []}Weighted WeightedWithNeighbors) ||(Result{!, []}WeightedWithNeighbors Weighted) ||(Result{!, []}WeightedWithNeighbors WithNeighbors) ||(Result{!, []}WithEdges Result{!, []}Weighted WeightedWithEdges) ||(Result{!, []}WeightedWithEdges Weighted) ||(Result{!, []}WeightedWithEdges WithEdges) ||(Result{!, []}OnlyVertices Result{!, []}Directed DirectedOnlyVertices) ||(Result{!, []}DirectedOnlyVertices Directed) ||(Result{!, []}DirectedOnlyVertices OnlyVertices) ||(Result{!, []}WithNeighbors Result{!, []}Directed DirectedWithNeighbors) ||(Result{!, []}DirectedWithNeighbors Directed) ||(Result{!, []}DirectedWithNeighbors WithNeighbors) ||(Result{!, []}WithEdges Result{!, []}Directed DirectedWithEdges) ||(Result{!, []}DirectedWithEdges Directed) ||(Result{!, []}DirectedWithEdges WithEdges) ||(Result{!, []}OnlyVertices Result{!, []}Undirected UndirectedOnlyVertices) ||(Result{!, []}UndirectedOnlyVertices Undirected) ||(Result{!, []}UndirectedOnlyVertices OnlyVertices) ||(Result{!, []}WithNeighbors Result{!, []}Undirected UndirectedWithNeighbors) ||(Result{!, []}UndirectedWithNeighbors Undirected) ||(Result{!, []}UndirectedWithNeighbors WithNeighbors) ||(Result{!, []}WithEdges Result{!, []}Undirected UndirectedWithEdges) ||(Result{!, []}UndirectedWithEdges Undirected) ||(Result{!, []}UndirectedWithEdges WithEdges))
FeatJAR development team:
- Sebastian Krieter (Paderborn University, Germany)
- Elias Kuiter (University of Magdeburg, Germany)
- Andreas Gerasimow (Ulm University, Germany)
- Thomas Thüm (Paderborn University, Germany)
Further contributors and former project members:
- Katjana Herbst (Ulm University, Germany)
- Daniel Hohmann (University of Magdeburg, Germany)
- Timo Zuccarello (Ulm University, Germany)