Externally controlled vocabulary support #7712
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -139,6 +139,35 @@ | |
| import org.primefaces.PrimeFaces; | ||
| import org.primefaces.model.DefaultTreeNode; | ||
| import org.primefaces.model.TreeNode; | ||
| import org.primefaces.model.file.UploadedFile; | ||
|
|
||
| import javax.ejb.EJB; | ||
| import javax.ejb.EJBException; | ||
| import javax.faces.application.FacesMessage; | ||
| import javax.faces.component.UIComponent; | ||
| import javax.faces.component.UIInput; | ||
| import javax.faces.context.FacesContext; | ||
| import javax.faces.event.ActionEvent; | ||
| import javax.faces.event.AjaxBehaviorEvent; | ||
| import javax.faces.event.ValueChangeEvent; | ||
| import javax.faces.model.SelectItem; | ||
| import javax.faces.view.ViewScoped; | ||
| import javax.inject.Inject; | ||
| import javax.inject.Named; | ||
| import javax.json.*; | ||
| import javax.servlet.ServletOutputStream; | ||
| import javax.servlet.http.HttpServletResponse; | ||
| import javax.validation.ConstraintViolation; | ||
| import java.io.*; | ||
|
Contributor
There was a problem hiding this comment. See above, comment on globbing imports. |
||
| import java.sql.Timestamp; | ||
| import java.text.SimpleDateFormat; | ||
| import java.util.*; | ||
|
Contributor
There was a problem hiding this comment. See above, comment on globbing imports. |
||
| import java.util.Map.Entry; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| import static edu.harvard.iq.dataverse.util.JsfHelper.JH; | ||
| import static edu.harvard.iq.dataverse.util.StringUtil.isEmpty; | ||
|
|
||
| /** | ||
| * | ||
|
|
@@ -1282,7 +1311,7 @@ public boolean canUpdateDataset() { | |
| public boolean canPublishDataverse() { | ||
| return permissionsWrapper.canIssuePublishDataverseCommand(dataset.getOwner()); | ||
| } | ||
|
|
||
| public boolean canPublishDataset(){ | ||
| return permissionsWrapper.canIssuePublishDatasetCommand(dataset); | ||
| } | ||
|
|
@@ -1863,8 +1892,8 @@ private String init(boolean initFull) { | |
| mdcLogService.logEntry(entry); | ||
| } | ||
| displayWorkflowComments(); | ||
|
|
||
|
|
||
| if (initFull) { | ||
| // init the list of FileMetadatas | ||
| if (workingVersion.isDraft() && canUpdateDataset()) { | ||
|
|
@@ -2727,7 +2756,7 @@ public String refresh() { | |
| } | ||
|
|
||
| displayWorkflowComments(); | ||
|
|
||
| return ""; | ||
| } | ||
|
|
||
|
|
@@ -3373,8 +3402,8 @@ public String save() { | |
| } | ||
|
|
||
|
|
||
|
|
||
| // Use the Create or Update command to save the dataset: | ||
| Command<Dataset> cmd; | ||
| Map<Long, String> deleteStorageLocations = null; | ||
|
|
||
|
|
@@ -3486,7 +3515,7 @@ public String save() { | |
| } else { | ||
| JsfHelper.addWarningMessage(BundleUtil.getStringFromBundle("dataset.message.createSuccess.failedToSaveFiles")); | ||
| } | ||
| } else { | ||
| JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.createSuccess").concat(" ").concat(datasetService.getReminderString(dataset, canPublishDataset()))); | ||
| } | ||
| } | ||
|
|
@@ -5488,12 +5517,156 @@ public void setFileAccessRequest(boolean fileAccessRequest) { | |
| this.fileAccessRequest = fileAccessRequest; | ||
| } | ||
|
|
||
| // wrapper method to see if the file has been deleted (or replaced) in the current version | ||
| public boolean isFileDeleted (DataFile dataFile) { | ||
| if (dataFile.getDeleted() == null) { | ||
| dataFile.setDeleted(datafileService.hasBeenDeleted(dataFile)); | ||
| } | ||
|
|
||
| return dataFile.getDeleted(); | ||
| } | ||
|
|
||
| public Map<String, CVoc> getCVocConf(){ | ||
|
Contributor
There was a problem hiding this comment. This method is invoked by every Dataset "Edit Mode" page call, reading the saved JSON from the database, parsing it and create a map to access the configurations for the fields. It get's called from JSF via EL and saved to a var IMHO there should be a call to get the config for a specific field (still inside |
||
| Map <String, CVoc> cvocMap = new HashMap<>(); | ||
| String cvocSetting = settingsService.getValueForKey(SettingsServiceBean.Key.CVocConf); | ||
| if (cvocSetting == null || cvocSetting.isEmpty()) | ||
| return cvocMap; | ||
|
|
||
| JsonReader jsonReader = Json.createReader(new StringReader(settingsService.getValueForKey(SettingsServiceBean.Key.CVocConf))); | ||
|
Contributor
There was a problem hiding this comment. We should either make this live inside |
||
| JsonArray cvocConfJsonArray = jsonReader.readArray(); | ||
| jsonReader.close(); | ||
| if (cvocConfJsonArray != null) { | ||
| for (JsonObject jo : cvocConfJsonArray.getValuesAs(JsonObject.class)) { | ||
| JsonArray vocabs = jo.getJsonArray("vocabs"); | ||
| List<String> vocabsList = new ArrayList<>(); | ||
| for (JsonString elm: vocabs.getValuesAs(JsonString.class)){ | ||
| vocabsList.add(elm.getString()); | ||
| } | ||
| JsonArray vocabCodes = jo.getJsonArray("vocab-codes"); | ||
| List<String> vocabCodesList = new ArrayList<>(); | ||
| for (JsonString elm: vocabCodes.getValuesAs(JsonString.class)){ | ||
| vocabCodesList.add(elm.getString()); | ||
| logger.fine("cvoc - vocab-codes: " + elm.getString()); | ||
| } | ||
| String cvocLang = BundleUtil.getDefaultLocale().getLanguage();//default | ||
| if (jo.containsKey("language")) | ||
| cvocLang = jo.getString("language"); // in case of "language":"", "&lang=" will be send to the middleware | ||
| logger.fine("cvoc - language: " + cvocLang); | ||
| boolean cvocReadonly = false; | ||
| if (jo.containsKey("readonly") && jo.getString("readonly").toLowerCase().equals("true")) | ||
| cvocReadonly = true; | ||
| logger.fine("cvoc - readonly: " + cvocReadonly); | ||
| boolean cvocHideReadonlyUrls = false; | ||
| if (jo.containsKey("hideReadonlyUrls") && jo.getString("hideReadonlyUrls").toLowerCase().equals("true")) | ||
| cvocHideReadonlyUrls = true; | ||
| logger.fine("cvoc - cvocHideReadonlyUrls: " + cvocHideReadonlyUrls); | ||
| int cvocMinChars = 0; | ||
| if (jo.containsKey("minChars") && jo.getInt("minChars") >= 0) | ||
| cvocMinChars = jo.getInt("minChars"); | ||
| logger.fine("cvoc - minChars: " + cvocMinChars); | ||
| String cvocProtocol = "skosmos";//default | ||
| if (jo.containsKey("protocol")) | ||
| cvocProtocol = jo.getString("protocol"); | ||
| logger.fine("cvoc - protocol: " + cvocProtocol); | ||
| String cvocMapId = "uri" ;//default | ||
| if (jo.containsKey("map-id")) | ||
| cvocMapId = jo.getString("map-id"); | ||
| logger.fine("cvoc - map-id: " + cvocMapId); | ||
| String cvocMapQuery = "prefLabel" ;//default | ||
| if (jo.containsKey("map-query")) | ||
| cvocMapQuery = jo.getString("map-query"); | ||
| logger.fine("cvoc - map-query: " + cvocMapQuery); | ||
| String cvocJsUrl = "/resources/js/cvoc-interface.js"; | ||
| if (jo.containsKey("js-url")) | ||
| cvocJsUrl = jo.getString("js-url"); | ||
| logger.fine("cvoc - js-url: " + cvocJsUrl); | ||
| String cvocTermParentUri = ""; | ||
| if (jo.containsKey("term-parent-uri")) | ||
| cvocTermParentUri = jo.getString("term-parent-uri"); | ||
| logger.fine("cvoc - term-parent-uri: " + cvocTermParentUri); | ||
| String cvocVocabUri = ""; | ||
| if (jo.containsKey("vocab-uri")) | ||
| cvocVocabUri = jo.getString("vocab-uri"); | ||
| logger.fine("cvoc - vocab-uri: " + cvocVocabUri); | ||
| String cvocUrl = "http://localhost/Skosmos"; | ||
| if (jo.containsKey("cvoc-url")) | ||
| cvocUrl = jo.getString("cvoc-url"); | ||
| logger.fine("cvoc - cvoc-url: " + cvocUrl); | ||
| CVoc cvoc = new CVoc(cvocUrl, cvocLang, cvocProtocol, cvocVocabUri, cvocTermParentUri, cvocReadonly, cvocHideReadonlyUrls, cvocMinChars, vocabsList, vocabCodesList | ||
| , cvocJsUrl, cvocMapId, cvocMapQuery); | ||
| cvocMap.put(jo.getString("vocab-name"), cvoc); | ||
| } | ||
| } | ||
| return cvocMap; | ||
| } | ||
| public class CVoc { | ||
|
Contributor
There was a problem hiding this comment. Can we please move this outta here to a distinct package? There are likely more places this code will be used in the future... (E. g. API endpoints) Also:
Contributor
There was a problem hiding this comment. @ekoi, something to make it more reusable in the future if API endpoints will be extended with external CV support. |
||
| String cvocUrl; | ||
| String language; | ||
| String protocol; | ||
| String vocabUri; | ||
| String termParentUri; | ||
| String jsUrl; | ||
| String mapId; | ||
| String mapQuery; | ||
| boolean readonly; | ||
| boolean hideReadonlyUrls; | ||
| int minChars; | ||
| List<String> vocabs; | ||
| List<String> keys; | ||
| public CVoc(String cvocUrl, String language, String protocol, String vocabUri, String termParentUri, boolean readonly, boolean hideReadonlyUrls, int minChars, | ||
| List<String> vocabs, List<String> keys, String jsUrl, String mapId, String mapQuery){ | ||
| this.cvocUrl = cvocUrl; | ||
| this.language = language; | ||
| this.protocol = protocol; | ||
| this.readonly = readonly; | ||
| this.hideReadonlyUrls = hideReadonlyUrls; | ||
| this.minChars = minChars; | ||
| this.vocabs = vocabs; | ||
| this.vocabUri = vocabUri; | ||
| this.termParentUri = termParentUri; | ||
| this.keys = keys; | ||
| this.jsUrl = jsUrl; | ||
| this.mapId = mapId; | ||
| this.mapQuery = mapQuery; | ||
| } | ||
|
|
||
| public String getCVocUrl() { | ||
| return cvocUrl; | ||
| } | ||
| public String getLanguage() { | ||
| return language; | ||
| } | ||
| public String getProtocol() { return protocol; } | ||
| public String getVocabUri() { | ||
| return vocabUri; | ||
| } | ||
| public String getTermParentUri() { | ||
| return termParentUri; | ||
| } | ||
| public boolean isReadonly() { | ||
| return readonly; | ||
| } | ||
| public boolean isHideReadonlyUrls() { | ||
| return hideReadonlyUrls; | ||
| } | ||
| public int getMinChars() { return minChars; } | ||
| public List<String> getVocabs() { | ||
| return vocabs; | ||
| } | ||
| public List<String> getKeys() { | ||
| return keys; | ||
| } | ||
|
|
||
| public String getJsUrl() { | ||
| return jsUrl; | ||
| } | ||
|
|
||
| public String getMapId() { | ||
| return mapId; | ||
| } | ||
|
|
||
| public String getMapQuery() { | ||
| return mapQuery; | ||
| } | ||
| } | ||
| } | ||
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.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See above, comment on globbing imports.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ekoi, fyi