From b9f05fc452f9fa810b1e347a5a4d0a6a7938b67d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Tue, 1 Jun 2021 12:31:07 +0200 Subject: [PATCH 01/23] release hotfix (#2895) --- package-lock.json | 2 +- package.json | 2 +- pom.xml | 2 +- src/main/webapp/scripts/app.constants.js | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 6fb71a27e2..cd05533a40 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "Metadatamanagement", - "version": "1.0.110-HOTFIX", + "version": "1.0.111-SNAPSHOT", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 9ddc55b2e7..4ca7119e77 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "Metadatamanagement", - "version": "1.0.110-HOTFIX", + "version": "1.0.111-SNAPSHOT", "description": "Data Search for Higher Education Research and Science Studies", "private": true, "dependencies": { diff --git a/pom.xml b/pom.xml index f4adecc278..0fa6db432c 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ eu.dzhw.fdz metadatamanagement - 1.0.110-HOTFIX + 1.0.111-SNAPSHOT war metadatamanagement diff --git a/src/main/webapp/scripts/app.constants.js b/src/main/webapp/scripts/app.constants.js index 79cf693bf3..0212f44f5e 100644 --- a/src/main/webapp/scripts/app.constants.js +++ b/src/main/webapp/scripts/app.constants.js @@ -6,7 +6,7 @@ angular.module('metadatamanagementApp') .constant('ENV', 'local') -.constant('VERSION', '1.0.110-HOTFIX') +.constant('VERSION', '1.0.111-SNAPSHOT') .constant('ElasticSearchProperties', {apiVersion:'7.x',logLevel:'error',pageSize:10}) From 3ed32167e492951a16f7da9b27b2f197ab305609 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Tue, 1 Jun 2021 13:22:36 +0200 Subject: [PATCH 02/23] add delay before capturing with seo4ajax (#2893) --- src/main/webapp/scripts/app.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/main/webapp/scripts/app.js b/src/main/webapp/scripts/app.js index 805ef6e002..44ed56c68d 100644 --- a/src/main/webapp/scripts/app.js +++ b/src/main/webapp/scripts/app.js @@ -182,7 +182,9 @@ try { $timeout(function() { $browser.notifyWhenNoOutstandingRequests(function() { if (window.onCaptureReady) { - window.onCaptureReady(); + $timeout(function() { + window.onCaptureReady(); + }, 1000); } }); }, 1000); From bb6c40eac5df2d7aa6efaab6b4c48f74dc6d4b01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Tue, 1 Jun 2021 13:38:48 +0200 Subject: [PATCH 03/23] Revert "add delay before capturing with seo4ajax (#2893)" This reverts commit 3ed32167e492951a16f7da9b27b2f197ab305609. --- src/main/webapp/scripts/app.js | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/main/webapp/scripts/app.js b/src/main/webapp/scripts/app.js index 44ed56c68d..805ef6e002 100644 --- a/src/main/webapp/scripts/app.js +++ b/src/main/webapp/scripts/app.js @@ -182,9 +182,7 @@ try { $timeout(function() { $browser.notifyWhenNoOutstandingRequests(function() { if (window.onCaptureReady) { - $timeout(function() { - window.onCaptureReady(); - }, 1000); + window.onCaptureReady(); } }); }, 1000); From acbb570273faacb46e14b1b9b008714a3276ffb4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 7 Jun 2021 22:15:26 +0000 Subject: [PATCH 04/23] Bump glob-parent from 5.1.1 to 5.1.2 Bumps [glob-parent](https://github.com/gulpjs/glob-parent) from 5.1.1 to 5.1.2. - [Release notes](https://github.com/gulpjs/glob-parent/releases) - [Changelog](https://github.com/gulpjs/glob-parent/blob/main/CHANGELOG.md) - [Commits](https://github.com/gulpjs/glob-parent/compare/v5.1.1...v5.1.2) --- updated-dependencies: - dependency-name: glob-parent dependency-type: indirect ... Signed-off-by: dependabot[bot] --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index cd05533a40..30bc39204b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6217,9 +6217,9 @@ } }, "glob-parent": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz", - "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==", + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, "requires": { "is-glob": "^4.0.1" From 9de276b6f822d71f6326bff7f85a856292b5635a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Wed, 9 Jun 2021 15:25:29 +0200 Subject: [PATCH 05/23] change 'sponsor' to 'sponsors' (#2890) --- .../domain/DataPackage.rst | 10 +- .../domain/DataPackage.java | 30 +- .../DataPackageSubDocumentProjection.java | 2 +- .../documents/DataPackageSearchDocument.java | 2 + .../documents/DataPackageSubDocument.java | 2 +- .../elasticsearch/data_packages/mapping.json | 29 +- .../elasticsearch/data_sets/mapping.json | 2 +- .../elasticsearch/indices_version.json | 2 +- .../elasticsearch/instruments/mapping.json | 2 +- .../elasticsearch/questions/mapping.json | 2 +- .../elasticsearch/surveys/mapping.json | 2 +- .../elasticsearch/variables/mapping.json | 2 +- .../templates/dara/register.xml.tmpl | 10 +- .../concept-edit-or-create.controller.js | 74 +---- .../configuration/translations-de.js | 15 +- .../configuration/translations-en.js | 5 + .../services/dataPackageSearch.service.js | 88 ++++-- .../templates/common-details.html.tmpl | 6 +- .../data-package-edit-or-create.controller.js | 261 +++++++----------- .../data-package-edit-or-create.html.tmpl | 187 +++++++++---- .../components/searchfilter.controller.js | 2 +- .../searchmanagement/configuration/search.js | 2 +- .../configuration/translations-de.js | 2 +- .../configuration/translations-en.js | 2 +- .../services/searchHelper.service.js | 34 +-- .../views/search.controller.js | 8 +- .../util/UnitTestCreateDomainObjectUtils.java | 4 +- .../Create_Data_Package.robot | 4 +- ...hers Metadata Deleting Access Rights.robot | 4 +- 29 files changed, 399 insertions(+), 396 deletions(-) diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.rst index a03503a46b..7478c56876 100644 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.rst +++ b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.rst @@ -126,7 +126,7 @@ institutions .. java:field:: @NotEmpty private List institutions :outertype: DataPackage - The names of the institutions which have performed this dataPackage. It must be specified in German and English and it must not contain more than 512 characters. + The names of the institutions which have performed the study from which this data package results. It must be specified in German and English and it must not contain more than 512 characters. masterId ^^^^^^^^ @@ -150,13 +150,13 @@ serialVersionUID .. java:field:: private static final long serialVersionUID :outertype: DataPackage -sponsor -^^^^^^^ +sponsors +^^^^^^^^ -.. java:field:: @NotNull @I18nStringSize @I18nStringEntireNotEmpty private I18nString sponsor +.. java:field:: @NotEmpty private List sponsors :outertype: DataPackage - The name of the sponsor who which has sponsored this dataPackage. It must be specified in German and English and it must not contain more than 512 characters. + The names of the sponsors which have sponsored the study or project from which this data package results. It must be specified in German and English and it must not contain more than 512 characters. studySeries ^^^^^^^^^^^ diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.java index d4fc707609..cae12c3106 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.java @@ -121,16 +121,17 @@ public class DataPackage extends AbstractShadowableRdcDomainObject private I18nString description; /** - * The names of the institutions which have performed this dataPackage. + * The names of the institutions which have performed the study from which this data package + * results. * * It must be specified in German and English and it must not contain more than 512 characters. */ @NotEmpty(message = "data-package-management.error.data-package.institutions.not-null") private List<@I18nStringSize(max = StringLengths.MEDIUM, - message = "data-package-management.error.data-package.institution.i18n-string-size") - @I18nStringEntireNotEmpty(message = "data-package-management.error.data-package.institution" - + ".i18n-string-entire-not-empty") - I18nString> institutions; + message = "data-package-management.error.data-package.institution.i18n-string-size") + @I18nStringEntireNotEmpty( + message = "data-package-management.error.data-package.institution" + + ".i18n-string-entire-not-empty") I18nString> institutions; /** * The name of the series of dataPackages to which this dataPackage belongs. @@ -142,23 +143,24 @@ public class DataPackage extends AbstractShadowableRdcDomainObject message = "data-package-management.error.data-package.study-series.i18n-string-size") @I18nStringEntireNotEmptyOptional( message = "data-package-management.error.data-package.study-series" - + ".i18n-string-entire-not-empty-optional") + + ".i18n-string-entire-not-empty-optional") @I18nStringMustNotContainComma( message = "data-package-management.error.data-package.study-series." - + "i18n-string-must-not-contain-comma") + + "i18n-string-must-not-contain-comma") private I18nString studySeries; /** - * The name of the sponsor who which has sponsored this dataPackage. + * The names of the sponsors which have sponsored the study or project from which this data + * package results. * * It must be specified in German and English and it must not contain more than 512 characters. */ - @NotNull(message = "data-package-management.error.data-package.sponsor.not-null") - @I18nStringSize(max = StringLengths.MEDIUM, - message = "data-package-management.error.data-package.sponsor.i18n-string-size") - @I18nStringEntireNotEmpty( - message = "data-package-management.error.data-package.sponsor.i18n-string-entire-not-empty") - private I18nString sponsor; + @NotEmpty(message = "data-package-management.error.data-package.sponsors.not-null") + private List<@I18nStringSize(max = StringLengths.MEDIUM, + message = "data-package-management.error.data-package.sponsor.i18n-string-size") + @I18nStringEntireNotEmpty( + message = "data-package-management.error.sponsor.institution" + + ".i18n-string-entire-not-empty") I18nString> sponsors; /** * List of {@link Person}s which have performed this dataPackage. diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/projection/DataPackageSubDocumentProjection.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/projection/DataPackageSubDocumentProjection.java index bf2ab3c9da..061460e86f 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/projection/DataPackageSubDocumentProjection.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/projection/DataPackageSubDocumentProjection.java @@ -22,7 +22,7 @@ public interface DataPackageSubDocumentProjection List getInstitutions(); - I18nString getSponsor(); + List getSponsors(); List getProjectContributors(); diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSearchDocument.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSearchDocument.java index bb969ca1e0..814faaf55d 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSearchDocument.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSearchDocument.java @@ -65,6 +65,7 @@ public class DataPackageSearchDocument extends DataPackage implements SearchDocu private List nestedConcepts = new ArrayList<>(); private List nestedInstitutions = new ArrayList<>(); + private List nestedSponsors = new ArrayList<>(); private Release release = null; @@ -153,6 +154,7 @@ public DataPackageSearchDocument(DataPackage dataPackage, .collect(Collectors.toList()); } this.nestedInstitutions = dataPackage.getInstitutions(); + this.nestedSponsors = dataPackage.getSponsors(); this.release = release; this.configuration = configuration; this.doi = doi; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSubDocument.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSubDocument.java index d14965c9f3..3a0c17babf 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSubDocument.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSubDocument.java @@ -34,7 +34,7 @@ public class DataPackageSubDocument extends AbstractRdcDomainObject private List institutions; - private I18nString sponsor; + private List sponsors; private I18nString studySeries; diff --git a/src/main/resources/elasticsearch/data_packages/mapping.json b/src/main/resources/elasticsearch/data_packages/mapping.json index ffec62ebda..f3e2435ceb 100644 --- a/src/main/resources/elasticsearch/data_packages/mapping.json +++ b/src/main/resources/elasticsearch/data_packages/mapping.json @@ -225,7 +225,7 @@ } } }, - "sponsor": { + "sponsors": { "type": "object", "properties": { "de": { @@ -310,6 +310,33 @@ } } }, + "nestedSponsors": { + "type": "nested", + "properties": { + "de": { + "type": "keyword", + "norms": false, + "fields": { + "ngrams": { + "type": "text", + "analyzer": "ngrams", + "norms": false + } + } + }, + "en": { + "type": "keyword", + "norms": false, + "fields": { + "ngrams": { + "type": "text", + "analyzer": "ngrams", + "norms": false + } + } + } + } + }, "projectContributors": { "type": "object", "properties": { diff --git a/src/main/resources/elasticsearch/data_sets/mapping.json b/src/main/resources/elasticsearch/data_sets/mapping.json index 5bc0e941a9..f3275076ce 100644 --- a/src/main/resources/elasticsearch/data_sets/mapping.json +++ b/src/main/resources/elasticsearch/data_sets/mapping.json @@ -259,7 +259,7 @@ } } }, - "sponsor": { + "sponsors": { "type": "object", "properties": { "de": { diff --git a/src/main/resources/elasticsearch/indices_version.json b/src/main/resources/elasticsearch/indices_version.json index a0d5eb8f32..94f1d8b52a 100644 --- a/src/main/resources/elasticsearch/indices_version.json +++ b/src/main/resources/elasticsearch/indices_version.json @@ -1,3 +1,3 @@ { - "indicesVersion": "202103291500" + "indicesVersion": "202106091000" } diff --git a/src/main/resources/elasticsearch/instruments/mapping.json b/src/main/resources/elasticsearch/instruments/mapping.json index 67b0906a47..caae369e39 100644 --- a/src/main/resources/elasticsearch/instruments/mapping.json +++ b/src/main/resources/elasticsearch/instruments/mapping.json @@ -304,7 +304,7 @@ } } }, - "sponsor": { + "sponsors": { "type": "object", "properties": { "de": { diff --git a/src/main/resources/elasticsearch/questions/mapping.json b/src/main/resources/elasticsearch/questions/mapping.json index b87abc86c9..8a9f8aa62a 100644 --- a/src/main/resources/elasticsearch/questions/mapping.json +++ b/src/main/resources/elasticsearch/questions/mapping.json @@ -256,7 +256,7 @@ } } }, - "sponsor": { + "sponsors": { "type": "object", "properties": { "de": { diff --git a/src/main/resources/elasticsearch/surveys/mapping.json b/src/main/resources/elasticsearch/surveys/mapping.json index 8ae956bc5b..aa0b7f0c77 100644 --- a/src/main/resources/elasticsearch/surveys/mapping.json +++ b/src/main/resources/elasticsearch/surveys/mapping.json @@ -324,7 +324,7 @@ } } }, - "sponsor": { + "sponsors": { "type": "object", "properties": { "de": { diff --git a/src/main/resources/elasticsearch/variables/mapping.json b/src/main/resources/elasticsearch/variables/mapping.json index 82f3c115a6..cbbedd039e 100644 --- a/src/main/resources/elasticsearch/variables/mapping.json +++ b/src/main/resources/elasticsearch/variables/mapping.json @@ -414,7 +414,7 @@ } } }, - "sponsor": { + "sponsors": { "type": "object", "properties": { "de": { diff --git a/src/main/resources/templates/dara/register.xml.tmpl b/src/main/resources/templates/dara/register.xml.tmpl index 98a876f3e9..655b5392ac 100644 --- a/src/main/resources/templates/dara/register.xml.tmpl +++ b/src/main/resources/templates/dara/register.xml.tmpl @@ -225,17 +225,19 @@ - <#if dataPackage.sponsor??> + <#if dataPackage.sponsors??> + <#list dataPackage.sponsors as sponsor> - <#if dataPackage.sponsor.de??> - ${dataPackage.sponsor.de} + <#if sponsor.de??> + ${sponsor.de} <#else> - ${dataPackage.sponsor.en} + ${sponsor.en} + diff --git a/src/main/webapp/scripts/conceptmanagement/views/concept-edit-or-create.controller.js b/src/main/webapp/scripts/conceptmanagement/views/concept-edit-or-create.controller.js index 4d6718f5c0..cab877e4a9 100644 --- a/src/main/webapp/scripts/conceptmanagement/views/concept-edit-or-create.controller.js +++ b/src/main/webapp/scripts/conceptmanagement/views/concept-edit-or-create.controller.js @@ -1,9 +1,9 @@ -/* global _, $, document */ +/* global _*/ 'use strict'; angular.module('metadatamanagementApp') .controller('ConceptEditOrCreateController', - function(entity, PageMetadataService, $document, $timeout, + function(entity, PageMetadataService, $timeout, $state, BreadcrumbService, Principal, SimpleMessageToastService, ConceptResource, ConceptSearchService, $scope, $q, ElasticSearchAdminService, $transitions, @@ -103,50 +103,6 @@ angular.module('metadatamanagementApp') } }; - ctrl.deleteAuthor = function(index) { - ctrl.concept.authors.splice(index, 1); - $scope.conceptForm.$setDirty(); - }; - - ctrl.addAuthor = function() { - ctrl.concept.authors.push({ - firstName: '', - lastName: '' - }); - $timeout(function() { - $document.find('input[name="authorsFirstName_' + - (ctrl.concept.authors.length - 1) + '"]') - .focus(); - }); - }; - - ctrl.setCurrentAuthor = function(index, event) { - ctrl.currentAuthorInputName = event.target.name; - ctrl.currentAuthorIndex = index; - }; - - var timeoutActive = null; - ctrl.deleteCurrentAuthor = function(event) { - if (timeoutActive) { - $timeout.cancel(timeoutActive); - } - timeoutActive = $timeout(function() { - timeoutActive = false; - // msie workaround: inputs unfocus on button mousedown - if (document.activeElement && - $(document.activeElement).parents('#move-container').length) { - return; - } - if (event.relatedTarget && ( - event.relatedTarget.id === 'move-author-up-button' || - event.relatedTarget.id === 'move-author-down-button')) { - return; - } - delete ctrl.currentAuthorIndex; - timeoutActive = null; - }, 500); - }; - var getDialogLabels = function() { return { createTitle: { @@ -169,32 +125,6 @@ angular.module('metadatamanagementApp') }; }; - ctrl.moveCurrentAuthorUp = function() { - var a = ctrl.concept.authors[ctrl.currentAuthorIndex - 1]; - ctrl.concept.authors[ctrl.currentAuthorIndex - 1] = - ctrl.concept.authors[ctrl.currentAuthorIndex]; - ctrl.concept.authors[ctrl.currentAuthorIndex] = a; - ctrl.currentAuthorInputName = ctrl.currentAuthorInputName - .replace('_' + ctrl.currentAuthorIndex, - '_' + (ctrl.currentAuthorIndex - 1)); - $document.find('input[name="' + ctrl.currentAuthorInputName + '"]') - .focus(); - $scope.conceptForm.$setDirty(); - }; - - ctrl.moveCurrentAuthorDown = function() { - var a = ctrl.concept.authors[ctrl.currentAuthorIndex + 1]; - ctrl.concept.authors[ctrl.currentAuthorIndex + 1] = - ctrl.concept.authors[ctrl.currentAuthorIndex]; - ctrl.concept.authors[ctrl.currentAuthorIndex] = a; - ctrl.currentAuthorInputName = ctrl.currentAuthorInputName - .replace('_' + ctrl.currentAuthorIndex, - '_' + (ctrl.currentAuthorIndex + 1)); - $document.find('input[name="' + ctrl.currentAuthorInputName + '"]') - .focus(); - $scope.conceptForm.$setDirty(); - }; - ctrl.saveConcept = function() { if ($scope.conceptForm.$valid) { ctrl.concept.$save() diff --git a/src/main/webapp/scripts/datapackagemanagement/configuration/translations-de.js b/src/main/webapp/scripts/datapackagemanagement/configuration/translations-de.js index 09a8bc257e..5f10440adf 100644 --- a/src/main/webapp/scripts/datapackagemanagement/configuration/translations-de.js +++ b/src/main/webapp/scripts/datapackagemanagement/configuration/translations-de.js @@ -154,9 +154,9 @@ angular.module('metadatamanagementApp').config( 'i18n-string-entire-not-empty': 'Die Institution eines Datenpakets muss in beiden Sprachen vorhanden sein.' }, 'sponsor': { - 'not-null': 'Der Sponsor eines Datenpakets darf nicht leer sein!', - 'i18n-string-size': 'Die Maximallänge des Sponsors eines Datenpakets ist 512 Zeichen.', - 'i18n-string-entire-not-empty': 'Der Sponsor eines Datenpakets muss in beiden Sprachen vorhanden sein.' + 'not-null': 'Die Geldgeber:in eines Datenpakets darf nicht leer sein!', + 'i18n-string-size': 'Die Maximallänge der Geldgeber:in eines Datenpakets ist 512 Zeichen.', + 'i18n-string-entire-not-empty': 'Die Geldgeber:in eines Datenpakets muss in beiden Sprachen vorhanden sein.' }, 'study-series': { 'i18n-string-size': 'Die Maximallänge der Studienreihe ist 512 Zeichen.', @@ -215,6 +215,7 @@ angular.module('metadatamanagementApp').config( 'tags': 'Tags (Schlagwörter) zum Datenpaket', 'publication-year': 'Jahr der Veröffentlichung', 'institution': 'Institution', + 'sponsor': 'Geldgeber:in', 'location': 'Ort' }, 'open-choose-previous-version-tooltip': 'Klicken, um eine ältere Version dieses Datenpakets wieder herzustellen.', @@ -235,6 +236,10 @@ angular.module('metadatamanagementApp').config( 'move-institution-down-tooltip': 'Klicken, um die ausgewählte Institution nach unten zu verschieben.', 'add-institution-tooltip': 'Klicken, um eine weitere Institution diesem Datenpaket hinzuzufügen.', 'delete-institution-tooltip': 'Klicken, um die Institution aus diesem Datenpaket zu entfernen.', + 'move-sponsor-up-tooltip': 'Klicken, um die ausgewählte Geldgeber:in nach oben zu verschieben.', + 'move-sponsor-down-tooltip': 'Klicken, um die ausgewählte Geldgeber:in nach unten zu verschieben.', + 'add-sponsor-tooltip': 'Klicken, um eine weitere Geldgeber:in diesem Datenpaket hinzuzufügen.', + 'delete-sponsor-tooltip': 'Klicken, um die Geldgeber:in aus diesem Datenpaket zu entfernen.', 'choose-previous-version': { 'next-page-tooltip': 'Klicken, um ältere Versionen anzuzeigen.', 'previous-page-tooltip': 'Klicken, um aktuellere Versionen anzuzeigen.', @@ -258,8 +263,8 @@ angular.module('metadatamanagementApp').config( 'en': 'Geben Sie den englischen Namen der Institution ein, die die Erhebungen durchgeführt hat.' }, 'sponsor': { - 'de': 'Geben Sie den deutschen Namen des Geldgebers für dieses Datenpaket ein.', - 'en': 'Geben Sie den englischen Namen des Geldgebers für dieses Datenpaket ein.' + 'de': 'Geben Sie den deutschen Namen der Geldgeber:in für dieses Datenpaket ein.', + 'en': 'Geben Sie den englischen Namen der Geldgeber:in für dieses Datenpaket ein.' }, 'survey-design': 'Wählen Sie das Erhebungsdesign dieses Datenpakets aus.', 'annotations': { diff --git a/src/main/webapp/scripts/datapackagemanagement/configuration/translations-en.js b/src/main/webapp/scripts/datapackagemanagement/configuration/translations-en.js index 25dbc67c56..124168dc97 100644 --- a/src/main/webapp/scripts/datapackagemanagement/configuration/translations-en.js +++ b/src/main/webapp/scripts/datapackagemanagement/configuration/translations-en.js @@ -215,6 +215,7 @@ angular.module('metadatamanagementApp').config( 'tags': 'Tags (Keywords) for the Data Package', 'publication-year': 'Year of Publication', 'institution': 'Institution', + 'sponsor': 'Sponsor', 'location': 'Location' }, 'open-choose-previous-version-tooltip': 'Click for restoring a previous version of this data package.', @@ -235,6 +236,10 @@ angular.module('metadatamanagementApp').config( 'move-institution-down-tooltip': 'Click to move the selected institution down.', 'add-institution-tooltip': 'Click to add another institution to this data package.', 'delete-institution-tooltip': 'Click to remove the institution from this data package.', + 'move-sponsor-up-tooltip': 'Click to move the selected sponsor up.', + 'move-sponsor-down-tooltip': 'Click to move the selected sponsor down.', + 'add-sponsor-tooltip': 'Click to add another sponsor to this data package.', + 'delete-sponsor-tooltip': 'Click to remove the sponsor from this data package.', 'choose-previous-version': { 'title': 'Restore Previous Version of Data Package {{ dataPackageId }}', 'text': 'Choose a previous version of this data package which shall be restored:', diff --git a/src/main/webapp/scripts/datapackagemanagement/services/dataPackageSearch.service.js b/src/main/webapp/scripts/datapackagemanagement/services/dataPackageSearch.service.js index d46e9d2f99..dec04b3976 100644 --- a/src/main/webapp/scripts/datapackagemanagement/services/dataPackageSearch.service.js +++ b/src/main/webapp/scripts/datapackagemanagement/services/dataPackageSearch.service.js @@ -317,7 +317,7 @@ angular.module('metadatamanagementApp').factory('DataPackageSearchService', }; var findSponsors = function(searchText, filter, language, - ignoreAuthorization) { + ignoreAuthorization, excludedSponsors) { ignoreAuthorization = ignoreAuthorization || false; language = language || LanguageService.getCurrentInstantly(); var query = createQueryObject(); @@ -325,16 +325,34 @@ angular.module('metadatamanagementApp').factory('DataPackageSearchService', query.size = 0; query.body = { 'aggs': { - 'sponsorDe': { - 'terms': { - 'field': 'sponsor.de', - 'size': 100 + 'sponsors': { + 'nested': { + 'path': 'nestedSponsors' }, 'aggs': { - 'sponsorEn': { - 'terms': { - 'field': 'sponsor.en', - 'size': 100 + 'filtered': { + 'filter': { + 'bool': { + 'must': [{ + 'match': {} + }] + } + }, + 'aggs': { + 'sponsorDe': { + 'terms': { + 'field': 'nestedSponsors.de', + 'size': 100 + }, + 'aggs': { + 'sponsorEn': { + 'terms': { + 'field': 'nestedSponsors.en', + 'size': 100 + } + } + } + } } } } @@ -344,32 +362,40 @@ angular.module('metadatamanagementApp').factory('DataPackageSearchService', query.body.query = { 'bool': { - 'must': [{ - 'match': {} - }] + 'filter': { + 'term': { + 'shadow': false + } + } } }; - query.body.query.bool.must[0].match - ['sponsor.' + language + '.ngrams'] = { + query.body.aggs.sponsors.aggs.filtered.filter.bool.must[0].match + ['nestedSponsors.' + language + '.ngrams'] = { 'query': searchText || '', 'operator': 'AND', 'minimum_should_match': '100%', 'zero_terms_query': 'ALL' }; + if (excludedSponsors && excludedSponsors.length > 0) { + query.body.aggs.sponsors.aggs.filtered.filter.bool.must_not = []; + excludedSponsors.forEach(function(sponsor) { + if (sponsor) { + query.body.aggs.sponsors.aggs.filtered.filter.bool.must_not + .push({ + 'term': { + 'nestedSponsors.de': sponsor.de + } + }); + } + }); + } + if (termFilters) { query.body.query.bool.filter = termFilters; - } else { - query.body.query.bool.filter = []; } - query.body.query.bool.filter.push({ - 'term': { - 'shadow': false - } - }); - if (!ignoreAuthorization) { SearchHelperService.addFilter(query); } @@ -377,13 +403,15 @@ angular.module('metadatamanagementApp').factory('DataPackageSearchService', return ElasticSearchClient.search(query).then(function(result) { var sponsors = []; var sponsorElement = {}; - result.aggregations.sponsorDe.buckets.forEach(function(bucket) { - sponsorElement = { - 'de': bucket.key, - 'en': bucket.sponsorEn.buckets[0].key - }; - sponsors.push(sponsorElement); - }); + result.aggregations.sponsors.filtered.sponsorDe.buckets.forEach( + function(bucket) { + sponsorElement = { + 'de': bucket.key, + 'en': bucket.sponsorEn.buckets[0].key + }; + sponsorElement.count = bucket.doc_count; + sponsors.push(sponsorElement); + }); return sponsors; }); }; @@ -526,7 +554,7 @@ angular.module('metadatamanagementApp').factory('DataPackageSearchService', type, queryTerm, dataAcquisitionProjectId, - 'sponsor' + 'sponsors' ); return GenericFilterOptionsSearchService.findFilterOptions(searchConfig); diff --git a/src/main/webapp/scripts/datapackagemanagement/templates/common-details.html.tmpl b/src/main/webapp/scripts/datapackagemanagement/templates/common-details.html.tmpl index 9e289991da..8ec1d7bb9a 100644 --- a/src/main/webapp/scripts/datapackagemanagement/templates/common-details.html.tmpl +++ b/src/main/webapp/scripts/datapackagemanagement/templates/common-details.html.tmpl @@ -40,11 +40,11 @@ class="md-secondary" style="white-space: pre-wrap;" ng-repeat="institution in $ctrl.options.dataPackage.institutions">{{institution[$ctrl.lang]}}{{!$last?'; ':''}} - +
{{'data-package-management.detail.label.sponsors' | translate }}:
+ class="md-secondary" style="white-space: pre-wrap;" + ng-repeat="sponsor in $ctrl.options.dataPackage.sponsors">{{sponsor[$ctrl.lang]}}{{!$last?'; ':''}}
{{'data-package-management.detail.label.projectContributors' | translate }}:
diff --git a/src/main/webapp/scripts/datapackagemanagement/views/data-package-edit-or-create.controller.js b/src/main/webapp/scripts/datapackagemanagement/views/data-package-edit-or-create.controller.js index 153d5dff4d..2b3442ad43 100644 --- a/src/main/webapp/scripts/datapackagemanagement/views/data-package-edit-or-create.controller.js +++ b/src/main/webapp/scripts/datapackagemanagement/views/data-package-edit-or-create.controller.js @@ -16,8 +16,8 @@ angular.module('metadatamanagementApp') var ctrl = this; var studySeriesCache = {}; - var sponsorsCache = {}; ctrl.currentInstitutions = []; + ctrl.currentSponsors = []; var attachmentTypes = [ {de: 'Daten- und Methodenbericht', en: 'Method Report'}, {de: 'Sonstiges', en: 'Other'} @@ -138,7 +138,8 @@ angular.module('metadatamanagementApp') CurrentProjectService.setCurrentProject(project); ctrl.dataPackage = dataPackage; ctrl.currentStudySeries = dataPackage.studySeries; - ctrl.currentSponsor = dataPackage.sponsor; + ctrl.currentSponsors = angular.copy( + ctrl.dataPackage.sponsors); ctrl.currentInstitutions = angular.copy( ctrl.dataPackage.institutions); ctrl.loadAttachments(); @@ -188,9 +189,14 @@ angular.module('metadatamanagementApp') institutions: [{ de: '', en: '' + }], + sponsors: [{ + de: '', + en: '' }] }); ctrl.currentInstitutions = new Array(1); + ctrl.currentSponsors = new Array(1); updateToolbarHeaderAndPageTitle(); $scope.registerConfirmOnDirtyHook(); }); @@ -213,158 +219,6 @@ angular.module('metadatamanagementApp') en: 'Cross-Section' }]; - ctrl.deleteProjectContributor = function(index) { - ctrl.dataPackage.projectContributors.splice(index, 1); - $scope.dataPackageForm.$setDirty(); - }; - - ctrl.addProjectContributor = function() { - ctrl.dataPackage.projectContributors.push({ - firstName: '', - lastName: '' - }); - $timeout(function() { - $document.find('input[name="projectContributorsFirstName_' + - (ctrl.dataPackage.projectContributors.length - 1) + '"]') - .focus(); - }); - }; - - ctrl.setCurrentProjectContributor = function(index, event) { - ctrl.currentProjectContributorInputName = event.target.name; - ctrl.currentProjectContributorIndex = index; - }; - - var timeoutActive = null; - ctrl.deleteCurrentProjectContributor = function(event) { - if (timeoutActive) { - $timeout.cancel(timeoutActive); - } - timeoutActive = $timeout(function() { - timeoutActive = false; - // msie workaround: inputs unfocus on button mousedown - if (document.activeElement && - $(document.activeElement).parents('#move-container').length) { - return; - } - if (event.relatedTarget && ( - event.relatedTarget.id === 'move-contributor-up-button' || - event.relatedTarget.id === 'move-contributor-down-button')) { - return; - } - delete ctrl.currentProjectContributorIndex; - timeoutActive = null; - }, 500); - }; - - ctrl.moveCurrentProjectContributorUp = function() { - var a = ctrl.dataPackage.projectContributors[ - ctrl.currentProjectContributorIndex - 1]; - ctrl.dataPackage.projectContributors[ - ctrl.currentProjectContributorIndex - 1] = - ctrl.dataPackage.projectContributors[ - ctrl.currentProjectContributorIndex]; - ctrl.dataPackage.projectContributors[ - ctrl.currentProjectContributorIndex] = a; - ctrl.currentProjectContributorInputName = ctrl - .currentProjectContributorInputName - .replace('_' + ctrl.currentProjectContributorIndex, - '_' + (ctrl.currentProjectContributorIndex - 1)); - $document.find('input[name="' + - ctrl.currentProjectContributorInputName + '"]') - .focus(); - $scope.dataPackageForm.$setDirty(); - }; - - ctrl.moveCurrentProjectContributorDown = function() { - var a = ctrl.dataPackage.projectContributors[ - ctrl.currentProjectContributorIndex + 1]; - ctrl.dataPackage.projectContributors[ - ctrl.currentProjectContributorIndex + 1] = - ctrl.dataPackage.projectContributors[ - ctrl.currentProjectContributorIndex]; - ctrl.dataPackage.projectContributors[ - ctrl.currentProjectContributorIndex] = a; - ctrl.currentProjectContributorInputName = ctrl - .currentProjectContributorInputName - .replace('_' + ctrl.currentProjectContributorIndex, - '_' + (ctrl.currentProjectContributorIndex + 1)); - $document.find('input[name="' + - ctrl.currentProjectContributorInputName + '"]') - .focus(); - $scope.dataPackageForm.$setDirty(); - }; - - ctrl.deleteCurator = function(index) { - ctrl.dataPackage.dataCurators.splice(index, 1); - $scope.dataPackageForm.$setDirty(); - }; - - ctrl.addCurator = function() { - ctrl.dataPackage.dataCurators.push({ - firstName: '', - lastName: '' - }); - $timeout(function() { - $document.find('input[name="curatorsFirstName_' + - (ctrl.dataPackage.dataCurators.length - 1) + '"]') - .focus(); - }); - }; - - ctrl.setCurrentCurator = function(index, event) { - ctrl.currentCuratorInputName = event.target.name; - ctrl.currentCuratorIndex = index; - }; - - ctrl.deleteCurrentCurator = function(event) { - if (timeoutActive) { - $timeout.cancel(timeoutActive); - } - timeoutActive = $timeout(function() { - timeoutActive = false; - // msie workaround: inputs unfocus on button mousedown - if (document.activeElement && - $(document.activeElement).parents('#move-curators-container') - .length) { - return; - } - if (event.relatedTarget && ( - event.relatedTarget.id === 'move-curator-up-button' || - event.relatedTarget.id === 'move-curator-down-button')) { - return; - } - delete ctrl.currentCuratorIndex; - timeoutActive = null; - }, 500); - }; - - ctrl.moveCurrentCuratorUp = function() { - var a = ctrl.dataPackage.dataCurators[ctrl.currentCuratorIndex - 1]; - ctrl.dataPackage.dataCurators[ctrl.currentCuratorIndex - 1] = - ctrl.dataPackage.dataCurators[ctrl.currentCuratorIndex]; - ctrl.dataPackage.dataCurators[ctrl.currentCuratorIndex] = a; - ctrl.currentCuratorInputName = ctrl.currentCuratorInputName - .replace('_' + ctrl.currentCuratorIndex, - '_' + (ctrl.currentCuratorIndex - 1)); - $document.find('input[name="' + ctrl.currentCuratorInputName + '"]') - .focus(); - $scope.dataPackageForm.$setDirty(); - }; - - ctrl.moveCurrentCuratorDown = function() { - var a = ctrl.dataPackage.dataCurators[ctrl.currentCuratorIndex + 1]; - ctrl.dataPackage.dataCurators[ctrl.currentCuratorIndex + 1] = - ctrl.dataPackage.dataCurators[ctrl.currentCuratorIndex]; - ctrl.dataPackage.dataCurators[ctrl.currentCuratorIndex] = a; - ctrl.currentCuratorInputName = ctrl.currentCuratorInputName - .replace('_' + ctrl.currentCuratorIndex, - '_' + (ctrl.currentCuratorIndex + 1)); - $document.find('input[name="' + ctrl.currentCuratorInputName + '"]') - .focus(); - $scope.dataPackageForm.$setDirty(); - }; - ctrl.deleteInstitution = function(index) { ctrl.dataPackage.institutions.splice(index, 1); ctrl.currentInstitutions.splice(index, 1); @@ -385,6 +239,8 @@ angular.module('metadatamanagementApp') ctrl.currentInstitutionIndex = index; }; + var timeoutActive = null; + ctrl.deleteCurrentInstitution = function(event) { if (timeoutActive) { $timeout.cancel(timeoutActive); @@ -441,6 +297,82 @@ angular.module('metadatamanagementApp') $scope.dataPackageForm.$setDirty(); }; + ctrl.deleteSponsor = function(index) { + ctrl.dataPackage.sponsors.splice(index, 1); + ctrl.currentSponsors.splice(index, 1); + $scope.dataPackageForm.$setDirty(); + }; + + ctrl.addSponsor = function() { + ctrl.currentSponsors.push(null); + $timeout(function() { + $document.find('input[name="sponsorDe_' + + (ctrl.dataPackage.sponsors.length - 1) + '"]') + .focus(); + }, 200); + }; + + ctrl.setCurrentSponsor = function(index, event) { + ctrl.currentSponsorInputName = event.target.name; + ctrl.currentSponsorIndex = index; + }; + + ctrl.deleteCurrentSponsor = function(event) { + if (timeoutActive) { + $timeout.cancel(timeoutActive); + } + timeoutActive = $timeout(function() { + timeoutActive = false; + // msie workaround: inputs unfocus on button mousedown + if (document.activeElement && + $(document.activeElement).parents('#move-sponsor-container') + .length) { + return; + } + if (event.relatedTarget && ( + event.relatedTarget.id === 'move-sponsor-up-button' || + event.relatedTarget.id === 'move-sponsor-down-button')) { + return; + } + delete ctrl.currentSponsorIndex; + timeoutActive = null; + }, 500); + }; + + ctrl.moveCurrentSponsorUp = function() { + var a = ctrl.dataPackage.sponsors[ctrl.currentSponsorIndex - 1]; + ctrl.dataPackage.sponsors[ctrl.currentSponsorIndex - 1] = + ctrl.dataPackage.sponsors[ctrl.currentSponsorIndex]; + ctrl.dataPackage.sponsors[ctrl.currentSponsorIndex] = a; + a = ctrl.currentSponsors[ctrl.currentSponsorIndex - 1]; + ctrl.currentSponsors[ctrl.currentSponsorIndex - 1] = + ctrl.currentSponsors[ctrl.currentSponsorIndex]; + ctrl.currentSponsors[ctrl.currentSponsorIndex] = a; + ctrl.currentSponsorInputName = ctrl.currentSponsorInputName + .replace('_' + ctrl.currentSponsorIndex, + '_' + (ctrl.currentSponsorIndex - 1)); + $document.find('input[name="' + ctrl.currentSponsorInputName + '"]') + .focus(); + $scope.dataPackageForm.$setDirty(); + }; + + ctrl.moveCurrentSponsorDown = function() { + var a = ctrl.dataPackage.sponsors[ctrl.currentSponsorIndex + 1]; + ctrl.dataPackage.sponsors[ctrl.currentSponsorIndex + 1] = + ctrl.dataPackage.sponsors[ctrl.currentSponsorIndex]; + ctrl.dataPackage.sponsors[ctrl.currentSponsorIndex] = a; + a = ctrl.currentSponsors[ctrl.currentSponsorIndex + 1]; + ctrl.currentSponsors[ctrl.currentSponsorIndex + 1] = + ctrl.currentSponsors[ctrl.currentSponsorIndex]; + ctrl.currentSponsors[ctrl.currentSponsorIndex] = a; + ctrl.currentSponsorInputName = ctrl.currentSponsorInputName + .replace('_' + ctrl.currentSponsorIndex, + '_' + (ctrl.currentSponsorIndex + 1)); + $document.find('input[name="' + ctrl.currentSponsorInputName + '"]') + .focus(); + $scope.dataPackageForm.$setDirty(); + }; + ctrl.saveDataPackage = function() { if ($scope.dataPackageForm.$valid) { if (angular.isUndefined(ctrl.dataPackage.masterId)) { @@ -556,6 +488,17 @@ angular.module('metadatamanagementApp') en: '' }]; } + if (ctrl.dataPackage.sponsors && + ctrl.dataPackage.sponsors.length > 0) { + ctrl.currentSponsors = angular.copy( + ctrl.dataPackage.sponsors); + } else { + ctrl.currentSponsors = new Array(1); + ctrl.dataPackage.sponsors = [{ + de: '', + en: '' + }]; + } if (wrapper.isCurrentVersion) { $scope.dataPackageForm.$setPristine(); SimpleMessageToastService.openSimpleMessageToast( @@ -602,18 +545,10 @@ angular.module('metadatamanagementApp') }; $scope.searchSponsors = function(searchText, language) { - if (searchText === sponsorsCache.searchText && - language === sponsorsCache.language) { - return sponsorsCache.searchResult; - } - //Search Call to Elasticsearch return DataPackageSearchService.findSponsors(searchText, {}, - language, true) + language, true, ctrl.currentSponsors) .then(function(sponsors) { - sponsorsCache.searchText = searchText; - sponsorsCache.language = language; - sponsorsCache.searchResult = sponsors; return sponsors; }); }; diff --git a/src/main/webapp/scripts/datapackagemanagement/views/data-package-edit-or-create.html.tmpl b/src/main/webapp/scripts/datapackagemanagement/views/data-package-edit-or-create.html.tmpl index 524d8f6474..486555b74d 100644 --- a/src/main/webapp/scripts/datapackagemanagement/views/data-package-edit-or-create.html.tmpl +++ b/src/main/webapp/scripts/datapackagemanagement/views/data-package-edit-or-create.html.tmpl @@ -126,67 +126,6 @@ -
- - - {{item.de}} - - - {{'search-management.filter.sponsor-filter.not-found' | translate}} - -
- {{'data-package-management.edit.hints.sponsor.de' | translate}} -
-
-
{{'data-package-management.error.data-package.sponsor.i18n-string-entire-not-empty' | - translate}} -
-
{{'data-package-management.error.data-package.sponsor.i18n-string-size' | translate}} -
-
- - - - {{item.en}} - - - {{'search-management.filter.sponsor-filter.not-found' | translate}} - -
- {{'data-package-management.edit.hints.sponsor.en' | translate}} -
-
-
{{'data-package-management.error.data-package.sponsor.i18n-string-entire-not-empty' | - translate}} -
-
{{'data-package-management.error.data-package.sponsor.i18n-string-size' | translate}} -
-
- -
+ + + +

{{'data-package-management.detail.label.sponsors' | translate }}

+ + + + +
+ + + {{'data-package-management.edit.delete-sponsor-tooltip' | translate}} + + delete_forever + + + + {{item.de}} + + + {{'search-management.filter.sponsor-filter.not-found' | translate}} + +
+ {{'data-package-management.edit.hints.sponsor.de' | translate}} +
+
+
{{'data-package-management.error.data-package.sponsor.i18n-string-entire-not-empty' | + translate}} +
+
{{'data-package-management.error.data-package.sponsor.i18n-string-size' | + translate}} +
+
+ + + + {{item.en}} + + + {{'search-management.filter.sponsor-filter.not-found' | translate}} + +
+ {{'data-package-management.edit.hints.sponsor.en' | translate}} +
+
+
{{'data-package-management.error.data-package.sponsor.i18n-string-entire-not-empty' | + translate}} +
+
{{'data-package-management.error.data-package.sponsor.i18n-string-size' | + translate}} +
+
+ +
+ + + + + {{'data-package-management.edit.add-sponsor-tooltip' | translate}} + + add + + + + {{'data-package-management.edit.move-sponsor-up-tooltip' | translate}} + + keyboard_arrow_up + + + + {{'data-package-management.edit.move-sponsor-down-tooltip' | translate}} + + keyboard_arrow_down + + + diff --git a/src/main/webapp/scripts/searchmanagement/components/searchfilter.controller.js b/src/main/webapp/scripts/searchmanagement/components/searchfilter.controller.js index defaf4dd4f..ed15666d7b 100644 --- a/src/main/webapp/scripts/searchmanagement/components/searchfilter.controller.js +++ b/src/main/webapp/scripts/searchmanagement/components/searchfilter.controller.js @@ -34,7 +34,7 @@ }, { name: 'global.filter.sponsors', - property: 'sponsor', collapsed: true + property: 'sponsors', collapsed: true }, { name: 'global.filter.institutions', diff --git a/src/main/webapp/scripts/searchmanagement/configuration/search.js b/src/main/webapp/scripts/searchmanagement/configuration/search.js index 9adb6a62b3..f961eaa11d 100644 --- a/src/main/webapp/scripts/searchmanagement/configuration/search.js +++ b/src/main/webapp/scripts/searchmanagement/configuration/search.js @@ -9,7 +9,7 @@ angular.module('metadatamanagementApp').config( '{data-set}{derived-variables-identifier}{instrument}{institution-de}' + '{institutions}{institution-en}{page}' + '{query}{question}{related-publication}' + - '{repeated-measurement-identifier}{size}{sponsor}{sponsor-de}' + + '{repeated-measurement-identifier}{size}{sponsors}{sponsor-de}' + '{sponsor-en}{study-series}{survey-data-types}' + '{study-series-de}{study-series-en}{survey}{survey-method-de}' + '{survey-method-en}{tags}{type}{variable}', diff --git a/src/main/webapp/scripts/searchmanagement/configuration/translations-de.js b/src/main/webapp/scripts/searchmanagement/configuration/translations-de.js index 9d0dc00079..94a0575409 100644 --- a/src/main/webapp/scripts/searchmanagement/configuration/translations-de.js +++ b/src/main/webapp/scripts/searchmanagement/configuration/translations-de.js @@ -96,7 +96,7 @@ angular.module('metadatamanagementApp').config( 'related-publications': 'Keine Publikationen zu Ihrer Suchanfrage gefunden.', 'instruments': 'Keine Instrumente zu Ihrer Suchanfrage gefunden.', 'concepts': 'Keine Konzepte zu Ihrer Suchanfrage gefunden.', - 'sponsor': 'Keine Ergebnisse zu Ihrer Suchanfrage gefunden' + 'sponsors': 'Keine Ergebnisse zu Ihrer Suchanfrage gefunden' }, 'tabs': { 'variables': 'Variablen', diff --git a/src/main/webapp/scripts/searchmanagement/configuration/translations-en.js b/src/main/webapp/scripts/searchmanagement/configuration/translations-en.js index a74da7eb9e..a7308b426d 100644 --- a/src/main/webapp/scripts/searchmanagement/configuration/translations-en.js +++ b/src/main/webapp/scripts/searchmanagement/configuration/translations-en.js @@ -97,7 +97,7 @@ angular.module('metadatamanagementApp').config( 'related-publications': 'No Publications found for your search request.', 'instruments': 'No Instruments found for your search request.', 'concepts': 'No Concepts found for your search request.', - 'sponsor': 'No Instruments found for your search request.' + 'sponsors': 'No Sponsors found for your search request.' }, 'tabs': { 'variables': 'Variables', diff --git a/src/main/webapp/scripts/searchmanagement/services/searchHelper.service.js b/src/main/webapp/scripts/searchmanagement/services/searchHelper.service.js index 095d2fe23c..4c7e856fd7 100644 --- a/src/main/webapp/scripts/searchmanagement/services/searchHelper.service.js +++ b/src/main/webapp/scripts/searchmanagement/services/searchHelper.service.js @@ -34,8 +34,8 @@ angular.module('metadatamanagementApp').factory( i18n: true, min_doc_count: 1 }, - 'sponsor': { - attribute: 'sponsor', + 'sponsors': { + attribute: 'sponsors', i18n: true, min_doc_count: 1 }, @@ -74,10 +74,10 @@ angular.module('metadatamanagementApp').factory( i18n: true, concatMultipleWithOr: false }, - 'sponsor': { - attribute: 'sponsor', + 'sponsors': { + attribute: 'sponsors', i18n: true, - concatMultipleWithOr: true + concatMultipleWithOr: false }, 'institutions': { attribute: 'institutions', @@ -99,8 +99,8 @@ angular.module('metadatamanagementApp').factory( 'related-publication': 'relatedPublications.id', 'institution-de': 'institutions.de', 'institution-en': 'institutions.en', - 'sponsor-de': 'sponsor.de', - 'sponsor-en': 'sponsor.en', + 'sponsor-de': 'sponsors.de', + 'sponsor-en': 'sponsors.en', 'survey-method-de': 'surveys.surveyMethod.de', 'survey-method-en': 'surveys.surveyMethod.en', 'concept': 'concepts.id' @@ -118,8 +118,8 @@ angular.module('metadatamanagementApp').factory( 'derived-variables-identifier': 'derivedVariablesIdentifier', 'institution-de': 'dataPackage.institutions.de', 'institution-en': 'dataPackage.institutions.en', - 'sponsor-de': 'dataPackage.sponsor.de', - 'sponsor-en': 'dataPackage.sponsor.en', + 'sponsor-de': 'dataPackage.sponsors.de', + 'sponsor-en': 'dataPackage.sponsors.en', 'survey-method-de': 'surveys.surveyMethod.de', 'survey-method-en': 'surveys.surveyMethod.en', 'concept': 'concepts.id' @@ -134,8 +134,8 @@ angular.module('metadatamanagementApp').factory( 'variable': 'variables.id', 'institution-de': 'dataPackage.institutions.de', 'institution-en': 'dataPackage.institutions.en', - 'sponsor-de': 'dataPackage.sponsor.de', - 'sponsor-en': 'dataPackage.sponsor.en', + 'sponsor-de': 'dataPackage.sponsors.de', + 'sponsor-en': 'dataPackage.sponsors.en', 'survey-method-de': 'surveyMethod.de', 'survey-method-en': 'surveyMethod.en', 'concept': 'concepts.id' @@ -150,8 +150,8 @@ angular.module('metadatamanagementApp').factory( 'variable': 'variables.id', 'institution-de': 'dataPackage.institutions.de', 'institution-en': 'dataPackage.institutions.en', - 'sponsor-de': 'dataPackage.sponsor.de', - 'sponsor-en': 'dataPackage.sponsor.en', + 'sponsor-de': 'dataPackage.sponsors.de', + 'sponsor-en': 'dataPackage.sponsors.en', 'survey-method-de': 'surveys.surveyMethod.de', 'survey-method-en': 'surveys.surveyMethod.en', 'concept': 'conceptIds' @@ -166,8 +166,8 @@ angular.module('metadatamanagementApp').factory( 'variable': 'variables.id', 'institution-de': 'dataPackage.institutions.de', 'institution-en': 'dataPackage.institutions.en', - 'sponsor-de': 'dataPackage.sponsor.de', - 'sponsor-en': 'dataPackage.sponsor.en', + 'sponsor-de': 'dataPackage.sponsors.de', + 'sponsor-en': 'dataPackage.sponsors.en', 'survey-method-de': 'surveys.surveyMethod.de', 'survey-method-en': 'surveys.surveyMethod.en', 'concept': 'concepts.id' @@ -183,8 +183,8 @@ angular.module('metadatamanagementApp').factory( 'access-way': 'accessWays', 'institution-de': 'dataPackage.institutions.de', 'institution-en': 'dataPackage.institutions.en', - 'sponsor-de': 'dataPackage.sponsor.de', - 'sponsor-en': 'dataPackage.sponsor.en', + 'sponsor-de': 'dataPackage.sponsors.de', + 'sponsor-en': 'dataPackage.sponsors.en', 'survey-method-de': 'surveys.surveyMethod.de', 'survey-method-en': 'surveys.surveyMethod.en', 'concept': 'concepts.id' diff --git a/src/main/webapp/scripts/searchmanagement/views/search.controller.js b/src/main/webapp/scripts/searchmanagement/views/search.controller.js index 8f11acfa23..347b400e09 100644 --- a/src/main/webapp/scripts/searchmanagement/views/search.controller.js +++ b/src/main/webapp/scripts/searchmanagement/views/search.controller.js @@ -26,7 +26,7 @@ angular.module('metadatamanagementApp').controller('SearchController', 'study-series', 'survey-data-types', 'tags', - 'sponsor', + 'sponsors', 'institutions', 'access-ways', 'concepts' @@ -309,8 +309,8 @@ angular.module('metadatamanagementApp').controller('SearchController', 'access-ways'), 'concepts': createDataPackageFilterContent(data, 'concepts'), - 'sponsor': createDataPackageFilterContent(data, - 'sponsor'), + 'sponsors': createDataPackageFilterContent(data, + 'sponsors'), 'institutions': createDataPackageFilterContent(data, 'institutions') }; @@ -348,7 +348,7 @@ angular.module('metadatamanagementApp').controller('SearchController', // Usage: // { // 'study-series': ['DZHW-Absolventenstudien','adf','asd'], - // 'sponsor': ['Bundesministerium für Bildung und Forschung (BMBF)'] + // 'sponsors': ['Bundesministerium für Bildung und Forschung (BMBF)'] // }) $scope.searchFilterMapping, $scope.options.sortObject.selected) .then(function(data) { diff --git a/src/test/java/eu/dzhw/fdz/metadatamanagement/common/unittesthelper/util/UnitTestCreateDomainObjectUtils.java b/src/test/java/eu/dzhw/fdz/metadatamanagement/common/unittesthelper/util/UnitTestCreateDomainObjectUtils.java index b08586f6b8..1ae169f381 100644 --- a/src/test/java/eu/dzhw/fdz/metadatamanagement/common/unittesthelper/util/UnitTestCreateDomainObjectUtils.java +++ b/src/test/java/eu/dzhw/fdz/metadatamanagement/common/unittesthelper/util/UnitTestCreateDomainObjectUtils.java @@ -104,6 +104,8 @@ public static DataPackage buildDataPackage(String projectId) { projectContributors.add(buildPerson("Test", null, "ProjectContributors")); List institutions = Arrays.asList(I18nString.builder().de("Institution De").en("Institution En").build()); + List sponsors = + Arrays.asList(I18nString.builder().de("Sponsor De").en("Sponsor En").build()); List dataCurators = new ArrayList<>(); dataCurators.add(buildPerson("Test", null, "ProjectContributors")); @@ -113,7 +115,7 @@ public static DataPackage buildDataPackage(String projectId) { .description(I18nString.builder().de("Description De").en("Description En").build()) .institutions(institutions) .studySeries(I18nString.builder().de("DataPackage Series De").en("DataPackage Series En").build()) - .sponsor(I18nString.builder().de("Sponsor De").en("Sponsor En").build()) + .sponsors(sponsors) .title(I18nString.builder().de("Titel De").en("Title En").build()) .annotations(I18nString.builder().de("De Anmerkungen").en("En Annotations").build()) .tags(tags).surveyDesign(SurveyDesigns.PANEL) diff --git a/src/test/robotframework/publisher/Datapackagemanagement/Create_Data_Package.robot b/src/test/robotframework/publisher/Datapackagemanagement/Create_Data_Package.robot index 74f7916063..5e8056f00b 100644 --- a/src/test/robotframework/publisher/Datapackagemanagement/Create_Data_Package.robot +++ b/src/test/robotframework/publisher/Datapackagemanagement/Create_Data_Package.robot @@ -19,8 +19,8 @@ Create Data Package by Publisher Choose Panel As Survey Design Input Text name=institutionDe_0 DZHW ${BROWSER} Input Text name=institutionEn_0 DZHW ${BROWSER} - Input Text name=sponsorDe BMBF ${BROWSER} - Input Text name=sponsorEn BMBF ${BROWSER} + Input Text name=sponsorDe_0 BMBF ${BROWSER} + Input Text name=sponsorEn_0 BMBF ${BROWSER} Input Text name=annotationsDe Dieses Datenpaket wurde von Robot automatisch erstellt. Input Text name=annotationsEn This data package was created automatically by Robot.x Focus xpath=//textarea[@name = 'descriptionDe'] diff --git a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Metadata Deleting Access Rights.robot b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Metadata Deleting Access Rights.robot index d158aa5dbd..e0fd468d7b 100644 --- a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Metadata Deleting Access Rights.robot +++ b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Metadata Deleting Access Rights.robot @@ -27,8 +27,8 @@ Publisher Create But Can Not Delete Data Package When Publisher is Ready Choose Panel As Survey Design Input Text name=institutionDe_0 DZHW ${BROWSER} Input Text name=institutionEn_0 DZHW ${BROWSER} - Input Text name=sponsorDe BMBF ${BROWSER} - Input Text name=sponsorEn BMBF ${BROWSER} + Input Text name=sponsorDe_0 BMBF ${BROWSER} + Input Text name=sponsorEn_0 BMBF ${BROWSER} Input Text name=annotationsDe Dieses Datenpaket wurde von Robot automatisch erstellt. Input Text name=annotationsEn This data package was created automatically by Robot.x Focus xpath=//textarea[@name = 'descriptionDe'] From ef604a243879b1e5eedc5a23c7ff02642c5f57ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Thu, 10 Jun 2021 14:33:27 +0200 Subject: [PATCH 06/23] remove python dependency from normal builds (#2829) --- .github/workflows/build-and-deploy.yml | 6 - .github/workflows/build.yml | 6 - README.md | 12 +- .../common/domain/AbstractRdcDomainObject.rst | 74 ----- .../AbstractShadowableRdcDomainObject.rst | 56 ---- .../common/domain/Counter.rst | 40 --- .../common/domain/Country.rst | 42 --- .../common/domain/I18nString.rst | 46 --- .../common/domain/ImmutableI18nString.rst | 18 - .../common/domain/Language.rst | 32 -- .../common/domain/Period.rst | 50 --- .../common/domain/Person.rst | 56 ---- .../common/domain/Resolution.rst | 48 --- .../ShadowCopyCreateNotAllowedException.rst | 18 - .../ShadowCopyDeleteNotAllowedException.rst | 18 - .../ShadowCopySaveNotAllowedException.rst | 18 - .../common/domain/Task-TaskState.rst | 51 --- .../common/domain/Task-TaskType.rst | 39 --- .../metadatamanagement/common/domain/Task.rst | 78 ----- .../common/domain/TaskErrorNotification.rst | 64 ---- .../common/domain/package-index.rst | 28 -- .../conceptmanagement/domain/Concept.rst | 142 -------- .../domain/ConceptAttachmentMetadata.rst | 122 ------- .../domain/ConceptAttachmentTypes.rst | 48 --- .../domain/ConceptInUseException.rst | 34 -- .../conceptmanagement/domain/Tags.rst | 44 --- .../domain/package-index.rst | 14 - .../domain/DataPackage.rst | 192 ----------- .../domain/DataPackageAttachmentMetadata.rst | 156 --------- .../domain/DataPackageAttachmentTypes.rst | 42 --- .../domain/MetadataExportFormat.rst | 108 ------ .../domain/MethodReportCitationDetails.rst | 82 ----- .../domain/SurveyDesigns.rst | 42 --- .../datapackagemanagement/domain/Tags.rst | 46 --- .../domain/TimeMethods.rst | 86 ----- .../domain/package-index.rst | 19 -- .../datasetmanagement/domain/DataFormat.rst | 42 --- .../datasetmanagement/domain/DataSet.rst | 198 ----------- .../domain/DataSetAttachmentMetadata.rst | 140 -------- .../datasetmanagement/domain/DataSetTypes.rst | 42 --- .../datasetmanagement/domain/Format.rst | 42 --- .../datasetmanagement/domain/SubDataSet.rst | 90 ----- .../domain/package-index.rst | 17 - .../domain/CollectionModes.rst | 288 ---------------- .../domain/Instrument.rst | 200 ----------- .../domain/InstrumentAttachmentMetadata.rst | 142 -------- .../domain/InstrumentAttachmentTypes.rst | 54 --- .../domain/InstrumentTypes.rst | 56 ---- .../domain/package-index.rst | 16 - .../ordermanagement/domain/Order.rst | 90 ----- .../domain/OrderAlreadyCompletedException.rst | 18 - .../ordermanagement/domain/OrderClient.rst | 26 -- .../ordermanagement/domain/OrderState.rst | 32 -- .../domain/OrderedDataPackage.rst | 76 ----- .../ordermanagement/domain/Product.rst | 86 ----- .../ordermanagement/domain/package-index.rst | 17 - .../domain/AssigneeGroup.rst | 24 -- .../domain/Configuration.rst | 120 ------- .../domain/DaraUpdateQueueItem.rst | 78 ----- .../domain/DataAcquisitionProject.rst | 134 -------- .../domain/FreeResourceTypes.rst | 36 -- .../projectmanagement/domain/ProjectState.rst | 48 --- .../projectmanagement/domain/Release.rst | 76 ----- .../projectmanagement/domain/Requirements.rst | 94 ------ .../domain/ShadowCopyQueueItem-Action.rst | 49 --- .../domain/ShadowCopyQueueItem.rst | 76 ----- .../ShadowCopyReleaseToDaraNotAllowed.rst | 18 - .../ShadowHidingNotAllowedException.rst | 20 -- .../ShadowUnhidingNotAllowedException.rst | 20 -- .../domain/package-index.rst | 24 -- .../questionmanagement/domain/ImageType.rst | 18 - .../questionmanagement/domain/Question.rst | 242 -------------- .../domain/QuestionImageMetadata.rst | 138 -------- .../domain/QuestionTypes.rst | 66 ---- .../domain/TechnicalRepresentation.rst | 62 ---- .../domain/package-index.rst | 16 - .../domain/RelatedPublication.rst | 144 -------- .../domain/package-index.rst | 14 - .../surveymanagement/domain/DataTypes.rst | 42 --- .../domain/GeographicCoverage.rst | 52 --- .../surveymanagement/domain/Population.rst | 74 ----- .../surveymanagement/domain/Survey.rst | 218 ------------ .../domain/SurveyAttachmentMetadata.rst | 138 -------- .../SurveyResponseRateImageMetadata.rst | 106 ------ .../domain/SurveySampleTypeProvider.rst | 34 -- .../domain/UnitValueProvider.rst | 30 -- .../surveymanagement/domain/package-index.rst | 19 -- .../variablemanagement/domain/AccessWays.rst | 60 ---- .../variablemanagement/domain/DataTypes.rst | 48 --- .../domain/Distribution.rst | 96 ------ .../domain/FilterDetails.rst | 66 ---- .../domain/FilterExpressionLanguages.rst | 38 --- .../domain/GenerationDetails.rst | 66 ---- .../variablemanagement/domain/Missing.rst | 70 ---- .../domain/RelatedQuestion.rst | 84 ----- .../domain/RuleExpressionLanguages.rst | 38 --- .../variablemanagement/domain/ScaleLevels.rst | 54 --- .../variablemanagement/domain/Statistics.rst | 128 ------- .../domain/StorageTypes.rst | 170 ---------- .../domain/ValidResponse.rst | 80 ----- .../variablemanagement/domain/Variable.rst | 314 ------------------ .../domain/package-index.rst | 25 -- docs/source/javadoc/packages.rst | 18 - pom.xml | 37 --- 104 files changed, 1 insertion(+), 7270 deletions(-) delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractRdcDomainObject.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractShadowableRdcDomainObject.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Counter.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Country.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/I18nString.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ImmutableI18nString.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Language.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Period.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Person.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Resolution.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopyCreateNotAllowedException.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopyDeleteNotAllowedException.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopySaveNotAllowedException.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task-TaskState.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task-TaskType.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/TaskErrorNotification.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Concept.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptAttachmentMetadata.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptAttachmentTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptInUseException.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Tags.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackageAttachmentMetadata.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackageAttachmentTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MethodReportCitationDetails.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/SurveyDesigns.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/Tags.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/TimeMethods.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataFormat.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSet.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSetAttachmentMetadata.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSetTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/Format.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/SubDataSet.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/CollectionModes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/Instrument.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentAttachmentMetadata.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentAttachmentTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Order.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderAlreadyCompletedException.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderClient.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderState.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderedDataPackage.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Product.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/AssigneeGroup.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Configuration.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/DaraUpdateQueueItem.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/DataAcquisitionProject.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/FreeResourceTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ProjectState.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Release.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Requirements.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem-Action.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyReleaseToDaraNotAllowed.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowHidingNotAllowedException.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowUnhidingNotAllowedException.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/ImageType.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/Question.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/QuestionImageMetadata.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/QuestionTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/TechnicalRepresentation.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain/RelatedPublication.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/DataTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/GeographicCoverage.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Population.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveyAttachmentMetadata.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveyResponseRateImageMetadata.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveySampleTypeProvider.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/UnitValueProvider.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/AccessWays.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/DataTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Distribution.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/FilterDetails.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/FilterExpressionLanguages.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/GenerationDetails.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Missing.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/RelatedQuestion.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/RuleExpressionLanguages.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/ScaleLevels.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Statistics.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/StorageTypes.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/ValidResponse.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Variable.rst delete mode 100644 docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/package-index.rst delete mode 100644 docs/source/javadoc/packages.rst diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 2e24e5a125..469394a0b5 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -26,12 +26,6 @@ jobs: # npm cache files are stored in `~/.npm` on Linux/macOS path: ~/.m2 key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/pom.xml') }} - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - - name: Install custom javasphinx - run: pip install git+https://github.com/dzhw/javasphinx.git - name: Install AWS CLI run: pip install awscli - name: Install jq for commandline json parsing diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b515398198..510c23fe1d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -24,12 +24,6 @@ jobs: # npm cache files are stored in `~/.npm` on Linux/macOS path: ~/.m2 key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/pom.xml') }} - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - - name: Install custom javasphinx - run: pip install git+https://github.com/dzhw/javasphinx.git - name: Set up node 14.16.0 uses: actions/setup-node@v2.1.2 with: diff --git a/README.md b/README.md index 59e8b57167..ec9c299bbf 100644 --- a/README.md +++ b/README.md @@ -66,21 +66,11 @@ This image can be run with all its dependent containers by Our CI pipleline will do some automatic checks and tests and it will optimize the metadatamanagement client for the dev environment. So before pushing to Github in order to be sure you won't fail the build you should run: - mvn -Pdev clean install + mvn -Pdev clean verify This will concatenate and minify CSS and JavaScript files using grunt. It will also modify the `index.html` so it references these new files. -To make the build runnable with an enabled dev profile, you'll need to install the following dependencies: - -* Python - -Once Python is installed, run: - - pip install git+https://github.com/dzhw/javasphinx.git --user - -Note that the `--user` flag installs the dependency somewhere in your user directory (e.g. /home/{user}/local/bin on Linux). Make sure that the installed binaries/scripts are on your path. - We test our project continuously with the Robot Framework. Test Developers can get further info [here](https://github.com/dzhw/metadatamanagement/wiki/Robot-Framework). ## Technical Documentation diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractRdcDomainObject.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractRdcDomainObject.rst deleted file mode 100644 index 9e5d841a67..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractRdcDomainObject.rst +++ /dev/null @@ -1,74 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.time LocalDateTime - -.. java:import:: org.springframework.data.annotation CreatedBy - -.. java:import:: org.springframework.data.annotation CreatedDate - -.. java:import:: org.springframework.data.annotation LastModifiedBy - -.. java:import:: org.springframework.data.annotation LastModifiedDate - -.. java:import:: org.springframework.data.annotation Version - -.. java:import:: lombok Data - -AbstractRdcDomainObject -======================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @Data public abstract class AbstractRdcDomainObject implements Serializable - - Base class for all rdc domain objects. All domain objects inherit the fields from this base class. - -Fields ------- -createdBy -^^^^^^^^^ - -.. java:field:: @CreatedBy private String createdBy - :outertype: AbstractRdcDomainObject - - The name of the user which has created this object. - -createdDate -^^^^^^^^^^^ - -.. java:field:: @CreatedDate private LocalDateTime createdDate - :outertype: AbstractRdcDomainObject - - The date and time (in UTC) when this domain object was created. - -lastModifiedBy -^^^^^^^^^^^^^^ - -.. java:field:: @LastModifiedBy private String lastModifiedBy - :outertype: AbstractRdcDomainObject - - The name of the user who last saved this object. - -lastModifiedDate -^^^^^^^^^^^^^^^^ - -.. java:field:: @LastModifiedDate private LocalDateTime lastModifiedDate - :outertype: AbstractRdcDomainObject - - The date and time when this object was last saved. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: AbstractRdcDomainObject - -version -^^^^^^^ - -.. java:field:: @Version private Long version - :outertype: AbstractRdcDomainObject - - Number which is incremented on each save of this object. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractShadowableRdcDomainObject.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractShadowableRdcDomainObject.rst deleted file mode 100644 index dbd180c40a..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractShadowableRdcDomainObject.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. java:import:: java.util Objects - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidHiddenShadow - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok Setter - -AbstractShadowableRdcDomainObject -================================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @Data @EqualsAndHashCode @ValidHiddenShadow public abstract class AbstractShadowableRdcDomainObject extends AbstractRdcDomainObject - - Base class for all rdc domain objects which can exist as multiple versions (shadows). - -Fields ------- -hidden -^^^^^^ - -.. java:field:: private boolean hidden - :outertype: AbstractShadowableRdcDomainObject - - True if and only if the shadow copy must not be available for the public user. Only shadow copies which have a successor may be hidden. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: AbstractShadowableRdcDomainObject - -shadow -^^^^^^ - -.. java:field:: @Setter @Indexed private boolean shadow - :outertype: AbstractShadowableRdcDomainObject - - Determines whether this document is a shadow copy. - -successorId -^^^^^^^^^^^ - -.. java:field:: private String successorId - :outertype: AbstractShadowableRdcDomainObject - - The document id which is the successor to this shadow copy. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Counter.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Counter.rst deleted file mode 100644 index 73d89f0ade..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Counter.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Counter -======= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @Document @NoArgsConstructor @Data @AllArgsConstructor @Builder public class Counter - - Counter document which can be used to get an incremented sequence number per document id. - -Fields ------- -id -^^ - -.. java:field:: @Id private String id - :outertype: Counter - - The id of the counter, e.g. "orders". - -seq -^^^ - -.. java:field:: private long seq - :outertype: Counter - - The current sequence number. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Country.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Country.rst deleted file mode 100644 index 065a9877ad..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Country.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Data - -Country -======= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @Data @AllArgsConstructor public class Country implements Serializable - - Represents a country with it's 2-letter country code and it's display name in german and english. - -Fields ------- -code -^^^^ - -.. java:field:: private String code - :outertype: Country - -de -^^ - -.. java:field:: private String de - :outertype: Country - -en -^^ - -.. java:field:: private String en - :outertype: Country - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Country - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/I18nString.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/I18nString.rst deleted file mode 100644 index dd063a9b85..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/I18nString.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -I18nString -========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class I18nString implements Serializable - - Strings that can be represented in English and German. - -Fields ------- -de -^^ - -.. java:field:: private String de - :outertype: I18nString - - The german version of this string. - -en -^^ - -.. java:field:: private String en - :outertype: I18nString - - The english version of this string. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: I18nString - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ImmutableI18nString.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ImmutableI18nString.rst deleted file mode 100644 index 6152b545a5..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ImmutableI18nString.rst +++ /dev/null @@ -1,18 +0,0 @@ -ImmutableI18nString -=================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: public class ImmutableI18nString extends I18nString - - Immutable (constant) version of \ :java:ref:`I18nString`\ s. - -Fields ------- -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ImmutableI18nString - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Language.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Language.rst deleted file mode 100644 index 5b430a3ff0..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Language.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Data - -Language -======== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @Data @AllArgsConstructor public class Language implements Comparable - - Wrapper for a language code and it's respective display name. - -Fields ------- -displayName -^^^^^^^^^^^ - -.. java:field:: private final String displayName - :outertype: Language - - Display name. - -languageCode -^^^^^^^^^^^^ - -.. java:field:: private final String languageCode - :outertype: Language - - Language code. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Period.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Period.rst deleted file mode 100644 index de0c621e17..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Period.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.time LocalDate - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidPeriod - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Period -====== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @ValidPeriod @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class Period implements Serializable - - Objects representing periods in time. All periods must have a start date and an end date and the start date must be before or equal to the end date. - -Fields ------- -end -^^^ - -.. java:field:: private LocalDate end - :outertype: Period - - The end date of the period. Mandatory and must not be before start date. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Period - -start -^^^^^ - -.. java:field:: private LocalDate start - :outertype: Period - - The start date of the period. Mandatory and must not be after end date. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Person.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Person.rst deleted file mode 100644 index 9044e09b1b..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Person.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Person -====== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class Person implements Serializable - - A representation of a person. - -Fields ------- -firstName -^^^^^^^^^ - -.. java:field:: @NotEmpty private String firstName - :outertype: Person - - The first name of the person. Must not be empty. - -lastName -^^^^^^^^ - -.. java:field:: @NotEmpty private String lastName - :outertype: Person - - The last name of the person. Must not be empty. - -middleName -^^^^^^^^^^ - -.. java:field:: private String middleName - :outertype: Person - - The middle name of the person. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Person - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Resolution.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Resolution.rst deleted file mode 100644 index 77cb154da1..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Resolution.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Resolution -========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class Resolution implements Serializable - - Representation of the resolution of images. - -Fields ------- -heightY -^^^^^^^ - -.. java:field:: @NotNull private Integer heightY - :outertype: Resolution - - The height in pixel. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Resolution - -widthX -^^^^^^ - -.. java:field:: @NotNull private Integer widthX - :outertype: Resolution - - The width in pixel. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopyCreateNotAllowedException.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopyCreateNotAllowedException.rst deleted file mode 100644 index cf5c6988ab..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopyCreateNotAllowedException.rst +++ /dev/null @@ -1,18 +0,0 @@ -ShadowCopyCreateNotAllowedException -=================================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: public class ShadowCopyCreateNotAllowedException extends IllegalArgumentException - - Exception that should be thrown if client tries to create a shadowed domain object. - -Fields ------- -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ShadowCopyCreateNotAllowedException - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopyDeleteNotAllowedException.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopyDeleteNotAllowedException.rst deleted file mode 100644 index d66827ca5c..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopyDeleteNotAllowedException.rst +++ /dev/null @@ -1,18 +0,0 @@ -ShadowCopyDeleteNotAllowedException -=================================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: public class ShadowCopyDeleteNotAllowedException extends IllegalArgumentException - - Exception thrown if client tries to delete a shadowed domain object. - -Fields ------- -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ShadowCopyDeleteNotAllowedException - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopySaveNotAllowedException.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopySaveNotAllowedException.rst deleted file mode 100644 index 0e090e3a7d..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/ShadowCopySaveNotAllowedException.rst +++ /dev/null @@ -1,18 +0,0 @@ -ShadowCopySaveNotAllowedException -================================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: public class ShadowCopySaveNotAllowedException extends IllegalArgumentException - - Exception that should be thrown if a client tries to update a shadow version of a domain object. - -Fields ------- -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ShadowCopySaveNotAllowedException - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task-TaskState.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task-TaskState.rst deleted file mode 100644 index e5ec711583..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task-TaskState.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.rest.errors ErrorListDto - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok ToString - -Task.TaskState -============== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: public enum TaskState - :outertype: Task - - State of tasks. - - :author: tgehrke - -Enum Constants --------------- -DONE -^^^^ - -.. java:field:: public static final Task.TaskState DONE - :outertype: Task.TaskState - -FAILURE -^^^^^^^ - -.. java:field:: public static final Task.TaskState FAILURE - :outertype: Task.TaskState - -RUNNING -^^^^^^^ - -.. java:field:: public static final Task.TaskState RUNNING - :outertype: Task.TaskState - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task-TaskType.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task-TaskType.rst deleted file mode 100644 index c347b4df9f..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task-TaskType.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.rest.errors ErrorListDto - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok ToString - -Task.TaskType -============= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: public enum TaskType - :outertype: Task - - type of tasks. - - :author: tgehrke - -Enum Constants --------------- -DATA_SET_REPORT -^^^^^^^^^^^^^^^ - -.. java:field:: public static final Task.TaskType DATA_SET_REPORT - :outertype: Task.TaskType - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task.rst deleted file mode 100644 index 2764c97679..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task.rst +++ /dev/null @@ -1,78 +0,0 @@ -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.rest.errors ErrorListDto - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok ToString - -Task -==== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @Document @EqualsAndHashCode @ToString @NoArgsConstructor @AllArgsConstructor @Data @Builder public class Task extends AbstractRdcDomainObject - - Task entity holding the current state of a long running task. - - :author: tgehrke - -Fields ------- -errorList -^^^^^^^^^ - -.. java:field:: private ErrorListDto errorList - :outertype: Task - - The list of errors which occurred during execution of the task. - -id -^^ - -.. java:field:: @Id private String id - :outertype: Task - - The id or task number of the task. - -location -^^^^^^^^ - -.. java:field:: private String location - :outertype: Task - - The location URI of the result of the task. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Task - -state -^^^^^ - -.. java:field:: private TaskState state - :outertype: Task - - The current state of the task. - -type -^^^^ - -.. java:field:: private TaskType type - :outertype: Task - - The type of the task. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/TaskErrorNotification.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/TaskErrorNotification.rst deleted file mode 100644 index 3820c8ddff..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/TaskErrorNotification.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain Task.TaskType - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok ToString - -TaskErrorNotification -===================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - :noindex: - -.. java:type:: @EqualsAndHashCode @ToString @NoArgsConstructor @AllArgsConstructor @Data @Builder public class TaskErrorNotification - - DTO holding all information required for sending notifications to users in case an error occurred during task execution. - - :author: René Reitmann - -Fields ------- -domainObjectId -^^^^^^^^^^^^^^ - -.. java:field:: private String domainObjectId - :outertype: TaskErrorNotification - - An id of a domainObject. May be empty. - -errorMessage -^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String errorMessage - :outertype: TaskErrorNotification - - An error message indicating the reason of the error. Must not be empty. - -onBehalfOf -^^^^^^^^^^ - -.. java:field:: private String onBehalfOf - :outertype: TaskErrorNotification - - The name of the user for which the task has been executed. May be empty. - -taskType -^^^^^^^^ - -.. java:field:: @NotNull private TaskType taskType - :outertype: TaskErrorNotification - - The type of the task which has been executed. Must not be empty. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/package-index.rst deleted file mode 100644 index 048c9c7d4d..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/package-index.rst +++ /dev/null @@ -1,28 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.common.domain -============================================ - -Common domain objects which can be used in all other subdomains of this application. - -.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain - -.. toctree:: - :maxdepth: 1 - - AbstractRdcDomainObject - AbstractShadowableRdcDomainObject - Counter - Country - I18nString - ImmutableI18nString - Language - Period - Person - Resolution - ShadowCopyCreateNotAllowedException - ShadowCopyDeleteNotAllowedException - ShadowCopySaveNotAllowedException - Task - Task-TaskState - Task-TaskType - TaskErrorNotification - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Concept.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Concept.rst deleted file mode 100644 index 68dbc7491f..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Concept.rst +++ /dev/null @@ -1,142 +0,0 @@ -.. java:import:: java.util List - -.. java:import:: java.util Set - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.springframework.beans BeanUtils - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain Person - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringEntireNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain.projections ConceptSubDocumentProjection - -.. java:import:: io.swagger.v3.oas.annotations.media Schema - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok ToString - -Concept -======= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain - :noindex: - -.. java:type:: @Entity @Document @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder @Schema public class Concept extends AbstractRdcDomainObject implements ConceptSubDocumentProjection - - A concept is something which cannot be observed directly but there is a model which helps observing the concept. E.g.: The concept "Personality" can be observed with the help of the five-factor model (Big5). - -Fields ------- -authors -^^^^^^^ - -.. java:field:: @Valid @NotEmpty private List authors - :outertype: Concept - - List of \ :java:ref:`Person`\ s which have defined this concept. Must not be empty. - -citationHint -^^^^^^^^^^^^ - -.. java:field:: @NotEmpty @Size private String citationHint - :outertype: Concept - - Hint on how to cite this concept. Markdown is supported. Must not be empty and must not contain more than 2048 characters. - -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringEntireNotEmpty private I18nString description - :outertype: Concept - - A description of the concept. Markdown is supported. It must be specified in German and English and it must not contain more than 2048 characters. - -doi -^^^ - -.. java:field:: @Size private String doi - :outertype: Concept - - The doi of the paper defining the concept. Must not contain more than 512 characters. - -id -^^ - -.. java:field:: @Id @NotEmpty @Pattern @Size private String id - :outertype: Concept - - The id of the concept which uniquely identifies the concept in this application. Must not be empty and must not contain more than 512 characters. Must start with "con-" and end with "$" and must not contain any whitespace. - -license -^^^^^^^ - -.. java:field:: @Size private String license - :outertype: Concept - - The license of this concept. Markdown is supported. Must not contain more than 1 MB characters. - -originalLanguages -^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private Set originalLanguages - :outertype: Concept - - The original languages of the definition of the concept as ISO 639 code. Must not be empty. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Concept - -tags -^^^^ - -.. java:field:: @Valid private Tags tags - :outertype: Concept - - Keywords for the concept. Must not be empty. - -title -^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringEntireNotEmpty private I18nString title - :outertype: Concept - - The title of the concept. It must be specified in German and English and it must not contain more than 512 characters. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptAttachmentMetadata.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptAttachmentMetadata.rst deleted file mode 100644 index c0a116e69d..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptAttachmentMetadata.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain.validation ValidConceptAttachmentType - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok ToString - -ConceptAttachmentMetadata -========================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain - :noindex: - -.. java:type:: @Entity @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class ConceptAttachmentMetadata extends AbstractRdcDomainObject - - Metadata which will be stored with each attachment of a \ :java:ref:`Concept`\ . - -Fields ------- -conceptId -^^^^^^^^^ - -.. java:field:: @NotEmpty private String conceptId - :outertype: ConceptAttachmentMetadata - - The id of the \ :java:ref:`Concept`\ to which this attachment belongs. Must not be empty. - -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringNotEmpty private I18nString description - :outertype: ConceptAttachmentMetadata - - A description for this attachment. It must be specified in at least one language and it must not contain more than 512 characters. - -fileName -^^^^^^^^ - -.. java:field:: @NotEmpty @Pattern private String fileName - :outertype: ConceptAttachmentMetadata - - The filename of the attachment. Must not be empty and must contain only (german) alphanumeric characters and "_" and "-" and ".". - -id -^^ - -.. java:field:: @Id private String id - :outertype: ConceptAttachmentMetadata - - The id of the attachment. Holds the complete path which can be used to download the file. - -indexInConcept -^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer indexInConcept - :outertype: ConceptAttachmentMetadata - - The index in the \ :java:ref:`Concept`\ of this attachment. Used for sorting the attachments of this \ :java:ref:`Concept`\ . Must not be empty. - -language -^^^^^^^^ - -.. java:field:: @NotNull @ValidIsoLanguage private String language - :outertype: ConceptAttachmentMetadata - - The language of the attachments content. Must not be empty and must be specified as ISO 639 language code. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ConceptAttachmentMetadata - -title -^^^^^ - -.. java:field:: @NotEmpty @Size private String title - :outertype: ConceptAttachmentMetadata - - An optional title of this attachment in the attachments' language. It must not contain more than 2048 characters. - -type -^^^^ - -.. java:field:: @NotNull @I18nStringSize @ValidConceptAttachmentType private I18nString type - :outertype: ConceptAttachmentMetadata - - The type of the attachment. Must be one of \ :java:ref:`ConceptAttachmentTypes`\ and must not be empty. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptAttachmentTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptAttachmentTypes.rst deleted file mode 100644 index 4fbcb0a13a..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptAttachmentTypes.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -ConceptAttachmentTypes -====================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain - :noindex: - -.. java:type:: public class ConceptAttachmentTypes - - All valid types of a \ :java:ref:`ConceptAttachmentMetadata`\ . - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: ConceptAttachmentTypes - -DOCUMENTATION -^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString DOCUMENTATION - :outertype: ConceptAttachmentTypes - -INSTRUMENT -^^^^^^^^^^ - -.. java:field:: public static final I18nString INSTRUMENT - :outertype: ConceptAttachmentTypes - -OTHER -^^^^^ - -.. java:field:: public static final I18nString OTHER - :outertype: ConceptAttachmentTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptInUseException.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptInUseException.rst deleted file mode 100644 index e2a17acfb8..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/ConceptInUseException.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. java:import:: java.util Set - -.. java:import:: lombok Getter - -ConceptInUseException -===================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain - :noindex: - -.. java:type:: public class ConceptInUseException extends RuntimeException - - Thrown if a delete attempt was made while the Concept is referenced by an instance of \ :java:ref:`eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain.Instrument`\ or \ :java:ref:`eu.dzhw.fdz.metadatamanagement.questionmanagement.domain.Question`\ . - -Fields ------- -instrumentIds -^^^^^^^^^^^^^ - -.. java:field:: @Getter private final Set instrumentIds - :outertype: ConceptInUseException - -questionIds -^^^^^^^^^^^ - -.. java:field:: @Getter private final Set questionIds - :outertype: ConceptInUseException - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ConceptInUseException - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Tags.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Tags.rst deleted file mode 100644 index a68150f4a8..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Tags.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.util Set - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Tags -==== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain - :noindex: - -.. java:type:: @Data @NoArgsConstructor public class Tags implements Serializable - - Contains tags associated with a concept. - -Fields ------- -de -^^ - -.. java:field:: @NotEmpty private Set de - :outertype: Tags - - German tags. At least one tag must be provided. - -en -^^ - -.. java:field:: @NotEmpty private Set en - :outertype: Tags - - English tags. At least one tag must be provided. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Tags - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/package-index.rst deleted file mode 100644 index 55618748ba..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/package-index.rst +++ /dev/null @@ -1,14 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain -======================================================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain - -.. toctree:: - :maxdepth: 1 - - Concept - ConceptAttachmentMetadata - ConceptAttachmentTypes - ConceptInUseException - Tags - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.rst deleted file mode 100644 index 7478c56876..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.rst +++ /dev/null @@ -1,192 +0,0 @@ -.. java:import:: java.util List - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.javers.core.metamodel.annotation TypeName - -.. java:import:: org.springframework.beans BeanUtils - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain Person - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringEntireNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringEntireNotEmptyOptional - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringMustNotContainComma - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidShadowId - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.projection DataPackageSubDocumentProjection - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.validation ValidDataPackageId - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.validation ValidSurveyDesign - -.. java:import:: io.swagger.v3.oas.annotations.media Schema - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -DataPackage -=========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain - :noindex: - -.. java:type:: @Entity @Document @TypeName @ValidDataPackageId @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder @Schema @ValidShadowId public class DataPackage extends AbstractShadowableRdcDomainObject implements DataPackageSubDocumentProjection - - A data package contains all metadata of a \ :java:ref:`DataAcquisitionProject`\ . It will get a DOI (Digital Object Identifier) when the \ :java:ref:`DataAcquisitionProject`\ is released. - -Fields ------- -annotations -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString annotations - :outertype: DataPackage - - Arbitrary additional text for this dataPackage. Markdown is supported. Must not contain more than 2048 characters. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataAcquisitionProjectId - :outertype: DataPackage - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which this dataPackage belongs. The dataAcquisitionProjectId must not be empty. - -dataCurators -^^^^^^^^^^^^ - -.. java:field:: @Valid @NotEmpty private List dataCurators - :outertype: DataPackage - - List of \ :java:ref:`Person`\ s which have curated this data package. Must not be empty. - -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringEntireNotEmpty private I18nString description - :outertype: DataPackage - - A description of the dataPackage. Markdown is supported. It must be specified in German and English and it must not contain more than 2048 characters. - -id -^^ - -.. java:field:: @Id @Setter @NotEmpty private String id - :outertype: DataPackage - - The id of the dataPackage which uniquely identifies the dataPackage in this application. - -institutions -^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private List institutions - :outertype: DataPackage - - The names of the institutions which have performed the study from which this data package results. It must be specified in German and English and it must not contain more than 512 characters. - -masterId -^^^^^^^^ - -.. java:field:: @NotEmpty @Size @Pattern @Setter @Indexed private String masterId - :outertype: DataPackage - - The master id of the dataPackage. The master id must not be empty, must be of the form \ ``stu-{{dataAcquisitionProjectId}}$``\ and the master id must not contain more than 512 characters. - -projectContributors -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Valid @NotEmpty private List projectContributors - :outertype: DataPackage - - List of \ :java:ref:`Person`\ s which have performed this dataPackage. Must not be empty. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: DataPackage - -sponsors -^^^^^^^^ - -.. java:field:: @NotEmpty private List sponsors - :outertype: DataPackage - - The names of the sponsors which have sponsored the study or project from which this data package results. It must be specified in German and English and it must not contain more than 512 characters. - -studySeries -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize @I18nStringEntireNotEmptyOptional @I18nStringMustNotContainComma private I18nString studySeries - :outertype: DataPackage - - The name of the series of dataPackages to which this dataPackage belongs. If specified it must be specified in German and English. It must not contain more than 512 characters and must not contain ",". - -surveyDesign -^^^^^^^^^^^^ - -.. java:field:: @NotNull @ValidSurveyDesign private I18nString surveyDesign - :outertype: DataPackage - - The survey design of this \ :java:ref:`DataPackage`\ . Must be one of \ :java:ref:`SurveyDesigns`\ and must not be empty. - -tags -^^^^ - -.. java:field:: @Valid private Tags tags - :outertype: DataPackage - - Keywords for the dataPackage. - -title -^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringEntireNotEmpty private I18nString title - :outertype: DataPackage - - The title of the dataPackage. It must be specified in German and English and it must not contain more than 2048 characters. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackageAttachmentMetadata.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackageAttachmentMetadata.rst deleted file mode 100644 index d1243c011a..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackageAttachmentMetadata.rst +++ /dev/null @@ -1,156 +0,0 @@ -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.javers.core.metamodel.annotation TypeName - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.validation ValidDataPackageAttachmentType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -DataPackageAttachmentMetadata -============================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain - :noindex: - -.. java:type:: @Entity @TypeName @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class DataPackageAttachmentMetadata extends AbstractShadowableRdcDomainObject - - Metadata which will be stored with each attachment of a \ :java:ref:`DataPackage`\ . - -Fields ------- -citationDetails -^^^^^^^^^^^^^^^ - -.. java:field:: @Valid private MethodReportCitationDetails citationDetails - :outertype: DataPackageAttachmentMetadata - - Additional details required to generate a citation hint for Method Reports. Can be null for other attachment types than method reports. Can also be null for legacy method reports. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String dataAcquisitionProjectId - :outertype: DataPackageAttachmentMetadata - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which the \ :java:ref:`DataPackage`\ of this attachment belongs. Must not be empty. - -dataPackageId -^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String dataPackageId - :outertype: DataPackageAttachmentMetadata - - The id of the \ :java:ref:`DataPackage`\ to which this attachment belongs. Must not be empty. - -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringNotEmpty private I18nString description - :outertype: DataPackageAttachmentMetadata - - A description for this attachment. It must be specified in at least one language and it must not contain more than 512 characters. - -fileName -^^^^^^^^ - -.. java:field:: @NotEmpty @Pattern private String fileName - :outertype: DataPackageAttachmentMetadata - - The filename of the attachment. Must not be empty and must contain only (german) alphanumeric characters and "_" and "-" and ".". - -id -^^ - -.. java:field:: @Id @Setter private String id - :outertype: DataPackageAttachmentMetadata - - The id of the attachment. Holds the complete path which can be used to download the file. - -indexInDataPackage -^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer indexInDataPackage - :outertype: DataPackageAttachmentMetadata - - The index in the \ :java:ref:`DataPackage`\ of this attachment. Used for sorting the attachments of this \ :java:ref:`DataPackage`\ . Must not be empty. - -language -^^^^^^^^ - -.. java:field:: @NotNull @ValidIsoLanguage private String language - :outertype: DataPackageAttachmentMetadata - - The language of the attachments content. Must not be empty and must be specified as ISO 639 language code. - -masterId -^^^^^^^^ - -.. java:field:: @Setter private String masterId - :outertype: DataPackageAttachmentMetadata - - The master id of the dataPackage attachment. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: DataPackageAttachmentMetadata - -title -^^^^^ - -.. java:field:: @NotEmpty @Size private String title - :outertype: DataPackageAttachmentMetadata - - An optional title of this attachment in the attachments' language. Must not be empty and it must not contain more than 2048 characters. - -type -^^^^ - -.. java:field:: @NotNull @I18nStringSize @ValidDataPackageAttachmentType private I18nString type - :outertype: DataPackageAttachmentMetadata - - The type of the attachment. Must be one of \ :java:ref:`DataPackageAttachmentTypes`\ and must not be empty. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackageAttachmentTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackageAttachmentTypes.rst deleted file mode 100644 index ae5b05a274..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackageAttachmentTypes.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -DataPackageAttachmentTypes -========================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain - :noindex: - -.. java:type:: public class DataPackageAttachmentTypes - - All valid types of a \ :java:ref:`DataPackageAttachmentMetadata`\ . - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: DataPackageAttachmentTypes - -METHOD_REPORT -^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString METHOD_REPORT - :outertype: DataPackageAttachmentTypes - -OTHER -^^^^^ - -.. java:field:: public static final I18nString OTHER - :outertype: DataPackageAttachmentTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.rst deleted file mode 100644 index 3401390104..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.rst +++ /dev/null @@ -1,108 +0,0 @@ -.. java:import:: java.util Set - -MetadataExportFormat -==================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain - :noindex: - -.. java:type:: public enum MetadataExportFormat - - Formats to which our metadata can be exported. The actual mapping is either powered by da|ra's OAI-PMH service or data cite. - - :author: René Reitmann - -Enum Constants --------------- -dara -^^^^ - -.. java:field:: public static final MetadataExportFormat dara - :outertype: MetadataExportFormat - -data_cite_json -^^^^^^^^^^^^^^ - -.. java:field:: public static final MetadataExportFormat data_cite_json - :outertype: MetadataExportFormat - -data_cite_xml -^^^^^^^^^^^^^ - -.. java:field:: public static final MetadataExportFormat data_cite_xml - :outertype: MetadataExportFormat - -mds -^^^ - -.. java:field:: public static final MetadataExportFormat mds - :outertype: MetadataExportFormat - -oai_dara -^^^^^^^^ - -.. java:field:: public static final MetadataExportFormat oai_dara - :outertype: MetadataExportFormat - -oai_dc -^^^^^^ - -.. java:field:: public static final MetadataExportFormat oai_dc - :outertype: MetadataExportFormat - -oai_ddi31 -^^^^^^^^^ - -.. java:field:: public static final MetadataExportFormat oai_ddi31 - :outertype: MetadataExportFormat - -oai_ddi32 -^^^^^^^^^ - -.. java:field:: public static final MetadataExportFormat oai_ddi32 - :outertype: MetadataExportFormat - -schema_org_json_ld -^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final MetadataExportFormat schema_org_json_ld - :outertype: MetadataExportFormat - -Fields ------- -DATACITE_FORMATS -^^^^^^^^^^^^^^^^ - -.. java:field:: public static final Set DATACITE_FORMATS - :outertype: MetadataExportFormat - - Export formats powered by data cite. - - **See also:** :java:ref:`https://commons.datacite.org/doi.org/10.21249/dzhw:gra2005:1.0.0` - -OAI_FORMATS -^^^^^^^^^^^ - -.. java:field:: public static final Set OAI_FORMATS - :outertype: MetadataExportFormat - - Export formats powered by da|ra's OAI-PMH service. - - **See also:** :java:ref:`https://www.da-ra.de/oaip/` - -fileExtension -^^^^^^^^^^^^^ - -.. java:field:: public final String fileExtension - :outertype: MetadataExportFormat - - The file extension for the downloaded format (xml or json). - -urlFormat -^^^^^^^^^ - -.. java:field:: public final String urlFormat - :outertype: MetadataExportFormat - - The format as it can be used in URLs. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MethodReportCitationDetails.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MethodReportCitationDetails.rst deleted file mode 100644 index 1e2492c132..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MethodReportCitationDetails.rst +++ /dev/null @@ -1,82 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.util List - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints Max - -.. java:import:: javax.validation.constraints Min - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain Person - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -MethodReportCitationDetails -=========================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class MethodReportCitationDetails implements Serializable - - Additional details required by \ :java:ref:`DataPackageAttachmentMetadata`\ s of type "Method Report". - - :author: René Reitmann - -Fields ------- -authors -^^^^^^^ - -.. java:field:: @Valid @NotEmpty private List authors - :outertype: MethodReportCitationDetails - - List of \ :java:ref:`Person`\ s which have authored this report. Must not be empty. - -institution -^^^^^^^^^^^ - -.. java:field:: @NotEmpty @Size private String institution - :outertype: MethodReportCitationDetails - - The institution which created the method report. Must not be empty and not more than 512 characters. - -location -^^^^^^^^ - -.. java:field:: @NotEmpty @Size private String location - :outertype: MethodReportCitationDetails - - The location of the institution which created the method report. Must not be empty and not more than 512 characters. - -publicationYear -^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull @Min @Max private Integer publicationYear - :outertype: MethodReportCitationDetails - - The year in which the method report was published. Must not be empty and not before 1990. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: MethodReportCitationDetails - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/SurveyDesigns.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/SurveyDesigns.rst deleted file mode 100644 index f565471884..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/SurveyDesigns.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -SurveyDesigns -============= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain - :noindex: - -.. java:type:: public class SurveyDesigns - - List of currently supported survey designs. - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: SurveyDesigns - -CROSS_SECTION -^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString CROSS_SECTION - :outertype: SurveyDesigns - -PANEL -^^^^^ - -.. java:field:: public static final I18nString PANEL - :outertype: SurveyDesigns - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/Tags.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/Tags.rst deleted file mode 100644 index 4d42c45f0c..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/Tags.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.util Set - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: org.javers.core.metamodel.annotation TypeName - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Tags -==== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain - :noindex: - -.. java:type:: @Data @TypeName @NoArgsConstructor public class Tags implements Serializable - - Contains tags associated with a dataPackage. - -Fields ------- -de -^^ - -.. java:field:: @NotEmpty private Set de - :outertype: Tags - - German tags. At least one tag must be provided. - -en -^^ - -.. java:field:: private Set en - :outertype: Tags - - English tags (optional). - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Tags - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/TimeMethods.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/TimeMethods.rst deleted file mode 100644 index 1c4548ecbf..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/TimeMethods.rst +++ /dev/null @@ -1,86 +0,0 @@ -TimeMethods -=========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain - :noindex: - -.. java:type:: public class TimeMethods - - Describes the time dimension of the data collection. Used by DARA as time dimension and harvested by the VFDB. - - **See also:** :java:ref:`https://mdr.iqb.hu-berlin.de/./catalog/56cc4164-6731-7d54-c97f-ad9bd24bf1b7` - -Fields ------- -CROSSSECTION -^^^^^^^^^^^^ - -.. java:field:: public static final String CROSSSECTION - :outertype: TimeMethods - -CROSSSECTIONADHOCFOLLOWUP -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String CROSSSECTIONADHOCFOLLOWUP - :outertype: TimeMethods - -LONGITUDINAL -^^^^^^^^^^^^ - -.. java:field:: public static final String LONGITUDINAL - :outertype: TimeMethods - -LONGITUDINAL_COHORTEVENTBASED -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String LONGITUDINAL_COHORTEVENTBASED - :outertype: TimeMethods - -LONGITUDINAL_PANEL -^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String LONGITUDINAL_PANEL - :outertype: TimeMethods - -LONGITUDINAL_PANEL_CONTINOUS -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String LONGITUDINAL_PANEL_CONTINOUS - :outertype: TimeMethods - -LONGITUDINAL_PANEL_INTERVAL -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String LONGITUDINAL_PANEL_INTERVAL - :outertype: TimeMethods - -LONGITUDINAL_TRENDREPEATEDCROSSSECTION -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String LONGITUDINAL_TRENDREPEATEDCROSSSECTION - :outertype: TimeMethods - -Other -^^^^^ - -.. java:field:: public static final String Other - :outertype: TimeMethods - -TIMESERIES -^^^^^^^^^^ - -.. java:field:: public static final String TIMESERIES - :outertype: TimeMethods - -TIMESERIES_CONTINOUS -^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String TIMESERIES_CONTINOUS - :outertype: TimeMethods - -TIMESERIES_DISCRETE -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String TIMESERIES_DISCRETE - :outertype: TimeMethods - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/package-index.rst deleted file mode 100644 index 337e81ad5a..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/package-index.rst +++ /dev/null @@ -1,19 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain -=========================================================== - -Domain objects describing \ :java:ref:`eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.DataPackage`\ s. - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain - -.. toctree:: - :maxdepth: 1 - - DataPackage - DataPackageAttachmentMetadata - DataPackageAttachmentTypes - MetadataExportFormat - MethodReportCitationDetails - SurveyDesigns - Tags - TimeMethods - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataFormat.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataFormat.rst deleted file mode 100644 index 943f46eb4a..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataFormat.rst +++ /dev/null @@ -1,42 +0,0 @@ -DataFormat -========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain - :noindex: - -.. java:type:: public enum DataFormat - - File format for \ :java:ref:`SubDataSet`\ . - -Enum Constants --------------- -CSV -^^^ - -.. java:field:: public static final DataFormat CSV - :outertype: DataFormat - -R -^ - -.. java:field:: public static final DataFormat R - :outertype: DataFormat - -SPSS -^^^^ - -.. java:field:: public static final DataFormat SPSS - :outertype: DataFormat - -Stata -^^^^^ - -.. java:field:: public static final DataFormat Stata - :outertype: DataFormat - -Word -^^^^ - -.. java:field:: public static final DataFormat Word - :outertype: DataFormat - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSet.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSet.rst deleted file mode 100644 index 9452f0f16e..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSet.rst +++ /dev/null @@ -1,198 +0,0 @@ -.. java:import:: java.util List - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.springframework.beans BeanUtils - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.index CompoundIndex - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidShadowId - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.validation UniqueDatasetNumberInProject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.validation UniqueSubDatasetAccessWayInDataSet - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.validation ValidDataSetIdName - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.validation ValidDataSetType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.validation ValidFormat - -.. java:import:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain OrderedDataPackage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain Survey - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain AccessWays - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain Variable - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -DataSet -======= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain - :noindex: - -.. java:type:: @Entity @Document @ValidDataSetIdName @UniqueDatasetNumberInProject @CompoundIndex @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValidShadowId public class DataSet extends AbstractShadowableRdcDomainObject - - A dataset contains \ :java:ref:`Variable`\ s. It results from at least one \ :java:ref:`Survey`\ . - -Fields ------- -annotations -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString annotations - :outertype: DataSet - - Arbitrary additional text for the dataset. Markdown is supported. Must not contain more than 2048 characters. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataAcquisitionProjectId - :outertype: DataSet - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which this dataset belongs. The dataAcquisitionProjectId must not be empty. - -dataPackageId -^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataPackageId - :outertype: DataSet - - The id of the \ :java:ref:`OrderedDataPackage`\ to which this dataset belongs. Must not be empty. - -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringNotEmpty private I18nString description - :outertype: DataSet - - A short description of the dataset. It must be specified in at least one language and it must not contain more than 2048 characters. - -format -^^^^^^ - -.. java:field:: @ValidFormat private I18nString format - :outertype: DataSet - - The format of the dataset. Must be one of \ :java:ref:`Format`\ . - -id -^^ - -.. java:field:: @Id @NotEmpty @Setter private String id - :outertype: DataSet - - The id of the dataset which uniquely identifies the dataset in this application. - -languages -^^^^^^^^^ - -.. java:field:: private List languages - :outertype: DataSet - - The languages used in the dataset. Must be specified as ISO 639 language codes. - -masterId -^^^^^^^^ - -.. java:field:: @NotEmpty @Size @Pattern @Setter @Indexed private String masterId - :outertype: DataSet - - The master id of this dataset. It must not contain more than 512 characters, must not be empty and must be of the form \ ``dat-{{dataAcquisitionProjectId}}-ds{{number}}$``\ . - -number -^^^^^^ - -.. java:field:: @NotNull private Integer number - :outertype: DataSet - - The number of the dataset. Must not be empty and must be unique within the \ :java:ref:`DataAcquisitionProject`\ . - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: DataSet - -subDataSets -^^^^^^^^^^^ - -.. java:field:: @Valid @NotEmpty @UniqueSubDatasetAccessWayInDataSet private List subDataSets - :outertype: DataSet - - List of \ :java:ref:`SubDataSet`\ s (concrete accessible files) within this dataset. Must contain at least one element. There must not be more than one \ :java:ref:`SubDataSet`\ per \ :java:ref:`AccessWays`\ . - -surveyIds -^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private List surveyIds - :outertype: DataSet - - List of ids of \ :java:ref:`Survey`\ s of this \ :java:ref:`DataAcquisitionProject`\ . The dataset contains results from these \ :java:ref:`Survey`\ s. Must contain at least one element. - -surveyNumbers -^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private List surveyNumbers - :outertype: DataSet - - List of numbers of \ :java:ref:`Survey`\ s of this \ :java:ref:`DataAcquisitionProject`\ . The dataset contains results from these \ :java:ref:`Survey`\ s. Must contain at least one element. - -type -^^^^ - -.. java:field:: @NotNull @ValidDataSetType private I18nString type - :outertype: DataSet - - The type of the dataset. Must be one of \ :java:ref:`DataSetTypes`\ and must not be empty. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSetAttachmentMetadata.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSetAttachmentMetadata.rst deleted file mode 100644 index 3fe7390a70..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSetAttachmentMetadata.rst +++ /dev/null @@ -1,140 +0,0 @@ -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -DataSetAttachmentMetadata -========================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain - :noindex: - -.. java:type:: @Entity @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class DataSetAttachmentMetadata extends AbstractShadowableRdcDomainObject - - Metadata which will be stored with each attachment of a \ :java:ref:`DataSet`\ . - -Fields ------- -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String dataAcquisitionProjectId - :outertype: DataSetAttachmentMetadata - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which the \ :java:ref:`DataSet`\ of this attachment belongs. Must not be empty. - -dataSetId -^^^^^^^^^ - -.. java:field:: @NotEmpty private String dataSetId - :outertype: DataSetAttachmentMetadata - - The id of the \ :java:ref:`DataSet`\ to which this attachment belongs. Must not be empty. - -dataSetNumber -^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer dataSetNumber - :outertype: DataSetAttachmentMetadata - - The number of the \ :java:ref:`DataSet`\ to which this attachment belongs. Must not be empty. - -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringNotEmpty private I18nString description - :outertype: DataSetAttachmentMetadata - - A description for this attachment. It must be specified in at least one language and it must not contain more than 512 characters. - -fileName -^^^^^^^^ - -.. java:field:: @NotEmpty @Pattern private String fileName - :outertype: DataSetAttachmentMetadata - - The filename of the attachment. Must not be empty and must contain only (german) alphanumeric characters and "_" and "-" and ".". - -id -^^ - -.. java:field:: @Id @Setter private String id - :outertype: DataSetAttachmentMetadata - - The id of the attachment. Holds the complete path which can be used to download the file. - -indexInDataSet -^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer indexInDataSet - :outertype: DataSetAttachmentMetadata - - The index in the \ :java:ref:`DataSet`\ of this attachment. Used for sorting the attachments of this \ :java:ref:`DataSet`\ . Must not be empty. - -language -^^^^^^^^ - -.. java:field:: @NotNull @ValidIsoLanguage private String language - :outertype: DataSetAttachmentMetadata - - The language of the attachments content. Must not be empty and must be specified as ISO 639 language code. - -masterId -^^^^^^^^ - -.. java:field:: @Setter private String masterId - :outertype: DataSetAttachmentMetadata - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: DataSetAttachmentMetadata - -title -^^^^^ - -.. java:field:: @NotEmpty @Size private String title - :outertype: DataSetAttachmentMetadata - - The title of the attachment in the language of the attachment. Must not be empty and must not contain more than 2048 characters. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSetTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSetTypes.rst deleted file mode 100644 index 866c2f4f23..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/DataSetTypes.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -DataSetTypes -============ - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain - :noindex: - -.. java:type:: public class DataSetTypes - - All possible types of a \ :java:ref:`DataSet`\ . - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: DataSetTypes - -EPISODE_RECORD -^^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString EPISODE_RECORD - :outertype: DataSetTypes - -PERSONAL_RECORD -^^^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString PERSONAL_RECORD - :outertype: DataSetTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/Format.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/Format.rst deleted file mode 100644 index c5791838d3..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/Format.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -Format -====== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain - :noindex: - -.. java:type:: public class Format - - All possible formats of a \ :java:ref:`DataSet`\ . - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: Format - -LONG -^^^^ - -.. java:field:: public static final I18nString LONG - :outertype: Format - -WIDE -^^^^ - -.. java:field:: public static final I18nString WIDE - :outertype: Format - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/SubDataSet.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/SubDataSet.rst deleted file mode 100644 index 96083cebb6..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/SubDataSet.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.util Set - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.validation ValidAccessWay - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain AccessWays - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -SubDataSet -========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class SubDataSet implements Serializable - - A subdataset is part of a \ :java:ref:`DataSet`\ and describes the concrete analyzable file which is accessible by a given access way. - -Fields ------- -accessWay -^^^^^^^^^ - -.. java:field:: @NotNull @ValidAccessWay private String accessWay - :outertype: SubDataSet - - The access way of this subdataset. Describes how the user will be able to work with the data set. Must not be empty and be one of \ :java:ref:`AccessWays`\ but not \ :java:ref:`AccessWays.NOT_ACCESSIBLE`\ . - -dataFormats -^^^^^^^^^^^ - -.. java:field:: @NotEmpty private Set dataFormats - :outertype: SubDataSet - - Set of available file formats of the \ :java:ref:`SubDataSet`\ . - -description -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize @I18nStringNotEmpty private I18nString description - :outertype: SubDataSet - - A description for this subdataset. It must be specified in at least one language and it must not contain more than 512 characters. - -name -^^^^ - -.. java:field:: @NotEmpty @Size private String name - :outertype: SubDataSet - - The filename of the subdataset without extension. Must not be empty and must not contain more than 32 characters. - -numberOfObservations -^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer numberOfObservations - :outertype: SubDataSet - - The number of rows (observations or episodes) which are present in this subdataset. Must not be empty. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: SubDataSet - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/package-index.rst deleted file mode 100644 index 255aafd9ba..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/package-index.rst +++ /dev/null @@ -1,17 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain -======================================================= - -Domain objects describing \ :java:ref:`eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.DataSet`\ s. - -.. java:package:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain - -.. toctree:: - :maxdepth: 1 - - DataFormat - DataSet - DataSetAttachmentMetadata - DataSetTypes - Format - SubDataSet - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/CollectionModes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/CollectionModes.rst deleted file mode 100644 index 42ad2bdde6..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/CollectionModes.rst +++ /dev/null @@ -1,288 +0,0 @@ -CollectionModes -=============== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain - :noindex: - -.. java:type:: public class CollectionModes - - The procedure, technique, or mode of inquiry used to attain the data. Used by DARA as collection mode type and harvested by the VFDB. - -Fields ------- -AGGREGATION -^^^^^^^^^^^ - -.. java:field:: public static final String AGGREGATION - :outertype: CollectionModes - -COMPILATIONSYNTHESIS -^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String COMPILATIONSYNTHESIS - :outertype: CollectionModes - -CONTENTCODING -^^^^^^^^^^^^^ - -.. java:field:: public static final String CONTENTCODING - :outertype: CollectionModes - -EXPERIMENT -^^^^^^^^^^ - -.. java:field:: public static final String EXPERIMENT - :outertype: CollectionModes - -EXPERIMENT_FIELDINTERVENTION -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String EXPERIMENT_FIELDINTERVENTION - :outertype: CollectionModes - -EXPERIMENT_LABORATORY -^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String EXPERIMENT_LABORATORY - :outertype: CollectionModes - -EXPERIMENT_WEBBASED -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String EXPERIMENT_WEBBASED - :outertype: CollectionModes - -FOCUSGROUP -^^^^^^^^^^ - -.. java:field:: public static final String FOCUSGROUP - :outertype: CollectionModes - -FOCUSGROUP_FACETOFACE -^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String FOCUSGROUP_FACETOFACE - :outertype: CollectionModes - -FOCUSGROUP_ONLINE -^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String FOCUSGROUP_ONLINE - :outertype: CollectionModes - -FOCUSGROUP_TELEPHONE -^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String FOCUSGROUP_TELEPHONE - :outertype: CollectionModes - -INTERVIEW -^^^^^^^^^ - -.. java:field:: public static final String INTERVIEW - :outertype: CollectionModes - -INTERVIEW_EMAIL -^^^^^^^^^^^^^^^ - -.. java:field:: public static final String INTERVIEW_EMAIL - :outertype: CollectionModes - -INTERVIEW_FACETOFACE -^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String INTERVIEW_FACETOFACE - :outertype: CollectionModes - -INTERVIEW_FACETOFACE_CAPICAMI -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String INTERVIEW_FACETOFACE_CAPICAMI - :outertype: CollectionModes - -INTERVIEW_FACETOFACE_PAPI -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String INTERVIEW_FACETOFACE_PAPI - :outertype: CollectionModes - -INTERVIEW_TELEPHONE -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String INTERVIEW_TELEPHONE - :outertype: CollectionModes - -INTERVIEW_TELEPHONE_CATI -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String INTERVIEW_TELEPHONE_CATI - :outertype: CollectionModes - -INTERVIEW_WEBBASED -^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String INTERVIEW_WEBBASED - :outertype: CollectionModes - -MEASUREMENTSANDTESTS -^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String MEASUREMENTSANDTESTS - :outertype: CollectionModes - -MEASUREMENTSANDTESTS_EDUCATIONAL -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String MEASUREMENTSANDTESTS_EDUCATIONAL - :outertype: CollectionModes - -MEASUREMENTSANDTESTS_PHYSICAL -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String MEASUREMENTSANDTESTS_PHYSICAL - :outertype: CollectionModes - -MEASUREMENTSANDTESTS_PSYCHOLOGICAL -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String MEASUREMENTSANDTESTS_PSYCHOLOGICAL - :outertype: CollectionModes - -OBSERVATION -^^^^^^^^^^^ - -.. java:field:: public static final String OBSERVATION - :outertype: CollectionModes - -OBSERVATION_COMPUTERBASED -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String OBSERVATION_COMPUTERBASED - :outertype: CollectionModes - -OBSERVATION_FIELD -^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String OBSERVATION_FIELD - :outertype: CollectionModes - -OBSERVATION_FIELD_NONPARTICIPANT -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String OBSERVATION_FIELD_NONPARTICIPANT - :outertype: CollectionModes - -OBSERVATION_FIELD_PARTICIPANT -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String OBSERVATION_FIELD_PARTICIPANT - :outertype: CollectionModes - -OBSERVATION_LABARATORY -^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String OBSERVATION_LABARATORY - :outertype: CollectionModes - -OBSERVATION_LABARATORY_NONPARTICIPANT -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String OBSERVATION_LABARATORY_NONPARTICIPANT - :outertype: CollectionModes - -OBSERVATION_LABARATORY_PARTICIPANT -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String OBSERVATION_LABARATORY_PARTICIPANT - :outertype: CollectionModes - -OTHER -^^^^^ - -.. java:field:: public static final String OTHER - :outertype: CollectionModes - -RECORDING -^^^^^^^^^ - -.. java:field:: public static final String RECORDING - :outertype: CollectionModes - -SELFADMINISTEREDQUESTIONNAIRE -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDQUESTIONNAIRE - :outertype: CollectionModes - -SELFADMINISTEREDQUESTIONNAIRE_COMPUTERASSISTED -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDQUESTIONNAIRE_COMPUTERASSISTED - :outertype: CollectionModes - -SELFADMINISTEREDQUESTIONNAIRE_EMAIL -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDQUESTIONNAIRE_EMAIL - :outertype: CollectionModes - -SELFADMINISTEREDQUESTIONNAIRE_PAPER -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDQUESTIONNAIRE_PAPER - :outertype: CollectionModes - -SELFADMINISTEREDQUESTIONNAIRE_SMSORMMS -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDQUESTIONNAIRE_SMSORMMS - :outertype: CollectionModes - -SELFADMINISTEREDQUESTIONNAIRE_WEBBASED -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDQUESTIONNAIRE_WEBBASED - :outertype: CollectionModes - -SELFADMINISTEREDWRITINGSANDDIARIES -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDWRITINGSANDDIARIES - :outertype: CollectionModes - -SELFADMINISTEREDWRITINGSANDDIARIES_EMAIL -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDWRITINGSANDDIARIES_EMAIL - :outertype: CollectionModes - -SELFADMINISTEREDWRITINGSANDDIARIES_PAPER -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDWRITINGSANDDIARIES_PAPER - :outertype: CollectionModes - -SELFADMINISTEREDWRITINGSANDDIARIES_WEBBASED -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final String SELFADMINISTEREDWRITINGSANDDIARIES_WEBBASED - :outertype: CollectionModes - -SIMULATION -^^^^^^^^^^ - -.. java:field:: public static final String SIMULATION - :outertype: CollectionModes - -SUMMARY -^^^^^^^ - -.. java:field:: public static final String SUMMARY - :outertype: CollectionModes - -TRANSCRIPTION -^^^^^^^^^^^^^ - -.. java:field:: public static final String TRANSCRIPTION - :outertype: CollectionModes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/Instrument.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/Instrument.rst deleted file mode 100644 index 8adc070fd3..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/Instrument.rst +++ /dev/null @@ -1,200 +0,0 @@ -.. java:import:: java.util List - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.springframework.beans BeanUtils - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.index CompoundIndex - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidShadowId - -.. java:import:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain Concept - -.. java:import:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain.validation ConceptExists - -.. java:import:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain.validation ValidInstrumentIdPattern - -.. java:import:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain.validation ValidInstrumentType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain.validation ValidUniqueInstrumentNumber - -.. java:import:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain OrderedDataPackage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain Survey - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -Instrument -========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain - :noindex: - -.. java:type:: @Entity @Document @ValidInstrumentIdPattern @ValidUniqueInstrumentNumber @CompoundIndex @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValidShadowId public class Instrument extends AbstractShadowableRdcDomainObject - - An instrument (e.g. a questionnaire) which was used in at least one \ :java:ref:`Survey`\ . - -Fields ------- -annotations -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString annotations - :outertype: Instrument - - Arbitrary additional text for this instrument. Markdown is supported. Must not contain more than 2048 characters. - -conceptIds -^^^^^^^^^^ - -.. java:field:: @Indexed private List conceptIds - :outertype: Instrument - - List of ids of \ :java:ref:`Concept`\ s to which are covered by this instrument. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataAcquisitionProjectId - :outertype: Instrument - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which this instrument belongs. The dataAcquisitionProjectId must not be empty. - -dataPackageId -^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataPackageId - :outertype: Instrument - - The id of the \ :java:ref:`OrderedDataPackage`\ to which this instrument belongs. Must not be empty. - -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringNotEmpty private I18nString description - :outertype: Instrument - - A short description of the instrument. It must be specified in at least one language and it must not contain more than 512 characters. - -id -^^ - -.. java:field:: @Id @NotEmpty @Setter private String id - :outertype: Instrument - - The id of the instrument which uniquely identifies the instrument in this application. - -masterId -^^^^^^^^ - -.. java:field:: @NotEmpty @Size @Pattern @Setter @Indexed private String masterId - :outertype: Instrument - - The instrument's master id. It must not be empty, must be of the form \ ``ins-{{dataAcquisitionProjectId}}-ins{{number}}$``\ and must not contain more than 512 characters. - -number -^^^^^^ - -.. java:field:: @NotNull private Integer number - :outertype: Instrument - - The number of the instrument. Must not be empty and must be unique within the \ :java:ref:`DataAcquisitionProject`\ . - -originalLanguages -^^^^^^^^^^^^^^^^^ - -.. java:field:: private List originalLanguages - :outertype: Instrument - - The languages of the instrument during the data collection. Must be specified as ISO 639 language codes. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Instrument - -subtitle -^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString subtitle - :outertype: Instrument - - An optional subtitle of the instrument. It must not contain more than 2048 characters. - -surveyIds -^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private List surveyIds - :outertype: Instrument - - List of ids of \ :java:ref:`Survey`\ s of this \ :java:ref:`DataAcquisitionProject`\ . The instrument has been used in these \ :java:ref:`Survey`\ s. Must contain at least one element. - -surveyNumbers -^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private List surveyNumbers - :outertype: Instrument - - List of numbers of \ :java:ref:`Survey`\ s of this \ :java:ref:`DataAcquisitionProject`\ . The instrument has been used in these \ :java:ref:`Survey`\ s. Must contain at least one element. - -title -^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringNotEmpty private I18nString title - :outertype: Instrument - - The title of the instrument. It must be specified in at least one language and it must not contain more than 2048 characters. - -type -^^^^ - -.. java:field:: @NotEmpty @ValidInstrumentType private String type - :outertype: Instrument - - The type of this instrument. Must be one of \ :java:ref:`InstrumentTypes`\ and must not be empty. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentAttachmentMetadata.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentAttachmentMetadata.rst deleted file mode 100644 index ccd8a99eff..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentAttachmentMetadata.rst +++ /dev/null @@ -1,142 +0,0 @@ -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain.validation ValidInstrumentAttachmentType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -InstrumentAttachmentMetadata -============================ - -.. java:package:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain - :noindex: - -.. java:type:: @Entity @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class InstrumentAttachmentMetadata extends AbstractShadowableRdcDomainObject - - Metadata which will be stored with each attachment of a \ :java:ref:`Instrument`\ . - -Fields ------- -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String dataAcquisitionProjectId - :outertype: InstrumentAttachmentMetadata - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which the \ :java:ref:`Instrument`\ of this attachment belongs. Must not be empty. - -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringNotEmpty private I18nString description - :outertype: InstrumentAttachmentMetadata - - A description for this attachment. It must be specified in at least one language and it must not contain more than 512 characters. - -fileName -^^^^^^^^ - -.. java:field:: @NotEmpty @Pattern private String fileName - :outertype: InstrumentAttachmentMetadata - - The filename of the attachment. Must not be empty and must contain only (german) alphanumeric characters and "_" and "-" and ".". - -id -^^ - -.. java:field:: @Id @Setter private String id - :outertype: InstrumentAttachmentMetadata - - The id of the attachment. Holds the complete path which can be used to download the file. - -indexInInstrument -^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer indexInInstrument - :outertype: InstrumentAttachmentMetadata - - The index in the \ :java:ref:`Instrument`\ of this attachment. Used for sorting the attachments of this \ :java:ref:`Instrument`\ . Must not be empty. - -instrumentId -^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String instrumentId - :outertype: InstrumentAttachmentMetadata - - The id of the \ :java:ref:`Instrument`\ to which this attachment belongs. Must not be empty. - -instrumentNumber -^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer instrumentNumber - :outertype: InstrumentAttachmentMetadata - - The number of the \ :java:ref:`Instrument`\ to which this attachment belongs. Must not be empty. - -language -^^^^^^^^ - -.. java:field:: @NotNull @ValidIsoLanguage private String language - :outertype: InstrumentAttachmentMetadata - - The language of the attachments content. Must not be empty and must be specified as ISO 639 language code. - -masterId -^^^^^^^^ - -.. java:field:: @Setter private String masterId - :outertype: InstrumentAttachmentMetadata - - The master id of the instrument attachment metadata. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: InstrumentAttachmentMetadata - -type -^^^^ - -.. java:field:: @NotNull @I18nStringSize @ValidInstrumentAttachmentType private I18nString type - :outertype: InstrumentAttachmentMetadata - - The type of this attachment. Must not be empty and must be one of \ :java:ref:`InstrumentAttachmentTypes`\ . - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentAttachmentTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentAttachmentTypes.rst deleted file mode 100644 index 2ab38a2208..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentAttachmentTypes.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. java:import:: java.util ArrayList - -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util List - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -InstrumentAttachmentTypes -========================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain - :noindex: - -.. java:type:: public class InstrumentAttachmentTypes - - All valid types of an instrument attachment. - -Fields ------- -ALL -^^^ - -.. java:field:: public static final List ALL - :outertype: InstrumentAttachmentTypes - -OTHER -^^^^^ - -.. java:field:: public static final I18nString OTHER - :outertype: InstrumentAttachmentTypes - -QUESTIONNAIRE -^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString QUESTIONNAIRE - :outertype: InstrumentAttachmentTypes - -QUESTION_FLOW -^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString QUESTION_FLOW - :outertype: InstrumentAttachmentTypes - -VARIABLE_QUESTIONNAIRE -^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString VARIABLE_QUESTIONNAIRE - :outertype: InstrumentAttachmentTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentTypes.rst deleted file mode 100644 index d33bdabb7a..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/InstrumentTypes.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -InstrumentTypes -=============== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain - :noindex: - -.. java:type:: public class InstrumentTypes - - All valid types of an instrument. - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: InstrumentTypes - -CAPI -^^^^ - -.. java:field:: public static final String CAPI - :outertype: InstrumentTypes - -CATI -^^^^ - -.. java:field:: public static final String CATI - :outertype: InstrumentTypes - -CAWI -^^^^ - -.. java:field:: public static final String CAWI - :outertype: InstrumentTypes - -INTERVIEW -^^^^^^^^^ - -.. java:field:: public static final String INTERVIEW - :outertype: InstrumentTypes - -PAPI -^^^^ - -.. java:field:: public static final String PAPI - :outertype: InstrumentTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/package-index.rst deleted file mode 100644 index ce9ccdbd07..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/package-index.rst +++ /dev/null @@ -1,16 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain -========================================================== - -Domain objects describing \ :java:ref:`eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain.Instrument`\ s. - -.. java:package:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain - -.. toctree:: - :maxdepth: 1 - - CollectionModes - Instrument - InstrumentAttachmentMetadata - InstrumentAttachmentTypes - InstrumentTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Order.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Order.rst deleted file mode 100644 index 02a3c061d9..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Order.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. java:import:: java.util List - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain Counter - -.. java:import:: io.swagger.v3.oas.annotations.media Schema - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok ToString - -Order -===== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain - :noindex: - -.. java:type:: @Document @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder @Schema public class Order extends AbstractRdcDomainObject - - Order (DTO) containing all relevant information for ordered \ :java:ref:`Product`\ s. - -Fields ------- -client -^^^^^^ - -.. java:field:: @Indexed @NotNull private OrderClient client - :outertype: Order - - The id of the client (one of @link \ :java:ref:`OrderClient`\ ) who has last modified this order. - -id -^^ - -.. java:field:: @Id private String id - :outertype: Order - - The id of an order. It is a number which is generated by a sequence (see \ :java:ref:`Counter`\ . - -languageKey -^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String languageKey - :outertype: Order - - The key of the preferred language (either "de" or "en") of the customer. Must not be empty. - -products -^^^^^^^^ - -.. java:field:: @Valid private List products - :outertype: Order - - List of data \ :java:ref:`Product`\ s the customer want to order. Must not be empty. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Order - -state -^^^^^ - -.. java:field:: @Indexed @NotNull private OrderState state - :outertype: Order - - The current state of the order. One of \ :java:ref:`OrderState`\ . - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderAlreadyCompletedException.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderAlreadyCompletedException.rst deleted file mode 100644 index aeea910de4..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderAlreadyCompletedException.rst +++ /dev/null @@ -1,18 +0,0 @@ -OrderAlreadyCompletedException -============================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain - :noindex: - -.. java:type:: public class OrderAlreadyCompletedException extends IllegalArgumentException - - Orders with \ :java:ref:`OrderState.ORDERED`\ must not be updated. This exception should be thrown whenever an update attempt is made on such orders. - -Fields ------- -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: OrderAlreadyCompletedException - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderClient.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderClient.rst deleted file mode 100644 index 1cd8c82647..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderClient.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. java:import:: io.swagger.v3.oas.annotations.media Schema - -OrderClient -=========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain - :noindex: - -.. java:type:: @Schema public enum OrderClient - - Enum holding possible clients with write access to the orders. - -Enum Constants --------------- -DLP -^^^ - -.. java:field:: public static final OrderClient DLP - :outertype: OrderClient - -MDM -^^^ - -.. java:field:: public static final OrderClient MDM - :outertype: OrderClient - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderState.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderState.rst deleted file mode 100644 index bce53bb60f..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderState.rst +++ /dev/null @@ -1,32 +0,0 @@ -OrderState -========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain - :noindex: - -.. java:type:: public enum OrderState - - The states an \ :java:ref:`Order`\ can have. - - :author: René Reitmann - -Enum Constants --------------- -CREATED -^^^^^^^ - -.. java:field:: public static final OrderState CREATED - :outertype: OrderState - -NOTIFIED -^^^^^^^^ - -.. java:field:: public static final OrderState NOTIFIED - :outertype: OrderState - -ORDERED -^^^^^^^ - -.. java:field:: public static final OrderState ORDERED - :outertype: OrderState - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderedDataPackage.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderedDataPackage.rst deleted file mode 100644 index 2aaec5aee8..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderedDataPackage.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.util List - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringEntireNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain DataTypes - -.. java:import:: io.swagger.v3.oas.annotations.media Schema - -.. java:import:: lombok Data - -OrderedDataPackage -================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain - :noindex: - -.. java:type:: @Data @Schema public class OrderedDataPackage implements Serializable - - Partial \ :java:ref:`eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.DataPackage`\ which is part of a \ :java:ref:`Product`\ . It is a copy of the \ :java:ref:`eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.DataPackage`\ attributes which is made when the customer places the orders. - -Fields ------- -annotations -^^^^^^^^^^^ - -.. java:field:: private I18nString annotations - :outertype: OrderedDataPackage - - The annotations of the \ :java:ref:`eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.DataPackage`\ . - -id -^^ - -.. java:field:: @NotEmpty private String id - :outertype: OrderedDataPackage - - The id of the \ :java:ref:`eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.DataPackage`\ . Must not be empty. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: OrderedDataPackage - -studySeries -^^^^^^^^^^^ - -.. java:field:: private I18nString studySeries - :outertype: OrderedDataPackage - - The name of the series of dataPackages to which this dataPackage belongs. May be null. - -surveyDataTypes -^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private List surveyDataTypes - :outertype: OrderedDataPackage - - List of \ :java:ref:`DataTypes`\ . Must not be empty. - -title -^^^^^ - -.. java:field:: @NotNull @I18nStringEntireNotEmpty private I18nString title - :outertype: OrderedDataPackage - - The title of the \ :java:ref:`eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.DataPackage`\ . Must not be empty neither in German nor in English. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Product.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Product.rst deleted file mode 100644 index 3bba7191c2..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Product.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain DataFormat - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain DataSet - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: io.swagger.v3.oas.annotations.media Schema - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: java.util Set - -Product -======= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @Schema public class Product implements Serializable - - Data Product which can be ordered by a customer. - - :author: René Reitmann - -Fields ------- -accessWay -^^^^^^^^^ - -.. java:field:: @NotEmpty private String accessWay - :outertype: Product - - The access way to the \ :java:ref:`DataSet`\ s which the customer wants to have. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String dataAcquisitionProjectId - :outertype: Product - - The id of the \ :java:ref:`DataAcquisitionProject`\ in which this product was generated. Must not be empty. - -dataFormats -^^^^^^^^^^^ - -.. java:field:: @NotEmpty private Set dataFormats - :outertype: Product - - The available data formats of the dataPackage. It must not be empty. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Product - -study -^^^^^ - -.. java:field:: @NotNull @Valid private OrderedDataPackage study - :outertype: Product - - The (partial) \ :java:ref:`OrderedDataPackage`\ of this product. Must not be empty. - -version -^^^^^^^ - -.. java:field:: @NotEmpty private String version - :outertype: Product - - The version of the \ :java:ref:`DataSet`\ s which the customer wants to have. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/package-index.rst deleted file mode 100644 index 299add2078..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/package-index.rst +++ /dev/null @@ -1,17 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.ordermanagement.domain -===================================================== - -Domain objects describing \ :java:ref:`eu.dzhw.fdz.metadatamanagement.ordermanagement.domain.Order`\ s. - -.. java:package:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain - -.. toctree:: - :maxdepth: 1 - - Order - OrderAlreadyCompletedException - OrderClient - OrderState - OrderedDataPackage - Product - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/AssigneeGroup.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/AssigneeGroup.rst deleted file mode 100644 index aa04ef96aa..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/AssigneeGroup.rst +++ /dev/null @@ -1,24 +0,0 @@ -AssigneeGroup -============= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: public enum AssigneeGroup - - Possible assignee groups. - -Enum Constants --------------- -DATA_PROVIDER -^^^^^^^^^^^^^ - -.. java:field:: public static final AssigneeGroup DATA_PROVIDER - :outertype: AssigneeGroup - -PUBLISHER -^^^^^^^^^ - -.. java:field:: public static final AssigneeGroup PUBLISHER - :outertype: AssigneeGroup - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Configuration.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Configuration.rst deleted file mode 100644 index 1b970fabf4..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Configuration.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.util ArrayList - -.. java:import:: java.util List - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Configuration -============= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: @Data @NoArgsConstructor @ValueObject @AllArgsConstructor @Builder public class Configuration implements Serializable - - The project configuration describes which users are publishers or data providers for a project. - -Fields ------- -dataPackagesState -^^^^^^^^^^^^^^^^^ - -.. java:field:: private ProjectState dataPackagesState - :outertype: Configuration - - The state of the dataPackage. - -dataProviders -^^^^^^^^^^^^^ - -.. java:field:: @Builder.Default private List dataProviders - :outertype: Configuration - - User names having the role of a data provider for a project. Must contain at least one user name. - -dataSetsState -^^^^^^^^^^^^^ - -.. java:field:: private ProjectState dataSetsState - :outertype: Configuration - - The state of data sets. - -instrumentsState -^^^^^^^^^^^^^^^^ - -.. java:field:: private ProjectState instrumentsState - :outertype: Configuration - - The state of instruments. - -publicationsState -^^^^^^^^^^^^^^^^^ - -.. java:field:: private ProjectState publicationsState - :outertype: Configuration - - The state of related publications. - -publishers -^^^^^^^^^^ - -.. java:field:: @NotEmpty @Builder.Default private List publishers - :outertype: Configuration - - User names having the role of a publisher for a project. Must contain at least one user name. - -questionsState -^^^^^^^^^^^^^^ - -.. java:field:: private ProjectState questionsState - :outertype: Configuration - - The state of questions. - -requirements -^^^^^^^^^^^^ - -.. java:field:: @Valid @NotNull @Builder.Default private Requirements requirements - :outertype: Configuration - - Defines which object types are required before a project can be released. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Configuration - -surveysState -^^^^^^^^^^^^ - -.. java:field:: private ProjectState surveysState - :outertype: Configuration - - The State of surveys. - -variablesState -^^^^^^^^^^^^^^ - -.. java:field:: private ProjectState variablesState - :outertype: Configuration - - The state of variables. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/DaraUpdateQueueItem.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/DaraUpdateQueueItem.rst deleted file mode 100644 index 7883591e04..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/DaraUpdateQueueItem.rst +++ /dev/null @@ -1,78 +0,0 @@ -.. java:import:: java.time LocalDateTime - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.index CompoundIndex - -.. java:import:: org.springframework.data.mongodb.core.index CompoundIndexes - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractRdcDomainObject - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok ToString - -DaraUpdateQueueItem -=================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: @Document @CompoundIndexes @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class DaraUpdateQueueItem extends AbstractRdcDomainObject - - Publishing metadata to \ `da|ra `_\ will be done asynchronously and repeated as long as the update queue item has not been processed successfully and has therefore been deleted. - -Fields ------- -id -^^ - -.. java:field:: @Id private String id - :outertype: DaraUpdateQueueItem - - The id of the update queue item. It is generated by the database. - -projectId -^^^^^^^^^ - -.. java:field:: @NotEmpty @Indexed private String projectId - :outertype: DaraUpdateQueueItem - - The id of the \ :java:ref:`DataAcquisitionProject`\ which needs to be sent to \ `da|ra `_\ . Must not be empty and there must be at most one update queue item in the database for any project. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: DaraUpdateQueueItem - -updateStartedAt -^^^^^^^^^^^^^^^ - -.. java:field:: private LocalDateTime updateStartedAt - :outertype: DaraUpdateQueueItem - - Timestamp at which the update has been started. - -updateStartedBy -^^^^^^^^^^^^^^^ - -.. java:field:: private String updateStartedBy - :outertype: DaraUpdateQueueItem - - Id of the process who started the updated. Stored in order to avoid having multiple concurrent processes sending data to \ `da|ra `_\ . - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/DataAcquisitionProject.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/DataAcquisitionProject.rst deleted file mode 100644 index 833574cdc0..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/DataAcquisitionProject.rst +++ /dev/null @@ -1,134 +0,0 @@ -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidShadowId - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain DataSet - -.. java:import:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain Instrument - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain.validation SetHasBeenReleasedBeforeOnlyOnce - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain.validation ValidSemanticVersion - -.. java:import:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain Question - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain DataPackage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain Survey - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain Variable - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.springframework.beans BeanUtils - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: java.io Serializable - -DataAcquisitionProject -====================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: @Entity @Document @SetHasBeenReleasedBeforeOnlyOnce @ValidSemanticVersion @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValidShadowId public class DataAcquisitionProject extends AbstractShadowableRdcDomainObject implements Serializable - - The data acquisition project collects the metadata for the data products which are published by our RDC. One project can contain one \ :java:ref:`DataPackage`\ , many \ :java:ref:`Survey`\ s, many \ :java:ref:`Instrument`\ s and \ :java:ref:`Question`\ s, and many \ :java:ref:`DataSet`\ s and \ :java:ref:`Variable`\ s. A project can be currently released (visible to public users) or not. When a publisher releases a project and its version is greater than or equal to 1.0.0 then the metadata is published to \ `da|ra `_\ . - -Fields ------- -assigneeGroup -^^^^^^^^^^^^^ - -.. java:field:: @NotNull private AssigneeGroup assigneeGroup - :outertype: DataAcquisitionProject - - Determines which assignee group is able to edit data on the project. - -configuration -^^^^^^^^^^^^^ - -.. java:field:: @Valid @NotNull @Builder.Default private Configuration configuration - :outertype: DataAcquisitionProject - - Contains the project configuration. - -hasBeenReleasedBefore -^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Boolean hasBeenReleasedBefore - :outertype: DataAcquisitionProject - - Flag indicating whether this project has ever been released in its life. It is used to ensure that project cannot be deleted once they have been released. - -id -^^ - -.. java:field:: @Id @NotEmpty @Setter private String id - :outertype: DataAcquisitionProject - - The id of this project. Must not be empty - -lastAssigneeGroupMessage -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Size private String lastAssigneeGroupMessage - :outertype: DataAcquisitionProject - - The last message provided by an assignee group user before \ :java:ref:`DataAcquisitionProject.assigneeGroup`\ value changed. - -masterId -^^^^^^^^ - -.. java:field:: @NotEmpty @Size @Pattern @Setter private String masterId - :outertype: DataAcquisitionProject - - The master id of this project. Must not be empty, must only contain lower cased (english) letters and numbers and must not contain more than 32 characters. - -release -^^^^^^^ - -.. java:field:: @Valid private Release release - :outertype: DataAcquisitionProject - - A valid \ :java:ref:`Release`\ object. Null if the project is currently not released. The version of a \ :java:ref:`Release`\ must be a syntactically correct according to semver (major.minor.patch) and must not be decreased. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: DataAcquisitionProject - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/FreeResourceTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/FreeResourceTypes.rst deleted file mode 100644 index e42038ace4..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/FreeResourceTypes.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -FreeResourceTypes -================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: public class FreeResourceTypes - - Resource Types as they are harvested from DARA by the VFDB. - - **See also:** :java:ref:`https://mdr.iqb.hu-berlin.de/./catalog/5c4748e0-bcaa-c3c3-e5af-dd481fddbf0c` - -Fields ------- -MIXED_DATA -^^^^^^^^^^ - -.. java:field:: public static final I18nString MIXED_DATA - :outertype: FreeResourceTypes - -QUALITATIVE_DATA -^^^^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString QUALITATIVE_DATA - :outertype: FreeResourceTypes - -SURVEY_DATA -^^^^^^^^^^^ - -.. java:field:: public static final I18nString SURVEY_DATA - :outertype: FreeResourceTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ProjectState.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ProjectState.rst deleted file mode 100644 index 8824ad394b..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ProjectState.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: java.io Serializable - -ProjectState -============ - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: @ValueObject @Data @AllArgsConstructor @NoArgsConstructor @Builder public class ProjectState implements Serializable - - State of a data acquisition project. Used for all metadata - - :author: tgehrke - -Fields ------- -isDataProviderReady -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Builder.Default private boolean isDataProviderReady - :outertype: ProjectState - - indicates if the data providers marked it's metadata as ready. - -isPublisherReady -^^^^^^^^^^^^^^^^ - -.. java:field:: @Builder.Default private boolean isPublisherReady - :outertype: ProjectState - - indicates if the publisher marked the metadata as ready. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ProjectState - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Release.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Release.rst deleted file mode 100644 index 710ca172b2..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Release.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.time LocalDateTime - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Release -======= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class Release implements Serializable - - The release object contains the version and a timestamp of the current release. - -Fields ------- -firstDate -^^^^^^^^^ - -.. java:field:: private LocalDateTime firstDate - :outertype: Release - - The timestamp (in UTC) indicates when a publisher has released the \ :java:ref:`DataAcquisitionProject`\ with the current version for the first time. Will be generated by the server and will not be empty. - -lastDate -^^^^^^^^ - -.. java:field:: @NotNull private LocalDateTime lastDate - :outertype: Release - - The timestamp (in UTC) indicates when a publisher has released the \ :java:ref:`DataAcquisitionProject`\ with the current version the last time. Must not be empty. - -pinToStartPage -^^^^^^^^^^^^^^ - -.. java:field:: private Boolean pinToStartPage - :outertype: Release - - Boolean which indicates whether the data package shall be displayed on the startpage or not. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Release - -version -^^^^^^^ - -.. java:field:: @NotEmpty @Size @Pattern private String version - :outertype: Release - - A valid semver version (major.minor.patch). Must not be empty and must not contain more than 32 characters. A version of a \ :java:ref:`DataAcquisitionProject`\ must not be decreased. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Requirements.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Requirements.rst deleted file mode 100644 index 5ab5e8e698..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/Requirements.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints AssertTrue - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -Requirements -============ - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: @Data @NoArgsConstructor @AllArgsConstructor @ValueObject @EqualsAndHashCode @Builder public class Requirements implements Serializable - - This configuration defines which object types have to be delivered before a project can be released. - -Fields ------- -isDataPackagesRequired -^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @AssertTrue @Setter @Builder.Default private boolean isDataPackagesRequired - :outertype: Requirements - - Defines if dataPackage data is required for a release (this object type is mandatory and this setting is therefore always \ ``true``\ . - -isDataSetsRequired -^^^^^^^^^^^^^^^^^^ - -.. java:field:: private boolean isDataSetsRequired - :outertype: Requirements - - Defines if data set data is required for a release. - -isInstrumentsRequired -^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: private boolean isInstrumentsRequired - :outertype: Requirements - - Defines if instrument data is required for a release. - -isPublicationsRequired -^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: private boolean isPublicationsRequired - :outertype: Requirements - - Defines if publication data is required for a release. - -isQuestionsRequired -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: private boolean isQuestionsRequired - :outertype: Requirements - - Defines if question data is required for a release. - -isSurveysRequired -^^^^^^^^^^^^^^^^^ - -.. java:field:: private boolean isSurveysRequired - :outertype: Requirements - - Defines if survey data is required for a release. - -isVariablesRequired -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: private boolean isVariablesRequired - :outertype: Requirements - - Defines if variable data is required for a release. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Requirements - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem-Action.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem-Action.rst deleted file mode 100644 index 569ce8e18d..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem-Action.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. java:import:: java.time LocalDateTime - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractRdcDomainObject - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -ShadowCopyQueueItem.Action -========================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: public enum Action - :outertype: ShadowCopyQueueItem - - The action which will be performed for the shadows. - -Enum Constants --------------- -CREATE -^^^^^^ - -.. java:field:: public static final ShadowCopyQueueItem.Action CREATE - :outertype: ShadowCopyQueueItem.Action - -HIDE -^^^^ - -.. java:field:: public static final ShadowCopyQueueItem.Action HIDE - :outertype: ShadowCopyQueueItem.Action - -UNHIDE -^^^^^^ - -.. java:field:: public static final ShadowCopyQueueItem.Action UNHIDE - :outertype: ShadowCopyQueueItem.Action - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem.rst deleted file mode 100644 index 54f420a3d0..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. java:import:: java.time LocalDateTime - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractRdcDomainObject - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -ShadowCopyQueueItem -=================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: @Document @AllArgsConstructor @NoArgsConstructor @Data @EqualsAndHashCode public class ShadowCopyQueueItem extends AbstractRdcDomainObject - - Represents a queued shadow copy task of a project. - -Fields ------- -action -^^^^^^ - -.. java:field:: @NotNull private Action action - :outertype: ShadowCopyQueueItem - - The action which will be performed for the shadow copies. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private String dataAcquisitionProjectId - :outertype: ShadowCopyQueueItem - - Project id for which a shadow copy should be created or hidden or unhidden. - -id -^^ - -.. java:field:: @Id private String id - :outertype: ShadowCopyQueueItem - - Queue item id. - -release -^^^^^^^ - -.. java:field:: @NotNull private Release release - :outertype: ShadowCopyQueueItem - - The release object of the project which has been released. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ShadowCopyQueueItem - -updateStartedAt -^^^^^^^^^^^^^^^ - -.. java:field:: private LocalDateTime updateStartedAt - :outertype: ShadowCopyQueueItem - - Start time of the copy process. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyReleaseToDaraNotAllowed.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyReleaseToDaraNotAllowed.rst deleted file mode 100644 index 7f52e0317f..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyReleaseToDaraNotAllowed.rst +++ /dev/null @@ -1,18 +0,0 @@ -ShadowCopyReleaseToDaraNotAllowed -================================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: public class ShadowCopyReleaseToDaraNotAllowed extends IllegalArgumentException - - Thrown if client attempts to release a shadowed project to dara. - -Fields ------- -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ShadowCopyReleaseToDaraNotAllowed - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowHidingNotAllowedException.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowHidingNotAllowedException.rst deleted file mode 100644 index 2dca651278..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowHidingNotAllowedException.rst +++ /dev/null @@ -1,20 +0,0 @@ -ShadowHidingNotAllowedException -=============================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: public class ShadowHidingNotAllowedException extends Exception - - Exception which is thrown when the user tries to hide a master or the most recent shadow copy. - - :author: René Reitmann - -Fields ------- -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ShadowHidingNotAllowedException - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowUnhidingNotAllowedException.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowUnhidingNotAllowedException.rst deleted file mode 100644 index cb72296592..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowUnhidingNotAllowedException.rst +++ /dev/null @@ -1,20 +0,0 @@ -ShadowUnhidingNotAllowedException -================================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - :noindex: - -.. java:type:: public class ShadowUnhidingNotAllowedException extends Exception - - Exception which is thrown when the user tries to unhide shadows which are already unhidden. - - :author: René Reitmann - -Fields ------- -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ShadowUnhidingNotAllowedException - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/package-index.rst deleted file mode 100644 index 91d4907f7f..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/package-index.rst +++ /dev/null @@ -1,24 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.projectmanagement.domain -======================================================= - -Domain objects describing \ :java:ref:`eu.dzhw.fdz.metadatamanagement.projectmanagement.domain.DataAcquisitionProject`\ s. - -.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain - -.. toctree:: - :maxdepth: 1 - - AssigneeGroup - Configuration - DaraUpdateQueueItem - DataAcquisitionProject - FreeResourceTypes - ProjectState - Release - Requirements - ShadowCopyQueueItem - ShadowCopyQueueItem-Action - ShadowCopyReleaseToDaraNotAllowed - ShadowHidingNotAllowedException - ShadowUnhidingNotAllowedException - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/ImageType.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/ImageType.rst deleted file mode 100644 index 442da19a42..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/ImageType.rst +++ /dev/null @@ -1,18 +0,0 @@ -ImageType -========= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain - :noindex: - -.. java:type:: public enum ImageType - - Enum representing supported types of question images. - -Enum Constants --------------- -PNG -^^^ - -.. java:field:: public static final ImageType PNG - :outertype: ImageType - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/Question.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/Question.rst deleted file mode 100644 index 1c146b0ed3..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/Question.rst +++ /dev/null @@ -1,242 +0,0 @@ -.. java:import:: java.util List - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.springframework.beans BeanUtils - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.index CompoundIndex - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidShadowId - -.. java:import:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain Concept - -.. java:import:: eu.dzhw.fdz.metadatamanagement.conceptmanagement.domain.validation ConceptExists - -.. java:import:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain Instrument - -.. java:import:: eu.dzhw.fdz.metadatamanagement.ordermanagement.domain OrderedDataPackage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain.validation ValidQuestionIdName - -.. java:import:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain.validation ValidQuestionType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain.validation ValidUniqueQuestionNumber - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain Survey - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain Variable - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -Question -======== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain - :noindex: - -.. java:type:: @Document @CompoundIndex @ValidUniqueQuestionNumber @ValidQuestionIdName @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValidShadowId public class Question extends AbstractShadowableRdcDomainObject - - A question is part of an \ :java:ref:`Instrument`\ which has been used in at least one \ :java:ref:`Survey`\ s. The responses to a question are stored in \ :java:ref:`Variable`\ s. - -Fields ------- -additionalQuestionText -^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString additionalQuestionText - :outertype: Question - - Arbitrary additional question text which has been presented to the participant. Must not contain more than 1 MB characters. - -annotations -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString annotations - :outertype: Question - - Arbitrary annotations to this question. Markdown is supported. Must not contain more than 2048 characters. - -conceptIds -^^^^^^^^^^ - -.. java:field:: @Indexed private List conceptIds - :outertype: Question - - List of ids of \ :java:ref:`Concept`\ s to which this question belongs. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataAcquisitionProjectId - :outertype: Question - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which this question belongs. The dataAcquisitionProjectId must not be empty. - -dataPackageId -^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataPackageId - :outertype: Question - - The id of the \ :java:ref:`OrderedDataPackage`\ to which this question belongs. Must not be empty. - -id -^^ - -.. java:field:: @Id @NotEmpty @Size @Setter private String id - :outertype: Question - - The id of the question which uniquely identifies the question in this application. - -indexInInstrument -^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer indexInInstrument - :outertype: Question - - The index of the question in the \ :java:ref:`Instrument`\ . Used for sorting the questions. - -instruction -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString instruction - :outertype: Question - - The instruction for the participant which tells how to give the answers to this question. Must not contain more than 1 MB characters. - -instrumentId -^^^^^^^^^^^^ - -.. java:field:: @NotEmpty @Indexed private String instrumentId - :outertype: Question - - The id of the \ :java:ref:`Instrument`\ to which this question belongs. Must not be empty. - -instrumentNumber -^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer instrumentNumber - :outertype: Question - - The number of the \ :java:ref:`Instrument`\ to which this question belongs. Must not be empty. - -introduction -^^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString introduction - :outertype: Question - - The introduction of this question which gives more context to the participant before asking the question. Must not contain more than 2048 characters. - -masterId -^^^^^^^^ - -.. java:field:: @NotEmpty @Size @Pattern @Setter @Indexed private String masterId - :outertype: Question - - The master id of the question. It must not be empty, must be of the form \ ``que-{{dataAcquisitionProjectId}}-ins{{instrumentNumber}}-{{number}}$``\ and must not contain more than 512 characters. - -number -^^^^^^ - -.. java:field:: @NotEmpty @Size @Pattern private String number - :outertype: Question - - The number of the question. Must not be empty and must be unique within the \ :java:ref:`Instrument`\ . Must contain only (german) alphanumeric characters and "_","-" and "." and must not contain more than 32 characters. - -questionText -^^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringNotEmpty @I18nStringSize private I18nString questionText - :outertype: Question - - The question the \ :java:ref:`Survey`\ s participant was asked. It must be specified in at least one language and it must not contain more than 2048 characters. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Question - -successorNumbers -^^^^^^^^^^^^^^^^ - -.. java:field:: private List successorNumbers - :outertype: Question - - List of numbers of the \ :java:ref:`Question`\ s which directly follow this question in the \ :java:ref:`Instrument`\ . - -successors -^^^^^^^^^^ - -.. java:field:: @Indexed private List successors - :outertype: Question - - List of ids of the \ :java:ref:`Question`\ s which directly follow this question in the \ :java:ref:`Instrument`\ . - -technicalRepresentation -^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Valid private TechnicalRepresentation technicalRepresentation - :outertype: Question - - A \ :java:ref:`TechnicalRepresentation`\ of this question. This is optional and can be used to add the source code of the question which was used to generate it. - -topic -^^^^^ - -.. java:field:: @I18nStringSize private I18nString topic - :outertype: Question - - The topic or section in the \ :java:ref:`Instrument`\ to which this question belongs. It must not contain more than 2048 characters. - -type -^^^^ - -.. java:field:: @NotNull @ValidQuestionType private I18nString type - :outertype: Question - - The type of the question. Must be one of QuestionTypes and must not be empty. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/QuestionImageMetadata.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/QuestionImageMetadata.rst deleted file mode 100644 index c1b886ef77..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/QuestionImageMetadata.rst +++ /dev/null @@ -1,138 +0,0 @@ -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain Resolution - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain.validation ValidQuestionImageType - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -QuestionImageMetadata -===================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain - :noindex: - -.. java:type:: @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class QuestionImageMetadata extends AbstractShadowableRdcDomainObject - - The metadata for one question images. One question image displays the question in one language with one given resolution. - -Fields ------- -containsAnnotations -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Boolean containsAnnotations - :outertype: QuestionImageMetadata - - Flag indicating whether the image contains annotations which highlight parts that were only visible to specific participants. These annotations were not visible to the participants. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String dataAcquisitionProjectId - :outertype: QuestionImageMetadata - - The id of the \ :java:ref:`DataAcquisitionProject`\ of the \ :java:ref:`Question`\ to which this image belongs. Must not be empty. - -fileName -^^^^^^^^ - -.. java:field:: @NotEmpty @Pattern private String fileName - :outertype: QuestionImageMetadata - - The name of the images file. Must not be empty and must only contain (german) alphanumeric characters and "_","-" and ".". - -id -^^ - -.. java:field:: @Id @Setter private String id - :outertype: QuestionImageMetadata - -imageType -^^^^^^^^^ - -.. java:field:: @NotNull @ValidQuestionImageType private ImageType imageType - :outertype: QuestionImageMetadata - - The type of this image. Must be one of \ :java:ref:`ImageType`\ and must not be empty. - -indexInQuestion -^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer indexInQuestion - :outertype: QuestionImageMetadata - - The index in the \ :java:ref:`Question`\ of this image. Used for sorting the images of this \ :java:ref:`Question`\ . Must not be empty. - -language -^^^^^^^^ - -.. java:field:: @NotEmpty @Size @ValidIsoLanguage private String language - :outertype: QuestionImageMetadata - - The language of the question text on this image. Must not be empty and must be a valid ISO 639 code. - -masterId -^^^^^^^^ - -.. java:field:: @Setter private String masterId - :outertype: QuestionImageMetadata - - The master id of question image metadata. - -questionId -^^^^^^^^^^ - -.. java:field:: @NotEmpty private String questionId - :outertype: QuestionImageMetadata - - The id of the \ :java:ref:`Question`\ to which this image belongs. Must not be empty. - -resolution -^^^^^^^^^^ - -.. java:field:: @Valid private Resolution resolution - :outertype: QuestionImageMetadata - - The resolution of the image. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: QuestionImageMetadata - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/QuestionTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/QuestionTypes.rst deleted file mode 100644 index 24f7075d8c..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/QuestionTypes.rst +++ /dev/null @@ -1,66 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -QuestionTypes -============= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain - :noindex: - -.. java:type:: public class QuestionTypes - - All valid types of a \ :java:ref:`Question`\ . - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: QuestionTypes - -GRID -^^^^ - -.. java:field:: public static final I18nString GRID - :outertype: QuestionTypes - -ITEM_SET -^^^^^^^^ - -.. java:field:: public static final I18nString ITEM_SET - :outertype: QuestionTypes - -MULTIPLE_CHOICE -^^^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString MULTIPLE_CHOICE - :outertype: QuestionTypes - -OPEN -^^^^ - -.. java:field:: public static final I18nString OPEN - :outertype: QuestionTypes - -SINGLE_CHOICE -^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString SINGLE_CHOICE - :outertype: QuestionTypes - -UNDOCUMENTED -^^^^^^^^^^^^ - -.. java:field:: public static final I18nString UNDOCUMENTED - :outertype: QuestionTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/TechnicalRepresentation.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/TechnicalRepresentation.rst deleted file mode 100644 index aea851af6e..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/TechnicalRepresentation.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain Instrument - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -TechnicalRepresentation -======================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class TechnicalRepresentation implements Serializable - - The technical representation of a \ :java:ref:`Question`\ which was used to generate the question for instance in an online \ :java:ref:`Instrument`\ . - -Fields ------- -language -^^^^^^^^ - -.. java:field:: @NotEmpty @Size private String language - :outertype: TechnicalRepresentation - - The technical language of the source of this representation. E.g. "qml". Must not be empty and must not contain more than 32 characters. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: TechnicalRepresentation - -source -^^^^^^ - -.. java:field:: @NotEmpty @Size private String source - :outertype: TechnicalRepresentation - - The source code of the question. Must not be empty and must not contain more than 1 MB characters. - -type -^^^^ - -.. java:field:: @NotEmpty @Size private String type - :outertype: TechnicalRepresentation - - The type of the technical representation. E.g. "zofar". Must not be empty and must not contain more than 32 characters. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/package-index.rst deleted file mode 100644 index 14d28ac07a..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/package-index.rst +++ /dev/null @@ -1,16 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.questionmanagement.domain -======================================================== - -Domain objects describing \ :java:ref:`eu.dzhw.fdz.metadatamanagement.questionmanagement.domain.Question`\ s. - -.. java:package:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain - -.. toctree:: - :maxdepth: 1 - - ImageType - Question - QuestionImageMetadata - QuestionTypes - TechnicalRepresentation - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain/RelatedPublication.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain/RelatedPublication.rst deleted file mode 100644 index c4ea389696..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain/RelatedPublication.rst +++ /dev/null @@ -1,144 +0,0 @@ -.. java:import:: java.util List - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.springframework.beans BeanUtils - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.relatedpublicationmanagement.domain.validation DataPackageExists - -.. java:import:: eu.dzhw.fdz.metadatamanagement.relatedpublicationmanagement.domain.validation ValidPublicationYear - -.. java:import:: eu.dzhw.fdz.metadatamanagement.relatedpublicationmanagement.domain.validation ValidRelatedPublicationId - -.. java:import:: eu.dzhw.fdz.metadatamanagement.relatedpublicationmanagement.domain.validation ValidUrl - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok ToString - -RelatedPublication -================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.relatedpublicationmanagement.domain - :noindex: - -.. java:type:: @Document @ValidPublicationYear @ValidRelatedPublicationId @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class RelatedPublication extends AbstractRdcDomainObject - - Domain Object for the Related Publications. - - :author: Daniel Katzberg - -Fields ------- -abstractSource -^^^^^^^^^^^^^^ - -.. java:field:: @Size private String abstractSource - :outertype: RelatedPublication - -annotations -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString annotations - :outertype: RelatedPublication - - Arbitrary additional text for this publication. Markdown is supported. Must not contain more than 2048 characters. - -authors -^^^^^^^ - -.. java:field:: @Size @NotEmpty private String authors - :outertype: RelatedPublication - -dataPackageIds -^^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private List dataPackageIds - :outertype: RelatedPublication - -doi -^^^ - -.. java:field:: @Size private String doi - :outertype: RelatedPublication - -id -^^ - -.. java:field:: @Id @NotEmpty @Size @Pattern private String id - :outertype: RelatedPublication - -language -^^^^^^^^ - -.. java:field:: @NotNull @ValidIsoLanguage private String language - :outertype: RelatedPublication - -publicationAbstract -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Size private String publicationAbstract - :outertype: RelatedPublication - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: RelatedPublication - -sourceLink -^^^^^^^^^^ - -.. java:field:: @ValidUrl private String sourceLink - :outertype: RelatedPublication - -sourceReference -^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty @Size private String sourceReference - :outertype: RelatedPublication - -title -^^^^^ - -.. java:field:: @Size @NotEmpty private String title - :outertype: RelatedPublication - -year -^^^^ - -.. java:field:: @NotNull private Integer year - :outertype: RelatedPublication - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain/package-index.rst deleted file mode 100644 index 27d1be3b6a..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain/package-index.rst +++ /dev/null @@ -1,14 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.relatedpublicationmanagement.domain -================================================================== - -In the domain layer are all domain classes of the related publication. - -:author: Daniel Katzberg - -.. java:package:: eu.dzhw.fdz.metadatamanagement.relatedpublicationmanagement.domain - -.. toctree:: - :maxdepth: 1 - - RelatedPublication - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/DataTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/DataTypes.rst deleted file mode 100644 index d8a9bcda18..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/DataTypes.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -DataTypes -========= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain - :noindex: - -.. java:type:: public class DataTypes - - Types of data, which a \ :java:ref:`Survey`\ can produce. - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: DataTypes - -QUALITATIVE_DATA -^^^^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString QUALITATIVE_DATA - :outertype: DataTypes - -QUANTITATIVE_DATA -^^^^^^^^^^^^^^^^^ - -.. java:field:: public static final I18nString QUANTITATIVE_DATA - :outertype: DataTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/GeographicCoverage.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/GeographicCoverage.rst deleted file mode 100644 index 12f8d88960..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/GeographicCoverage.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.validation ValidCountryCode - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -GeographicCoverage -================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain - :noindex: - -.. java:type:: @AllArgsConstructor @NoArgsConstructor @Data @Builder public class GeographicCoverage implements Serializable - - Contains data regarding the location where survey data was collected. - -Fields ------- -country -^^^^^^^ - -.. java:field:: @ValidCountryCode private String country - :outertype: GeographicCoverage - - ISO 3166-1 alpha-2 country code. - -description -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString description - :outertype: GeographicCoverage - - Free text description for additional information regarding the location. Markdown is supported. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: GeographicCoverage - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Population.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Population.rst deleted file mode 100644 index c50574529f..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Population.rst +++ /dev/null @@ -1,74 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.util List - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: org.javers.core.metamodel.annotation ValueObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringEntireNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.validation ValidUnitValue - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Population -========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class Population implements Serializable - - Details of the population of a \ :java:ref:`Survey`\ . - -Fields ------- -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringEntireNotEmpty @I18nStringSize private I18nString description - :outertype: Population - - A description of the population. Markdown is supported. It must be specified in all languages and it must not contain more than 2048 characters. - -geographicCoverages -^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Valid @NotEmpty private List geographicCoverages - :outertype: Population - - A list of geographic coverages. Must contain at least one entry. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Population - -unit -^^^^ - -.. java:field:: @NotNull @ValidUnitValue private I18nString unit - :outertype: Population - - Unit type. Mandatory field which only allows values specified by VFDB. - - **See also:** \ `GNERD: Survey Unit Educational Research (Version 1.0) `_\ - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.rst deleted file mode 100644 index 654426c0e8..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.rst +++ /dev/null @@ -1,218 +0,0 @@ -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints Max - -.. java:import:: javax.validation.constraints Min - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.javers.core.metamodel.annotation Entity - -.. java:import:: org.springframework.beans BeanUtils - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain Period - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringEntireNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidShadowId - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain DataPackage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain DataSet - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.validation ValidDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.validation ValidSampleType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.validation ValidSurveyIdName - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.validation ValidUniqueSurveyNumber - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -Survey -====== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain - :noindex: - -.. java:type:: @Entity @Document @ValidSurveyIdName @ValidUniqueSurveyNumber @ValidShadowId @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class Survey extends AbstractShadowableRdcDomainObject - - A survey is conducted to examine a population on the basis of a sample. The resulting \ :java:ref:`DataSet`\ s can be used to make statements about the population. - -Fields ------- -annotations -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString annotations - :outertype: Survey - - Arbitrary additional text for this survey. Markdown is supported. Must not contain more than 2048 characters. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataAcquisitionProjectId - :outertype: Survey - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which this survey belongs. The dataAcquisitionProjectId must not be empty. - -dataPackageId -^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataPackageId - :outertype: Survey - - The id of the \ :java:ref:`DataPackage`\ to which this survey belongs. Must not be empty. - -dataType -^^^^^^^^ - -.. java:field:: @NotNull @ValidDataType private I18nString dataType - :outertype: Survey - - The type of data which the survey produced. Must be one of \ :java:ref:`DataTypes`\ and must not be empty. - -fieldPeriod -^^^^^^^^^^^ - -.. java:field:: @NotNull @Valid private Period fieldPeriod - :outertype: Survey - - The period during which the survey has been conducted or is expected to be conducted. Must not be empty. - -grossSampleSize -^^^^^^^^^^^^^^^ - -.. java:field:: @Min private Integer grossSampleSize - :outertype: Survey - - The gross sample size represents the number of participants which have been invited to take part in the \ :java:ref:`Survey`\ . Must not be negative. - -id -^^ - -.. java:field:: @Id @Setter private String id - :outertype: Survey - - The id of the survey which uniquely identifies the survey in this application. - -masterId -^^^^^^^^ - -.. java:field:: @NotEmpty @Size @Pattern @Setter @Indexed private String masterId - :outertype: Survey - - The master id of the survey. It must not be empty, must be of the form \ ``sur-{{dataAcquisitionProjectId}}-sy{{number}}$``\ and must not contain more than 512 characters. - -number -^^^^^^ - -.. java:field:: @NotNull private Integer number - :outertype: Survey - - The number of the instrument. Must not be empty and must be unique within the \ :java:ref:`DataAcquisitionProject`\ . - -population -^^^^^^^^^^ - -.. java:field:: @Valid @NotNull private Population population - :outertype: Survey - - Details about the \ :java:ref:`Population`\ . Must not be empty. - -responseRate -^^^^^^^^^^^^ - -.. java:field:: @Min @Max private Double responseRate - :outertype: Survey - - The response rate is the quotient of the gross sample size and the sample size. Must be between 0 and 100. - -sample -^^^^^^ - -.. java:field:: @NotNull @ValidSampleType private I18nString sample - :outertype: Survey - - The sampling method is the procedure for selecting sample members from a population. It must match the controlled vocabulary specified by VFDB. - - **See also:** \ ` Catalog: GNERD: Sampling Procedure Educational Research (Version 1.0) `_\ - -sampleSize -^^^^^^^^^^ - -.. java:field:: @NotNull @Min private Integer sampleSize - :outertype: Survey - - The sample size is the number of participant which took part in the survey. Must not be empty and must not be negative. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Survey - -surveyMethod -^^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringEntireNotEmpty @I18nStringSize private I18nString surveyMethod - :outertype: Survey - - The survey method briefly describes how the data were collected. It must be specified in German and English and it must not contain more than 2048 characters. - -title -^^^^^ - -.. java:field:: @I18nStringSize @I18nStringEntireNotEmpty private I18nString title - :outertype: Survey - - The title of the instrument. It must be specified in German and English and it must not contain more than 2048 characters. - -wave -^^^^ - -.. java:field:: @NotNull @Min private Integer wave - :outertype: Survey - - Number of the wave which this \ :java:ref:`Survey`\ represents. Will be ignored if the \ :java:ref:`DataPackage`\ is not organized in waves. Must not be empty and must be greater than or equal to 1. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveyAttachmentMetadata.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveyAttachmentMetadata.rst deleted file mode 100644 index 1afb433bc2..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveyAttachmentMetadata.rst +++ /dev/null @@ -1,138 +0,0 @@ -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -SurveyAttachmentMetadata -======================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain - :noindex: - -.. java:type:: @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class SurveyAttachmentMetadata extends AbstractShadowableRdcDomainObject - - Metadata which will be stored with each attachment of a \ :java:ref:`Survey`\ . - -Fields ------- -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String dataAcquisitionProjectId - :outertype: SurveyAttachmentMetadata - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which the \ :java:ref:`Survey`\ of this attachment belongs. Must not be empty. - -description -^^^^^^^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringNotEmpty private I18nString description - :outertype: SurveyAttachmentMetadata - - A description for this attachment. It must be specified in at least one language and it must not contain more than 512 characters. - -fileName -^^^^^^^^ - -.. java:field:: @NotEmpty @Pattern private String fileName - :outertype: SurveyAttachmentMetadata - - The filename of the attachment. Must not be empty and must contain only (german) alphanumeric characters and "_" and "-" and ".". - -id -^^ - -.. java:field:: @Id @Setter private String id - :outertype: SurveyAttachmentMetadata - - The id of the attachment. Holds the complete path which can be used to download the file. - -indexInSurvey -^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer indexInSurvey - :outertype: SurveyAttachmentMetadata - - The index in the \ :java:ref:`Survey`\ of this attachment. Used for sorting the attachments of this \ :java:ref:`Survey`\ . Must not be empty. - -language -^^^^^^^^ - -.. java:field:: @NotNull @ValidIsoLanguage private String language - :outertype: SurveyAttachmentMetadata - - The language of the attachments content. Must not be empty and must be specified as ISO 639 language code. - -masterId -^^^^^^^^ - -.. java:field:: @Setter private String masterId - :outertype: SurveyAttachmentMetadata - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: SurveyAttachmentMetadata - -surveyId -^^^^^^^^ - -.. java:field:: @NotEmpty private String surveyId - :outertype: SurveyAttachmentMetadata - - The id of the \ :java:ref:`Survey`\ to which this attachment belongs. Must not be empty. - -surveyNumber -^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer surveyNumber - :outertype: SurveyAttachmentMetadata - - The number of the \ :java:ref:`Survey`\ to which this attachment belongs. Must not be empty. - -title -^^^^^ - -.. java:field:: @NotEmpty @Size private String title - :outertype: SurveyAttachmentMetadata - - A title of this attachment in the attachments' language. Must not be empty and it must not contain more than 2048 characters. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveyResponseRateImageMetadata.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveyResponseRateImageMetadata.rst deleted file mode 100644 index 7c9fabfe58..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveyResponseRateImageMetadata.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidIsoLanguage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -SurveyResponseRateImageMetadata -=============================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain - :noindex: - -.. java:type:: @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class SurveyResponseRateImageMetadata extends AbstractShadowableRdcDomainObject - - Metadata which will be stored with each response rate image of a \ :java:ref:`Survey`\ . - -Fields ------- -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String dataAcquisitionProjectId - :outertype: SurveyResponseRateImageMetadata - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which the \ :java:ref:`Survey`\ of this response rate image belongs. Must not be empty. - -fileName -^^^^^^^^ - -.. java:field:: @NotEmpty @Pattern private String fileName - :outertype: SurveyResponseRateImageMetadata - - The filename of the image. Must not be empty and must contain only (german) alphanumeric characters and "_" and "-" and ".". - -id -^^ - -.. java:field:: @Id @Setter private String id - :outertype: SurveyResponseRateImageMetadata - - The id of the response rate image. Holds the complete path which can be used to download the file. - -language -^^^^^^^^ - -.. java:field:: @NotNull @ValidIsoLanguage private String language - :outertype: SurveyResponseRateImageMetadata - - The language used in the response rate image. Must be either "de" or "en". - -masterId -^^^^^^^^ - -.. java:field:: @Setter private String masterId - :outertype: SurveyResponseRateImageMetadata - - The master id of the survey response rate image metadata. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: SurveyResponseRateImageMetadata - -surveyId -^^^^^^^^ - -.. java:field:: @NotEmpty private String surveyId - :outertype: SurveyResponseRateImageMetadata - - The id of the \ :java:ref:`Survey`\ to which this response rate image belongs. Must not be empty. - -surveyNumber -^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer surveyNumber - :outertype: SurveyResponseRateImageMetadata - - The number of the \ :java:ref:`Survey`\ to which this response rate image belongs. Must not be empty. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveySampleTypeProvider.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveySampleTypeProvider.rst deleted file mode 100644 index 1f6cab81da..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveySampleTypeProvider.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -.. java:import:: org.springframework.stereotype Service - -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -SurveySampleTypeProvider -======================== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain - :noindex: - -.. java:type:: @Service public class SurveySampleTypeProvider - - Sample types for survey. This list is based on official VFDB vocabulary. - - **See also:** \ `Catalog: GNERD: Sampling Procedure Educational Research (Version 1.0) `_\ - -Fields ------- -CONTROLLED_SAMPLE_VOCABULARY -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: private static final Set CONTROLLED_SAMPLE_VOCABULARY - :outertype: SurveySampleTypeProvider - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/UnitValueProvider.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/UnitValueProvider.rst deleted file mode 100644 index c496229fdb..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/UnitValueProvider.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -.. java:import:: org.springframework.stereotype Service - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -UnitValueProvider -================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain - :noindex: - -.. java:type:: @Service public class UnitValueProvider - - Provides valid unit values for Survey. - -Fields ------- -UNIT_VALUES -^^^^^^^^^^^ - -.. java:field:: private static final Set UNIT_VALUES - :outertype: UnitValueProvider - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/package-index.rst deleted file mode 100644 index 7878fb6c76..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/package-index.rst +++ /dev/null @@ -1,19 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.surveymanagement.domain -====================================================== - -Domain objects describing \ :java:ref:`eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.Survey`\ s. - -.. java:package:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain - -.. toctree:: - :maxdepth: 1 - - DataTypes - GeographicCoverage - Population - Survey - SurveyAttachmentMetadata - SurveyResponseRateImageMetadata - SurveySampleTypeProvider - UnitValueProvider - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/AccessWays.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/AccessWays.rst deleted file mode 100644 index b6f6bfb385..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/AccessWays.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util List - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain DataSet - -AccessWays -========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: public class AccessWays - - An access way of a \ :java:ref:`Variable`\ or a \ :java:ref:`DataSet`\ indicates how the data user will be able to work with the data. - -Fields ------- -ALL -^^^ - -.. java:field:: public static final List ALL - :outertype: AccessWays - -DOWNLOAD_CUF -^^^^^^^^^^^^ - -.. java:field:: public static final String DOWNLOAD_CUF - :outertype: AccessWays - -DOWNLOAD_SUF -^^^^^^^^^^^^ - -.. java:field:: public static final String DOWNLOAD_SUF - :outertype: AccessWays - -NOT_ACCESSIBLE -^^^^^^^^^^^^^^ - -.. java:field:: public static final String NOT_ACCESSIBLE - :outertype: AccessWays - -ONSITE_SUF -^^^^^^^^^^ - -.. java:field:: public static final String ONSITE_SUF - :outertype: AccessWays - -REMOTE_DESKTOP -^^^^^^^^^^^^^^ - -.. java:field:: public static final String REMOTE_DESKTOP - :outertype: AccessWays - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/DataTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/DataTypes.rst deleted file mode 100644 index 9cd700b777..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/DataTypes.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -DataTypes -========= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: public class DataTypes - - The technical type which the \ :java:ref:`ValidResponse`\ s have. - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: DataTypes - -DATE -^^^^ - -.. java:field:: public static final I18nString DATE - :outertype: DataTypes - -NUMERIC -^^^^^^^ - -.. java:field:: public static final I18nString NUMERIC - :outertype: DataTypes - -STRING -^^^^^^ - -.. java:field:: public static final I18nString STRING - :outertype: DataTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Distribution.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Distribution.rst deleted file mode 100644 index 2037450942..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Distribution.rst +++ /dev/null @@ -1,96 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: java.util List - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Size - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation UniqueCode - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation UniqueValue - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Distribution -============ - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder public class Distribution implements Serializable - - A distribution contains the descriptives of a \ :java:ref:`Variable`\ meaning its \ :java:ref:`ValidResponse`\ s, \ :java:ref:`Missing`\ s and \ :java:ref:`Statistics`\ . - -Fields ------- -maxNumberOfDecimalPlaces -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: private Integer maxNumberOfDecimalPlaces - :outertype: Distribution - - Integer used for rounding the values of this \ :java:ref:`Variable`\ when displaying it. It is computed during the import of the \ :java:ref:`Variable`\ by finding the maximum number of decimal places in the list of \ :java:ref:`ValidResponse`\ s. - -missings -^^^^^^^^ - -.. java:field:: @UniqueCode @Valid @Size private List missings - :outertype: Distribution - - List of \ :java:ref:`Missing`\ s of this \ :java:ref:`Variable`\ . Must not contain more than 7000 entries and the code of the \ :java:ref:`Missing`\ s must be unique. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Distribution - -statistics -^^^^^^^^^^ - -.. java:field:: @Valid private Statistics statistics - :outertype: Distribution - - Descriptive metrics of this \ :java:ref:`Variable`\ . - -totalAbsoluteFrequency -^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer totalAbsoluteFrequency - :outertype: Distribution - - The total absolute number of \ :java:ref:`ValidResponse`\ s and \ :java:ref:`Missing`\ s. Must not be empty. - -totalValidAbsoluteFrequency -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer totalValidAbsoluteFrequency - :outertype: Distribution - - The total absolute number of \ :java:ref:`ValidResponse`\ s. Must not be empty. - -totalValidRelativeFrequency -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Double totalValidRelativeFrequency - :outertype: Distribution - - The quotient from totalValidAbsoluteFrequency and totalAbsoluteFrequency. Must not be empty. - -validResponses -^^^^^^^^^^^^^^ - -.. java:field:: @UniqueValue @Valid @Size private List validResponses - :outertype: Distribution - - List of \ :java:ref:`ValidResponse`\ s of this variable. Must not contain more than 7000 entries and the value of the \ :java:ref:`ValidResponse`\ s must be unique. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/FilterDetails.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/FilterDetails.rst deleted file mode 100644 index b9e13807e1..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/FilterDetails.rst +++ /dev/null @@ -1,66 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints Size - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain Question - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation FilterExpressionAndLanguageNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidFilterExpressionLanguage - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -FilterDetails -============= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @FilterExpressionAndLanguageNotEmpty public class FilterDetails implements Serializable - - Filter details of a \ :java:ref:`Variable`\ describe the condition which must have evaluated to true before a participant was asked a \ :java:ref:`Question`\ resulting in this \ :java:ref:`Variable`\ . All participants for which the conditions evaluates to false will have a \ :java:ref:`Missing`\ in this \ :java:ref:`Variable`\ . - -Fields ------- -description -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString description - :outertype: FilterDetails - - A description of this filter condition. Markdown is supported. Must not contain more than 2048 characters - -expression -^^^^^^^^^^ - -.. java:field:: @Size private String expression - :outertype: FilterDetails - - A technical expression describing the condition which must have evaluated to true. The expression is given in the expressionLanguage. Can be empty and must not contain more than 2048 characters. - -expressionLanguage -^^^^^^^^^^^^^^^^^^ - -.. java:field:: @ValidFilterExpressionLanguage private String expressionLanguage - :outertype: FilterDetails - - The name of the language in which the expression was given. Can be empty if and only if expression is empty. If present must be one of \ :java:ref:`FilterExpressionLanguages`\ . - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: FilterDetails - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/FilterExpressionLanguages.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/FilterExpressionLanguages.rst deleted file mode 100644 index d0a6a401ba..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/FilterExpressionLanguages.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -FilterExpressionLanguages -========================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: public class FilterExpressionLanguages - - All supported expression languages for \ :java:ref:`FilterDetails`\ . - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: FilterExpressionLanguages - -SPEL -^^^^ - -.. java:field:: public static final String SPEL - :outertype: FilterExpressionLanguages - -STATA -^^^^^ - -.. java:field:: public static final String STATA - :outertype: FilterExpressionLanguages - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/GenerationDetails.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/GenerationDetails.rst deleted file mode 100644 index b2833c65c4..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/GenerationDetails.rst +++ /dev/null @@ -1,66 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints Size - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation NotEmptyGenerationDetailsDescriptionOrRule - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation RuleExpressionLanguageAndRuleFilledOrEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidRuleExpressionLanguage - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -GenerationDetails -================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: @NotEmptyGenerationDetailsDescriptionOrRule @RuleExpressionLanguageAndRuleFilledOrEmpty @NoArgsConstructor @Data @AllArgsConstructor @Builder public class GenerationDetails implements Serializable - - Generation details describe how a \ :java:ref:`Variable`\ was generated from one or more input \ :java:ref:`Variable`\ s. - -Fields ------- -description -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString description - :outertype: GenerationDetails - - A description of this generation rule. Markdown is supported. Must not contain more than 2048 characters - -rule -^^^^ - -.. java:field:: @Size private String rule - :outertype: GenerationDetails - - The computation rule in the ruleExpressionLanguage which was used to generate this \ :java:ref:`Variable`\ . Must not contain more than 1 MB characters. - -ruleExpressionLanguage -^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @ValidRuleExpressionLanguage private String ruleExpressionLanguage - :outertype: GenerationDetails - - The language which was used to describe this rule. Must be one of \ :java:ref:`RuleExpressionLanguages`\ . - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: GenerationDetails - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Missing.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Missing.rst deleted file mode 100644 index 85d25554ce..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Missing.rst +++ /dev/null @@ -1,70 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Missing -======= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder public class Missing implements Serializable - - A missing or missing value is a value in a \ :java:ref:`Variable`\ which represents a reason why no observation (\ :java:ref:`ValidResponse`\ ) has been stored. It also contains its frequency. - -Fields ------- -absoluteFrequency -^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer absoluteFrequency - :outertype: Missing - - The absolute number of occurrences of this missing. Must not be empty. - -code -^^^^ - -.. java:field:: @NotEmpty private String code - :outertype: Missing - - A (unique in this \ :java:ref:`Variable`\ ) code for this missing. Must not be empty. - -label -^^^^^ - -.. java:field:: @I18nStringSize private I18nString label - :outertype: Missing - - A label describing this missing. Must not contain more than 512 characters. - -relativeFrequency -^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Double relativeFrequency - :outertype: Missing - - The quotient from absoluteFrequency and \ :java:ref:`Distribution`\ .totalAbsoluteFrequency. Must not be empty. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Missing - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/RelatedQuestion.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/RelatedQuestion.rst deleted file mode 100644 index e2a4e88798..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/RelatedQuestion.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain Instrument - -.. java:import:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain Question - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -RelatedQuestion -=============== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder public class RelatedQuestion implements Serializable - - A related question is a \ :java:ref:`Question`\ which has been asked to generate the values of a \ :java:ref:`Variable`\ . It contains the ids of the \ :java:ref:`Instrument`\ and the \ :java:ref:`Question`\ as well as all Strings of the \ :java:ref:`Question`\ which are related to this \ :java:ref:`Variable`\ . - -Fields ------- -instrumentId -^^^^^^^^^^^^ - -.. java:field:: @Indexed private String instrumentId - :outertype: RelatedQuestion - - The id of the \ :java:ref:`Instrument`\ of this \ :java:ref:`Question`\ . Must not be empty. - -instrumentNumber -^^^^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private String instrumentNumber - :outertype: RelatedQuestion - - The number of the \ :java:ref:`Instrument`\ of this \ :java:ref:`Question`\ . Must not be empty. - -questionId -^^^^^^^^^^ - -.. java:field:: @Indexed private String questionId - :outertype: RelatedQuestion - - The id of the corresponding \ :java:ref:`Question`\ . Must not be empty. - -questionNumber -^^^^^^^^^^^^^^ - -.. java:field:: @Size @NotEmpty private String questionNumber - :outertype: RelatedQuestion - - The number of the corresponding \ :java:ref:`Question`\ . Must not be empty. - -relatedQuestionStrings -^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString relatedQuestionStrings - :outertype: RelatedQuestion - - All Strings (concatenated) of this \ :java:ref:`Question`\ which "belong" to this \ :java:ref:`Variable`\ . These Strings typically overlap with String from other \ :java:ref:`Variable`\ s of the same \ :java:ref:`Question`\ . - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: RelatedQuestion - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/RuleExpressionLanguages.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/RuleExpressionLanguages.rst deleted file mode 100644 index 8aaaa63799..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/RuleExpressionLanguages.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -RuleExpressionLanguages -======================= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: public class RuleExpressionLanguages - - All supported expression languages for \ :java:ref:`GenerationDetails`\ . - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: RuleExpressionLanguages - -R -^ - -.. java:field:: public static final String R - :outertype: RuleExpressionLanguages - -STATA -^^^^^ - -.. java:field:: public static final String STATA - :outertype: RuleExpressionLanguages - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/ScaleLevels.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/ScaleLevels.rst deleted file mode 100644 index 94ca178b37..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/ScaleLevels.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain ImmutableI18nString - -ScaleLevels -=========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: public class ScaleLevels - - The scale level (or level of measurement) classifies the nature of information within the values assigned to a \ :java:ref:`Variable`\ (\ :java:ref:`ValidResponse`\ s). It determines which mathematical operations can be performed with the values. - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: ScaleLevels - -INTERVAL -^^^^^^^^ - -.. java:field:: public static final I18nString INTERVAL - :outertype: ScaleLevels - -NOMINAL -^^^^^^^ - -.. java:field:: public static final I18nString NOMINAL - :outertype: ScaleLevels - -ORDINAL -^^^^^^^ - -.. java:field:: public static final I18nString ORDINAL - :outertype: ScaleLevels - -RATIO -^^^^^ - -.. java:field:: public static final I18nString RATIO - :outertype: ScaleLevels - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Statistics.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Statistics.rst deleted file mode 100644 index 4bf8b7a32d..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Statistics.rst +++ /dev/null @@ -1,128 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints Size - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -Statistics -========== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder public class Statistics implements Serializable - - Descriptive metrics of this \ :java:ref:`Variable`\ . - -Fields ------- -deviance -^^^^^^^^ - -.. java:field:: private Double deviance - :outertype: Statistics - - See \ `Deviance (Wikipedia) `_\ . - -firstQuartile -^^^^^^^^^^^^^ - -.. java:field:: @Size private String firstQuartile - :outertype: Statistics - - Splits off the lowest 25% of the values (\ :java:ref:`ValidResponse`\ s) of this \ :java:ref:`Variable`\ from the highest 75%. Must not contain more than 32 characters. - -kurtosis -^^^^^^^^ - -.. java:field:: private Double kurtosis - :outertype: Statistics - - See \ `Kurtosis (Wikipedia) `_\ . - -maximum -^^^^^^^ - -.. java:field:: @Size private String maximum - :outertype: Statistics - - The maximum of the values (\ :java:ref:`ValidResponse`\ s) of this \ :java:ref:`Variable`\ . Must not contain more than 32 characters. - -meanDeviation -^^^^^^^^^^^^^ - -.. java:field:: private Double meanDeviation - :outertype: Statistics - - See \ `Mean Absolute Deviation (Wikipedia) `_\ . - -meanValue -^^^^^^^^^ - -.. java:field:: private Double meanValue - :outertype: Statistics - - The arithmetic mean of the values (\ :java:ref:`ValidResponse`\ s) of this \ :java:ref:`Variable`\ . - -median -^^^^^^ - -.. java:field:: @Size private String median - :outertype: Statistics - - The median is the value separating the higher half from the lower half of the values (\ :java:ref:`ValidResponse`\ s) of this \ :java:ref:`Variable`\ . Must not contain more than 32 characters. - -minimum -^^^^^^^ - -.. java:field:: @Size private String minimum - :outertype: Statistics - - The minimum of the values (\ :java:ref:`ValidResponse`\ s) of this \ :java:ref:`Variable`\ . Must not contain more than 32 characters. - -mode -^^^^ - -.. java:field:: private String mode - :outertype: Statistics - - The mode is the value (\ :java:ref:`ValidResponse`\ ) that appears most often. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Statistics - -skewness -^^^^^^^^ - -.. java:field:: private Double skewness - :outertype: Statistics - - See \ `Skewness (Wikipedia) `_\ . - -standardDeviation -^^^^^^^^^^^^^^^^^ - -.. java:field:: private Double standardDeviation - :outertype: Statistics - - Measure that is used to quantify the amount of variation of the values (\ :java:ref:`ValidResponse`\ s) of this \ :java:ref:`Variable`\ . - -thirdQuartile -^^^^^^^^^^^^^ - -.. java:field:: @Size private String thirdQuartile - :outertype: Statistics - - Splits off the highest 25% of the values (\ :java:ref:`ValidResponse`\ s) of this \ :java:ref:`Variable`\ from the lowest 75%. Must not contain more than 32 characters. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/StorageTypes.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/StorageTypes.rst deleted file mode 100644 index 98b6b714a9..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/StorageTypes.rst +++ /dev/null @@ -1,170 +0,0 @@ -.. java:import:: java.util Arrays - -.. java:import:: java.util Collections - -.. java:import:: java.util HashSet - -.. java:import:: java.util Set - -StorageTypes -============ - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: public class StorageTypes - - All supported storage types of \ :java:ref:`Variable`\ s. - -Fields ------- -ALL -^^^ - -.. java:field:: public static final Set ALL - :outertype: StorageTypes - -ANY -^^^ - -.. java:field:: public static final String ANY - :outertype: StorageTypes - -BUILTIN -^^^^^^^ - -.. java:field:: public static final String BUILTIN - :outertype: StorageTypes - -BYTECODE -^^^^^^^^ - -.. java:field:: public static final String BYTECODE - :outertype: StorageTypes - -CHAR -^^^^ - -.. java:field:: public static final String CHAR - :outertype: StorageTypes - -CHARACTER -^^^^^^^^^ - -.. java:field:: public static final String CHARACTER - :outertype: StorageTypes - -CLOSURE -^^^^^^^ - -.. java:field:: public static final String CLOSURE - :outertype: StorageTypes - -COMPLEX -^^^^^^^ - -.. java:field:: public static final String COMPLEX - :outertype: StorageTypes - -DOTDOTDOT -^^^^^^^^^ - -.. java:field:: public static final String DOTDOTDOT - :outertype: StorageTypes - -DOUBLE -^^^^^^ - -.. java:field:: public static final String DOUBLE - :outertype: StorageTypes - -ENVIRONMENT -^^^^^^^^^^^ - -.. java:field:: public static final String ENVIRONMENT - :outertype: StorageTypes - -EXPRESSION -^^^^^^^^^^ - -.. java:field:: public static final String EXPRESSION - :outertype: StorageTypes - -EXTERNALPTR -^^^^^^^^^^^ - -.. java:field:: public static final String EXTERNALPTR - :outertype: StorageTypes - -INTEGER -^^^^^^^ - -.. java:field:: public static final String INTEGER - :outertype: StorageTypes - -LANGUAGE -^^^^^^^^ - -.. java:field:: public static final String LANGUAGE - :outertype: StorageTypes - -LIST -^^^^ - -.. java:field:: public static final String LIST - :outertype: StorageTypes - -LOGICAL -^^^^^^^ - -.. java:field:: public static final String LOGICAL - :outertype: StorageTypes - -NULL -^^^^ - -.. java:field:: public static final String NULL - :outertype: StorageTypes - -PAIRLIST -^^^^^^^^ - -.. java:field:: public static final String PAIRLIST - :outertype: StorageTypes - -PROMISE -^^^^^^^ - -.. java:field:: public static final String PROMISE - :outertype: StorageTypes - -RAW -^^^ - -.. java:field:: public static final String RAW - :outertype: StorageTypes - -S4 -^^ - -.. java:field:: public static final String S4 - :outertype: StorageTypes - -SPECIAL -^^^^^^^ - -.. java:field:: public static final String SPECIAL - :outertype: StorageTypes - -SYMBOL -^^^^^^ - -.. java:field:: public static final String SYMBOL - :outertype: StorageTypes - -WEAKREF -^^^^^^^ - -.. java:field:: public static final String WEAKREF - :outertype: StorageTypes - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/ValidResponse.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/ValidResponse.rst deleted file mode 100644 index b62c6febdc..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/ValidResponse.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. java:import:: java.io Serializable - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Size - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok NoArgsConstructor - -ValidResponse -============= - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: @Data @NoArgsConstructor @AllArgsConstructor @Builder public class ValidResponse implements Serializable - - A valid response represents one observation of a \ :java:ref:`Variable`\ and its frequency. - -Fields ------- -absoluteFrequency -^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer absoluteFrequency - :outertype: ValidResponse - - The absolute number of occurrences of this observation. Must not be empty. - -label -^^^^^ - -.. java:field:: @I18nStringSize private I18nString label - :outertype: ValidResponse - - An optional label for the value of this observation. - -relativeFrequency -^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Double relativeFrequency - :outertype: ValidResponse - - The quotient from absoluteFrequency and \ :java:ref:`Distribution`\ .totalAbsoluteFrequency. Must not be empty. - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: ValidResponse - -validRelativeFrequency -^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Double validRelativeFrequency - :outertype: ValidResponse - - The quotient from absoluteFrequency and \ :java:ref:`Distribution`\ .totalValidAbsoluteFrequency. Must not be empty. - -value -^^^^^ - -.. java:field:: @NotEmpty @Size private String value - :outertype: ValidResponse - - The value which has been observed (e.g. was responded by the participant). Must not be empty and must not contain more than 256 characters. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Variable.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Variable.rst deleted file mode 100644 index 1e70cc7c42..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/Variable.rst +++ /dev/null @@ -1,314 +0,0 @@ -.. java:import:: java.util List - -.. java:import:: javax.validation Valid - -.. java:import:: javax.validation.constraints NotEmpty - -.. java:import:: javax.validation.constraints NotNull - -.. java:import:: javax.validation.constraints Pattern - -.. java:import:: javax.validation.constraints Size - -.. java:import:: org.springframework.beans BeanUtils - -.. java:import:: org.springframework.data.annotation Id - -.. java:import:: org.springframework.data.mongodb.core.index CompoundIndex - -.. java:import:: org.springframework.data.mongodb.core.index CompoundIndexes - -.. java:import:: org.springframework.data.mongodb.core.index Indexed - -.. java:import:: org.springframework.data.mongodb.core.mapping Document - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractShadowableRdcDomainObject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain I18nString - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.util Patterns - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringNotEmpty - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation I18nStringSize - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation StringLengths - -.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidShadowId - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain DataSet - -.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject - -.. java:import:: eu.dzhw.fdz.metadatamanagement.questionmanagement.domain Question - -.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain DataPackage - -.. java:import:: eu.dzhw.fdz.metadatamanagement.surveymanagement.domain Survey - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation RestrictedScaleLevelForDateDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsFirstQuartileMustBeANumberOnNumericDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsFirstQuartileMustBeAnIsoDateOnDateDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsMaximumMustBeANumberOnNumericDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsMaximumMustBeAnIsoDateOnDateDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsMedianMustBeANumberOnNumericDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsMedianMustBeAnIsoDateOnDateDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsMinimumMustBeANumberOnNumericDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsMinimumMustBeAnIsoDateOnDateDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsThirdQuartileMustBeANumberOnNumericDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation StatisticsThirdQuartileMustBeAnIsoDateOnDateDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation UniqueVariableNameInDataSet - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidAccessWays - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidDerivedVariablesIdentifier - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidRepeatedMeasurementIdentifier - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidResponseValueMustBeANumberOnNumericDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidResponseValueMustBeAnIsoDateOnDateDataType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidScaleLevel - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidStorageType - -.. java:import:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.validation ValidVariableIdName - -.. java:import:: lombok AccessLevel - -.. java:import:: lombok AllArgsConstructor - -.. java:import:: lombok Builder - -.. java:import:: lombok Data - -.. java:import:: lombok EqualsAndHashCode - -.. java:import:: lombok NoArgsConstructor - -.. java:import:: lombok Setter - -.. java:import:: lombok ToString - -Variable -======== - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - :noindex: - -.. java:type:: @Document @CompoundIndexes @ValidShadowId @ValidVariableIdName @ValidRepeatedMeasurementIdentifier @ValidDerivedVariablesIdentifier @UniqueVariableNameInDataSet @RestrictedScaleLevelForDateDataType @ValidResponseValueMustBeAnIsoDateOnDateDataType @StatisticsMinimumMustBeAnIsoDateOnDateDataType @StatisticsMaximumMustBeAnIsoDateOnDateDataType @StatisticsMedianMustBeAnIsoDateOnDateDataType @StatisticsFirstQuartileMustBeAnIsoDateOnDateDataType @StatisticsThirdQuartileMustBeAnIsoDateOnDateDataType @ValidResponseValueMustBeANumberOnNumericDataType @StatisticsMinimumMustBeANumberOnNumericDataType @StatisticsMaximumMustBeANumberOnNumericDataType @StatisticsMedianMustBeANumberOnNumericDataType @StatisticsFirstQuartileMustBeANumberOnNumericDataType @StatisticsThirdQuartileMustBeANumberOnNumericDataType @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class Variable extends AbstractShadowableRdcDomainObject - - A variable contains the results from at least one \ :java:ref:`Survey`\ . These results can be the responses from participants of an online survey, hence a variable can result from \ :java:ref:`RelatedQuestion`\ s. A variable is part of exactly one \ :java:ref:`DataSet`\ . - -Fields ------- -accessWays -^^^^^^^^^^ - -.. java:field:: @NotEmpty @ValidAccessWays private List accessWays - :outertype: Variable - - The access way of this variable. Depends on the sensitivity of the data and describes how the data user will be able to work with the data. Must not be empty and be one of \ :java:ref:`AccessWays`\ . - -annotations -^^^^^^^^^^^ - -.. java:field:: @I18nStringSize private I18nString annotations - :outertype: Variable - - Arbitrary additional text for this variable. Markdown is supported. Must not contain more than 2048 characters. - -dataAcquisitionProjectId -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataAcquisitionProjectId - :outertype: Variable - - The id of the \ :java:ref:`DataAcquisitionProject`\ to which this variable belongs. The dataAcquisitionProjectId must not be empty. - -dataPackageId -^^^^^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataPackageId - :outertype: Variable - - Id of the \ :java:ref:`DataPackage`\ to which this variable belongs. - -dataSetId -^^^^^^^^^ - -.. java:field:: @Indexed @NotEmpty private String dataSetId - :outertype: Variable - - The id of the \ :java:ref:`DataSet`\ to which this variable belongs. Must not be empty. - -dataSetNumber -^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer dataSetNumber - :outertype: Variable - - The number of the \ :java:ref:`DataSet`\ to which this variable belongs. Must not be empty. - -dataType -^^^^^^^^ - -.. java:field:: @NotNull @ValidDataType private I18nString dataType - :outertype: Variable - - The technical type which the \ :java:ref:`ValidResponse`\ s have. Must be one of \ :java:ref:`DataTypes`\ and must not be empty. - -derivedVariablesIdentifier -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Size @Pattern private String derivedVariablesIdentifier - :outertype: Variable - - Identifier used to group variables within this \ :java:ref:`DataSet`\ which have been derived from each other. For instance one variable might be an aggregated version of the other. Must be of the form {{dataAcquisitionProjectId}}-ds{{dataSetNumber}}-{{string}}$. Must not contain more than 512 characters and must contain only (german) alphanumeric characters and "_" and "-". - -distribution -^^^^^^^^^^^^ - -.. java:field:: @Valid private Distribution distribution - :outertype: Variable - - The \ :java:ref:`Distribution`\ contains the descriptives of this variable meaning \ :java:ref:`ValidResponse`\ s, \ :java:ref:`Missing`\ s and \ :java:ref:`Statistics`\ . - -doNotDisplayThousandsSeparator -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Builder.Default private Boolean doNotDisplayThousandsSeparator - :outertype: Variable - - Flag indicating whether the \ :java:ref:`ValidResponse`\ s should be displayed with a thousands separator or not. For instance years (1970) are numeric but should not be displayed with a thousands separator. Default value is false indicating that the \ :java:ref:`ValidResponse`\ s are displayed with thousands separator. - -filterDetails -^^^^^^^^^^^^^ - -.. java:field:: @Valid private FilterDetails filterDetails - :outertype: Variable - - \ :java:ref:`FilterDetails`\ of a variable describe the condition which must have evaluated to true before a participant was asked a \ :java:ref:`Question`\ resulting in this variable. - -generationDetails -^^^^^^^^^^^^^^^^^ - -.. java:field:: @Valid private GenerationDetails generationDetails - :outertype: Variable - - \ :java:ref:`GenerationDetails`\ describe how this variable was generated from one or more input variables. - -id -^^ - -.. java:field:: @Id @Setter private String id - :outertype: Variable - - The id of the variable which uniquely identifies the variable in this application. The id must not be empty and must be of the form var-{{dataAcquisitionProjectId}}-ds{{dataSetNumber}}-{{name}}$. The id must not contain more than 512 characters. - -indexInDataSet -^^^^^^^^^^^^^^ - -.. java:field:: @NotNull private Integer indexInDataSet - :outertype: Variable - - The index in the \ :java:ref:`DataSet`\ of this variable. Used for sorting the variables of this \ :java:ref:`DataSet`\ and for displaying successors and predecessors of this variable. Must not be empty and the successor of this variable must have indexInDataSet incremented by one. - -label -^^^^^ - -.. java:field:: @NotNull @I18nStringSize @I18nStringNotEmpty private I18nString label - :outertype: Variable - - The label of the variable should describe its content. It must be specified in at least one language and it must not contain more than 512 characters. - -masterId -^^^^^^^^ - -.. java:field:: @NotEmpty @Size @Pattern @Setter @Indexed private String masterId - :outertype: Variable - -name -^^^^ - -.. java:field:: @NotEmpty @Size @Pattern private String name - :outertype: Variable - - The name of the variable as it is used in the \ :java:ref:`DataSet`\ . It must not be empty and must be unique in the \ :java:ref:`DataSet`\ . It must contain only alphanumeric (english) characters and "_". The first character must not be a number. It must not contain more than 32 characters. - -relatedQuestions -^^^^^^^^^^^^^^^^ - -.. java:field:: @Valid private List relatedQuestions - :outertype: Variable - - List of \ :java:ref:`RelatedQuestion`\ s which have been asked to generate the values of this variable. - -relatedVariables -^^^^^^^^^^^^^^^^ - -.. java:field:: private List relatedVariables - :outertype: Variable - - List of ids of variables which are "related" to this variable. The type of relation is arbitrary. - -repeatedMeasurementIdentifier -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. java:field:: @Size @Pattern private String repeatedMeasurementIdentifier - :outertype: Variable - - Identifier used to group variables within this \ :java:ref:`DataSet`\ which measure the same across multiple waves. Must be of the form {{dataAcquisitionProjectId}}-ds{{dataSetNumber}}-{{string}}$. Must not contain more than 512 characters and must contain only (german) alphanumeric characters and "_" and "-". - -scaleLevel -^^^^^^^^^^ - -.. java:field:: @NotNull @ValidScaleLevel private I18nString scaleLevel - :outertype: Variable - - The scale level (or level of measurement) classifies the nature of information within the values assigned to this variable (\ :java:ref:`ValidResponse`\ s). It determines which mathematical operations can be performed with the values. It must be one of \ :java:ref:`ScaleLevels`\ and must not be empty. If the data type of this variable is \ :java:ref:`DataTypes.DATE`\ then the ScaleLevel must be \ :java:ref:`ScaleLevels.ORDINAL`\ , \ :java:ref:`ScaleLevels.INTERVAL`\ or \ :java:ref:`ScaleLevels.NOMINAL`\ . - -serialVersionUID -^^^^^^^^^^^^^^^^ - -.. java:field:: private static final long serialVersionUID - :outertype: Variable - -storageType -^^^^^^^^^^^ - -.. java:field:: @NotNull @ValidStorageType private String storageType - :outertype: Variable - - Associated with each data type is a storage type. For instance numerics can be stored as integer or double. Must be one of \ :java:ref:`StorageTypes`\ and must not be empty. - -surveyIds -^^^^^^^^^ - -.. java:field:: @Indexed private List surveyIds - :outertype: Variable - - List of ids of \ :java:ref:`Survey`\ s which have been conducted to create this variable. Must not be empty. - -surveyNumbers -^^^^^^^^^^^^^ - -.. java:field:: @NotEmpty private List surveyNumbers - :outertype: Variable - - List of numbers of \ :java:ref:`Survey`\ s which have been conducted to create this variable. Must not be empty. - diff --git a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/package-index.rst b/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/package-index.rst deleted file mode 100644 index eb8e88b43c..0000000000 --- a/docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/package-index.rst +++ /dev/null @@ -1,25 +0,0 @@ -eu.dzhw.fdz.metadatamanagement.variablemanagement.domain -======================================================== - -Domain objects describing \ :java:ref:`eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.Variable`\ s. - -.. java:package:: eu.dzhw.fdz.metadatamanagement.variablemanagement.domain - -.. toctree:: - :maxdepth: 1 - - AccessWays - DataTypes - Distribution - FilterDetails - FilterExpressionLanguages - GenerationDetails - Missing - RelatedQuestion - RuleExpressionLanguages - ScaleLevels - Statistics - StorageTypes - ValidResponse - Variable - diff --git a/docs/source/javadoc/packages.rst b/docs/source/javadoc/packages.rst deleted file mode 100644 index 9011638cee..0000000000 --- a/docs/source/javadoc/packages.rst +++ /dev/null @@ -1,18 +0,0 @@ -Javadoc -======= - -.. toctree:: - :maxdepth: 2 - - eu/dzhw/fdz/metadatamanagement/common/domain/package-index - eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/package-index - eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/package-index - eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain/package-index - eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain/package-index - eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/package-index - eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/package-index - eu/dzhw/fdz/metadatamanagement/questionmanagement/domain/package-index - eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain/package-index - eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/package-index - eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/package-index - diff --git a/pom.xml b/pom.xml index 0fa6db432c..d42869afc0 100644 --- a/pom.xml +++ b/pom.xml @@ -665,43 +665,6 @@ - - javasphinx-apidoc - generate-resources - - exec - - - javasphinx-apidoc - - src/main/java/eu/dzhw/fdz/metadatamanagement - -o - ./docs/source/javadoc - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/common/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/questionmanagement/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/domain - -I - src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain - - - unpack-fat-jar install From 1caf53ad11348db12c5644a7722ed43b174cc091 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Thu, 10 Jun 2021 16:17:19 +0200 Subject: [PATCH 07/23] enable javadoc creation and deployment to gh-pages (#2829) --- .github/workflows/build-and-deploy.yml | 7 +++++ deploy/build-and-deploy.sh | 2 +- deploy/build.sh | 2 +- pom.xml | 20 +++++------- .../domain/MetadataExportFormat.java | 18 +++++------ .../domain/TimeMethods.java | 4 +-- .../domain/FreeResourceTypes.java | 4 +-- .../surveymanagement/domain/Population.java | 7 ++--- .../surveymanagement/domain/Survey.java | 31 +++++++++---------- .../domain/SurveySampleTypeProvider.java | 2 +- .../domain/validation/ValidSampleType.java | 2 +- .../domain/validation/ValidUnitValue.java | 2 +- 12 files changed, 49 insertions(+), 52 deletions(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 469394a0b5..da877e9417 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -58,6 +58,13 @@ jobs: uses: codecov/codecov-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} + - name: Deploy Javadoc to Github Pages + uses: JamesIves/github-pages-deploy-action@3.7.1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages # The branch the action should deploy to. + FOLDER: target/site/apidocs # The folder the action should deploy. + CLEAN: true # Automatically remove deleted files from the deploy branch - name: Report build status via Slack uses: act10ns/slack@v1 if: always() diff --git a/deploy/build-and-deploy.sh b/deploy/build-and-deploy.sh index 9e65b686c6..807a50948d 100755 --- a/deploy/build-and-deploy.sh +++ b/deploy/build-and-deploy.sh @@ -21,7 +21,7 @@ if [ -z ${PROFILE} ]; then exit -1 fi echo "Going to run maven build with profile: ${PROFILE}" -mvn --settings ./.github/workflows/.github.settings.xml --no-transfer-progress -P${PROFILE} clean install +mvn --settings ./.github/workflows/.github.settings.xml --no-transfer-progress -P${PROFILE} clean install javadoc:javadoc if [ $? -ne 0 ]; then echo "Maven build failed!" exit -1 diff --git a/deploy/build.sh b/deploy/build.sh index 224fa7e162..6353f2d799 100755 --- a/deploy/build.sh +++ b/deploy/build.sh @@ -20,7 +20,7 @@ if [ -z ${PROFILE} ]; then exit -1 fi echo "Going to run maven build with profile: ${PROFILE}" -mvn --settings ./.github/workflows/.github.settings.xml --no-transfer-progress -P${PROFILE} clean install +mvn --settings ./.github/workflows/.github.settings.xml --no-transfer-progress -P${PROFILE} clean install javadoc:javadoc if [ $? -ne 0 ]; then echo "Maven build failed!" exit -1 diff --git a/pom.xml b/pom.xml index d42869afc0..b42c914b14 100644 --- a/pom.xml +++ b/pom.xml @@ -377,15 +377,21 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.2.0 + 3.3.0 private **/domain/*.java **/domain/validation/*.java + all,-missing + + org.apache.maven.plugins + maven-site-plugin + 3.9.1 + org.codehaus.mojo exec-maven-plugin @@ -850,9 +856,6 @@ .tmp - - docs/source/javadoc - @@ -901,9 +904,6 @@ .tmp - - docs/source/javadoc - @@ -951,9 +951,6 @@ .tmp - - docs/source/javadoc - @@ -1001,9 +998,6 @@ .tmp - - docs/source/javadoc - diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.java index 4fd2c0ccc3..59a27f5179 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.java @@ -3,9 +3,10 @@ import java.util.Set; /** - * Formats to which our metadata can be exported. The actual mapping is either powered by da|ra's - * OAI-PMH service or data cite. - * + * Formats to which our metadata can be exported. The actual mapping is either powered by + * da|ra's OAI-PMH service or + * data cite. + * * @author René Reitmann */ public enum MetadataExportFormat { @@ -15,17 +16,14 @@ public enum MetadataExportFormat { ".json"), schema_org_json_ld("vnd.schemaorg.ld+json", ".json"); /** - * Export formats powered by da|ra's OAI-PMH service. - * - * @see https://www.da-ra.de/oaip/ + * Export formats powered by da|ra's OAI-PMH service. */ public static final Set OAI_FORMATS = Set.of(oai_dc, dara, oai_ddi31, oai_ddi32, oai_dara, mds); /** - * Export formats powered by data cite. - * - * @see https://commons.datacite.org/doi.org/10.21249/dzhw:gra2005:1.0.0 + * Export formats powered by + * data cite. */ public static final Set DATACITE_FORMATS = Set.of(data_cite_xml, data_cite_json, schema_org_json_ld); @@ -42,7 +40,7 @@ public enum MetadataExportFormat { /** * Construct the enum. - * + * * @param urlFormat The format as it can be used in URLs. * @param fileExtension The file extension for the downloaded format (xml or json). */ diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/TimeMethods.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/TimeMethods.java index ffe12856e5..0d16ae7de1 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/TimeMethods.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/TimeMethods.java @@ -2,8 +2,8 @@ /** * Describes the time dimension of the data collection. Used by DARA as time dimension and harvested - * by the VFDB. - * @see https://mdr.iqb.hu-berlin.de/#/catalog/56cc4164-6731-7d54-c97f-ad9bd24bf1b7 + * by the VFDB. Controlled vocabulary as defined + * here. */ public class TimeMethods { public static final String LONGITUDINAL = "Longitudinal"; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/FreeResourceTypes.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/FreeResourceTypes.java index e6d722429e..d3bce98b6c 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/FreeResourceTypes.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/FreeResourceTypes.java @@ -4,8 +4,8 @@ import eu.dzhw.fdz.metadatamanagement.common.domain.ImmutableI18nString; /** - * Resource Types as they are harvested from DARA by the VFDB. - * @see https://mdr.iqb.hu-berlin.de/#/catalog/5c4748e0-bcaa-c3c3-e5af-dd481fddbf0c + * Resource Types as they are harvested from DARA by the VFDB. Controlled vocabulary as defined + * here. */ public class FreeResourceTypes { public static final I18nString SURVEY_DATA = diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Population.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Population.java index 4164aed0ce..d9b3f4625c 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Population.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Population.java @@ -33,7 +33,7 @@ public class Population implements Serializable { /** * A description of the population. Markdown is supported. - * + * * It must be specified in all languages and it must not contain more than 2048 characters. */ @NotNull(message = "survey-management.error.population.description.not-null") @@ -52,9 +52,8 @@ public class Population implements Serializable { /** * Unit type. Mandatory field which only allows values specified by VFDB. - * @see - * GNERD: Survey Unit Educational Research (Version 1.0) - * + * + * GNERD: Survey Unit Educational Research (Version 1.0) */ @NotNull(message = "survey-management.error.population.unit.not-null") @ValidUnitValue(message = "survey-management.error.population.valid-unit-value") diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.java index 38c42ce427..6138a39477 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.java @@ -79,7 +79,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The id of the {@link DataAcquisitionProject} to which this survey belongs. - * + * * The dataAcquisitionProjectId must not be empty. */ @Indexed @@ -88,7 +88,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The title of the instrument. - * + * * It must be specified in German and English and it must not contain more than 2048 characters. */ @I18nStringSize(max = StringLengths.LARGE, @@ -99,7 +99,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * Details about the {@link Population}. - * + * * Must not be empty. */ @Valid @@ -108,7 +108,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The survey method briefly describes how the data were collected. - * + * * It must be specified in German and English and it must not contain more than 2048 characters. */ @NotNull(message = "survey-management.error.survey.survey-method.not-null") @@ -120,7 +120,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The number of the instrument. - * + * * Must not be empty and must be unique within the {@link DataAcquisitionProject}. */ @NotNull(message = "survey-management.error.survey.number.not-null") @@ -128,7 +128,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The period during which the survey has been conducted or is expected to be conducted. - * + * * Must not be empty. */ @NotNull(message = "survey-management.error.survey.field-period.not-null") @@ -138,9 +138,8 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The sampling method is the procedure for selecting sample members from a population. It must * match the controlled vocabulary specified by VFDB. - * - * @see - * Catalog: GNERD: Sampling Procedure Educational Research (Version 1.0) + * + * Catalog: GNERD: Sampling Procedure Educational Research (Version 1.0) */ @NotNull(message = "survey-management.error.survey.sample.not-null") @ValidSampleType(message = "survey-management.error.survey.sample.valid-sample-type") @@ -149,7 +148,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * Number of the wave which this {@link Survey} represents. Will be ignored if the * {@link DataPackage} is not organized in waves. - * + * * Must not be empty and must be greater than or equal to 1. */ @NotNull(message = "survey-management.error.survey.wave.not-null") @@ -159,7 +158,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The gross sample size represents the number of participants which have been invited to take * part in the {@link Survey}. - * + * * Must not be negative. */ @Min(value = 0, message = "survey-management.error.survey.gross-sample-size.min") @@ -167,7 +166,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The sample size is the number of participant which took part in the survey. - * + * * Must not be empty and must not be negative. */ @NotNull(message = "survey-management.error.survey.sample-size.not-null") @@ -176,7 +175,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The response rate is the quotient of the gross sample size and the sample size. - * + * * Must be between 0 and 100. */ @Min(value = 0, message = "survey-management.error.survey.response-rate.min") @@ -185,7 +184,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The type of data which the survey produced. - * + * * Must be one of {@link DataTypes} and must not be empty. */ @NotNull(message = "survey-management.error.survey.data-type.not-null") @@ -194,7 +193,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * The id of the {@link DataPackage} to which this survey belongs. - * + * * Must not be empty. */ @Indexed @@ -203,7 +202,7 @@ public class Survey extends AbstractShadowableRdcDomainObject { /** * Arbitrary additional text for this survey. Markdown is supported. - * + * * Must not contain more than 2048 characters. */ @I18nStringSize(max = StringLengths.LARGE, diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveySampleTypeProvider.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveySampleTypeProvider.java index 11680a49da..ba747bce82 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveySampleTypeProvider.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/SurveySampleTypeProvider.java @@ -11,7 +11,7 @@ /** * Sample types for survey. This list is based on official VFDB vocabulary. - * @see + * * Catalog: GNERD: Sampling Procedure Educational Research (Version 1.0) * */ diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/validation/ValidSampleType.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/validation/ValidSampleType.java index d809dafbfc..59a238e83f 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/validation/ValidSampleType.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/validation/ValidSampleType.java @@ -11,7 +11,7 @@ /** * Validates that a {@link eu.dzhw.fdz.metadatamanagement.common.domain.I18nString} * matches the controlled VFDB vocabulary. - * @see + * * Catalog: GNERD: Sampling Procedure Educational Research (Version 1.0) * */ diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/validation/ValidUnitValue.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/validation/ValidUnitValue.java index 5b7b75d63f..74c2391264 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/validation/ValidUnitValue.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/validation/ValidUnitValue.java @@ -11,7 +11,7 @@ /** * Validates that an (@link {@link eu.dzhw.fdz.metadatamanagement.common.domain.I18nString} * contains values specified by VFDB. - * @see + * * GNERD: Survey Unit Educational Research (Version 1.0) * */ From 79a8bc09453819b4c7e9fee7612cba64fea75b6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Thu, 10 Jun 2021 16:38:21 +0200 Subject: [PATCH 08/23] run javadoc creation earlier (#2829) --- deploy/build-and-deploy.sh | 2 +- deploy/build.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/deploy/build-and-deploy.sh b/deploy/build-and-deploy.sh index 807a50948d..d7d55a9e18 100755 --- a/deploy/build-and-deploy.sh +++ b/deploy/build-and-deploy.sh @@ -21,7 +21,7 @@ if [ -z ${PROFILE} ]; then exit -1 fi echo "Going to run maven build with profile: ${PROFILE}" -mvn --settings ./.github/workflows/.github.settings.xml --no-transfer-progress -P${PROFILE} clean install javadoc:javadoc +mvn --settings ./.github/workflows/.github.settings.xml --no-transfer-progress -P${PROFILE} clean javadoc:javadoc install if [ $? -ne 0 ]; then echo "Maven build failed!" exit -1 diff --git a/deploy/build.sh b/deploy/build.sh index 6353f2d799..13131a7f24 100755 --- a/deploy/build.sh +++ b/deploy/build.sh @@ -20,7 +20,7 @@ if [ -z ${PROFILE} ]; then exit -1 fi echo "Going to run maven build with profile: ${PROFILE}" -mvn --settings ./.github/workflows/.github.settings.xml --no-transfer-progress -P${PROFILE} clean install javadoc:javadoc +mvn --settings ./.github/workflows/.github.settings.xml --no-transfer-progress -P${PROFILE} clean javadoc:javadoc install if [ $? -ne 0 ]; then echo "Maven build failed!" exit -1 From 98017fdc78bdd93c3b73b95f9b9a5031bac8c933 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Thu, 10 Jun 2021 17:23:20 +0200 Subject: [PATCH 09/23] change links to javadoc (#2829) --- README.md | 4 ++-- .../conceptmanagement/domain/Concept.java | 4 ++-- .../datapackagemanagement/domain/DataPackage.java | 4 ++-- .../metadatamanagement/ordermanagement/domain/Order.java | 9 +++++---- .../ordermanagement/domain/OrderClient.java | 4 ++-- .../ordermanagement/domain/OrderedDataPackage.java | 6 +++--- .../ordermanagement/domain/Product.java | 5 +++-- 7 files changed, 19 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index ec9c299bbf..7d02e03924 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Build Status](https://github.com/dzhw/metadatamanagement/workflows/Build%20and%20Deploy/badge.svg)](https://github.com/dzhw/metadatamanagement/actions) [![Documentation Status](https://readthedocs.org/projects/metadatamanagement/badge/?version=latest)](https://metadatamanagement.readthedocs.io/de/latest/javadoc/packages.html) +[![Build Status](https://github.com/dzhw/metadatamanagement/workflows/Build%20and%20Deploy/badge.svg)](https://github.com/dzhw/metadatamanagement/actions) [![Documentation Status](https://readthedocs.org/projects/metadatamanagement/badge/?version=latest)](https://metadatamanagement.readthedocs.io/de/latest/) [![Known Backend Vulnerabilities](https://snyk.io/test/github/dzhw/metadatamanagement/badge.svg?targetFile=pom.xml)](https://snyk.io/test/github/dzhw/metadatamanagement?targetFile=pom.xml )[![Known Frontend Vulnerabilities](https://snyk.io/test/github/dzhw/metadatamanagement/badge.svg?targetFile=package.json)](https://snyk.io/test/github/dzhw/metadatamanagement?targetFile=package.json )[![codecov](https://codecov.io/gh/dzhw/metadatamanagement/branch/development/graph/badge.svg)](https://codecov.io/gh/dzhw/metadatamanagement)[![Mergify Status](https://gh.mergify.io/badges/dzhw/metadatamanagement.png?style=cut)](https://mergify.io) @@ -79,7 +79,7 @@ We test our project continuously with the Robot Framework. Test Developers can g The following picture models the relationships and attributes of the domain objects which are managed by our system. ![Domain Model](https://github.com/dzhw/metadatamanagement/wiki/images/domain-model.png) -Javadoc for our domain model can be found [here](https://metadatamanagement.readthedocs.io/de/latest/javadoc/packages.html). +Javadoc for our domain model can be found [here](https://dzhw.github.io/metadatamanagement/). ### Architecture diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Concept.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Concept.java index a21ef59734..90b2c97d5d 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Concept.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/conceptmanagement/domain/Concept.java @@ -44,8 +44,8 @@ @AllArgsConstructor @Builder @Schema( - description = "Go here" + description = "Go here" + " for further details.") public class Concept extends AbstractRdcDomainObject implements ConceptSubDocumentProjection { diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.java index cae12c3106..aa26c946f6 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/DataPackage.java @@ -54,8 +54,8 @@ @AllArgsConstructor @Builder @Schema( - description = "Go here" + description = "Go here" + " for further details.") @ValidShadowId(message = "data-package-management.error.data-package.id.pattern") public class DataPackage extends AbstractShadowableRdcDomainObject diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Order.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Order.java index 8e1f3a3600..3a320262f6 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Order.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Order.java @@ -31,8 +31,9 @@ @AllArgsConstructor @Builder @Schema( - description = "Go here for further details.") + description = "Go here" + + " for further details.") public class Order extends AbstractRdcDomainObject { private static final long serialVersionUID = 8058350737401818558L; @@ -45,7 +46,7 @@ public class Order extends AbstractRdcDomainObject { /** * The key of the preferred language (either "de" or "en") of the customer. - * + * * Must not be empty. */ @NotEmpty @@ -67,7 +68,7 @@ public class Order extends AbstractRdcDomainObject { /** * List of data {@link Product}s the customer want to order. - * + * * Must not be empty. */ @Valid diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderClient.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderClient.java index 4290dbf208..de7465065f 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderClient.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderClient.java @@ -6,8 +6,8 @@ * Enum holding possible clients with write access to the orders. */ @Schema( - description = "Go here" + description = "Go here" + " for further details.") public enum OrderClient { DLP, MDM diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderedDataPackage.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderedDataPackage.java index cafd0fd691..ad3a5590b7 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderedDataPackage.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/OrderedDataPackage.java @@ -20,9 +20,9 @@ */ @Data @Schema( - description = "Go here " - + "for further details.") + description = "Go " + + "here for further details.") public class OrderedDataPackage implements Serializable { private static final long serialVersionUID = 5959657930630887807L; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Product.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Product.java index fd6c511cfb..04c3a4b529 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Product.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/ordermanagement/domain/Product.java @@ -27,8 +27,9 @@ @AllArgsConstructor @Builder @Schema( - description = "Go here for further details.") + description = "Go here" + + " for further details.") public class Product implements Serializable { private static final long serialVersionUID = -1403870156469073381L; From cc942f1691e2ba5f839600bfd208451ab7e96973 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Mon, 14 Jun 2021 09:36:55 +0200 Subject: [PATCH 10/23] use different github token (#2829) --- .github/workflows/build-and-deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index da877e9417..fc3f42cd48 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -61,7 +61,7 @@ jobs: - name: Deploy Javadoc to Github Pages uses: JamesIves/github-pages-deploy-action@3.7.1 with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }} BRANCH: gh-pages # The branch the action should deploy to. FOLDER: target/site/apidocs # The folder the action should deploy. CLEAN: true # Automatically remove deleted files from the deploy branch From 32e43ba096e03a3e5f49cb1f44abe585299abb2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Mon, 14 Jun 2021 14:59:58 +0200 Subject: [PATCH 11/23] implement deletion of released projects (#2853) --- ...bstractAttachmentShadowCopyDataSource.java | 3 +- .../common/service/ShadowCopyHelper.java | 8 ++++ .../repository/DataPackageRepository.java | 5 ++- .../service/DataPackageManagementService.java | 3 +- .../DataPackageShadowCopyDataSource.java | 2 +- .../repository/DataSetRepository.java | 3 +- .../service/DataSetManagementService.java | 3 +- .../helper/DataSetShadowCopyDataSource.java | 2 +- .../repository/InstrumentRepository.java | 6 ++- .../service/InstrumentManagementService.java | 3 +- .../InstrumentShadowCopyDataSource.java | 2 +- .../domain/ShadowCopyQueueItem.java | 2 +- .../DataAcquisitionProjectRepository.java | 2 +- ...taAcquisitionProjectManagementService.java | 18 ++++++++- .../service/ShadowCopyQueueItemService.java | 40 +++++++++++++++---- .../service/ShadowCopyingEndedEvent.java | 2 +- .../service/ShadowCopyingStartedEvent.java | 2 +- ...cquisitionProjectShadowCopyDataSource.java | 2 +- .../repository/QuestionRepository.java | 3 +- .../helper/QuestionShadowCopyDataSource.java | 2 +- .../repository/SurveyRepository.java | 6 ++- .../service/SurveyManagementService.java | 3 +- .../helper/SurveyShadowCopyDataSource.java | 2 +- .../repository/VariableRepository.java | 4 -- .../helper/VariableShadowCopyDataSource.java | 2 +- ...cquisition-project-navbar-module.html.tmpl | 4 +- 26 files changed, 93 insertions(+), 41 deletions(-) diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/common/service/AbstractAttachmentShadowCopyDataSource.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/common/service/AbstractAttachmentShadowCopyDataSource.java index 75a83a9dc8..63b17d13cd 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/common/service/AbstractAttachmentShadowCopyDataSource.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/common/service/AbstractAttachmentShadowCopyDataSource.java @@ -143,8 +143,7 @@ public void deleteExistingShadowCopies(String projectId, String version) { Query query = new Query(GridFsCriteria.whereMetaData("dataAcquisitionProjectId").is(oldProjectId) .andOperator(GridFsCriteria.whereFilename().regex(getMasterFileNamePattern()), - GridFsCriteria.whereMetaData("shadow").is(true), - GridFsCriteria.whereMetaData("successorId").is(null))); + GridFsCriteria.whereMetaData("shadow").is(true))); gridFsOperations.delete(query); } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/common/service/ShadowCopyHelper.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/common/service/ShadowCopyHelper.java index 1004c991fe..debd2d65dc 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/common/service/ShadowCopyHelper.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/common/service/ShadowCopyHelper.java @@ -81,6 +81,10 @@ private void unhideExistingShadowCopies(String dataAcquisitionProjectId, String shadowCopyDataSource.unhideExistingShadowCopies(dataAcquisitionProjectId, version); } + private void deleteExistingShadowCopies(String dataAcquisitionProjectId, String version) { + shadowCopyDataSource.deleteExistingShadowCopies(dataAcquisitionProjectId, version); + } + /** * Create, hide or unhide shadow copies of current master domain objects on project release. * @@ -102,6 +106,10 @@ public void onShadowCopyingStarted(ShadowCopyingStartedEvent shadowCopyingStarte this.unhideExistingShadowCopies(shadowCopyingStartedEvent.getDataAcquisitionProjectId(), shadowCopyingStartedEvent.getRelease().getVersion()); break; + case DELETE: + this.deleteExistingShadowCopies(shadowCopyingStartedEvent.getDataAcquisitionProjectId(), + shadowCopyingStartedEvent.getRelease().getVersion()); + break; default: throw new IllegalArgumentException( shadowCopyingStartedEvent.getAction() + " has not been implemented yet!"); diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/repository/DataPackageRepository.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/repository/DataPackageRepository.java index 1e51f2a91a..55035b47c5 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/repository/DataPackageRepository.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/repository/DataPackageRepository.java @@ -75,6 +75,9 @@ Stream streamIdsByMasterIdInAndShadowIsTrueAndSuccessorI Stream streamIdsByMasterIdIn(Collection dataSetIds); @RestResource(exported = false) - Stream findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull( + Stream findByDataAcquisitionProjectIdAndShadowIsTrue( String dataAcquisitionProjectId); + + @RestResource(exported = false) + Stream findByMasterIdAndShadowIsTrue(String masterId); } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/DataPackageManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/DataPackageManagementService.java index cf26244c3f..cf41fa28bd 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/DataPackageManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/DataPackageManagementService.java @@ -9,6 +9,7 @@ import org.springframework.data.rest.core.annotation.HandleAfterCreate; import org.springframework.data.rest.core.annotation.HandleAfterDelete; import org.springframework.data.rest.core.annotation.HandleAfterSave; +import org.springframework.data.rest.core.annotation.HandleBeforeDelete; import org.springframework.data.rest.core.annotation.RepositoryEventHandler; import org.springframework.security.access.annotation.Secured; import org.springframework.stereotype.Service; @@ -92,8 +93,8 @@ public void deleteAllDataPackagesByProjectId(String dataAcquisitionProjectId) { try (Stream dataPackages = dataPackageRepository.streamByDataAcquisitionProjectId(dataAcquisitionProjectId)) { dataPackages.forEach(dataPackage -> { - crudHelper.deleteMaster(dataPackage); dataPackageAttachmentService.deleteAllByDataPackageId(dataPackage.getId()); + crudHelper.deleteMaster(dataPackage); }); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/helper/DataPackageShadowCopyDataSource.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/helper/DataPackageShadowCopyDataSource.java index 8357371fa2..24f77c3de6 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/helper/DataPackageShadowCopyDataSource.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/helper/DataPackageShadowCopyDataSource.java @@ -78,7 +78,7 @@ public Stream findShadowCopiesWithDeletedMasters(String projectId, public void deleteExistingShadowCopies(String projectId, String version) { String oldProjectId = projectId + "-" + version; try (Stream dataPackages = dataPackageRepository - .findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull(oldProjectId)) { + .findByDataAcquisitionProjectIdAndShadowIsTrue(oldProjectId)) { dataPackages.forEach(crudHelper::deleteShadow); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/repository/DataSetRepository.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/repository/DataSetRepository.java index cb395ebd2c..0f2e36e54c 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/repository/DataSetRepository.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/repository/DataSetRepository.java @@ -89,6 +89,5 @@ Stream streamIdsByMasterIdInAndShadowIsTrueAndSuccessorI Stream streamIdsByMasterIdIn(Collection dataSetIds); @RestResource(exported = false) - Stream findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull( - String dataAcquisitionProjectId); + Stream findByDataAcquisitionProjectIdAndShadowIsTrue(String dataAcquisitionProjectId); } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetManagementService.java index 8c437ed601..a047714510 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetManagementService.java @@ -11,6 +11,7 @@ import org.springframework.data.rest.core.annotation.HandleAfterCreate; import org.springframework.data.rest.core.annotation.HandleAfterDelete; import org.springframework.data.rest.core.annotation.HandleAfterSave; +import org.springframework.data.rest.core.annotation.HandleBeforeDelete; import org.springframework.data.rest.core.annotation.RepositoryEventHandler; import org.springframework.security.access.annotation.Secured; import org.springframework.stereotype.Service; @@ -88,8 +89,8 @@ public void deleteDataSetsByProjectId(String dataAcquisitionProjectId) { try (Stream dataSets = dataSetRepository.streamByDataAcquisitionProjectId(dataAcquisitionProjectId)) { dataSets.forEach(dataSet -> { - crudHelper.deleteMaster(dataSet); dataSetAttachmentService.deleteAllByDataSetId(dataSet.getId()); + crudHelper.deleteMaster(dataSet); }); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/helper/DataSetShadowCopyDataSource.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/helper/DataSetShadowCopyDataSource.java index 98085c602a..a4439e8da1 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/helper/DataSetShadowCopyDataSource.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/helper/DataSetShadowCopyDataSource.java @@ -85,7 +85,7 @@ private static List createDerivedSurveyIds(List surveyIds, Strin public void deleteExistingShadowCopies(String projectId, String version) { String oldProjectId = projectId + "-" + version; try (Stream dataSets = dataSetRepository - .findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull(oldProjectId)) { + .findByDataAcquisitionProjectIdAndShadowIsTrue(oldProjectId)) { dataSets.forEach(crudHelper::deleteShadow); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/repository/InstrumentRepository.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/repository/InstrumentRepository.java index fade23da67..aa2d5e69e3 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/repository/InstrumentRepository.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/repository/InstrumentRepository.java @@ -99,6 +99,8 @@ Stream streamIdsByMasterIdInAndShadowIsTrueAndSuccessorI List findIdsByConceptIdsContaining(String id); @RestResource(exported = false) - Stream findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull( - String dataAcquisitionProjectId); + Stream findByDataAcquisitionProjectIdAndShadowIsTrue(String dataAcquisitionProjectId); + + @RestResource(exported = false) + Stream findByMasterIdAndShadowIsTrue(String masterId); } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/InstrumentManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/InstrumentManagementService.java index 3930e14e99..7343755971 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/InstrumentManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/InstrumentManagementService.java @@ -11,6 +11,7 @@ import org.springframework.data.rest.core.annotation.HandleAfterCreate; import org.springframework.data.rest.core.annotation.HandleAfterDelete; import org.springframework.data.rest.core.annotation.HandleAfterSave; +import org.springframework.data.rest.core.annotation.HandleBeforeDelete; import org.springframework.data.rest.core.annotation.RepositoryEventHandler; import org.springframework.security.access.annotation.Secured; import org.springframework.stereotype.Service; @@ -89,8 +90,8 @@ public void deleteAllInstrumentsByProjectId(String dataAcquisitionProjectId) { try (Stream instruments = instrumentRepository.streamByDataAcquisitionProjectId(dataAcquisitionProjectId)) { instruments.forEach(instrument -> { - crudHelper.deleteMaster(instrument); instrumentAttachmentService.deleteAllByInstrumentId(instrument.getId()); + crudHelper.deleteMaster(instrument); }); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/helper/InstrumentShadowCopyDataSource.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/helper/InstrumentShadowCopyDataSource.java index d52496e0f1..b4de843cb3 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/helper/InstrumentShadowCopyDataSource.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/helper/InstrumentShadowCopyDataSource.java @@ -87,7 +87,7 @@ private static List createDerivedSurveyIds(List surveyIds, Strin public void deleteExistingShadowCopies(String projectId, String version) { String oldProjectId = projectId + "-" + version; try (Stream instruments = instrumentRepository - .findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull(oldProjectId)) { + .findByDataAcquisitionProjectIdAndShadowIsTrue(oldProjectId)) { instruments.forEach(crudHelper::deleteShadow); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem.java index 0af1f94434..ab5722439b 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem.java @@ -58,6 +58,6 @@ public class ShadowCopyQueueItem extends AbstractRdcDomainObject { * The action which will be performed for the shadows. */ public enum Action { - CREATE, HIDE, UNHIDE + CREATE, HIDE, UNHIDE, DELETE } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/repository/DataAcquisitionProjectRepository.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/repository/DataAcquisitionProjectRepository.java index 5fac9343f9..aaf8221379 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/repository/DataAcquisitionProjectRepository.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/repository/DataAcquisitionProjectRepository.java @@ -51,5 +51,5 @@ Stream streamByIdAndShadowIsTrueAndSuccessorIdIsNull( Stream streamByIdAndShadowIsTrue(String dataAcquisitionProjectId); @RestResource(exported = false) - Stream findByIdAndShadowIsTrueAndSuccessorIdIsNull(String id); + Stream findByMasterIdAndShadowIsTrue(String masterId); } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java index 7aa75b2662..888d2c70cd 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java @@ -10,6 +10,8 @@ import java.util.stream.Collectors; import org.springframework.context.event.EventListener; +import org.springframework.core.env.Environment; +import org.springframework.core.env.Profiles; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.rest.core.annotation.RepositoryEventHandler; @@ -19,6 +21,7 @@ import com.github.zafarkhaja.semver.Version; +import eu.dzhw.fdz.metadatamanagement.common.config.Constants; import eu.dzhw.fdz.metadatamanagement.common.config.MetadataManagementProperties; import eu.dzhw.fdz.metadatamanagement.common.service.CrudService; import eu.dzhw.fdz.metadatamanagement.mailmanagement.service.MailService; @@ -69,6 +72,8 @@ public class DataAcquisitionProjectManagementService private final DaraService daraService; + private final Environment environment; + /** * Searches for {@link DataAcquisitionProject} items for the given id. The result may be limited * if the current user is not an admin or publisher. @@ -234,8 +239,17 @@ public Optional read(String id) { @Override @Secured(value = {AuthoritiesConstants.PUBLISHER, AuthoritiesConstants.ADMIN}) public void delete(DataAcquisitionProject project) { - if (!project.getHasBeenReleasedBefore()) { + if (!project.getHasBeenReleasedBefore() || (this.isAdmin() + && environment.acceptsProfiles(Profiles.of("!" + Constants.SPRING_PROFILE_PROD)))) { crudHelper.deleteMaster(project); + if (project.getHasBeenReleasedBefore()) { + // delete all shadows + acquisitionProjectRepository.findByMasterIdAndShadowIsTrue(project.getMasterId()) + .forEach(shadow -> { + shadowCopyQueueItemService.scheduleShadowCopyDeletion(shadow.getMasterId(), + shadow.getRelease()); + }); + } } else { throw new IllegalStateException( "Project has been released before and therefore it must not be deleted."); @@ -321,6 +335,8 @@ public void onShadowCopyingEnded(ShadowCopyingEndedEvent shadowCopyingEndedEvent + "-" + shadowCopyingEndedEvent.getRelease().getVersion()); } break; + case DELETE: + break; // nothing to do in this case default: throw new IllegalArgumentException( shadowCopyingEndedEvent.getAction() + " has not been implemented yet!"); diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyQueueItemService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyQueueItemService.java index 0cf673ed91..83ebc0f31c 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyQueueItemService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyQueueItemService.java @@ -51,7 +51,7 @@ public class ShadowCopyQueueItemService { /** * Create a new shadow copy queue item. - * + * * @param dataAcquisitionProjectId Id of project for which a shadow copy should be created * @param release The release object of the project which has been released. */ @@ -79,7 +79,7 @@ private void createShadowCopyQueueItem(String dataAcquisitionProjectId, Release /** * Create a new shadow copy queue item for hiding the shadow copies of the given version. - * + * * @param dataAcquisitionProjectId Id of project for which the shadow copies shall be hidden. * @param release The release object of the project which has been released. */ @@ -89,7 +89,7 @@ public void scheduleShadowCopyHiding(String dataAcquisitionProjectId, Release re /** * Create a new shadow copy queue item for unhiding the shadow copies of the given version. - * + * * @param dataAcquisitionProjectId Id of project for which the shadow copies shall be unhidden. * @param release The release object of the project which has been released. */ @@ -97,6 +97,17 @@ public void scheduleShadowCopyUnhiding(String dataAcquisitionProjectId, Release createShadowCopyQueueItem(dataAcquisitionProjectId, release, Action.UNHIDE); } + /** + * Create a new shadow copy queue item for deleting the shadow copies of the given version. + * + * @param dataAcquisitionProjectId (Master-) Id of project for which the shadow copies shall be + * deleted. + * @param release The release object containing the version of the project which shall be deleted. + */ + public void scheduleShadowCopyDeletion(String dataAcquisitionProjectId, Release release) { + createShadowCopyQueueItem(dataAcquisitionProjectId, release, Action.DELETE); + } + /** * Emits {@link ShadowCopyingStartedEvent} for each entry of the collection at a fixed rate. */ @@ -112,8 +123,14 @@ public void executeShadowCopyActions() { setupSecurityContext(task); String dataAcquisitionProjectId = task.getDataAcquisitionProjectId(); Release release = task.getRelease(); - Optional dataAcquisitionProjectOpt = - dataAcquisitionProjectRepository.findById(dataAcquisitionProjectId); + Optional dataAcquisitionProjectOpt; + if (task.getAction().equals(ShadowCopyQueueItem.Action.DELETE)) { + dataAcquisitionProjectOpt = dataAcquisitionProjectRepository + .findById(dataAcquisitionProjectId + "-" + release.getVersion()); + } else { + dataAcquisitionProjectOpt = + dataAcquisitionProjectRepository.findById(dataAcquisitionProjectId); + } if (dataAcquisitionProjectOpt.isPresent()) { DataAcquisitionProject dataAcquisitionProject = dataAcquisitionProjectOpt.get(); switch (task.getAction()) { @@ -134,6 +151,12 @@ public void executeShadowCopyActions() { emitShadowCopyingEndedEvent(dataAcquisitionProject, release, null, true, task.getAction()); break; + case DELETE: + emitShadowCopyingStartedEvent(dataAcquisitionProject, release, null, + task.getAction()); + emitShadowCopyingEndedEvent(dataAcquisitionProject, release, null, false, + task.getAction()); + break; default: throw new IllegalArgumentException( task.getAction() + " has not been implemented yet!"); @@ -155,7 +178,8 @@ public void executeShadowCopyActions() { private void emitShadowCopyingEndedEvent(DataAcquisitionProject dataAcquisitionProject, Release release, String previousReleaseVersion, boolean isRerelease, Action action) { this.applicationEventPublisher.publishEvent(new ShadowCopyingEndedEvent(this, - dataAcquisitionProject.getId(), release, previousReleaseVersion, isRerelease, action)); + dataAcquisitionProject.getMasterId(), release, previousReleaseVersion, isRerelease, + action)); } private void setupSecurityContext(ShadowCopyQueueItem shadowCopyQueueItem) { @@ -194,13 +218,13 @@ private String getPreviousReleaseVersion(DataAcquisitionProject dataAcquisitionP private void emitShadowCopyingStartedEvent(DataAcquisitionProject dataAcquisitionProject, Release release, String previousReleaseVersion, Action action) { this.applicationEventPublisher.publishEvent(new ShadowCopyingStartedEvent(this, - dataAcquisitionProject.getId(), release, previousReleaseVersion, action)); + dataAcquisitionProject.getMasterId(), release, previousReleaseVersion, action)); } /** * Get the action which is currently performed for the given shadow identified by the given * params. - * + * * @param dataAcquisitionProjectId masterId of the project * @param version the version of the project * @return The current action if the shadow is still in the queue. diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyingEndedEvent.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyingEndedEvent.java index c44bd5adaf..7ecb931130 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyingEndedEvent.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyingEndedEvent.java @@ -30,7 +30,7 @@ public class ShadowCopyingEndedEvent extends ApplicationEvent { * Create a new event instance. * * @param source Event emitter reference - * @param dataAcquisitionProjectId id of the released project + * @param dataAcquisitionProjectId master id of the released project * @param release the version which has been released * @param previousReleaseVersion the previous version or null * @param isRerelease true if the project has been released with this version before diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyingStartedEvent.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyingStartedEvent.java index 9213c5047a..cd048a277e 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyingStartedEvent.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/ShadowCopyingStartedEvent.java @@ -28,7 +28,7 @@ public class ShadowCopyingStartedEvent extends ApplicationEvent { * Create a new event instance. * * @param source Event emitter reference - * @param dataAcquisitionProjectId id of the released project + * @param dataAcquisitionProjectId master id of the released project * @param release the version which has been released * @param previousReleaseVersion the previous version or null * @param action The action to be executed. diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/helper/DataAcquisitionProjectShadowCopyDataSource.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/helper/DataAcquisitionProjectShadowCopyDataSource.java index fb3fc24698..522dc054a7 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/helper/DataAcquisitionProjectShadowCopyDataSource.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/helper/DataAcquisitionProjectShadowCopyDataSource.java @@ -73,7 +73,7 @@ public Stream findShadowCopiesWithDeletedMasters(String public void deleteExistingShadowCopies(String projectId, String version) { String oldProjectId = projectId + "-" + version; try (Stream projects = dataAcquisitionProjectRepository - .findByIdAndShadowIsTrueAndSuccessorIdIsNull(oldProjectId)) { + .streamByIdAndShadowIsTrue(oldProjectId)) { projects.forEach(crudHelper::deleteShadow); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/questionmanagement/repository/QuestionRepository.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/questionmanagement/repository/QuestionRepository.java index 48dced372a..78a7043fd7 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/questionmanagement/repository/QuestionRepository.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/questionmanagement/repository/QuestionRepository.java @@ -84,6 +84,5 @@ Stream streamIdsByMasterIdInAndShadowIsTrueAndSuccessorI List findSubDocumentsByConceptIdsContaining(String id); @RestResource(exported = false) - Stream findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull( - String dataAcquisitionProjectId); + Stream findByDataAcquisitionProjectIdAndShadowIsTrue(String dataAcquisitionProjectId); } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/questionmanagement/service/helper/QuestionShadowCopyDataSource.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/questionmanagement/service/helper/QuestionShadowCopyDataSource.java index 191ce0a01e..ad81a1d090 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/questionmanagement/service/helper/QuestionShadowCopyDataSource.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/questionmanagement/service/helper/QuestionShadowCopyDataSource.java @@ -88,7 +88,7 @@ private List createDerivedSuccessorIds(List successorIds, String public void deleteExistingShadowCopies(String projectId, String version) { String oldProjectId = projectId + "-" + version; try (Stream questions = questionRepository - .findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull(oldProjectId)) { + .findByDataAcquisitionProjectIdAndShadowIsTrue(oldProjectId)) { questions.forEach(crudHelper::deleteShadow); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/repository/SurveyRepository.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/repository/SurveyRepository.java index ae6dff57ac..113ae46359 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/repository/SurveyRepository.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/repository/SurveyRepository.java @@ -78,6 +78,8 @@ Stream streamIdsByMasterIdInAndShadowIsTrueAndSuccessorI Stream streamIdsByMasterIdIn(Collection surveyIds); @RestResource(exported = false) - Stream findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull( - String dataAcquisitionProjectId); + Stream findByDataAcquisitionProjectIdAndShadowIsTrue(String dataAcquisitionProjectId); + + @RestResource(exported = false) + Stream findByMasterIdAndShadowIsTrue(String masterId); } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyManagementService.java index 2b8de12a29..5efd34285f 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyManagementService.java @@ -11,6 +11,7 @@ import org.springframework.data.rest.core.annotation.HandleAfterCreate; import org.springframework.data.rest.core.annotation.HandleAfterDelete; import org.springframework.data.rest.core.annotation.HandleAfterSave; +import org.springframework.data.rest.core.annotation.HandleBeforeDelete; import org.springframework.data.rest.core.annotation.RepositoryEventHandler; import org.springframework.security.access.annotation.Secured; import org.springframework.stereotype.Service; @@ -100,9 +101,9 @@ public void deleteAllSurveysByProjectId(String dataAcquisitionProjectId) { try (Stream surveys = surveyRepository.streamByDataAcquisitionProjectId(dataAcquisitionProjectId)) { surveys.forEach(survey -> { - crudHelper.deleteMaster(survey); imageService.deleteAllSurveyImagesById(survey.getId()); surveyAttachmentService.deleteAllBySurveyId(survey.getId()); + crudHelper.deleteMaster(survey); }); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/helper/SurveyShadowCopyDataSource.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/helper/SurveyShadowCopyDataSource.java index 23b4616fbf..279cb85e53 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/helper/SurveyShadowCopyDataSource.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/helper/SurveyShadowCopyDataSource.java @@ -78,7 +78,7 @@ public Stream findShadowCopiesWithDeletedMasters(String projectId, public void deleteExistingShadowCopies(String projectId, String version) { String oldProjectId = projectId + "-" + version; try (Stream surveys = surveyRepository - .findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull(oldProjectId)) { + .findByDataAcquisitionProjectIdAndShadowIsTrue(oldProjectId)) { surveys.forEach(crudHelper::deleteShadow); } } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/repository/VariableRepository.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/repository/VariableRepository.java index 363e330a95..088d1a3986 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/repository/VariableRepository.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/repository/VariableRepository.java @@ -120,10 +120,6 @@ List findSubDocumentsByRelatedQuestionsQuestionId @RestResource(exported = false) Stream streamIdsByRelatedQuestionsQuestionId(String questionId); - @RestResource(exported = false) - Stream findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull( - String dataAcquisitionProjectId); - @RestResource(exported = false) List findAllByDerivedVariablesIdentifierAndDataSetIdAndIdNot( String derivedVariablesIdentifier, String dataSetId, String id); diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/service/helper/VariableShadowCopyDataSource.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/service/helper/VariableShadowCopyDataSource.java index f6ded78655..a5c51b3f7e 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/service/helper/VariableShadowCopyDataSource.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/service/helper/VariableShadowCopyDataSource.java @@ -119,7 +119,7 @@ private static List createDerivedSurveyIds(List surveyIds, Strin public void deleteExistingShadowCopies(String projectId, String version) { String oldProjectId = projectId + "-" + version; try (Stream variables = variableRepository - .findByDataAcquisitionProjectIdAndShadowIsTrueAndSuccessorIdIsNull(oldProjectId)) { + .findByDataAcquisitionProjectIdAndShadowIsTrue(oldProjectId)) { variables.forEach(crudHelper::deleteShadow); } } diff --git a/src/main/webapp/scripts/dataacquisitionprojectmanagement/directives/data-acquisition-project-navbar-module.html.tmpl b/src/main/webapp/scripts/dataacquisitionprojectmanagement/directives/data-acquisition-project-navbar-module.html.tmpl index 0e3652cb75..19303f89cb 100644 --- a/src/main/webapp/scripts/dataacquisitionprojectmanagement/directives/data-acquisition-project-navbar-module.html.tmpl +++ b/src/main/webapp/scripts/dataacquisitionprojectmanagement/directives/data-acquisition-project-navbar-module.html.tmpl @@ -22,8 +22,8 @@
- + {{'global.tooltips.delete-project' | translate}} From db69fea09fdaaa3bcdc9978786670a20f9c40217 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Mon, 14 Jun 2021 15:32:33 +0200 Subject: [PATCH 12/23] update github pages deployment action (#2829) --- .github/workflows/build-and-deploy.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index fc3f42cd48..a8dddde4be 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -59,12 +59,10 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} - name: Deploy Javadoc to Github Pages - uses: JamesIves/github-pages-deploy-action@3.7.1 + uses: JamesIves/github-pages-deploy-action@4.1.4 with: - GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }} - BRANCH: gh-pages # The branch the action should deploy to. - FOLDER: target/site/apidocs # The folder the action should deploy. - CLEAN: true # Automatically remove deleted files from the deploy branch + branch: gh-pages # The branch the action should deploy to. + folder: target/site/apidocs # The folder the action should deploy. - name: Report build status via Slack uses: act10ns/slack@v1 if: always() From 852f61125a643435f78e40c23ddaaea646d843d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Mon, 14 Jun 2021 17:24:40 +0200 Subject: [PATCH 13/23] sort project ids (#2853) --- .../repository/DataAcquisitionProjectRepository.java | 6 ++---- .../service/DataAcquisitionProjectManagementService.java | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/repository/DataAcquisitionProjectRepository.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/repository/DataAcquisitionProjectRepository.java index aaf8221379..d92fba9791 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/repository/DataAcquisitionProjectRepository.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/repository/DataAcquisitionProjectRepository.java @@ -22,10 +22,8 @@ public interface DataAcquisitionProjectRepository extends BaseRepository, DataAcquisitionProjectRepositoryCustom { @RestResource(exported = false) - List findByIdLikeOrderByIdAsc(String id); - - @RestResource(exported = false) - List findByIdLikeAndShadowIsFalseAndSuccessorIdIsNull(String id); + List findByIdLikeAndShadowIsFalseAndSuccessorIdIsNullOrderByIdAsc( + String id); @RestResource(exported = true) List diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java index 888d2c70cd..e4e0c9c59f 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java @@ -84,7 +84,7 @@ public class DataAcquisitionProjectManagementService public List findByIdLikeOrderByIdAsc(String projectId) { if (isAdmin() || isPublisher()) { return acquisitionProjectRepository - .findByIdLikeAndShadowIsFalseAndSuccessorIdIsNull(projectId); + .findByIdLikeAndShadowIsFalseAndSuccessorIdIsNullOrderByIdAsc(projectId); } else { String loginName = userInformationProvider.getUserLogin(); return acquisitionProjectRepository From 64c0e79bb59daf5911079299de8870f106be8ffa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Tue, 15 Jun 2021 10:42:39 +0200 Subject: [PATCH 14/23] update spring boot, javers and other, enable pmd checks (#2902) --- pom.xml | 14 +++++++------- .../common/rest/filter/Seo4AjaxFilter.java | 19 ++++++++----------- .../domain/MetadataExportFormat.java | 2 +- .../service/DataPackageManagementService.java | 1 - .../service/DataSetAttachmentService.java | 1 - .../service/DataSetManagementService.java | 1 - .../service/InstrumentManagementService.java | 1 - ...taAcquisitionProjectManagementService.java | 4 ++-- ...DataAcquisitionProjectVersionsService.java | 1 - .../RelatedPublicationManagementService.java | 2 -- .../service/SurveyAttachmentService.java | 1 - .../service/SurveyManagementService.java | 1 - .../variablemanagement/domain/AccessWays.java | 2 -- 13 files changed, 18 insertions(+), 32 deletions(-) diff --git a/pom.xml b/pom.xml index b42c914b14..459e60b302 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.springframework.boot spring-boot-starter-parent - 2.4.6 + 2.4.7 @@ -120,7 +120,7 @@ commons-io commons-io - 2.8.0 + 2.10.0 commons-validator @@ -165,7 +165,7 @@ org.javers javers-spring-boot-starter-mongo - 6.1.1 + 6.2.1 org.jsoup @@ -303,7 +303,7 @@ org.springframework.security.oauth.boot spring-security-oauth2-autoconfigure - 2.4.5 + 2.4.6 org.zalando @@ -588,11 +588,11 @@ - org.apache.maven.plugins maven-pmd-plugin - 3.13.0 + 3.14.0 pmd check @@ -606,7 +606,7 @@ false - --> + org.apache.maven.plugins maven-surefire-plugin diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/common/rest/filter/Seo4AjaxFilter.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/common/rest/filter/Seo4AjaxFilter.java index 31e8a50004..f6882d473e 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/common/rest/filter/Seo4AjaxFilter.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/common/rest/filter/Seo4AjaxFilter.java @@ -81,7 +81,7 @@ public Seo4AjaxFilter(MetadataManagementProperties properties) throws ServletExc @Override public void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException { - if (forwardRequestsToRobotsTxtOnProd(request, response, chain)) { + if (forwardRequestsToRobotsTxtOnProd(request, response)) { return; } String queryString = request.getQueryString(); @@ -101,11 +101,10 @@ public void doFilterInternal(HttpServletRequest request, HttpServletResponse res urlConnection = (HttpsURLConnection) new URL(url).openConnection(); } else { String userAgent = request.getHeader(USER_AGENT_HEADER); - if (userAgent != null && userAgent.toLowerCase(Locale.US).matches(regexpBots)) { - if (StringUtils.isEmpty(path) || path.equals("/") || path.startsWith("/de/") - || path.startsWith("/en/") || path.equals("/en") || path.equals("/de")) { - urlConnection = (HttpsURLConnection) new URL(url).openConnection(); - } + if (userAgent != null && userAgent.toLowerCase(Locale.US).matches(regexpBots) + && (StringUtils.isEmpty(path) || path.equals("/") || path.startsWith("/de/") + || path.startsWith("/en/") || path.equals("/en") || path.equals("/de"))) { + urlConnection = (HttpsURLConnection) new URL(url).openConnection(); } } if (urlConnection == null) { @@ -119,8 +118,7 @@ public void doFilterInternal(HttpServletRequest request, HttpServletResponse res return; } for (String headerName : urlConnection.getHeaderFields().keySet()) { - if (!StringUtils.isEmpty(headerName) - && !"transfer-encoding".equalsIgnoreCase(headerName) + if (!StringUtils.isEmpty(headerName) && !"transfer-encoding".equalsIgnoreCase(headerName) && !"connection".equalsIgnoreCase(headerName)) { response.addHeader(headerName, urlConnection.getHeaderField(headerName)); } @@ -130,7 +128,7 @@ public void doFilterInternal(HttpServletRequest request, HttpServletResponse res } private boolean forwardRequestsToRobotsTxtOnProd(HttpServletRequest request, - HttpServletResponse response, FilterChain chain) throws ServletException, IOException { + HttpServletResponse response) throws ServletException, IOException { String contextPath = request.getContextPath(); String requestUri = request.getRequestURI(); requestUri = org.apache.commons.lang3.StringUtils.substringAfter(requestUri, contextPath); @@ -149,8 +147,7 @@ private boolean forwardRequestsToRobotsTxtOnProd(HttpServletRequest request, return false; } - private void copy(InputStream inputStream, OutputStream outputStream) - throws IOException { + private void copy(InputStream inputStream, OutputStream outputStream) throws IOException { try (inputStream; outputStream) { ByteStreams.copy(inputStream, outputStream); } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.java index 59a27f5179..cd5a5c8904 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/domain/MetadataExportFormat.java @@ -44,7 +44,7 @@ public enum MetadataExportFormat { * @param urlFormat The format as it can be used in URLs. * @param fileExtension The file extension for the downloaded format (xml or json). */ - private MetadataExportFormat(String urlFormat, String fileExtension) { + MetadataExportFormat(String urlFormat, String fileExtension) { this.urlFormat = urlFormat; this.fileExtension = fileExtension; } diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/DataPackageManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/DataPackageManagementService.java index cf41fa28bd..b72ed1ff3c 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/DataPackageManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datapackagemanagement/service/DataPackageManagementService.java @@ -9,7 +9,6 @@ import org.springframework.data.rest.core.annotation.HandleAfterCreate; import org.springframework.data.rest.core.annotation.HandleAfterDelete; import org.springframework.data.rest.core.annotation.HandleAfterSave; -import org.springframework.data.rest.core.annotation.HandleBeforeDelete; import org.springframework.data.rest.core.annotation.RepositoryEventHandler; import org.springframework.security.access.annotation.Secured; import org.springframework.stereotype.Service; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetAttachmentService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetAttachmentService.java index ea083c20f4..4cbea5c87d 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetAttachmentService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetAttachmentService.java @@ -26,7 +26,6 @@ import eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.DataSetAttachmentMetadata; import eu.dzhw.fdz.metadatamanagement.datasetmanagement.repository.DataSetRepository; import eu.dzhw.fdz.metadatamanagement.datasetmanagement.service.helper.DataSetAttachmentFilenameBuilder; -import eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain.InstrumentAttachmentMetadata; import eu.dzhw.fdz.metadatamanagement.projectmanagement.domain.DataAcquisitionProject; import eu.dzhw.fdz.metadatamanagement.usermanagement.security.SecurityUtils; import lombok.RequiredArgsConstructor; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetManagementService.java index a047714510..5c23041d80 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/datasetmanagement/service/DataSetManagementService.java @@ -11,7 +11,6 @@ import org.springframework.data.rest.core.annotation.HandleAfterCreate; import org.springframework.data.rest.core.annotation.HandleAfterDelete; import org.springframework.data.rest.core.annotation.HandleAfterSave; -import org.springframework.data.rest.core.annotation.HandleBeforeDelete; import org.springframework.data.rest.core.annotation.RepositoryEventHandler; import org.springframework.security.access.annotation.Secured; import org.springframework.stereotype.Service; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/InstrumentManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/InstrumentManagementService.java index 7343755971..866a7a091e 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/InstrumentManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/instrumentmanagement/service/InstrumentManagementService.java @@ -11,7 +11,6 @@ import org.springframework.data.rest.core.annotation.HandleAfterCreate; import org.springframework.data.rest.core.annotation.HandleAfterDelete; import org.springframework.data.rest.core.annotation.HandleAfterSave; -import org.springframework.data.rest.core.annotation.HandleBeforeDelete; import org.springframework.data.rest.core.annotation.RepositoryEventHandler; import org.springframework.security.access.annotation.Secured; import org.springframework.stereotype.Service; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java index e4e0c9c59f..16e05c91dc 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectManagementService.java @@ -239,8 +239,8 @@ public Optional read(String id) { @Override @Secured(value = {AuthoritiesConstants.PUBLISHER, AuthoritiesConstants.ADMIN}) public void delete(DataAcquisitionProject project) { - if (!project.getHasBeenReleasedBefore() || (this.isAdmin() - && environment.acceptsProfiles(Profiles.of("!" + Constants.SPRING_PROFILE_PROD)))) { + if (!project.getHasBeenReleasedBefore() || this.isAdmin() + && environment.acceptsProfiles(Profiles.of("!" + Constants.SPRING_PROFILE_PROD))) { crudHelper.deleteMaster(project); if (project.getHasBeenReleasedBefore()) { // delete all shadows diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectVersionsService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectVersionsService.java index 0882a552c7..2e89998513 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectVersionsService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/projectmanagement/service/DataAcquisitionProjectVersionsService.java @@ -3,7 +3,6 @@ import java.util.ArrayList; import java.util.List; import java.util.Optional; -import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import java.util.stream.Collectors; import java.util.stream.Stream; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/service/RelatedPublicationManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/service/RelatedPublicationManagementService.java index 248ff19906..6049cd1742 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/service/RelatedPublicationManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/relatedpublicationmanagement/service/RelatedPublicationManagementService.java @@ -1,9 +1,7 @@ package eu.dzhw.fdz.metadatamanagement.relatedpublicationmanagement.service; import java.util.Optional; -import java.util.stream.Stream; -import org.javers.common.collections.Lists; import org.springframework.data.rest.core.annotation.HandleAfterCreate; import org.springframework.data.rest.core.annotation.HandleAfterDelete; import org.springframework.data.rest.core.annotation.HandleAfterSave; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyAttachmentService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyAttachmentService.java index 644d844ec7..2bdca1877c 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyAttachmentService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyAttachmentService.java @@ -21,7 +21,6 @@ import eu.dzhw.fdz.metadatamanagement.common.domain.ShadowCopyCreateNotAllowedException; import eu.dzhw.fdz.metadatamanagement.common.domain.ShadowCopyDeleteNotAllowedException; import eu.dzhw.fdz.metadatamanagement.common.service.AttachmentMetadataHelper; -import eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.DataSetAttachmentMetadata; import eu.dzhw.fdz.metadatamanagement.projectmanagement.domain.DataAcquisitionProject; import eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.SurveyAttachmentMetadata; import eu.dzhw.fdz.metadatamanagement.surveymanagement.service.helper.SurveyAttachmentFilenameBuilder; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyManagementService.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyManagementService.java index 5efd34285f..ba92d5db7f 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyManagementService.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/service/SurveyManagementService.java @@ -11,7 +11,6 @@ import org.springframework.data.rest.core.annotation.HandleAfterCreate; import org.springframework.data.rest.core.annotation.HandleAfterDelete; import org.springframework.data.rest.core.annotation.HandleAfterSave; -import org.springframework.data.rest.core.annotation.HandleBeforeDelete; import org.springframework.data.rest.core.annotation.RepositoryEventHandler; import org.springframework.security.access.annotation.Secured; import org.springframework.stereotype.Service; diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/AccessWays.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/AccessWays.java index 3972b8c32c..9578a71397 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/AccessWays.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/variablemanagement/domain/AccessWays.java @@ -2,9 +2,7 @@ import java.util.Arrays; import java.util.Collections; -import java.util.HashSet; import java.util.List; -import java.util.Set; import eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.DataSet; From cb72900691db4eaa953122e604dbbc87955a1b8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Wed, 16 Jun 2021 10:15:10 +0200 Subject: [PATCH 15/23] upgrade robottests to python 3.9 (#2829) --- .github/workflows/nightly-e2e-tests.yml | 75 ------------------- .gitignore | 1 + src/test/robotframework/__init__.robot | 3 +- .../data_provider/__init__.robot | 3 +- .../check_banner_as_dataproviders.robot | 1 - .../upload_data_package_attachment.robot | 8 +- .../datasetmanagement/create_dataset.robot | 2 +- .../create_instrument.robot | 2 +- .../upload_instrument_attachment.robot | 4 +- .../surveymanagement/create_survey.robot | 2 +- .../surveymanagement/upload_file.robot | 4 +- src/test/robotframework/libs/SauceLabs.py | 4 +- .../robotframework/public_user/__init__.robot | 1 + .../check_shoppingcart_funtionalities.robot | 6 +- .../Check Banner As Publisher.robot | 2 +- .../Check Used Concept Unable to Delete.robot | 1 + .../Conceptmanagement/Create Concept.robot | 4 +- .../Create_Data_Package.robot | 8 +- ...hers Metadata Deleting Access Rights.robot | 6 +- ...easing and Unreleasing Access Rights.robot | 6 +- .../Related Publications Upload.robot | 2 +- .../robotframework/publisher/__init__.robot | 3 +- .../resources/check_url_resource.robot | 8 +- .../resources/click_element_resource.robot | 7 +- .../resources/home_page_resource.robot | 2 +- .../resources/login_resource.robot | 12 ++- .../project_management_resource.robot | 2 +- .../resources/search_resource.robot | 14 ++-- src/test/robotframework/setup.sh | 6 +- 29 files changed, 69 insertions(+), 130 deletions(-) diff --git a/.github/workflows/nightly-e2e-tests.yml b/.github/workflows/nightly-e2e-tests.yml index dab88b7835..69a051016b 100644 --- a/.github/workflows/nightly-e2e-tests.yml +++ b/.github/workflows/nightly-e2e-tests.yml @@ -10,16 +10,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Chrome Tests (Public User) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/chrome -v USE_SAUCELABS:TRUE -v BROWSER:chrome --include publicuserNOTfirefoxonlyNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} firefox-public-user: @@ -28,16 +23,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Firefox Tests (Public User) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/firefox -v USE_SAUCELABS:TRUE -v BROWSER:firefox --include publicuserNOTchromeonlyNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} ie11-public-user: @@ -46,16 +36,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Internet Explorer Tests (Public User) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/ie11 -v USE_SAUCELABS:TRUE -v BROWSER:ie --include publicuserNOTfirefoxonlyNOTchromeonlyNOTnoslowpokeNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} edge-public-user: @@ -64,16 +49,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Edge Tests (Public User) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/edge -v USE_SAUCELABS:TRUE -v BROWSER:edge --include publicuserNOTfirefoxonlyNOTchromeonlyNOTnoslowpokeNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} safari-public-user: @@ -82,16 +62,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Safari Tests (Public User) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/safari -v USE_SAUCELABS:TRUE -v BROWSER:safari --include publicuserNOTfirefoxonlyNOTchromeonlyNOTnoslowpokeNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} chrome-dataprovider: @@ -106,16 +81,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Chrome Tests (Dataprovider) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/chrome -v USE_SAUCELABS:TRUE -v BROWSER:chrome --include dataproviderNOTfirefoxonlyNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} firefox-dataprovider: @@ -130,16 +100,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Firefox Tests (Dataprovider) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/firefox -v USE_SAUCELABS:TRUE -v BROWSER:firefox --include dataproviderNOTchromeonlyNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} ie11-dataprovider: @@ -154,16 +119,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Internet Explorer Tests (Dataprovider) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/ie11 -v USE_SAUCELABS:TRUE -v BROWSER:ie --include dataproviderNOTfirefoxonlyNOTchromeonlyNOTnoslowpokeNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} edge-dataprovider: @@ -178,16 +138,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Edge Tests (Dataprovider) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/edge -v USE_SAUCELABS:TRUE -v BROWSER:edge --include dataproviderNOTfirefoxonlyNOTchromeonlyNOTnoslowpokeNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} safari-dataprovider: @@ -202,16 +157,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Safari Tests (Dataprovider) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/safari -v USE_SAUCELABS:TRUE -v BROWSER:safari --include dataproviderNOTfirefoxonlyNOTchromeonlyNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} chrome-publisher: @@ -226,16 +176,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Chrome Tests (Publisher) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/chrome -v USE_SAUCELABS:TRUE -v BROWSER:chrome --include publisherNOTfirefoxonlyNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} firefox-publisher: @@ -250,16 +195,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Firefox Tests (Publisher) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/firefox -v USE_SAUCELABS:TRUE -v BROWSER:firefox --include publisherNOTchromeonlyNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} ie11-publisher: @@ -274,16 +214,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Internet Explorer Tests (Publisher) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/ie11 -v USE_SAUCELABS:TRUE -v BROWSER:ie --include publisherNOTfirefoxonlyNOTchromeonlyNOTnoslowpokeNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} edge-publisher: @@ -298,16 +233,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Edge Tests (Publisher) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/edge -v USE_SAUCELABS:TRUE -v BROWSER:edge --include publisherNOTfirefoxonlyNOTchromeonlyNOTnoslowpokeNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} safari-publisher: @@ -321,16 +251,11 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Set up Python 2.7 - uses: actions/setup-python@v2 - with: - python-version: 2.7.17 - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Safari Tests (Publisher) run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/safari -v USE_SAUCELABS:TRUE -v BROWSER:safari --include publisherNOTfirefoxonlyNOTchromeonlyNOTlocalonly ./src/test/robotframework env: - PYTHONWARNINGS: ignore SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} report-via-slack: diff --git a/.gitignore b/.gitignore index 3906affc85..643d34c045 100644 --- a/.gitignore +++ b/.gitignore @@ -124,6 +124,7 @@ Desktop.ini .merge_file* *.pyc .attach* +.python-version ###################### # Gradle Wrapper diff --git a/src/test/robotframework/__init__.robot b/src/test/robotframework/__init__.robot index b91bf7e87d..b1d791411b 100644 --- a/src/test/robotframework/__init__.robot +++ b/src/test/robotframework/__init__.robot @@ -2,7 +2,7 @@ Documentation Common setup and teardown for all tests Suite Setup Open Home Page Suite Teardown Finish Tests -Library ExtendedSelenium2Library +Library SeleniumLibrary Library Collections Library OperatingSystem Resource ./resources/click_element_resource.robot @@ -16,6 +16,7 @@ ${BUILD_NUMBER} local *** Keywords *** Open Local Browser + Set To Dictionary ${CAPABILITIES.${BROWSER}} platform=${EMPTY} Open Browser ${WEBSITE} ${BROWSER} desired_capabilities=${CAPABILITIES.${BROWSER}} Open Saucelabs Browser diff --git a/src/test/robotframework/data_provider/__init__.robot b/src/test/robotframework/data_provider/__init__.robot index 9aca333bd3..4bb4ade1c0 100644 --- a/src/test/robotframework/data_provider/__init__.robot +++ b/src/test/robotframework/data_provider/__init__.robot @@ -2,6 +2,7 @@ Documentation Common setup and teardown for all dataprovider tests Suite Setup Login as dataprovider Suite Teardown Data Provider Logout -Library ExtendedSelenium2Library +Library SeleniumLibrary +Library AngularJSLibrary root_selector=[data-ng-app] Resource ../resources/login_resource.robot Force Tags dataprovider diff --git a/src/test/robotframework/data_provider/common/check_banner_as_dataproviders.robot b/src/test/robotframework/data_provider/common/check_banner_as_dataproviders.robot index 3500cfb8e6..1ec1fcdc53 100644 --- a/src/test/robotframework/data_provider/common/check_banner_as_dataproviders.robot +++ b/src/test/robotframework/data_provider/common/check_banner_as_dataproviders.robot @@ -1,6 +1,5 @@ *** Settings *** Documentation Banner appears for Dataproviders and assert the welcome text and dont show again checkbox -Library HttpLibrary.HTTP Resource ../../resources/login_resource.robot Resource ../../resources/click_element_resource.robot Resource ../../resources/check_url_resource.robot diff --git a/src/test/robotframework/data_provider/datapackagemanagement/upload_data_package_attachment.robot b/src/test/robotframework/data_provider/datapackagemanagement/upload_data_package_attachment.robot index c4b5b1fe83..f755578621 100644 --- a/src/test/robotframework/data_provider/datapackagemanagement/upload_data_package_attachment.robot +++ b/src/test/robotframework/data_provider/datapackagemanagement/upload_data_package_attachment.robot @@ -17,7 +17,7 @@ Upload Attachment for Data Package Write data package description in de and en Save Changes for data package attachment Assert gra2005_MethodReport in the attachment - Delete data package with uploaded document + Delete uploaded document Get back to home page and deselect project *** Keywords *** @@ -32,7 +32,7 @@ Click add button Click Element Through Tooltips xpath=//ui-view//button[@ng-click="ctrl.addAttachment($event)"]//md-icon[text()="add"] Upload data package file - Press Key xpath=//input[@type='file' and @ngf-select="ctrl.upload($file)"][1] ${CURDIR}/data/gra2005_MethodReport_de.pdf # data folder contains the PDF file + Choose File xpath=//input[@type='file' and @ngf-select="ctrl.upload($file)"][1] ${CURDIR}/data/gra2005_MethodReport_de.pdf # data folder contains the PDF file Select data package data type Click Element Through Tooltips xpath=//md-select[@ng-model="ctrl.attachmentMetadata.type"] @@ -58,8 +58,8 @@ Save Changes for data package attachment Assert gra2005_MethodReport in the attachment Page Should Contain Element xpath=//a[@ng-href="/public/files/data-packages/stu-fileuploadproject$/attachments/gra2005_MethodReport_de.pdf"] -Delete data package with uploaded document +Delete uploaded document Click Element Through Tooltips xpath=//button[md-icon[text()="delete_forever"]] Click Element Through Tooltips xpath=//button[text()="Ja"] - Wait Until Angular Ready 2s + Wait for Angular 2s Page Should Not Contain Element xpath=//a[@ng-href="/public/files/data-packages/stu-fileuploadproject$/attachments/gra2005_MethodReport_de.pdf"] diff --git a/src/test/robotframework/data_provider/datasetmanagement/create_dataset.robot b/src/test/robotframework/data_provider/datasetmanagement/create_dataset.robot index 2b8d75c677..de7806d2ba 100644 --- a/src/test/robotframework/data_provider/datasetmanagement/create_dataset.robot +++ b/src/test/robotframework/data_provider/datasetmanagement/create_dataset.robot @@ -26,7 +26,7 @@ Create Dataset by Dataprovider *** Keywords *** Go To Dataset Create Page Select project by name robotproject4${BROWSER} - Wait Until Angular Ready 2s + Wait for Angular 2s Click on data set tab Click Element Through Tooltips xpath=//ui-view/descendant::button[md-icon[text()='add']] diff --git a/src/test/robotframework/data_provider/instrumentmanagement/create_instrument.robot b/src/test/robotframework/data_provider/instrumentmanagement/create_instrument.robot index 5894d006dc..f2834ad068 100644 --- a/src/test/robotframework/data_provider/instrumentmanagement/create_instrument.robot +++ b/src/test/robotframework/data_provider/instrumentmanagement/create_instrument.robot @@ -20,7 +20,7 @@ Create Instrument by Dataprovider *** Keywords *** Go To Instrument Create Page Select project by name robotproject4${BROWSER} - Wait Until Angular Ready 2s + Wait for Angular 2s Click on instruments tab Click Element Through Tooltips xpath=//ui-view/descendant::button[md-icon[text()='add']] diff --git a/src/test/robotframework/data_provider/instrumentmanagement/upload_instrument_attachment.robot b/src/test/robotframework/data_provider/instrumentmanagement/upload_instrument_attachment.robot index eff8ac08c6..636e73d2d8 100644 --- a/src/test/robotframework/data_provider/instrumentmanagement/upload_instrument_attachment.robot +++ b/src/test/robotframework/data_provider/instrumentmanagement/upload_instrument_attachment.robot @@ -32,7 +32,7 @@ Click add button Click Element Through Tooltips xpath=//ui-view//button/md-icon[text()='add'] Upload instrument file - Press Key xpath=//input[@type='file' and @ngf-select="ctrl.upload($file)"][1] ${CURDIR}/data/gra2005_W1_Questionnaire_de.pdf # data folder contains the PDF file + Choose File xpath=//input[@type='file' and @ngf-select="ctrl.upload($file)"][1] ${CURDIR}/data/gra2005_W1_Questionnaire_de.pdf # data folder contains the PDF file Select instrument data type Click Element Through Tooltips xpath=//md-select[@ng-model="ctrl.attachmentMetadata.type"] @@ -57,5 +57,5 @@ Assert gra2005_W1_Questionnaire in the attachment Delete uploaded document Click Element Through Tooltips xpath=//button[md-icon[text()='delete_forever']] Click Element Through Tooltips xpath=//button[text()='Ja'] - Wait Until Angular Ready 2s + Wait for Angular 2s Page Should Not Contain Element xpath=//a[@ng-href="/public/files/instruments/ins-fileuploadproject-ins1$/attachments/gra2005_W1_Questionnaire_de.pdf"] diff --git a/src/test/robotframework/data_provider/surveymanagement/create_survey.robot b/src/test/robotframework/data_provider/surveymanagement/create_survey.robot index 1f75d720ad..5e91e87577 100644 --- a/src/test/robotframework/data_provider/surveymanagement/create_survey.robot +++ b/src/test/robotframework/data_provider/surveymanagement/create_survey.robot @@ -79,7 +79,7 @@ Survey Page With Empty Or Invalid Options Should Fail Go To Survey Create Page Pass Execution If '${BROWSER}' == 'ie' Survey Creation not possible in IE Select project by name robotproject - Wait Until Angular Ready 2s + Wait for Angular 2s Click on surveys tab Click Element Through Tooltips xpath=//ui-view/descendant::button[md-icon[text()='add']] Click add button diff --git a/src/test/robotframework/data_provider/surveymanagement/upload_file.robot b/src/test/robotframework/data_provider/surveymanagement/upload_file.robot index d1c76a8aa2..a90e384d89 100644 --- a/src/test/robotframework/data_provider/surveymanagement/upload_file.robot +++ b/src/test/robotframework/data_provider/surveymanagement/upload_file.robot @@ -27,7 +27,7 @@ Get back to home page and deselect project Delete Response Rate Upload Click Element Through Tooltips xpath=//md-card//button[@ng-click='ctrl.deleteResponseRateImageDe()'] - Wait Until Angular Ready 2s + Wait for Angular 2s Save Response Rate Changes Click Element Through Tooltips xpath=//md-card//button[contains(.,'save')] @@ -37,7 +37,7 @@ Get To Survey Page Upload Response Response Rate Choose File xpath=//input[@type='file'][@ngf-select='ctrl.saveResponseRateImageDe($file)'][1] ${CURDIR}/data/1_responserate_de.svg - Wait Until Angular Ready 2s + Wait for Angular 2s Click Edit Button on Survey Details Click Element Through Tooltips xpath=//ui-view//button/md-icon[text()='mode_edit'] diff --git a/src/test/robotframework/libs/SauceLabs.py b/src/test/robotframework/libs/SauceLabs.py index a66082e5bc..7700dbeafa 100644 --- a/src/test/robotframework/libs/SauceLabs.py +++ b/src/test/robotframework/libs/SauceLabs.py @@ -23,7 +23,7 @@ def report_test_status(self, name, status, tags=[], remote_url=''): """Report test status and tags to SauceLabs """ job_id = BuiltIn().get_library_instance( - 'ExtendedSelenium2Library')._current_browser().session_id + 'SeleniumLibrary').driver.session_id if USERNAME_ACCESS_KEY.match(remote_url): username, access_key =\ @@ -37,7 +37,7 @@ def report_test_status(self, name, status, tags=[], remote_url=''): elif not username or not access_key: return u"No Sauce environment variables found. Skipping..." - token = base64.encodestring('%s:%s' % (username, access_key))[:-1] + token = str(base64.b64encode(('%s:%s' % (username, access_key)).encode('utf-8')),'utf-8') body = json.dumps({'name': name, 'passed': status == 'PASS', 'tags': tags}) diff --git a/src/test/robotframework/public_user/__init__.robot b/src/test/robotframework/public_user/__init__.robot index d3e6468026..ae2c6d9f64 100644 --- a/src/test/robotframework/public_user/__init__.robot +++ b/src/test/robotframework/public_user/__init__.robot @@ -1,3 +1,4 @@ *** Setting *** Documentation Common setup and teardown for all public user tests Force Tags publicuser +Library AngularJSLibrary root_selector=[data-ng-app] diff --git a/src/test/robotframework/public_user/shoppingcartmanagement/check_shoppingcart_funtionalities.robot b/src/test/robotframework/public_user/shoppingcartmanagement/check_shoppingcart_funtionalities.robot index b30012b991..92b60ad568 100644 --- a/src/test/robotframework/public_user/shoppingcartmanagement/check_shoppingcart_funtionalities.robot +++ b/src/test/robotframework/public_user/shoppingcartmanagement/check_shoppingcart_funtionalities.robot @@ -27,7 +27,8 @@ Put all access ways in shopping cart Delete an Item Click Element Through Tooltips xpath=//button[text()=' Löschen '] - Xpath Should Match X Times //md-card[contains(@class, 'fdz-search-result')] 3 + ${count} = Get Element Count //md-card[contains(@class, 'fdz-search-result')] + Should Be True ${count} == 3 Select Access Way for the Data Package [Arguments] ${accesswayname} @@ -44,7 +45,8 @@ Put in Shopping Cart Go to Shopping Cart Click Element Through Tooltips xpath=//a//md-icon[contains(., 'shopping_cart')] - Xpath Should Match X Times //md-card[contains(@class, 'fdz-search-result')] 4 + ${count} = Get Element Count //md-card[contains(@class, 'fdz-search-result')] + Should Be True ${count} == 4 Check The Links @{MD_DATALINKS} Create List Variablen Datensätze diff --git a/src/test/robotframework/publisher/Bannerchecking/Check Banner As Publisher.robot b/src/test/robotframework/publisher/Bannerchecking/Check Banner As Publisher.robot index 209648d698..32b1a51a09 100644 --- a/src/test/robotframework/publisher/Bannerchecking/Check Banner As Publisher.robot +++ b/src/test/robotframework/publisher/Bannerchecking/Check Banner As Publisher.robot @@ -1,6 +1,6 @@ *** Settings *** Documentation Check for Publishers no welcome banner appears -Library ExtendedSelenium2Library +Library SeleniumLibrary *** Test Cases *** Check for Publisher Banner Does not Appear diff --git a/src/test/robotframework/publisher/Conceptmanagement/Check Used Concept Unable to Delete.robot b/src/test/robotframework/publisher/Conceptmanagement/Check Used Concept Unable to Delete.robot index 3283edd267..4d7486cea8 100644 --- a/src/test/robotframework/publisher/Conceptmanagement/Check Used Concept Unable to Delete.robot +++ b/src/test/robotframework/publisher/Conceptmanagement/Check Used Concept Unable to Delete.robot @@ -21,6 +21,7 @@ Click on Concept Delete Button Click Element Through Tooltips xpath=(//concept-search-result//md-card-actions//button[normalize-space()="Löschen"])[1] Assert concept can not be deleted toast message + Wait For Angular 2s Page Should Contain Das Konzept kann nicht gelöscht werden Close The Toast Message diff --git a/src/test/robotframework/publisher/Conceptmanagement/Create Concept.robot b/src/test/robotframework/publisher/Conceptmanagement/Create Concept.robot index c3098280df..66850b1f05 100644 --- a/src/test/robotframework/publisher/Conceptmanagement/Create Concept.robot +++ b/src/test/robotframework/publisher/Conceptmanagement/Create Concept.robot @@ -22,7 +22,7 @@ Create Concepts by Publisher Input Text name=authorsMiddleName_0 noMiddleName Input Text name=authorsLastName_0 Hossain Add Another Author - Focus xpath=//input[@name = 'authorsFirstName_1'] + Set Focus To Element xpath=//input[@name = 'authorsFirstName_1'] Input Text name=authorsFirstName_1 Md Rameez Input Text name=authorsMiddleName_1 noMiddleName Input Text name=authorsLastName_1 Raza @@ -63,7 +63,7 @@ Assert created concept under concept list Page Should Contain Element xpath=//concept-search-result//span[contains(., "RDC-ID-007_${BROWSER}")] Upload concept attchment file - Press Key xpath=//input[@type='file' and @ngf-select="ctrl.upload($file)"][1] ${CURDIR}/data/gra2005_MethodReport_de.pdf # data folder contains the PDF file + Choose File xpath=//input[@type='file' and @ngf-select="ctrl.upload($file)"][1] ${CURDIR}/data/gra2005_MethodReport_de.pdf # data folder contains the PDF file Select concept data type Click Element Through Tooltips xpath=//md-select[@ng-model="ctrl.attachmentMetadata.type"] diff --git a/src/test/robotframework/publisher/Datapackagemanagement/Create_Data_Package.robot b/src/test/robotframework/publisher/Datapackagemanagement/Create_Data_Package.robot index 5e8056f00b..7fdddd8a3c 100644 --- a/src/test/robotframework/publisher/Datapackagemanagement/Create_Data_Package.robot +++ b/src/test/robotframework/publisher/Datapackagemanagement/Create_Data_Package.robot @@ -23,20 +23,20 @@ Create Data Package by Publisher Input Text name=sponsorEn_0 BMBF ${BROWSER} Input Text name=annotationsDe Dieses Datenpaket wurde von Robot automatisch erstellt. Input Text name=annotationsEn This data package was created automatically by Robot.x - Focus xpath=//textarea[@name = 'descriptionDe'] + Set Focus To Element xpath=//textarea[@name = 'descriptionDe'] Input Text name=descriptionDe Dieses Datenpaket wurde automatisch erstellt und überprüft die Eingabe valider Eigenschaften. Input Text name=descriptionEn This data package was created automatically and test the input of valid attributes. - Focus xpath=//input[@name = 'projectContributorsFirstName_0'] + Set Focus To Element xpath=//input[@name = 'projectContributorsFirstName_0'] Input Text name=projectContributorsFirstName_0 Anne Input Text name=projectContributorsMiddleName_0 noMiddleName Input Text name=projectContributorsLastName_0 Droid Add Another Contributor - Focus xpath=//input[@name = 'projectContributorsFirstName_1'] + Set Focus To Element xpath=//input[@name = 'projectContributorsFirstName_1'] Input Text name=projectContributorsFirstName_1 R2 Input Text name=projectContributorsMiddleName_1 D2 Input Text name=projectContributorsLastName_1 noLastName Move Second Contributor To Place One - Focus xpath=//input[@name = 'dataCuratorsFirstName_0'] + Set Focus To Element xpath=//input[@name = 'dataCuratorsFirstName_0'] Input Text name=dataCuratorsFirstName_0 Anne Input Text name=dataCuratorsMiddleName_0 noMiddleName Input Text name=dataCuratorsLastName_0 Droid diff --git a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Metadata Deleting Access Rights.robot b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Metadata Deleting Access Rights.robot index e0fd468d7b..9a8cf49278 100644 --- a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Metadata Deleting Access Rights.robot +++ b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Metadata Deleting Access Rights.robot @@ -31,14 +31,14 @@ Publisher Create But Can Not Delete Data Package When Publisher is Ready Input Text name=sponsorEn_0 BMBF ${BROWSER} Input Text name=annotationsDe Dieses Datenpaket wurde von Robot automatisch erstellt. Input Text name=annotationsEn This data package was created automatically by Robot.x - Focus xpath=//textarea[@name = 'descriptionDe'] + Set Focus To Element xpath=//textarea[@name = 'descriptionDe'] Input Text name=descriptionDe Dieses Datenpaket wurde automatisch erstellt und überprüft die Eingabe valider Eigenschaften. Input Text name=descriptionEn This data package was created automatically and test the input of valid attributes. - Focus xpath=//input[@name = 'projectContributorsFirstName_0'] + Set Focus To Element xpath=//input[@name = 'projectContributorsFirstName_0'] Input Text name=projectContributorsFirstName_0 Anne Input Text name=projectContributorsMiddleName_0 noMiddleName Input Text name=projectContributorsLastName_0 Droid - Focus xpath=//input[@name = 'dataCuratorsFirstName_0'] + Set Focus To Element xpath=//input[@name = 'dataCuratorsFirstName_0'] Input Text name=dataCuratorsFirstName_0 Anne Input Text name=dataCuratorsMiddleName_0 noMiddleName Input Text name=dataCuratorsLastName_0 Droid diff --git a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot index e919127d64..a9637e23e4 100644 --- a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot +++ b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot @@ -76,7 +76,7 @@ Verify The Unreleased Project is Still Available under The Data Package Tab with Click on Cockpit Button Change Project Release Status Click on OK Button - Wait Until Angular Ready 2s + Wait for Angular 2s Click Publisher Ready Checkbox for Data Packages Sleep 5s #We need explicit sleep to ensure the project is not available under the data package tab Publisher Logout @@ -119,7 +119,7 @@ Restore The Previous Project Version and Publish Again Click on Cockpit Button Change Project Release Status Click on OK Button - Wait Until Angular Ready 2s + Wait for Angular 2s Click Publisher Ready Checkbox for Data Packages Get back to german home page Click Data Package Edit Button @@ -145,7 +145,7 @@ Unrelased The Project again to Sync with Intial Step Click on Cockpit Button Change Project Release Status #unrelease the project to initial state Click on OK Button - Wait Until Angular Ready 2s + Wait for Angular 2s Click Publisher Ready Checkbox for Data Packages Sleep 5s Get back to home page and deselect project diff --git a/src/test/robotframework/publisher/Publicationmanagement/Related Publications Upload.robot b/src/test/robotframework/publisher/Publicationmanagement/Related Publications Upload.robot index 22270c1957..5d2187ac87 100644 --- a/src/test/robotframework/publisher/Publicationmanagement/Related Publications Upload.robot +++ b/src/test/robotframework/publisher/Publicationmanagement/Related Publications Upload.robot @@ -14,7 +14,7 @@ Upload excel file for related publications *** Keywords *** Upload Excel file - Press Key xpath=//input[@type='file' and @ngf-select='uploadRelatedPublications($file)'][1] ${CURDIR}/publicationdata/relatedPublications.xlsx + Choose File xpath=//input[@type='file' and @ngf-select='uploadRelatedPublications($file)'][1] ${CURDIR}/publicationdata/relatedPublications.xlsx Close The Toast Message for upload Wait Until Page Contains Element xpath=//md-toast//span[contains(., "Upload von 199 Publikationen")] timeout=240s diff --git a/src/test/robotframework/publisher/__init__.robot b/src/test/robotframework/publisher/__init__.robot index 675d22f4be..13708e47ab 100644 --- a/src/test/robotframework/publisher/__init__.robot +++ b/src/test/robotframework/publisher/__init__.robot @@ -2,7 +2,8 @@ Documentation Publisher Common setup and teardown for all publisher tests Suite Setup Login as publisher Suite Teardown Publisher Logout -Library ExtendedSelenium2Library +Library SeleniumLibrary +Library AngularJSLibrary root_selector=[data-ng-app] Resource ../resources/click_element_resource.robot Resource ../resources/login_resource.robot Force Tags publisher diff --git a/src/test/robotframework/resources/check_url_resource.robot b/src/test/robotframework/resources/check_url_resource.robot index dd396b3e67..44784be464 100644 --- a/src/test/robotframework/resources/check_url_resource.robot +++ b/src/test/robotframework/resources/check_url_resource.robot @@ -1,11 +1,11 @@ *** Settings *** Documentation Resources for checking url status -Library HttpLibrary.HTTP -Library ExtendedSelenium2Library +Library RequestsLibrary +Library SeleniumLibrary *** Keywords *** Check URL Status with xpath Locator [Arguments] ${xpathlocator} - ${uri} Get Element Attribute xpath=${xpathlocator}@href + ${uri} Get Element Attribute xpath=${xpathlocator} href GET ${uri} - Response Status Code Should Equal 200 OK + Request Should Be Successful diff --git a/src/test/robotframework/resources/click_element_resource.robot b/src/test/robotframework/resources/click_element_resource.robot index 5a92aca04e..71edb33dab 100644 --- a/src/test/robotframework/resources/click_element_resource.robot +++ b/src/test/robotframework/resources/click_element_resource.robot @@ -1,7 +1,8 @@ *** Settings *** Documentation Enabling clicks which avoid overlay problems caused by tooltips -Library ExtendedSelenium2Library +Library SeleniumLibrary Library String +Library AngularJSLibrary root_selector=[data-ng-app] Variables ../common_variables.yaml *** Variables *** @@ -18,7 +19,7 @@ Click Element Through Tooltips ${var} = Replace String ${xpath_string} xpath= ${EMPTY} ${element_xpath} = Replace String ${var} \" \\\" Run Keyword If '${BROWSER}' != 'ie' Wait Until Keyword Succeeds 10s 0.5s Execute JavaScript window.document.evaluate("${element_xpath}", document, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null).snapshotItem(0).click(); - Run Keyword If '${BROWSER}' == 'ie' Wait Until Keyword Succeeds 10s 0.5s Focus ${xpath_string} + Run Keyword If '${BROWSER}' == 'ie' Wait Until Keyword Succeeds 10s 0.5s Set Focus To Element ${xpath_string} Run Keyword If '${BROWSER}' == 'ie' Wait Until Keyword Succeeds 10s 0.5s Mouse Over ${xpath_string} Run Keyword If '${BROWSER}' == 'ie' Wait Until Keyword Succeeds 10s 0.5s Click Element ${xpath_string} - Wait Until Angular Ready 2s + Wait for Angular 2s diff --git a/src/test/robotframework/resources/home_page_resource.robot b/src/test/robotframework/resources/home_page_resource.robot index 6167c4e9f4..be5a44196c 100644 --- a/src/test/robotframework/resources/home_page_resource.robot +++ b/src/test/robotframework/resources/home_page_resource.robot @@ -1,6 +1,6 @@ *** Settings *** Documentation Resource used by all search and view test cases -Library ExtendedSelenium2Library +Library SeleniumLibrary Resource click_element_resource.robot Variables ../common_variables.yaml diff --git a/src/test/robotframework/resources/login_resource.robot b/src/test/robotframework/resources/login_resource.robot index 5f9d26be38..992fde1832 100644 --- a/src/test/robotframework/resources/login_resource.robot +++ b/src/test/robotframework/resources/login_resource.robot @@ -1,6 +1,7 @@ *** Settings *** Documentation Resource used by all search and view test cases -Library ExtendedSelenium2Library +Library SeleniumLibrary +Library AngularJSLibrary root_selector=[data-ng-app] Resource click_element_resource.robot Resource home_page_resource.robot Variables ../common_variables.yaml @@ -23,17 +24,20 @@ Create Project Click Element Through Tooltips xpath=//md-sidenav//button[md-icon[text()='add']] Input Text name=id ${projectname} Run Keyword If '${BROWSER}' == 'safari' Sleep 10s - Wait Until Angular Ready 2s + Wait for Angular 2s Wait Until Keyword Succeeds 5s 0.5s Page Should Contain Element xpath=//button[@type='submit' and not(contains(@disabled, 'disabled'))] Click Element Through Tooltips xpath=//button[@type='submit'][contains(.,'OK')] - Wait Until Angular Ready 2s + Wait for Angular 2s Delete Robotsproject Pass Execution If '${BROWSER}' == 'ie' Data Package Creation not possible in IE Get back to german home page Input Text xpath=//input[@placeholder = 'Projekt auswählen'] robotsproject${BROWSER} - Click Element Through Tooltips xpath=//md-sidenav/descendant::button[md-icon[text()='']] + Wait For Angular 2s + Click Element Through Tooltips xpath=//md-sidenav/descendant::button[@ng-click='ctrl.deleteProject()'] Click Element Through Tooltips xpath=//button[text()='OK'] + Run Keyword If '${BROWSER}' == 'safari' Sleep 10s + Wait for Angular 2s Save Changes Click Element Through Tooltips xpath=//ui-view/descendant::button[md-icon[text()='save']] diff --git a/src/test/robotframework/resources/project_management_resource.robot b/src/test/robotframework/resources/project_management_resource.robot index d8839b42dc..b902326a7a 100644 --- a/src/test/robotframework/resources/project_management_resource.robot +++ b/src/test/robotframework/resources/project_management_resource.robot @@ -1,6 +1,6 @@ *** Settings *** Documentation Resources for Project Cockpit Management -Library ExtendedSelenium2Library +Library SeleniumLibrary Resource click_element_resource.robot Variables ../common_variables.yaml diff --git a/src/test/robotframework/resources/search_resource.robot b/src/test/robotframework/resources/search_resource.robot index f521e24d48..56a807d6da 100644 --- a/src/test/robotframework/resources/search_resource.robot +++ b/src/test/robotframework/resources/search_resource.robot @@ -1,6 +1,7 @@ *** Settings *** Documentation Resource used by all search and view test cases -Library ExtendedSelenium2Library +Library SeleniumLibrary +Library AngularJSLibrary root_selector=[data-ng-app] Resource click_element_resource.robot Variables ../common_variables.yaml @@ -9,20 +10,20 @@ Search for [Arguments] ${query} Click Element Through Tooltips xpath=//input[@id='query'] Input Text id=query ${query} - Wait Until Angular Ready 2s + Wait for Angular 2s Search for on startpage [Arguments] ${query} Click Element Through Tooltips xpath=//input[@id='query'] Input Text id=query ${query} Press Key id=query \\13 - Wait Until Angular Ready 2s + Wait for Angular 2s Search for in details [Arguments] ${query} Click Element Through Tooltips xpath=//input[@id='detailSearchQuery'] Input Text id=detailSearchQuery ${query} - Wait Until Angular Ready 2s + Wait for Angular 2s Select project by name [Arguments] ${projectname} @@ -32,10 +33,11 @@ Select project by name Delete project by name [Arguments] ${projectname} Input Text xpath=//input[@placeholder = 'Projekt auswählen'] ${projectname} - Click Element Through Tooltips xpath=//md-sidenav/descendant::button[md-icon[text()='']] + Wait For Angular 2s + Click Element Through Tooltips xpath=//md-sidenav/descendant::button[@ng-click='ctrl.deleteProject()'] Click Element Through Tooltips xpath=//button[text()='OK'] Run Keyword If '${BROWSER}' == 'safari' Sleep 10s - Wait Until Angular Ready 2s + Wait for Angular 2s Click on search result by id [Arguments] ${id} diff --git a/src/test/robotframework/setup.sh b/src/test/robotframework/setup.sh index ffa3d14d58..53da0bdfb1 100755 --- a/src/test/robotframework/setup.sh +++ b/src/test/robotframework/setup.sh @@ -2,9 +2,9 @@ # this script installs all dependencies for executing robotframework tests sudo apt-get update -qq sudo apt-get -y install python-pip python-dev --allow-unauthenticated -pip install urllib3[secure]==1.24.1 -Iv pip install robotframework -pip install robotframework-extendedselenium2library -pip install robotframework-httplibrary +pip install robotframework-seleniumlibrary==3.2.0 +pip install robotframework-angularjs +pip install robotframework-requests pip install pyyaml pip install six From 654b77aa542e866f567476bcdd390aeadee8861c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Wed, 16 Jun 2021 10:59:56 +0200 Subject: [PATCH 16/23] add python 3. setup (#2829) --- .github/workflows/nightly-e2e-tests.yml | 60 +++++++++++++++++++++++++ src/test/robotframework/setup.sh | 4 +- 2 files changed, 61 insertions(+), 3 deletions(-) diff --git a/.github/workflows/nightly-e2e-tests.yml b/.github/workflows/nightly-e2e-tests.yml index 69a051016b..c87764deb9 100644 --- a/.github/workflows/nightly-e2e-tests.yml +++ b/.github/workflows/nightly-e2e-tests.yml @@ -10,6 +10,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Chrome Tests (Public User) @@ -23,6 +27,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Firefox Tests (Public User) @@ -36,6 +44,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Internet Explorer Tests (Public User) @@ -49,6 +61,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Edge Tests (Public User) @@ -62,6 +78,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Safari Tests (Public User) @@ -81,6 +101,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Chrome Tests (Dataprovider) @@ -100,6 +124,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Firefox Tests (Dataprovider) @@ -119,6 +147,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Internet Explorer Tests (Dataprovider) @@ -138,6 +170,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Edge Tests (Dataprovider) @@ -157,6 +193,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Safari Tests (Dataprovider) @@ -176,6 +216,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Chrome Tests (Publisher) @@ -195,6 +239,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Firefox Tests (Publisher) @@ -214,6 +262,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Internet Explorer Tests (Publisher) @@ -233,6 +285,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Edge Tests (Publisher) @@ -251,6 +307,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development + - name: Setup Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Safari Tests (Publisher) diff --git a/src/test/robotframework/setup.sh b/src/test/robotframework/setup.sh index 53da0bdfb1..3c1dc1c761 100755 --- a/src/test/robotframework/setup.sh +++ b/src/test/robotframework/setup.sh @@ -1,10 +1,8 @@ #!/bin/bash # this script installs all dependencies for executing robotframework tests -sudo apt-get update -qq -sudo apt-get -y install python-pip python-dev --allow-unauthenticated pip install robotframework -pip install robotframework-seleniumlibrary==3.2.0 pip install robotframework-angularjs +pip install robotframework-seleniumlibrary==3.2.0 pip install robotframework-requests pip install pyyaml pip install six From e9975160bf918787830d3f5dc36645718fdc0e63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Wed, 16 Jun 2021 12:04:04 +0200 Subject: [PATCH 17/23] use python 3.8 cause we depend on base64.encodestring (#2829) --- .github/workflows/nightly-e2e-tests.yml | 60 ++++++++++++------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/.github/workflows/nightly-e2e-tests.yml b/.github/workflows/nightly-e2e-tests.yml index c87764deb9..db7f0ccc39 100644 --- a/.github/workflows/nightly-e2e-tests.yml +++ b/.github/workflows/nightly-e2e-tests.yml @@ -10,10 +10,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Chrome Tests (Public User) @@ -27,10 +27,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Firefox Tests (Public User) @@ -44,10 +44,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Internet Explorer Tests (Public User) @@ -61,10 +61,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Edge Tests (Public User) @@ -78,10 +78,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Safari Tests (Public User) @@ -101,10 +101,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Chrome Tests (Dataprovider) @@ -124,10 +124,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Firefox Tests (Dataprovider) @@ -147,10 +147,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Internet Explorer Tests (Dataprovider) @@ -170,10 +170,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Edge Tests (Dataprovider) @@ -193,10 +193,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Safari Tests (Dataprovider) @@ -216,10 +216,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Chrome Tests (Publisher) @@ -239,10 +239,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Firefox Tests (Publisher) @@ -262,10 +262,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Internet Explorer Tests (Publisher) @@ -285,10 +285,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Edge Tests (Publisher) @@ -307,10 +307,10 @@ jobs: - uses: actions/checkout@v1 with: ref: development - - name: Setup Python 3.x + - name: Setup Python 3.8.x uses: actions/setup-python@v2 with: - python-version: '3.x' + python-version: '3.8.x' - name: Install robotframework dependencies run: ./src/test/robotframework/setup.sh - name: Nightly Safari Tests (Publisher) From 20b5bf1441f61d542a3fa9a03f6956994d1c98f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Wed, 16 Jun 2021 13:38:27 +0200 Subject: [PATCH 18/23] change wave to serialNumber (#2779) --- .../documents/DataPackageSearchDocument.java | 18 +++++++------- .../documents/SurveySubDocument.java | 8 +++---- .../surveymanagement/domain/Survey.java | 10 ++++---- .../SurveySubDocumentProjection.java | 10 ++++---- .../elasticsearch/indices_version.json | 2 +- .../configuration/translations-de.js | 11 +++++---- .../configuration/translations-en.js | 13 +++++----- .../views/survey-edit-or-create.controller.js | 7 ++++-- .../views/survey-edit-or-create.html.tmpl | 20 ++++++++-------- .../util/UnitTestCreateDomainObjectUtils.java | 4 ++-- .../surveymanagement/create_survey.robot | 24 +++++++++---------- 11 files changed, 66 insertions(+), 61 deletions(-) diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSearchDocument.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSearchDocument.java index 814faaf55d..4e17b4a632 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSearchDocument.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/DataPackageSearchDocument.java @@ -89,7 +89,7 @@ public class DataPackageSearchDocument extends DataPackage implements SearchDocu /** * Construct the search document with all related subdocuments. - * + * * @param dataPackage The dataPackage to be searched for * @param dataSets all data sets available in this dataPackage * @param variables all variables available in this dataPackage @@ -176,17 +176,17 @@ private Period generateSurveyPeriod(List surveys) { } /** - * Check the wave number of every survey. - * + * Check the serial number of every survey. + * * @param surveys All Survey Sub Document Projections. - * @return The highest (max) wave number. + * @return The highest (max) serial number. */ private Integer generateNumberOfWaves(List surveys) { Integer numberOfWaves = 0; for (SurveySubDocumentProjection survey : surveys) { - if (survey.getWave() > numberOfWaves) { - numberOfWaves = survey.getWave(); + if (survey.getSerialNumber() > numberOfWaves) { + numberOfWaves = survey.getSerialNumber(); } } @@ -195,7 +195,7 @@ private Integer generateNumberOfWaves(List surveys) /** * Create an aggregated list of the data types of all {@link Survey}s. - * + * * @param surveys All Survey Sub Document Projections. * @return aggregated List of survey data types */ @@ -206,7 +206,7 @@ private List generateSurveyDataTypes(List generateAccessWays(List dataS /** * Create an aggregated list of the languages of all {@link DataSet}s. - * + * * @param dataSets All DataSet Sub Document Projections. * @return aggregated List of languages */ diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/SurveySubDocument.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/SurveySubDocument.java index 79d38136e0..6893a23cf4 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/SurveySubDocument.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/searchmanagement/documents/SurveySubDocument.java @@ -43,16 +43,16 @@ public class SurveySubDocument extends AbstractRdcDomainObject private I18nString sample; - private Integer wave; + private Integer serialNumber; private I18nString dataType; private String dataPackageId; private String masterId; - + private String successorId; - + private boolean shadow; public SurveySubDocument() { @@ -61,7 +61,7 @@ public SurveySubDocument() { /** * Create the subdocument. - * + * * @param projection The projection coming from mongo. */ public SurveySubDocument(SurveySubDocumentProjection projection) { diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.java index 6138a39477..5500b09ef9 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/Survey.java @@ -146,14 +146,14 @@ public class Survey extends AbstractShadowableRdcDomainObject { private I18nString sample; /** - * Number of the wave which this {@link Survey} represents. Will be ignored if the - * {@link DataPackage} is not organized in waves. + * Serial number of this {@link Survey} as it is implemented in the survey design + * (e.g. number of the panel wave). * * Must not be empty and must be greater than or equal to 1. */ - @NotNull(message = "survey-management.error.survey.wave.not-null") - @Min(value = 1, message = "survey-management.error.survey.wave.min") - private Integer wave; + @NotNull(message = "survey-management.error.survey.serial-number.not-null") + @Min(value = 1, message = "survey-management.error.survey.serial-number.min") + private Integer serialNumber; /** * The gross sample size represents the number of participants which have been invited to take diff --git a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/projections/SurveySubDocumentProjection.java b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/projections/SurveySubDocumentProjection.java index a46ffe85b4..3b5287faef 100644 --- a/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/projections/SurveySubDocumentProjection.java +++ b/src/main/java/eu/dzhw/fdz/metadatamanagement/surveymanagement/domain/projections/SurveySubDocumentProjection.java @@ -11,7 +11,7 @@ * * @author René Reitmann */ -public interface SurveySubDocumentProjection +public interface SurveySubDocumentProjection extends AbstractRdcDomainObjectProjection { String getDataAcquisitionProjectId(); @@ -28,14 +28,14 @@ public interface SurveySubDocumentProjection Period getFieldPeriod(); I18nString getSample(); - - Integer getWave(); + + Integer getSerialNumber(); I18nString getDataType(); String getMasterId(); - + String getSuccessorId(); - + boolean isShadow(); } diff --git a/src/main/resources/elasticsearch/indices_version.json b/src/main/resources/elasticsearch/indices_version.json index 94f1d8b52a..e95c7c5d71 100644 --- a/src/main/resources/elasticsearch/indices_version.json +++ b/src/main/resources/elasticsearch/indices_version.json @@ -1,3 +1,3 @@ { - "indicesVersion": "202106091000" + "indicesVersion": "202106161300" } diff --git a/src/main/webapp/scripts/surveymanagement/configuration/translations-de.js b/src/main/webapp/scripts/surveymanagement/configuration/translations-de.js index 54a807d8de..33882c262a 100644 --- a/src/main/webapp/scripts/surveymanagement/configuration/translations-de.js +++ b/src/main/webapp/scripts/surveymanagement/configuration/translations-de.js @@ -132,9 +132,10 @@ angular.module('metadatamanagementApp').config( 'sample': { 'not-null': 'Das Stichprobenverfahren der Erhebung darf nicht leer sein!' }, - 'wave': { - 'not-null': 'Die Welle der Erhebung darf nicht leer sein!', - 'min': 'Die Anzahl der Wellen muss mindestens 1 sein!' + 'serial-number': { + 'not-null': 'Die Ordnungsnummer der Erhebung darf nicht leer sein!', + 'min': 'Die Ordnungsnummer muss mindestens 1 sein!', + 'invalid-number': 'Geben Sie eine gültige Zahl ein.' }, 'response-rate': { 'min': 'Die Rücklaufquote darf nicht kleiner als 0% sein.', @@ -192,7 +193,7 @@ angular.module('metadatamanagementApp').config( 'edit-survey': 'Erhebung bearbeiten:', 'create-survey': 'Erhebung anlegen:', 'title': 'Titel', - 'wave': 'Welle', + 'serial-number': 'Ordnungsnummer', 'field-period-start': 'Beginn Feldzeit', 'field-period-end': 'Ende Feldzeit', 'population': { @@ -227,7 +228,7 @@ angular.module('metadatamanagementApp').config( 'de': 'Geben Sie den Titel der Erhebung auf Deutsch ein.', 'en': 'Geben Sie den Titel der Erhebung auf Englisch ein.' }, - 'wave': 'Geben Sie die Nummer der Welle an bzw. lassen Sie die Nummer auf 1 falls nicht zutreffend.', + 'serial-number': 'Bitte tragen Sie hier die Ordnungsnummer der Erhebung ein, wie sie im Erhebungsdesign angelegt ist (z.B. Nummer der Panelwelle).', 'field-period-start': 'Geben Sie den Beginn der Feldzeit ein.', 'field-period-end': 'Geben Sie das Ende der Feldzeit ein.', 'survey-method': { diff --git a/src/main/webapp/scripts/surveymanagement/configuration/translations-en.js b/src/main/webapp/scripts/surveymanagement/configuration/translations-en.js index 31033496f2..945ce06d03 100644 --- a/src/main/webapp/scripts/surveymanagement/configuration/translations-en.js +++ b/src/main/webapp/scripts/surveymanagement/configuration/translations-en.js @@ -127,14 +127,15 @@ angular.module('metadatamanagementApp').config( } }, 'population': { - 'not-null': 'The Population of a Survey must not be empty!' + 'not-null': 'The population of a survey must not be empty!' }, 'sample': { 'not-null': 'The sampling procedure of a survey must not be empty!' }, - 'wave': { - 'not-null': 'The Wave of a Survey must not be empty!', - 'min': 'The number of waves has to be 1 or higher.' + 'serial-number': { + 'not-null': 'The serial number of a survey must not be empty!', + 'min': 'The serial number has to be 1 or higher.', + 'invalid-number': 'Please enter a valid number.' }, 'response-rate': { 'min': 'The response rate must not be less than 0%.', @@ -192,7 +193,7 @@ angular.module('metadatamanagementApp').config( 'edit-survey': 'Edit Survey:', 'create-survey': 'Create Survey:', 'title': 'Title', - 'wave': 'Wave', + 'serial-number': 'Serial Number', 'field-period-start': 'Field Period Start', 'field-period-end': 'Field Period End', 'population': { @@ -233,7 +234,7 @@ angular.module('metadatamanagementApp').config( 'de': 'Please enter the title of this survey in German.', 'en': 'Please enter the title of this survey in English.' }, - 'wave': 'Please enter the number of the wave for this survey or keep 1 if not relevant.', + 'serial-number': 'Please enter the serial number of the survey as it is implemented in the survey design (e.g. number of the panel wave).', 'field-period-start': 'Please enter the beginning of the field period.', 'field-period-end': 'Please enter the end of the field period.', 'survey-method': { diff --git a/src/main/webapp/scripts/surveymanagement/views/survey-edit-or-create.controller.js b/src/main/webapp/scripts/surveymanagement/views/survey-edit-or-create.controller.js index 7780438c2b..631e8820ed 100644 --- a/src/main/webapp/scripts/surveymanagement/views/survey-edit-or-create.controller.js +++ b/src/main/webapp/scripts/surveymanagement/views/survey-edit-or-create.controller.js @@ -138,7 +138,7 @@ angular.module('metadatamanagementApp') .buildDataPackageId(CurrentProjectService .getCurrentProject().id ), - wave: 1 + serialNumber: 1 }); $scope.responseRateInitializing = true; updateToolbarHeaderAndPageTitle(); @@ -167,7 +167,7 @@ angular.module('metadatamanagementApp') .buildDataPackageId(CurrentProjectService .getCurrentProject().id ), - wave: 1 + serialNumber: 1 }); $scope.responseRateInitializing = true; updateToolbarHeaderAndPageTitle(); @@ -302,6 +302,9 @@ angular.module('metadatamanagementApp') ChoosePreviousVersionService.showDialog(dialogConfig, event) .then(function(wrapper) { ctrl.survey = new SurveyResource(wrapper.selection); + if (!ctrl.survey.serialNumber) { + ctrl.survey.serialNumber = 1; + } $scope.responseRateInitializing = true; if (wrapper.isCurrentVersion) { $scope.surveyForm.$setPristine(); diff --git a/src/main/webapp/scripts/surveymanagement/views/survey-edit-or-create.html.tmpl b/src/main/webapp/scripts/surveymanagement/views/survey-edit-or-create.html.tmpl index 8fe9c28235..2aa6925723 100644 --- a/src/main/webapp/scripts/surveymanagement/views/survey-edit-or-create.html.tmpl +++ b/src/main/webapp/scripts/surveymanagement/views/survey-edit-or-create.html.tmpl @@ -50,17 +50,17 @@
- - - -
- {{'survey-management.edit.hints.wave' | translate}} + + + +
+ {{'survey-management.edit.hints.serial-number' | translate}}
-
-
{{'survey-management.error.survey.wave.not-null' | translate}}
-
{{'survey-management.error.survey.wave.invalid-number' | translate}}
-
{{'survey-management.error.survey.wave.invalid-number' | translate}}
-
{{'survey-management.error.survey.wave.min' | translate}}
+
+
{{'survey-management.error.survey.serial-number.not-null' | translate}}
+
{{'survey-management.error.survey.serial-number.invalid-number' | translate}}
+
{{'survey-management.error.survey.serial-number.invalid-number' | translate}}
+
{{'survey-management.error.survey.serial-number.min' | translate}}
diff --git a/src/test/java/eu/dzhw/fdz/metadatamanagement/common/unittesthelper/util/UnitTestCreateDomainObjectUtils.java b/src/test/java/eu/dzhw/fdz/metadatamanagement/common/unittesthelper/util/UnitTestCreateDomainObjectUtils.java index 1ae169f381..de5f54ea23 100644 --- a/src/test/java/eu/dzhw/fdz/metadatamanagement/common/unittesthelper/util/UnitTestCreateDomainObjectUtils.java +++ b/src/test/java/eu/dzhw/fdz/metadatamanagement/common/unittesthelper/util/UnitTestCreateDomainObjectUtils.java @@ -104,7 +104,7 @@ public static DataPackage buildDataPackage(String projectId) { projectContributors.add(buildPerson("Test", null, "ProjectContributors")); List institutions = Arrays.asList(I18nString.builder().de("Institution De").en("Institution En").build()); - List sponsors = + List sponsors = Arrays.asList(I18nString.builder().de("Sponsor De").en("Sponsor En").build()); List dataCurators = new ArrayList<>(); dataCurators.add(buildPerson("Test", null, "ProjectContributors")); @@ -143,7 +143,7 @@ public static Survey buildSurvey(String projectId, Integer surveyNumber) { .surveyMethod(I18nString.builder().de("Survey Method DE").en("Survey Method EN").build()) .annotations(I18nString.builder().de("De Anmerkungen").en("En Annotations").build()) .dataType(eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.DataTypes.QUALITATIVE_DATA) - .grossSampleSize(100).sampleSize(100).responseRate(100.0).number(surveyNumber).wave(1) + .grossSampleSize(100).sampleSize(100).responseRate(100.0).number(surveyNumber).serialNumber(1) .build(); survey.setMasterId(surveyId); diff --git a/src/test/robotframework/data_provider/surveymanagement/create_survey.robot b/src/test/robotframework/data_provider/surveymanagement/create_survey.robot index 5e91e87577..7dec6f96e7 100644 --- a/src/test/robotframework/data_provider/surveymanagement/create_survey.robot +++ b/src/test/robotframework/data_provider/surveymanagement/create_survey.robot @@ -11,28 +11,28 @@ Resource ../../resources/login_resource.robot *** Variables *** ${TOAST_MSSG} Die Erhebung wurde nicht gespeichert -*** Test Cases *** GerTitle EngTitle Wave FielPeriodStart FieldPeriodEnd GerSurvMeth GerSurvMeth GerPopDesc EngPopDesc NetSampleSize +*** Test Cases *** GerTitle EngTitle SerialNumber FielPeriodStart FieldPeriodEnd GerSurvMeth GerSurvMeth GerPopDesc EngPopDesc NetSampleSize -Empty German Title ${Empty} Something 1 01.05.2018 31.05.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle Of course everyone 1 +Empty German Title ${Empty} Something 1 01.05.2018 31.05.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle Of course everyone 1 Empty English Title - Irgendetwas ${Empty} 1 01.05.2018 31.05.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle Of course everyone 1 + Irgendetwas ${Empty} 1 01.05.2018 31.05.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle Of course everyone 1 -Empty Wave Irgendetwas Something ${Empty} 01.05.2018 31.05.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle Of course everyone 1 +Empty Serial Number Irgendetwas Something ${Empty} 01.05.2018 31.05.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle Of course everyone 1 Empty German SurveyMethod - Irgendetwas Something 1 01.05.2018 01.06.2018 ${Empty} Standardised self-administered survey Na eben alle Of course everyone 1 + Irgendetwas Something 1 01.05.2018 01.06.2018 ${Empty} Standardised self-administered survey Na eben alle Of course everyone 1 Empty English SurveyMethod - Irgendetwas Something 1 01.05.2018 01.06.2018 Standardisierte postalische Befragung ${Empty} Na eben alle Of course everyone 1 + Irgendetwas Something 1 01.05.2018 01.06.2018 Standardisierte postalische Befragung ${Empty} Na eben alle Of course everyone 1 Empty German PopDescription - Irgendetwas Something 1 01.05.2018 01.06.2018 Standardisierte postalische Befragung Standardised self-administered survey ${Empty} Of course everyone 1 + Irgendetwas Something 1 01.05.2018 01.06.2018 Standardisierte postalische Befragung Standardised self-administered survey ${Empty} Of course everyone 1 Empty English PopDescription - Irgendetwas Something 1 01.05.2018 01.06.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle ${Empty} 1 + Irgendetwas Something 1 01.05.2018 01.06.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle ${Empty} 1 -Empty NetSampleSize Irgendetwas Something 1 01.05.2018 01.06.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle Of course everyone ${Empty} +Empty NetSampleSize Irgendetwas Something 1 01.05.2018 01.06.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle Of course everyone ${Empty} Invalid NetSampleSize First Irgendetwas Something 1 01.05.2018 01.06.2018 Standardisierte postalische Befragung Standardised self-administered survey Na eben alle Of course everyone -5 @@ -44,15 +44,15 @@ Invalid NetSampleSize Second *** Keywords *** Survey Page With Empty Or Invalid Options Should Fail - [Arguments] ${GTitle} ${ETitle} ${Wave} ${FieldPeriodStart} ${FieldPeriodEnd} ${GSurveyMethod} ${ESurveyMethod} + [Arguments] ${GTitle} ${ETitle} ${SerialNumber} ${FieldPeriodStart} ${FieldPeriodEnd} ${GSurveyMethod} ${ESurveyMethod} ... ${GPopDesc} ${EPopDesc} ${NetSampleSize} Pass Execution If '${BROWSER}' == 'ie' Survey Creation not possible in IE Clear Element Text name=titleDe Input Text name=titleDe ${GTitle} Clear Element Text name=titleEn Input Text name=titleEn ${ETitle} - Clear Element Text name=wave - Input Text name=wave ${Wave} + Clear Element Text name=serialNumber + Input Text name=serialNumber ${SerialNumber} Clear Element Text xpath=//md-datepicker[@name='fieldPeriodStart']//input Input Text xpath=//md-datepicker[@name='fieldPeriodStart']//input ${FieldPeriodStart} Clear Element Text xpath=//md-datepicker[@name='fieldPeriodEnd']//input From a11b2a872800db3d1e08480d2418ccf79f8dc3be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Thu, 17 Jun 2021 10:52:29 +0200 Subject: [PATCH 19/23] add wait for angular for safari (#2829) --- ...ishers Project Releasing and Unreleasing Access Rights.robot | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot index a9637e23e4..88f656a5be 100644 --- a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot +++ b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot @@ -96,6 +96,7 @@ Edit Project Title and Check it does not appear under data package when unreleas Publisher Logout Navigate to search Search for Test Project Release Study ${BROWSER} DE + Wait For Angular 30s Wait Until Page Contains Element xpath=//md-card-header-text//span[contains(. ,"Test Project Release Study ${BROWSER} DE")] 10s Check Edited Project appears under data package when released @@ -111,6 +112,7 @@ Check Edited Project appears under data package when released Publisher Logout #explicit logout Navigate to search Search for Test Project Release Study ${BROWSER} DE Edit_786 + Wait For Angular 30s Wait Until Page Contains Element xpath=//md-card-header-text//span[contains(. ,"Test Project Release Study ${BROWSER} DE Edit_786")] 10s Restore The Previous Project Version and Publish Again From 7e125560a4170cc823e24d1f421bc03aac1328c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Thu, 17 Jun 2021 16:23:18 +0200 Subject: [PATCH 20/23] disable publisher tests on safari (#2829) --- .github/workflows/nightly-e2e-tests.yml | 46 +++++++++---------- ...easing and Unreleasing Access Rights.robot | 10 ++-- 2 files changed, 29 insertions(+), 27 deletions(-) diff --git a/.github/workflows/nightly-e2e-tests.yml b/.github/workflows/nightly-e2e-tests.yml index db7f0ccc39..6f8410ae36 100644 --- a/.github/workflows/nightly-e2e-tests.yml +++ b/.github/workflows/nightly-e2e-tests.yml @@ -296,28 +296,28 @@ jobs: env: SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} - safari-publisher: - runs-on: ubuntu-18.04 - needs: - - chrome-publisher - - firefox-publisher - - ie11-publisher - - edge-publisher - steps: - - uses: actions/checkout@v1 - with: - ref: development - - name: Setup Python 3.8.x - uses: actions/setup-python@v2 - with: - python-version: '3.8.x' - - name: Install robotframework dependencies - run: ./src/test/robotframework/setup.sh - - name: Nightly Safari Tests (Publisher) - run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/safari -v USE_SAUCELABS:TRUE -v BROWSER:safari --include publisherNOTfirefoxonlyNOTchromeonlyNOTlocalonly ./src/test/robotframework - env: - SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} - SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} + #safari-publisher: + # runs-on: ubuntu-18.04 + # needs: + # - chrome-publisher + # - firefox-publisher + # - ie11-publisher + # - edge-publisher + # steps: + # - uses: actions/checkout@v1 + # with: + # ref: development + # - name: Setup Python 3.8.x + # uses: actions/setup-python@v2 + # with: + # python-version: '3.8.x' + # - name: Install robotframework dependencies + # run: ./src/test/robotframework/setup.sh + # - name: Nightly Safari Tests (Publisher) + # run: robot -P ./src/test/robotframework/libs -d target/test/robotframework/logs/safari -v USE_SAUCELABS:TRUE -v BROWSER:safari --include publisherNOTfirefoxonlyNOTchromeonlyNOTlocalonly ./src/test/robotframework + # env: + # SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} + # SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} report-via-slack: runs-on: ubuntu-18.04 needs: @@ -335,7 +335,7 @@ jobs: - firefox-publisher - ie11-publisher - edge-publisher - - safari-publisher + # - safari-publisher if: always() steps: - name: Report build status via Slack diff --git a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot index 88f656a5be..88a57f53e6 100644 --- a/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot +++ b/src/test/robotframework/publisher/Projectmanagement/Check Publishers Project Releasing and Unreleasing Access Rights.robot @@ -76,7 +76,7 @@ Verify The Unreleased Project is Still Available under The Data Package Tab with Click on Cockpit Button Change Project Release Status Click on OK Button - Wait for Angular 2s + Wait for Angular 10s Click Publisher Ready Checkbox for Data Packages Sleep 5s #We need explicit sleep to ensure the project is not available under the data package tab Publisher Logout @@ -92,7 +92,7 @@ Edit Project Title and Check it does not appear under data package when unreleas Input Text name=titleEn Test Project Release Study ${BROWSER} EN Edit_786 Click Data Package Save Button Get back to german home page - Sleep 10s + Sleep 30s Publisher Logout Navigate to search Search for Test Project Release Study ${BROWSER} DE @@ -121,7 +121,7 @@ Restore The Previous Project Version and Publish Again Click on Cockpit Button Change Project Release Status Click on OK Button - Wait for Angular 2s + Wait for Angular 10s Click Publisher Ready Checkbox for Data Packages Get back to german home page Click Data Package Edit Button @@ -136,9 +136,11 @@ Restore The Previous Project Version and Publish Again Sleep 90s Verify The Re-Released Previous Project is Available under The Data Package Tab + Wait For Angular 10s Publisher Logout Navigate to search Search for Test Project Release Study ${BROWSER} DE + Wait For Angular 30s Wait Until Page Contains Element xpath=//md-card-header-text//span[contains(. ,"Test Project Release Study ${BROWSER} DE")] 10s Unrelased The Project again to Sync with Intial Step @@ -147,7 +149,7 @@ Unrelased The Project again to Sync with Intial Step Click on Cockpit Button Change Project Release Status #unrelease the project to initial state Click on OK Button - Wait for Angular 2s + Wait for Angular 10s Click Publisher Ready Checkbox for Data Packages Sleep 5s Get back to home page and deselect project From 736fd5cb0638778f191353cc9a851e19dd98071d Mon Sep 17 00:00:00 2001 From: snyk-bot Date: Sat, 19 Jun 2021 04:16:46 +0000 Subject: [PATCH 21/23] fix: pom.xml to reduce vulnerabilities The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-JAVA-NETMINIDEV-1078499 - https://snyk.io/vuln/SNYK-JAVA-NETMINIDEV-1298655 --- pom.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pom.xml b/pom.xml index 459e60b302..46bcbcd90e 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ org.springframework.boot spring-boot-starter-parent 2.4.7 - + eu.dzhw.fdz @@ -308,7 +308,7 @@ org.zalando logbook-spring-boot-starter - 2.9.0 + 2.10.0 @@ -416,7 +416,7 @@ - + @@ -429,7 +429,7 @@ - + @@ -442,7 +442,7 @@ - + @@ -455,7 +455,7 @@ - + From 9aca2e936477f648186ad9d413048bac772559ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Mon, 28 Jun 2021 09:53:58 +0200 Subject: [PATCH 22/23] upgrade spring boot (#2902) --- pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index 459e60b302..8ef2fb6503 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.springframework.boot spring-boot-starter-parent - 2.4.7 + 2.4.8 @@ -303,7 +303,7 @@ org.springframework.security.oauth.boot spring-security-oauth2-autoconfigure - 2.4.6 + 2.4.7 org.zalando From b52127c7496c569325c13dbdc37056efa73b8be7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Reitmann?= Date: Tue, 29 Jun 2021 09:39:33 +0200 Subject: [PATCH 23/23] Prepare release sprint 111 (#2904) --- package-lock.json | 2 +- package.json | 2 +- pom.xml | 2 +- src/main/webapp/scripts/app.constants.js | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 30bc39204b..5d58386c38 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "Metadatamanagement", - "version": "1.0.111-SNAPSHOT", + "version": "1.0.111", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 4ca7119e77..05482e195c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "Metadatamanagement", - "version": "1.0.111-SNAPSHOT", + "version": "1.0.111", "description": "Data Search for Higher Education Research and Science Studies", "private": true, "dependencies": { diff --git a/pom.xml b/pom.xml index 3c9b8cc141..343615d49c 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ eu.dzhw.fdz metadatamanagement - 1.0.111-SNAPSHOT + 1.0.111 war metadatamanagement diff --git a/src/main/webapp/scripts/app.constants.js b/src/main/webapp/scripts/app.constants.js index 0212f44f5e..dcc936e3da 100644 --- a/src/main/webapp/scripts/app.constants.js +++ b/src/main/webapp/scripts/app.constants.js @@ -6,7 +6,7 @@ angular.module('metadatamanagementApp') .constant('ENV', 'local') -.constant('VERSION', '1.0.111-SNAPSHOT') +.constant('VERSION', '1.0.111') .constant('ElasticSearchProperties', {apiVersion:'7.x',logLevel:'error',pageSize:10})