Variable¶
-
public class
Variable
extends AbstractShadowableRdcDomainObject¶ A variable contains the results from at least one
Survey
. These results can be the responses from participants of an online survey, hence a variable can result fromRelatedQuestion
s. A variable is part of exactly oneDataSet
.
Fields¶
accessWays¶
-
private List<String>
accessWays
¶ 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
AccessWays
.
annotations¶
-
private I18nString
annotations
¶ Arbitrary additional text for this variable. Must not contain more than 2048 characters.
dataAcquisitionProjectId¶
-
private String
dataAcquisitionProjectId
¶ The id of the
DataAcquisitionProject
to which this variable belongs. The dataAcquisitionProjectId must not be empty.
dataSetId¶
dataSetNumber¶
dataType¶
-
private I18nString
dataType
¶ The technical type which the
ValidResponse
s have. Must be one ofDataTypes
and must not be empty.
derivedVariablesIdentifier¶
-
private String
derivedVariablesIdentifier
¶ Identifier used to group variables within this
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¶
-
private Distribution
distribution
¶ The
Distribution
contains the descriptives of this variable meaningValidResponse
s,Missing
s andStatistics
.
doNotDisplayThousandsSeparator¶
-
private Boolean
doNotDisplayThousandsSeparator
¶ Flag indicating whether the
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 theValidResponse
s are displayed with thousands separator.
filterDetails¶
-
private FilterDetails
filterDetails
¶ FilterDetails
of a variable describe the condition which must have evaluated to true before a participant was asked aQuestion
resulting in this variable.
generationDetails¶
-
private GenerationDetails
generationDetails
¶ GenerationDetails
describe how this variable was generated from one or more input variables.
id¶
indexInDataSet¶
label¶
-
private I18nString
label
¶ 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.
name¶
panelIdentifier¶
-
private String
panelIdentifier
¶ Identifier used to group variables within this
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¶
-
private I18nString
scaleLevel
¶ The scale level (or level of measurement) classifies the nature of information within the values assigned to this variable (
ValidResponse
s). It determines which mathematical operations can be performed with the values. It must be one ofScaleLevels
and must not be empty. If the data type of this variable isDataTypes.DATE
then the ScaleLevel must beScaleLevels.ORDINAL
.
storageType¶
-
private String
storageType
¶ Associated with each data type is a storage type. For instance numerics can be stored as integer or double. Must be one of
StorageTypes
and must not be empty.