Package eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain

Class DataSet

java.lang.Object
eu.dzhw.fdz.metadatamanagement.common.domain.AbstractRdcDomainObject
eu.dzhw.fdz.metadatamanagement.common.domain.AbstractShadowableRdcDomainObject
eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.DataSet
All Implemented Interfaces:
Serializable
@ValidDataSetIdName(message="data-set-management.error.data-set.id.valid-data-set-id-name")
@UniqueDatasetNumberInProject(message="data-set-management.error.data-set.unique-data-set-number-in-project")
@CompoundIndex(def="{number: 1, dataAcquisitionProjectId: 1}",
               unique=true)
@ValidShadowId(message="data-set-management.error.data-set.id.pattern")
public class DataSet
extends AbstractShadowableRdcDomainObject
A dataset contains Variables. It results from at least one Survey.
See Also:
Serialized Form

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
      Constant Field Values

    • id

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

    • masterId

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

    • dataAcquisitionProjectId

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

    • description

      @NotNull(message="data-set-management.error.data-set.description.not-null") @I18nStringSize(max=2048, message="data-set-management.error.data-set.description.i18n-string-size") @I18nStringNotEmpty(message="data-set-management.error.data-set.description.i18n-string-not-empty") private @NotNull(message="data-set-management.error.data-set.description.not-null") @I18nStringSize(max=2048,message="data-set-management.error.data-set.description.i18n-string-size") I18nString description
      A short description of the dataset. It must be specified in at least one language and it must not contain more than 2048 characters.

    • number

      @NotNull(message="data-set-management.error.data-set.number.not-null") private @NotNull(message="data-set-management.error.data-set.number.not-null") Integer number
      The number of the dataset. Must not be empty and must be unique within the DataAcquisitionProject.

    • format

      @ValidFormat(message="data-set-management.error.data-set.format.valid-format") private I18nString format
      The format of the dataset. Must be one of Format.

    • type

      @NotNull(message="data-set-management.error.data-set.type.not-null") @ValidDataSetType(message="data-set-management.error.data-set.type.valid-type") private @NotNull(message="data-set-management.error.data-set.type.not-null") I18nString type
      The type of the dataset. Must be one of DataSetTypes and must not be empty.

    • annotations

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

    • surveyNumbers

      @NotEmpty(message="data-set-management.error.data-set.survey-numbers.not-empty") private @NotEmpty(message="data-set-management.error.data-set.survey-numbers.not-empty") List<Integer> surveyNumbers
      List of numbers of Surveys of this DataAcquisitionProject. The dataset contains results from these Surveys. Must contain at least one element.

    • dataPackageId

      @NotEmpty(message="data-set-management.error.data-set.dataPackage.id.not-empty") private @NotEmpty(message="data-set-management.error.data-set.dataPackage.id.not-empty") String dataPackageId
      The id of the OrderedDataPackage to which this dataset belongs. Must not be empty.

    • surveyIds

      @NotEmpty(message="data-set-management.error.data-set.survey.ids.not-empty") private @NotEmpty(message="data-set-management.error.data-set.survey.ids.not-empty") List<String> surveyIds
      List of ids of Surveys of this DataAcquisitionProject. The dataset contains results from these Surveys. Must contain at least one element.

    • subDataSets

      @Valid @NotEmpty(message="data-set-management.error.data-set.sub-data-sets.not-empty") @UniqueSubDatasetAccessWayInDataSet(message="data-set-management.error.data-set.sub-data-sets.access-way-unique-within-data-set") private @Valid @NotEmpty(message="data-set-management.error.data-set.sub-data-sets.not-empty") List<SubDataSet> subDataSets
      List of SubDataSets (concrete accessible files) within this dataset. Must contain at least one element. There must not be more than one SubDataSet per AccessWays.

    • languages

      private List<@ValidIsoLanguage(message="data-set-management.error.sub-data-set.languages.not-supported") String> languages
      The languages used in the dataset. Must be specified as ISO 639 language codes.

  • Constructor Details

    • DataSet

      public DataSet​(DataSet dataSet)

  • Method Details