-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master' into fix-967
# Conflicts: # src/main/java/org/jabref/gui/maintable/MainTable.java # src/main/java/org/jabref/gui/preferences/table/TableTabViewModel.java
- Loading branch information
Showing
259 changed files
with
4,987 additions
and
2,988 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Use Jackson to parse study.yml | ||
|
||
## Context and Problem Statement | ||
|
||
The study definition file is formulated as a YAML document. | ||
To accessed the definition within JabRef this document has to be parsed. | ||
What parser should be used to parse YAML files? | ||
|
||
## Considered Options | ||
|
||
* [Jackson](https://github.com/FasterXML/jackson-dataformat-yaml) | ||
* [SnakeYAML Engine](https://bitbucket.org/asomov/snakeyaml) | ||
* [yamlbeans](https://github.com/EsotericSoftware/yamlbeans) | ||
* [eo-yaml](https://github.com/decorators-squad/eo-yaml) | ||
* Self-written parser | ||
|
||
## Decision Outcome | ||
|
||
Chosen option: Jackson, because as it is a dedicated library for parsing YAML. yamlbeans also seem to be viable. They all offer similar functionality | ||
|
||
## Pros and Cons of the Options | ||
|
||
### Jackson | ||
|
||
* Good, because established YAML parser library | ||
* Good, because supports YAML 1.2 | ||
* Good, because it can parse LocalDate | ||
|
||
### SnakeYAML Engine | ||
|
||
* Good, because established YAML parser library | ||
* Good, because supports YAML 1.2 | ||
* Bad, because cannot parse YAML into Java DTOs, only into [basic Java structures](https://bitbucket.org/asomov/snakeyaml-engine/src/master/), this then has to be assembled into DTOs | ||
|
||
### yamlbeans | ||
|
||
* Good, because established YAML parser library | ||
* Good, because [nice getting started page](https://github.com/EsotericSoftware/yamlbeans) | ||
* Bad, because objects need to be annotated in the yaml file to be parsed into Java objects | ||
|
||
### eo-yaml | ||
|
||
* Good, because established YAML parser library | ||
* Good, because supports YAML 1.2 | ||
* Bad, because cannot parse YAML into Java DTOs | ||
|
||
### Own parser | ||
|
||
* Good, because easily customizable | ||
* Bad, because high effort | ||
* Bad, because has to be tested extensively | ||
|
||
## Links | ||
|
||
* [Winery's ADR-0009](https://github.com/eclipse/winery/blob/master/docs/adr/0009-manual-tosca-yaml-serialisation.md) | ||
* [Winery's ADR-0010](https://github.com/eclipse/winery/blob/master/docs/adr/0010-tosca-yaml-deserialisation-using-snakeyaml.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Keep study as a DTO | ||
|
||
## Context and Problem Statement | ||
|
||
The study holds query and library entries that could be replaced respectively with complex query and fetcher instances. | ||
This poses the question: should the study remain a pure DTO object or should it contain direct object instances? | ||
|
||
## Considered Options | ||
|
||
* Keep study as DTO and use transformers | ||
* Replace entries with instances | ||
|
||
## Decision Outcome | ||
|
||
Chosen option: "Keep study as DTO and use transformators", because comes out best (see below). | ||
|
||
## Pros and Cons of the Options | ||
|
||
### Keep study as DTO and use transformators | ||
|
||
* Good, because no need for custom serialization | ||
* Good, because deactivated fetchers can be documented (important for traceable Searching (SLRs)) | ||
* Bad, because Entries for databases and queries needed | ||
|
||
### Replace entries with instances | ||
|
||
* Good, because no need for database and query entries | ||
* Bad, because custom de-/serializers for fetchers and complex queries needed | ||
* Bad, because harder to maintain than using "vanilla" jackson de-/serialization | ||
* … <!-- numbers of pros and cons can vary --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.