Dataverse topic class term uri

doc/release-notes/12614-topicClassTermURI.md

@@ -0,0 +1,57 @@
+Analogue to the addition of a termURI field to the keywords in the citation metadata blocks, the same idea should also be applied to the topicClassification fields:
+
+add a new subfield topicClassTermURI to the citation metadata block
+migrate contents from topicClassVocabURI to topicClassTermURI
+change DataCite export format, so that the content of topicClassTermURI goes into the property valueURI of the subject element
+old:
+
+<subject schemeURI="https://github.com/tibonto/dfgfo/44" subjectScheme="DFGFO">
+Computer Science, Systems and Electrical Engineering
+</subject>
+
+
+
+new:
+
+<subject schemeURI="https://github.com/tibonto/dfgfo/" valueURI="https://github.com/tibonto/dfgfo/44" subjectScheme="DFGFO">
+Computer Science, Systems and Electrical Engineering
+</subject>
+
+in the general case:
+
+
+
+<subject schemeURI="topicClassVocabURI" valueURI="topicClassTermURI" subjectScheme="topicClassVocab">topicClassValue</subject>
+
+
+The implementation expects a new metadata field called "topicClassTermURI". The old field was called "topicClassVocabURI".
+The old field still holds an URL but the schemeUrl but not the TermURI of the metadata value.
+This change has been adapted to the 
+    DdiExportUtil.java
+    OpenAireExportUtil.java
+    XmlMetadataTemplate.java
+
+In DdiExportUtil the field "topicClassVocabURI" is overwritten with "topicClassTermURI" because this is the new vocabUri.
+
+In OpenAireExportUtil the changes are made and tested like in the explanation above.
+
+In XmlMetadataTemplate there is just a new getter and an addition of the new "valueURI" attribute.
+
+You can migrate your topicClassVocabURI data containing URIs to the new topicClassTermURI field.
+In case of data migration, view the affected data with the following database query:
+
+    SELECT value FROM datasetfieldvalue dfv
+    INNER JOIN datasetfield df ON df.id = dfv.datasetfield_id
+    WHERE df.datasetfieldtype_id = (SELECT id FROM datasetfieldtype WHERE name = 'topicClassVocabURI')
+    AND value ILIKE 'http%';
+
+
+If you wish to migrate your data, a database update is then necessary:
+
+
+    UPDATE datasetfield df
+    SET datasetfieldtype_id  = (SELECT id FROM datasetfieldtype WHERE name = 'topicClassTermURI')
+    FROM datasetfieldvalue dfv
+    WHERE dfv.datasetfield_id  = df.id
+    AND df.datasetfieldtype_id = (SELECT id FROM datasetfieldtype WHERE name = 'topicClassVocabURI')
+    AND dfv.value ILIKE 'http%';

src/main/java/edu/harvard/iq/dataverse/DatasetFieldConstant.java

@@ -97,6 +97,7 @@ public class DatasetFieldConstant implements java.io.Serializable  {
     public static final String topicClassValue="topicClassValue";
     public static final String topicClassVocab="topicClassVocab";
     public static final String topicClassVocabURI="topicClassVocabURI";
+    public static final String topicClassTermURI="topicClassTermURI";
     public static final String descriptionText="dsDescriptionValue";
     public static final String descriptionDate="dsDescriptionDate";
     public static final String timePeriodCovered="timePeriodCovered"; // SEK added 6/13/2016

src/main/java/edu/harvard/iq/dataverse/export/ddi/DdiExportUtil.java

@@ -837,7 +837,7 @@ DatasetFieldConstant.keywordValue, CITATION_BLOCK_NAME, new Locale(lang),
                         for (HashSet<FieldDTO> foo : fieldDTO.getMultipleCompound()) {
                             String topicClassificationValue = "";
                             String topicClassificationVocab = "";
-                            String topicClassificationURI = "";
+                            String topicClassificationTermURI = "";
                             for (Iterator<FieldDTO> iterator = foo.iterator(); iterator.hasNext();) {
                                 FieldDTO next = iterator.next();
                                 if (DatasetFieldConstant.topicClassValue.equals(next.getTypeName())) {
@@ -851,14 +851,14 @@ DatasetFieldConstant.keywordValue, CITATION_BLOCK_NAME, new Locale(lang),
                                 if (DatasetFieldConstant.topicClassVocab.equals(next.getTypeName())) {
                                     topicClassificationVocab = next.getSinglePrimitive();
                                 }
-                                if (DatasetFieldConstant.topicClassVocabURI.equals(next.getTypeName())) {
-                                    topicClassificationURI = next.getSinglePrimitive();
+                                if (DatasetFieldConstant.topicClassTermURI.equals(next.getTypeName())) {
+                                    topicClassificationTermURI = next.getSinglePrimitive();
                                 }
                             }
                             if (!topicClassificationValue.isEmpty()) {
                                 xmlw.writeStartElement("topcClas");
                                 XmlWriterUtil.writeAttribute(xmlw, "vocab", topicClassificationVocab);
-                                XmlWriterUtil.writeAttribute(xmlw, "vocabURI", topicClassificationURI);
+                                XmlWriterUtil.writeAttribute(xmlw, "vocabURI", topicClassificationTermURI);
                                 if (lang != null && isCVV) {
                                     XmlWriterUtil.writeAttribute(xmlw, "xml:lang", defaultLocale.getLanguage());
                                     xmlw.writeCharacters(ControlledVocabularyValue.getLocaleStrValue(
@@ -875,7 +875,7 @@ DatasetFieldConstant.keywordValue, CITATION_BLOCK_NAME, new Locale(lang),
                                     if (translatedValue != null) {
                                         xmlw.writeStartElement("topcClas");
                                         XmlWriterUtil.writeAttribute(xmlw, "vocab", topicClassificationVocab);
-                                        XmlWriterUtil.writeAttribute(xmlw, "vocabURI", topicClassificationURI);
+                                        XmlWriterUtil.writeAttribute(xmlw, "vocabURI", topicClassificationTermURI);
                                         XmlWriterUtil.writeAttribute(xmlw, "xml:lang", lang);
                                         xmlw.writeCharacters(translatedValue);
                                         xmlw.writeEndElement(); // topcClas

src/main/java/edu/harvard/iq/dataverse/export/openaire/OpenAireExportUtil.java

@@ -493,6 +493,7 @@ public static void writeSubjectsElement(XMLStreamWriter xmlw, DatasetVersionDTO
                             String subject = null;
                             String subjectScheme = null;
                             String schemeURI = null;
+                            String valueURI = null;
 
                             for (Iterator<FieldDTO> iterator = fieldDTOs.iterator(); iterator.hasNext();) {
                                 FieldDTO next = iterator.next();
@@ -507,11 +508,15 @@ public static void writeSubjectsElement(XMLStreamWriter xmlw, DatasetVersionDTO
                                 if (DatasetFieldConstant.topicClassVocabURI.equals(next.getTypeName())) {
                                     schemeURI = next.getSinglePrimitive();
                                 }
+
+                                if (DatasetFieldConstant.topicClassTermURI.equals(next.getTypeName())) {
+                                    valueURI = next.getSinglePrimitive();
+                                }
                             }
 
                             if (StringUtils.isNotBlank(subject)) {
                                 subject_check = writeOpenTag(xmlw, "subjects", subject_check);
-                                writeSubjectElement(xmlw, subjectScheme, null, schemeURI, subject, language);
+                                writeSubjectElement(xmlw, subjectScheme, valueURI, schemeURI, subject, language);
                             }
                         }
                     }

src/main/java/edu/harvard/iq/dataverse/pidproviders/doi/XmlMetadataTemplate.java

@@ -388,6 +388,7 @@ private void writeSubjects(XMLStreamWriter xmlw, DvObject dvObject) throws XMLSt
             String topic = null;
             String scheme = null;
             String schemeUri = null;
+            String valueURI = null;
 
             for (DatasetField subField : topicFieldValue.getChildDatasetFields()) {
 
@@ -401,6 +402,9 @@ private void writeSubjects(XMLStreamWriter xmlw, DvObject dvObject) throws XMLSt
                 case DatasetFieldConstant.topicClassVocabURI:
                     schemeUri = subField.getValue();
                     break;
+                case DatasetFieldConstant.topicClassTermURI:
+                    valueURI = subField.getValue();
+                    break;
                 }
             }
             if (StringUtils.isNotBlank(topic)) {
@@ -411,6 +415,9 @@ private void writeSubjects(XMLStreamWriter xmlw, DvObject dvObject) throws XMLSt
                 if (StringUtils.isNotBlank(schemeUri)) {
                     attributesMap.put("schemeURI", schemeUri);
                 }
+                if (StringUtils.isNotBlank(valueURI)) {
+                    attributesMap.put("valueURI", valueURI);
+                }
                 subjectsCreated = XmlWriterUtil.writeOpenTagIfNeeded(xmlw, "subjects", subjectsCreated);
                 XmlWriterUtil.writeFullElementWithAttributes(xmlw, "subject", attributesMap, StringEscapeUtils.escapeXml10(topic));
             }

src/main/java/propertyFiles/citation.properties

@@ -30,6 +30,7 @@ datasetfieldtype.topicClassification.title=Topic Classification
 datasetfieldtype.topicClassValue.title=Term
 datasetfieldtype.topicClassVocab.title=Controlled Vocabulary Name
 datasetfieldtype.topicClassVocabURI.title=Controlled Vocabulary URL
+datasetfieldtype.topicClassTermURI.title=Term URI
 datasetfieldtype.publication.title=Related Publication
 datasetfieldtype.publicationRelationType.title=Relation Type
 datasetfieldtype.publicationCitation.title=Citation
@@ -110,6 +111,7 @@ datasetfieldtype.topicClassification.description=Indicates a broad, important to
 datasetfieldtype.topicClassValue.description=A topic or subject term
 datasetfieldtype.topicClassVocab.description=The controlled vocabulary used for the keyword term (e.g. LCSH, MeSH)
 datasetfieldtype.topicClassVocabURI.description=The URL where one can access information about the term's controlled vocabulary
+datasetfieldtype.topicClassTermURI.description=A URI that points to the web presence of the Topic Classification Term
 datasetfieldtype.publication.description=The article or report that uses the data in the Dataset. The full list of related publications will be displayed on the metadata tab
 datasetfieldtype.publicationRelationType.description=The nature of the relationship between this Dataset and the related publication
 datasetfieldtype.publicationCitation.description=The full bibliographic citation for the related publication
@@ -190,6 +192,7 @@ datasetfieldtype.topicClassification.watermark=
 datasetfieldtype.topicClassValue.watermark=
 datasetfieldtype.topicClassVocab.watermark=
 datasetfieldtype.topicClassVocabURI.watermark=https://
+datasetfieldtype.topicClassTermURI.watermark=https://
 datasetfieldtype.publication.watermark=
 datasetfieldtype.publicationRelationType.watermark=
 datasetfieldtype.publicationCitation.watermark=

src/test/java/edu/harvard/iq/dataverse/export/ddi/dataset-finch-terms-of-use.json

@@ -300,8 +300,8 @@
                   "typeClass": "primitive",
                   "value": "TC Vocabulary"
                 },
-                "topicClassVocabURI": {
-                  "typeName": "topicClassVocabURI",
+                "topicClassTermURI": {
+                  "typeName": "topicClassTermURI",
                   "multiple": false,
                   "typeClass": "primitive",
                   "value": "http://www.topicClass.com/one"

src/test/java/edu/harvard/iq/dataverse/export/ddi/dataset-finch1.json

@@ -304,8 +304,8 @@
                   "typeClass": "primitive",
                   "value": "TC Vocabulary"
                 },
-                "topicClassVocabURI": {
-                  "typeName": "topicClassVocabURI",
+                "topicClassTermURI": {
+                  "typeName": "topicClassTermURI",
                   "multiple": false,
                   "typeClass": "primitive",
                   "value": "http://www.topicClass.com/one"