Package eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain

Class DataPackage

java.lang.Object
eu.dzhw.fdz.metadatamanagement.common.domain.AbstractRdcDomainObject
eu.dzhw.fdz.metadatamanagement.common.domain.AbstractShadowableRdcDomainObject
eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.DataPackage
All Implemented Interfaces:
eu.dzhw.fdz.metadatamanagement.common.domain.projections.AbstractRdcDomainObjectProjection, eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.projection.DataPackageSubDocumentProjection, Serializable
@ValidDataPackageId(message="data-package-management.error.data-package.id.not-valid-id")
@ValidShadowId(message="data-package-management.error.data-package.id.pattern")
public class DataPackage
extends AbstractShadowableRdcDomainObject
implements eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.projection.DataPackageSubDocumentProjection
A data package contains all metadata of a DataAcquisitionProject. It will get a DOI (Digital Object Identifier) when the DataAcquisitionProject is released.
See Also:
Serialized Form

  • Field Summary

    Fields
    Modifier and Type Field Description
    private @Valid List<I18nLink> additionalLinks
    A list of additional links for the data package.
    private @I18nStringSize(max=2048,message="data-package-management.error.data-package.annotations.i18n-string-size") I18nString annotations
    Arbitrary additional text for this dataPackage.
    private String approvedUsage
    Arbitrary text with approved purposes of use for this dataPackage.
    private List<ApprovedUsageEnum> approvedUsageList
    A list of allowed use cases for the data-package.
    private @NotEmpty(message="data-package-management.error.data-package.data-acquisition-project.id.not-empty") String dataAcquisitionProjectId
    The id of the DataAcquisitionProject to which this dataPackage belongs.
    private @Valid @NotEmpty(message="data-package-management.error.data-package.data-curators.not-empty") List<Person> dataCurators
    List of Persons which have curated this data package.
    private @NotNull(message="data-package-management.error.data-package.description.not-null") @I18nStringSize(max=2048,message="data-package-management.error.data-package.description.i18n-string-size") @I18nStringEntireNotEmpty(message="data-package-management.error.data-package.description.i18n-string-not-empty") I18nString description
    A description of the dataPackage.
    private Boolean externalDataPackage
    Shows if a data package is external.
    private @NotEmpty(message="data-package-management.error.data-package.id.not-empty") String id
    The id of the dataPackage which uniquely identifies the dataPackage in this application.
    private @NotEmpty(message="data-package-management.error.data-package.institutions.not-null") List<@I18nStringSize(max=512,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 names of the institutions which have performed the study from which this data package results.
    private @NotEmpty(message="data-package-management.error.data-package.master-id.not-empty") @Size(max=512,message="data-package-management.error.data-package.master-id.size") @Pattern(regexp="^[_A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df\\-\\$]*$",message="data-package-management.error.data-package.master-id.pattern") String masterId
    The master id of the dataPackage.
    private @Valid @NotEmpty(message="data-package-management.error.data-package.project-contributors.not-empty") List<Person> projectContributors
    List of Persons which have performed this dataPackage.
    private String remarksUserService
    Remarks for the User Service configuration.
    private static long serialVersionUID  
    private @Valid @NotEmpty(message="data-package-management.error.data-package.sponsor.not-empty") List<Sponsor> sponsors
    List of Sponsors which have sponsored this data package.
    private @I18nStringSize(max=512,message="data-package-management.error.data-package.study-series.i18n-string-size") I18nString studySeries
    The name of the series of dataPackages to which this dataPackage belongs.
    private @NotNull(message="data-package-management.error.data-package.survey-design.not-null") I18nString surveyDesign
    The survey design of this DataPackage.
    private @Valid @NotNull(message="data-package-management.error.data-package.tags.not-null") Tags tags
    Keywords for the dataPackage.
    private @NotNull(message="data-package-management.error.data-package.title.not-null") @I18nStringSize(max=2048,message="data-package-management.error.data-package.title.i18n-string-size") @I18nStringEntireNotEmpty(message="data-package-management.error.data-package.title.i18n-string-entire-not-empty") I18nString title
    The title of the dataPackage.
    private Boolean transmissionViaVerbundFdb
    Shows if a dataPackage was transmitted via VerbundFDB.

  • Constructor Summary

    Constructors
    Constructor Description
    DataPackage​(DataPackage dataPackage)  

  • Method Summary

    Modifier and Type Method Description
    void reformatTitle()
    Report generation will fail if title strings include line breaks, Line breaks are replaced with spaces.
    protected void setIdInternal​(String id)
    Set id on implementation of AbstractShadowableRdcDomainObject.
    protected void setMasterIdInternal​(String masterId)
    Set masterId on implementations of AbstractShadowableRdcDomainObject.

    Methods inherited from class eu.dzhw.fdz.metadatamanagement.common.domain.AbstractShadowableRdcDomainObject

    getMasterId, setId, setMasterId

    Methods inherited from class eu.dzhw.fdz.metadatamanagement.common.domain.AbstractRdcDomainObject

    getId

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface eu.dzhw.fdz.metadatamanagement.common.domain.projections.AbstractRdcDomainObjectProjection

    getCreatedBy, getCreatedDate, getId, getLastModifiedBy, getLastModifiedDate, getVersion

    Methods inherited from interface eu.dzhw.fdz.metadatamanagement.datapackagemanagement.domain.projection.DataPackageSubDocumentProjection

    getDataAcquisitionProjectId, getInstitutions, getMasterId, getProjectContributors, getSponsors, getStudySeries, getSuccessorId, getSurveyDesign, getTitle, isShadow

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
      Constant Field Values

    • id

      @NotEmpty(message="data-package-management.error.data-package.id.not-empty") private @NotEmpty(message="data-package-management.error.data-package.id.not-empty") String id
      The id of the dataPackage which uniquely identifies the dataPackage in this application.

    • masterId

      @NotEmpty(message="data-package-management.error.data-package.master-id.not-empty") @Size(max=512, message="data-package-management.error.data-package.master-id.size") @Pattern(regexp="^[_A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df\\-\\$]*$", message="data-package-management.error.data-package.master-id.pattern") private @NotEmpty(message="data-package-management.error.data-package.master-id.not-empty") @Size(max=512,message="data-package-management.error.data-package.master-id.size") @Pattern(regexp="^[_A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df\\-\\$]*$",message="data-package-management.error.data-package.master-id.pattern") String masterId
      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.

    • dataAcquisitionProjectId

      @NotEmpty(message="data-package-management.error.data-package.data-acquisition-project.id.not-empty") private @NotEmpty(message="data-package-management.error.data-package.data-acquisition-project.id.not-empty") String dataAcquisitionProjectId
      The id of the DataAcquisitionProject to which this dataPackage belongs. The dataAcquisitionProjectId must not be empty.

    • title

      @NotNull(message="data-package-management.error.data-package.title.not-null") @I18nStringSize(max=2048, message="data-package-management.error.data-package.title.i18n-string-size") @I18nStringEntireNotEmpty(message="data-package-management.error.data-package.title.i18n-string-entire-not-empty") private @NotNull(message="data-package-management.error.data-package.title.not-null") @I18nStringSize(max=2048,message="data-package-management.error.data-package.title.i18n-string-size") @I18nStringEntireNotEmpty(message="data-package-management.error.data-package.title.i18n-string-entire-not-empty") I18nString title
      The title of the dataPackage. It must be specified in German and English and it must not contain more than 2048 characters.

    • description

      @NotNull(message="data-package-management.error.data-package.description.not-null") @I18nStringSize(max=2048, message="data-package-management.error.data-package.description.i18n-string-size") @I18nStringEntireNotEmpty(message="data-package-management.error.data-package.description.i18n-string-not-empty") private @NotNull(message="data-package-management.error.data-package.description.not-null") @I18nStringSize(max=2048,message="data-package-management.error.data-package.description.i18n-string-size") @I18nStringEntireNotEmpty(message="data-package-management.error.data-package.description.i18n-string-not-empty") I18nString description
      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.

    • institutions

      @NotEmpty(message="data-package-management.error.data-package.institutions.not-null") private @NotEmpty(message="data-package-management.error.data-package.institutions.not-null") List<@I18nStringSize(max=512,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 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.

    • studySeries

      @I18nStringSize(max=512, 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") @I18nStringMustNotContainComma(message="data-package-management.error.data-package.study-series.i18n-string-must-not-contain-comma") private @I18nStringSize(max=512,message="data-package-management.error.data-package.study-series.i18n-string-size") I18nString studySeries
      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 ",".

    • sponsors

      @Valid @NotEmpty(message="data-package-management.error.data-package.sponsor.not-empty") private @Valid @NotEmpty(message="data-package-management.error.data-package.sponsor.not-empty") List<Sponsor> sponsors
      List of Sponsors which have sponsored this data package. Must not be empty. Needs at least one sponsor.

    • projectContributors

      @Valid @NotEmpty(message="data-package-management.error.data-package.project-contributors.not-empty") private @Valid @NotEmpty(message="data-package-management.error.data-package.project-contributors.not-empty") List<Person> projectContributors
      List of Persons which have performed this dataPackage. Must not be empty.

    • dataCurators

      @Valid @NotEmpty(message="data-package-management.error.data-package.data-curators.not-empty") private @Valid @NotEmpty(message="data-package-management.error.data-package.data-curators.not-empty") List<Person> dataCurators
      List of Persons which have curated this data package. Must not be empty.

    • surveyDesign

      @NotNull(message="data-package-management.error.data-package.survey-design.not-null") @ValidSurveyDesign(message="data-package-management.error.data-package.survey-design.valid-survey-design") private @NotNull(message="data-package-management.error.data-package.survey-design.not-null") I18nString surveyDesign
      The survey design of this DataPackage. Must be one of SurveyDesigns and must not be empty.

    • annotations

      @I18nStringSize(max=2048, message="data-package-management.error.data-package.annotations.i18n-string-size") private @I18nStringSize(max=2048,message="data-package-management.error.data-package.annotations.i18n-string-size") I18nString annotations
      Arbitrary additional text for this dataPackage. Markdown is supported. Must not contain more than 2048 characters.

    • tags

      @Valid @NotNull(message="data-package-management.error.data-package.tags.not-null") private @Valid @NotNull(message="data-package-management.error.data-package.tags.not-null") Tags tags
      Keywords for the dataPackage.

    • remarksUserService

      private String remarksUserService
      Remarks for the User Service configuration.

    • approvedUsage

      private String approvedUsage
      Arbitrary text with approved purposes of use for this dataPackage.

    • approvedUsageList

      private List<ApprovedUsageEnum> approvedUsageList
      A list of allowed use cases for the data-package. The items of that list are elements of the ApprovedUsageEnum (--> controlled vocabulary).

    • transmissionViaVerbundFdb

      private Boolean transmissionViaVerbundFdb
      Shows if a dataPackage was transmitted via VerbundFDB.

    • externalDataPackage

      private Boolean externalDataPackage
      Shows if a data package is external.

  • Constructor Details

    • DataPackage

      public DataPackage​(DataPackage dataPackage)

  • Method Details