Integrate with SearchRxiv #15373
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -17,8 +17,12 @@ | |
|
|
||
| import org.jabref.gui.DialogService; | ||
| import org.jabref.gui.WorkspacePreferences; | ||
| import org.jabref.gui.desktop.os.NativeDesktop; | ||
| import org.jabref.gui.frame.ExternalApplicationsPreferences; | ||
| import org.jabref.gui.util.DirectoryDialogConfiguration; | ||
| import org.jabref.logic.crawler.StudyRepository; | ||
| import org.jabref.logic.crawler.StudyYamlParser; | ||
| import org.jabref.logic.exporter.SearchRxivExporter; | ||
| import org.jabref.logic.git.GitHandler; | ||
| import org.jabref.logic.git.preferences.GitPreferences; | ||
| import org.jabref.logic.importer.ImportFormatPreferences; | ||
|
|
@@ -55,8 +59,10 @@ public class ManageStudyDefinitionViewModel { | |
| private final ObservableList<String> authors = FXCollections.observableArrayList(); | ||
| private final ObservableList<String> researchQuestions = FXCollections.observableArrayList(); | ||
| private final ObservableList<String> queries = FXCollections.observableArrayList(); | ||
| // Observe changes to each item's enabledProperty so bindings re-evaluate when catalogs are toggled | ||
| private final ObservableList<StudyCatalogItem> databases = FXCollections.observableArrayList( | ||
|
InAnYan marked this conversation as resolved.
|
||
| item -> new javafx.beans.Observable[] {item.enabledProperty()} | ||
| ); | ||
| // Hold the complement of databases for the selector | ||
| private final SimpleStringProperty directory = new SimpleStringProperty(); | ||
|
|
||
|
|
@@ -218,12 +224,7 @@ public void addQuery(String query) { | |
| } | ||
|
|
||
| public SlrStudyAndDirectory saveStudy() { | ||
| Study study = buildStudy(); | ||
| Path studyDirectory; | ||
| final String studyDirectoryAsString = directory.getValueSafe(); | ||
| try { | ||
|
|
@@ -257,6 +258,19 @@ public SlrStudyAndDirectory saveStudy() { | |
| return new SlrStudyAndDirectory(study, studyDirectory); | ||
| } | ||
|
|
||
| /// Builds a {@link Study} from the current UI state without persisting it. | ||
| public Study buildStudy() { | ||
| return new Study( | ||
| authors, | ||
| title.getValueSafe(), | ||
| researchQuestions, | ||
| queries.stream().map(StudyQuery::new).collect(Collectors.toList()), | ||
| databases.stream() | ||
| .map(item -> new StudyDatabase(item.getName(), item.isEnabled())) | ||
| .filter(StudyDatabase::isEnabled) | ||
| .collect(Collectors.toList())); | ||
| } | ||
|
|
||
| public Property<String> titleProperty() { | ||
| return title; | ||
| } | ||
|
|
@@ -316,4 +330,30 @@ public StringProperty queriesValidationMessageProperty() { | |
| public StringProperty catalogsValidationMessageProperty() { | ||
| return catalogsValidationMessage; | ||
| } | ||
|
|
||
| public void shareOnSearchRxiv(Path initialDirectory, ExternalApplicationsPreferences externalPreferences) { | ||
| Study study = buildStudy(); | ||
| if (study.getDatabases().isEmpty()) { | ||
| dialogService.notify(Localization.lang("Please select at least one catalog.")); | ||
| return; | ||
| } | ||
|
|
||
| DirectoryDialogConfiguration config = new DirectoryDialogConfiguration.Builder() | ||
| .withInitialDirectory(initialDirectory) | ||
| .build(); | ||
|
|
||
| dialogService.showDirectorySelectionDialog(config).ifPresent(exportDirectory -> { | ||
| try { | ||
| new SearchRxivExporter().export(study, exportDirectory); | ||
| NativeDesktop.openBrowserShowPopup( | ||
|
Member
There was a problem hiding this comment. I'm still not sure if we want to open a website after exporting the search queries to JSON. @koppor @calixtus @subhramit what do you think?
Member
There was a problem hiding this comment. I think this is partially known behaviour, if I export something, I open the browser to show the result of the export. If it's just Json exportet, I wouldn't show the result, its just technical.
Member
There was a problem hiding this comment. I couldn’t really find the button “use json search” on the website, so I think it’s better not to show |
||
| SearchRxivExporter.SEARCHRXIV_URL, | ||
| dialogService, | ||
| externalPreferences); | ||
| dialogService.notify(Localization.lang("Exported search queries for SearchRxiv.")); | ||
| } catch (IOException e) { | ||
| LOGGER.error("Could not export search queries for SearchRxiv", e); | ||
| dialogService.notify(Localization.lang("Could not export search queries.")); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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,73 @@ | ||
| package org.jabref.logic.exporter; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.jabref.model.study.Study; | ||
| import org.jabref.model.study.StudyDatabase; | ||
| import org.jabref.model.study.StudyQuery; | ||
|
|
||
| import tools.jackson.databind.ObjectMapper; | ||
|
|
||
| /// Exports study search queries in the SearchRxiv / search-query JSON format. | ||
| /// One file is created per query and database combination, | ||
| /// as the format uses a single platform string per record. | ||
| /// | ||
| /// The JSON format follows the search-query library's SearchFile specification. | ||
| /// | ||
| /// @see <a href="https://github.com/CoLRev-Environment/search-query">search-query library</a> | ||
| /// @see <a href="https://colrev-environment.github.io/search-query/">search-query format documentation</a> | ||
| /// @see <a href="https://www.cabidigitallibrary.org/journal/searchrxiv">SearchRxiv</a> | ||
| public class SearchRxivExporter { | ||
|
|
||
| public static final String SEARCHRXIV_URL = "https://www.cabidigitallibrary.org/journal/searchrxiv"; | ||
|
|
||
| private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper(); | ||
|
|
||
| /// Exports the study's search queries as JSON files to the given directory. | ||
| /// One file per query and database combination is created. | ||
| /// | ||
| /// @param study The study containing queries, databases, and authors | ||
| /// @param directory The target directory to write the JSON files into | ||
| /// @throws IOException if a file cannot be written | ||
| public void export(Study study, Path directory) throws IOException { | ||
| int index = 0; | ||
| for (StudyQuery studyQuery : study.getQueries()) { | ||
| for (StudyDatabase database : study.getDatabases()) { | ||
| Path file = directory.resolve(buildFileName(studyQuery.getQuery(), database.getName(), index)); | ||
| Files.writeString(file, buildJson(study, studyQuery.getQuery(), database.getName())); | ||
| index++; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Builds a JSON string following the search-query format. | ||
| /// Format spec: <a href="https://github.com/CoLRev-Environment/search-query">search-query</a> | ||
| private String buildJson(Study study, String query, String platform) throws IOException { | ||
| Map<String, Object> data = new LinkedHashMap<>(); | ||
| data.put("search_string", query); | ||
| data.put("platform", platform.toLowerCase()); | ||
| data.put("authors", study.getAuthors().stream() | ||
| .map(author -> Map.of("name", author)) | ||
| .toList()); | ||
| // Placeholder fields — to be filled by the user on SearchRxiv | ||
| data.put("record_info", Map.of()); | ||
| data.put("date", Map.of()); | ||
| return OBJECT_MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(data); | ||
| } | ||
|
|
||
| private String buildFileName(String query, String databaseName, int index) { | ||
| String cleanDb = databaseName.replaceAll("[^A-Za-z0-9]", "_"); | ||
| String cleanQuery = query.replaceAll("[^A-Za-z0-9]", "_"); | ||
| if (cleanQuery.isEmpty()) { | ||
| cleanQuery = "query"; | ||
| } | ||
| if (cleanQuery.length() > 20) { | ||
| cleanQuery = cleanQuery.substring(0, 20); | ||
| } | ||
| return cleanDb + "-" + cleanQuery + "-" + index + ".json"; | ||
| } | ||
| } |
This file contains hidden or 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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.