Package eu.dzhw.fdz.metadatamanagement.surveymanagement.domain

Class Survey

java.lang.Object
eu.dzhw.fdz.metadatamanagement.common.domain.AbstractRdcDomainObject
eu.dzhw.fdz.metadatamanagement.common.domain.AbstractShadowableRdcDomainObject
eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.Survey
All Implemented Interfaces:
Serializable
@ValidSurveyIdName(message="survey-management.error.survey.id.valid-survey-id-name")
@ValidUniqueSurveyNumber(message="survey-management.error.survey.unique-survey-number")
@ValidShadowId(message="survey-management.error.survey.id.pattern")
@GrossSampleSizeGreaterThanNetSampleSize(message="survey-management.error.survey.gross-sample-size.min")
public class Survey
extends AbstractShadowableRdcDomainObject
A survey is conducted to examine a population on the basis of a sample. The resulting DataSets can be used to make statements about the population.
See Also:
Serialized Form

  • Field Summary

    Fields
    Modifier and Type Field Description
    private @I18nStringSize(max=2048,message="variable-management.error.variable.annotations.i18n-string-size") I18nString annotations
    Arbitrary additional text for this survey.
    private @NotEmpty(message="survey-management.error.survey.data-acquisition-project.id.not-empty") String dataAcquisitionProjectId
    The id of the DataAcquisitionProject to which this survey belongs.
    private @NotEmpty(message="survey-management.error.survey.dataPackage-id.not-empty") String dataPackageId
    The id of the DataPackage to which this survey belongs.
    private @NotNull(message="survey-management.error.survey.data-type.not-null") I18nString dataType
    The type of data which the survey produced.
    private @NotNull(message="survey-management.error.survey.field-period.not-null") @Valid Period fieldPeriod
    The period during which the survey has been conducted or is expected to be conducted.
    private @Min(value=0L,message="survey-management.error.survey.gross-sample-size.min") Integer grossSampleSize
    The gross sample size represents the number of participants which have been invited to take part in the Survey.
    private String id
    The id of the survey which uniquely identifies the survey in this application.
    private @NotEmpty(message="survey-management.error.survey.master-id.not-empty") @Size(max=512,message="survey-management.error.survey.master-id.size") @Pattern(regexp="^[_A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df\\-\\.\\$]*$",message="survey-management.error.survey.master-id.pattern") String masterId
    The master id of the survey.
    private @NotNull(message="survey-management.error.survey.number.not-null") Integer number
    The number of the instrument.
    private @Valid @NotNull(message="survey-management.error.survey.population.not-null") Population population
    Details about the Population.
    private @Min(value=0L,message="survey-management.error.survey.response-rate.min") @Max(value=100L,message="survey-management.error.survey.response-rate.max") Double responseRate
    The response rate is the quotient of the gross sample size and the sample size.
    private @NotNull(message="survey-management.error.survey.sample.not-null") I18nString sample
    The sampling method is the procedure for selecting sample members from a population.
    private @NotNull(message="survey-management.error.survey.sample-size.not-null") @Min(value=0L,message="survey-management.error.survey.sample-size.min") Integer sampleSize
    The sample size is the number of participants which took part in the survey.
    private @NotNull(message="survey-management.error.survey.serial-number.not-null") @Min(value=1L,message="survey-management.error.survey.serial-number.min") Integer serialNumber
    Serial number of this Survey as it is implemented in the survey design (e.g.
    private static long serialVersionUID  
    private @NotNull(message="survey-management.error.survey.survey-method.not-null") @I18nStringEntireNotEmpty(message="survey-management.error.survey.survey-method.i18n-string-entire-not-empty") @I18nStringSize(max=512,message="survey-management.error.survey.survey-method.i18n-string-size") I18nString surveyMethod
    The survey method briefly describes how the data were collected.
    private @I18nStringSize(max=2048,message="survey-management.error.survey.title.i18n-string-size") @I18nStringEntireNotEmpty(message="survey-management.error.survey.title.i18n-string-entire-not-empty") I18nString title
    The title of the instrument.

  • Constructor Summary

    Constructors
    Constructor Description
    Survey​(Survey survey)  

  • Method Summary

    Modifier and Type Method Description
    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

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
      Constant Field Values

    • id

      private String id
      The id of the survey which uniquely identifies the survey in this application.

    • masterId

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

    • dataAcquisitionProjectId

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

    • title

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

    • population

      @Valid @NotNull(message="survey-management.error.survey.population.not-null") private @Valid @NotNull(message="survey-management.error.survey.population.not-null") Population population
      Details about the Population. Must not be empty.

    • surveyMethod

      @NotNull(message="survey-management.error.survey.survey-method.not-null") @I18nStringEntireNotEmpty(message="survey-management.error.survey.survey-method.i18n-string-entire-not-empty") @I18nStringSize(max=512, message="survey-management.error.survey.survey-method.i18n-string-size") private @NotNull(message="survey-management.error.survey.survey-method.not-null") @I18nStringEntireNotEmpty(message="survey-management.error.survey.survey-method.i18n-string-entire-not-empty") @I18nStringSize(max=512,message="survey-management.error.survey.survey-method.i18n-string-size") I18nString surveyMethod
      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.

    • number

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

    • fieldPeriod

      @NotNull(message="survey-management.error.survey.field-period.not-null") @Valid private @NotNull(message="survey-management.error.survey.field-period.not-null") @Valid Period fieldPeriod
      The period during which the survey has been conducted or is expected to be conducted. Must not be empty.

    • sample

      @NotNull(message="survey-management.error.survey.sample.not-null") @ValidSampleType(message="survey-management.error.survey.sample.valid-sample-type") private @NotNull(message="survey-management.error.survey.sample.not-null") I18nString sample
      The sampling method is the procedure for selecting sample members from a population. It must match the controlled vocabulary specified by VFDB. Catalog: GNERD: Sampling Procedure Educational Research (Version 1.0)

    • serialNumber

      @NotNull(message="survey-management.error.survey.serial-number.not-null") @Min(value=1L, message="survey-management.error.survey.serial-number.min") private @NotNull(message="survey-management.error.survey.serial-number.not-null") @Min(value=1L,message="survey-management.error.survey.serial-number.min") Integer serialNumber
      Serial number of this 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.

    • grossSampleSize

      @Min(value=0L, message="survey-management.error.survey.gross-sample-size.min") private @Min(value=0L,message="survey-management.error.survey.gross-sample-size.min") Integer grossSampleSize
      The gross sample size represents the number of participants which have been invited to take part in the Survey. Must not be negative. If present, it must be greater than or equal to sampleSize.

    • sampleSize

      @NotNull(message="survey-management.error.survey.sample-size.not-null") @Min(value=0L, message="survey-management.error.survey.sample-size.min") private @NotNull(message="survey-management.error.survey.sample-size.not-null") @Min(value=0L,message="survey-management.error.survey.sample-size.min") Integer sampleSize
      The sample size is the number of participants which took part in the survey. Must not be empty and must not be negative. If a grossSampleSize is given then it must be less than or equal to the grossSampleSize.

    • responseRate

      @Min(value=0L, message="survey-management.error.survey.response-rate.min") @Max(value=100L, message="survey-management.error.survey.response-rate.max") private @Min(value=0L,message="survey-management.error.survey.response-rate.min") @Max(value=100L,message="survey-management.error.survey.response-rate.max") Double responseRate
      The response rate is the quotient of the gross sample size and the sample size. Must be between 0 and 100.

    • dataType

      @NotNull(message="survey-management.error.survey.data-type.not-null") @ValidDataType(message="survey-management.error.survey.data-type.valid-data-type") private @NotNull(message="survey-management.error.survey.data-type.not-null") I18nString dataType
      The type of data which the survey produced. Must be one of DataTypes and must not be empty.

    • dataPackageId

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

    • annotations

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

  • Constructor Details

    • Survey

      public Survey​(Survey survey)

  • Method Details