Skip to content

Commit

Permalink
Merge pull request #2655 from dzhw/release
Browse files Browse the repository at this point in the history 
Release v1.0.104
  • Loading branch information
René Reitmann authored Oct 5, 2020
2 parents eca8ea5 + 5fa67d2 commit 1ec1703
Show file tree
Hide file tree
Showing 467 changed files with 9,754 additions and 7,154 deletions.
6 changes: 3 additions & 3 deletions Gruntfile.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ module.exports = function(grunt) {
},
sources: {
src: [
'src/main/webapp/scripts/studymanagement/**/translations*.js',
'src/main/webapp/scripts/datapackagemanagement/**/translations*.js',
'src/main/webapp/scripts/conceptmanagement/**/translations*.js',
'src/main/webapp/scripts/surveymanagement/**/translations*.js',
'src/main/webapp/scripts/instrumentmanagement/**/translations*.js',
Expand Down Expand Up @@ -720,8 +720,8 @@ module.exports = function(grunt) {
};

var detectDomainObjectFromFilename = function(filename) {
if (filename.includes('studymanagement')) {
return 'Study';
if (filename.includes('datapackagemanagement')) {
return 'DataPackage';
}
if (filename.includes('surveymanagement')) {
return 'Survey';
Expand Down
4 changes: 2 additions & 2 deletions ...ymanagement/domain/DataAvailabilities.rst → ...emanagement/domain/DataAvailabilities.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@
DataAvailabilities
==================

.. java:package:: eu.dzhw.fdz.metadatamanagement.studymanagement.domain
.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain
:noindex:

.. java:type:: public class DataAvailabilities
The data's availability of a \ :java:ref:`Study`\ can be in one of these states.
The data's availability of a \ :java:ref:`DataPackage`\ can be in one of these states.

Fields
------
Expand Down
86 changes: 44 additions & 42 deletions ...nagement/studymanagement/domain/Study.rst → ...apackagemanagement/domain/DataPackage.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
.. 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
Expand Down Expand Up @@ -42,13 +44,13 @@
.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject
.. java:import:: eu.dzhw.fdz.metadatamanagement.studymanagement.domain.projection StudySubDocumentProjection
.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.projection DataPackageSubDocumentProjection
.. java:import:: eu.dzhw.fdz.metadatamanagement.studymanagement.domain.validation ValidDataAvailability
.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.validation ValidDataAvailability
.. java:import:: eu.dzhw.fdz.metadatamanagement.studymanagement.domain.validation ValidStudyId
.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.validation ValidDataPackageId
.. java:import:: eu.dzhw.fdz.metadatamanagement.studymanagement.domain.validation ValidSurveyDesign
.. java:import:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.validation ValidSurveyDesign
.. java:import:: io.swagger.v3.oas.annotations.media Schema
Expand All @@ -68,133 +70,133 @@
.. java:import:: lombok ToString
Study
=====
DataPackage
===========

.. java:package:: eu.dzhw.fdz.metadatamanagement.studymanagement.domain
.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain
:noindex:

.. java:type:: @Entity @Document @ValidStudyId @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder @Schema @ValidShadowId public class Study extends AbstractShadowableRdcDomainObject implements StudySubDocumentProjection
.. java:type:: @Entity @Document @TypeName @ValidDataPackageId @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder @Schema @ValidShadowId public class DataPackage extends AbstractShadowableRdcDomainObject implements DataPackageSubDocumentProjection
A study also know as 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.
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: Study

Arbitrary additional text for this study. Markdown is supported. Must not contain more than 2048 characters.

authors
^^^^^^^
:outertype: DataPackage

.. java:field:: @Valid @NotEmpty private List<Person> authors
:outertype: Study

List of \ :java:ref:`Person`\ s which have performed this study. Must not be empty.
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: Study
:outertype: DataPackage

The id of the \ :java:ref:`DataAcquisitionProject`\ to which this study belongs. The dataAcquisitionProjectId must not be empty.
The id of the \ :java:ref:`DataAcquisitionProject`\ to which this dataPackage belongs. The dataAcquisitionProjectId must not be empty.

dataAvailability
^^^^^^^^^^^^^^^^

.. java:field:: @NotNull @ValidDataAvailability private I18nString dataAvailability
:outertype: Study
:outertype: DataPackage

The current state of the data's availability. Must be one of \ :java:ref:`DataAvailabilities`\ and must not be empty.

dataCurators
^^^^^^^^^^^^

.. java:field:: @Valid @NotEmpty private List<Person> dataCurators
:outertype: Study
: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: Study
:outertype: DataPackage

A description of the study. Markdown is supported. It must be specified in German and English and it must not contain more than 2048 characters.
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: Study
:outertype: DataPackage

The id of the study which uniquely identifies the study in this application.
The id of the dataPackage which uniquely identifies the dataPackage in this application.

institutions
^^^^^^^^^^^^

.. java:field:: @NotEmpty private List<I18nString> institutions
:outertype: Study
:outertype: DataPackage

The names of the institutions which have performed this study. 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 this dataPackage. 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: Study
: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<Person> projectContributors
:outertype: DataPackage

The master id of the study. 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.
List of \ :java:ref:`Person`\ s which have performed this dataPackage. Must not be empty.

serialVersionUID
^^^^^^^^^^^^^^^^

.. java:field:: private static final long serialVersionUID
:outertype: Study
:outertype: DataPackage

sponsor
^^^^^^^

.. java:field:: @NotNull @I18nStringSize @I18nStringEntireNotEmpty private I18nString sponsor
:outertype: Study
:outertype: DataPackage

The name of the sponsor who which has sponsored this study. It must be specified in German and English and it must not contain more than 512 characters.
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.

studySeries
^^^^^^^^^^^

.. java:field:: @I18nStringSize @I18nStringEntireNotEmptyOptional @I18nStringMustNotContainComma private I18nString studySeries
:outertype: Study
:outertype: DataPackage

The name of the series of studies to which this study belongs. If specified it must be specified in German and English. It must not contain more than 512 characters and must not contain ",".
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: Study
:outertype: DataPackage

The survey design of this \ :java:ref:`Study`\ . Must be one of \ :java:ref:`SurveyDesigns`\ and must not be empty.
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: Study
:outertype: DataPackage

Keywords for the study.
Keywords for the dataPackage.

title
^^^^^

.. java:field:: @NotNull @I18nStringSize @I18nStringEntireNotEmpty private I18nString title
:outertype: Study
:outertype: DataPackage

The title of the study. It must be specified in German and English and it must not contain more than 2048 characters.
The title of the dataPackage. It must be specified in German and English and it must not contain more than 2048 characters.

68 changes: 35 additions & 33 deletions ...gement/domain/StudyAttachmentMetadata.rst → .../domain/DataPackageAttachmentMetadata.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
.. 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
Expand All @@ -24,9 +26,9 @@
.. 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.datapackagemanagement.domain.validation ValidDataPackageAttachmentType
.. java:import:: eu.dzhw.fdz.metadatamanagement.studymanagement.domain.validation ValidStudyAttachmentType
.. java:import:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain DataAcquisitionProject
.. java:import:: lombok AccessLevel
Expand All @@ -44,101 +46,101 @@
.. java:import:: lombok ToString
StudyAttachmentMetadata
=======================
DataPackageAttachmentMetadata
=============================

.. java:package:: eu.dzhw.fdz.metadatamanagement.studymanagement.domain
.. java:package:: eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain
:noindex:

.. java:type:: @Entity @EqualsAndHashCode @ToString @NoArgsConstructor @Data @AllArgsConstructor @Builder public class StudyAttachmentMetadata extends AbstractShadowableRdcDomainObject
.. 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:`Study`\ .
Metadata which will be stored with each attachment of a \ :java:ref:`DataPackage`\ .

Fields
------
dataAcquisitionProjectId
^^^^^^^^^^^^^^^^^^^^^^^^

.. java:field:: @NotEmpty private String dataAcquisitionProjectId
:outertype: StudyAttachmentMetadata
:outertype: DataPackageAttachmentMetadata

The id of the \ :java:ref:`DataAcquisitionProject`\ to which the \ :java:ref:`DataPackage`\ of this attachment belongs. Must not be empty.

dataPackageId
^^^^^^^^^^^^^

The id of the \ :java:ref:`DataAcquisitionProject`\ to which the \ :java:ref:`Study`\ of this attachment belongs. Must not be empty.
.. 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: StudyAttachmentMetadata
: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: StudyAttachmentMetadata
: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: StudyAttachmentMetadata
:outertype: DataPackageAttachmentMetadata

The id of the attachment. Holds the complete path which can be used to download the file.

indexInStudy
^^^^^^^^^^^^
indexInDataPackage
^^^^^^^^^^^^^^^^^^

.. java:field:: @NotNull private Integer indexInStudy
:outertype: StudyAttachmentMetadata
.. java:field:: @NotNull private Integer indexInDataPackage
:outertype: DataPackageAttachmentMetadata

The index in the \ :java:ref:`Study`\ of this attachment. Used for sorting the attachments of this \ :java:ref:`Study`\ . Must not be empty.
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: StudyAttachmentMetadata
: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: StudyAttachmentMetadata
:outertype: DataPackageAttachmentMetadata

The master id of the study attachment.
The master id of the dataPackage attachment.

serialVersionUID
^^^^^^^^^^^^^^^^

.. java:field:: private static final long serialVersionUID
:outertype: StudyAttachmentMetadata

studyId
^^^^^^^

.. java:field:: @NotEmpty private String studyId
:outertype: StudyAttachmentMetadata

The id of the \ :java:ref:`Study`\ to which this attachment belongs. Must not be empty.
:outertype: DataPackageAttachmentMetadata

title
^^^^^

.. java:field:: @NotEmpty @Size private String title
:outertype: StudyAttachmentMetadata
: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 @ValidStudyAttachmentType private I18nString type
:outertype: StudyAttachmentMetadata
.. java:field:: @NotNull @I18nStringSize @ValidDataPackageAttachmentType private I18nString type
:outertype: DataPackageAttachmentMetadata

The type of the attachment. Must be one of \ :java:ref:`StudyAttachmentTypes`\ and must not be empty.
The type of the attachment. Must be one of \ :java:ref:`DataPackageAttachmentTypes`\ and must not be empty.

Loading

0 comments on commit 1ec1703

Please sign in to comment.