Namespace Algenta.Colectica.Model.Ddi
Contains classes that implement the DDI 3 metadata model by deriving from the classes in the Algenta.Colectica.Model namespace.
Classes
Access
Represents information about access policies at an archive.
ActionActivity
Represents source code in a specified language to be executed as part of a survey Instrument.
ActivityBase
Provides a base class from which classes representing DDI ControlConstructs may derive.
AddinManifest
Describes the Colectica DDI addin.
Address
Represents the postal address of a location.
Agent
Base class for Organization and Individual
Aggregation
Represents combination of multiple variables into a single aggregate variable via some computation method.
Anchor
Represents a labelled anchor on a ScaleDomain.
Archive
Represents information about a data archive.
AuthorizationSource
Identifies the authorizing agency.
Binding
Represents the connection of two parameters, and the flow of data between them.
Blaise5DataLookupFieldInformation
Blaise5DataLookupInformation
CaptureBase
Represents a question or a field used to collect data.
CaseLaw
Refers to a case law ruling related to the Classification Item.
Category
Describes a particular category or response. OECD Glossary of Statistical Terms: Generic term for items at any level within a classification, typically tabulation categories, sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses.
CategoryDomain
Represents a categorical response to be collected by a Question.
CategoryGroup
Represents a group of Category items.
CategoryScheme
Represents a collection of Category objects.
CategoryStatistic
Represents a statistic about a specific categorical value of a variable.
CategoryStatistics
Represents a collection of statistics for a specific value of a variable.
CellCoordinatesAsDefined
Part of the GridAttachment implementation. Colectica will serialize and deserialize this, but will not provide any display or user interaction with this information, except through the SDK. We consider this section of the standard ambiguous and do not recommend using it.
ClassificationCorrespondenceTable
A Correspondence Table expresses the relationship between two Statistical Classifications. These are typically: two versions from the same Classification Series; Statistical Classifications from different Classification Series; a variant and the version on which it is based; different versions of a variant. In the first and last examples, the Correspondence Table facilitates comparability over time. Correspondence relationships are shown in both directions
ClassificationFamily
A Classification Family is a group of Classification Series related from a particular point of view. The Classification Family is related by being based on a common concept (e.g. economic activity).
ClassificationIndex
A Classification Index is an ordered list (alphabetical, in code order etc) of Classification Index Entries. A Classification Index can relate to one particular or to several Statistical Classifications. A Classification Index shows the relationship between text found in statistical data sources (responses to survey questionnaires, administrative records) and one or more Statistical Classifications. A Classification Index may be used to assign the codes for Classification Items to observations in statistical collections.
ClassificationIndexEntry
A Classification Index Entry is a word or a short text (e.g. the name of a locality, an economic activity or an occupational title) describing a type of object/unit or object property to which a Classification Item applies, together with the code of the corresponding Classification Item. Each Classification Index Entry typically refers to one item of the Statistical Classification. Although a Classification Index Entry may be associated with a Classification Item at any Level of a Statistical Classification, Classification Index Entries are normally associated with Classification Items at the lowest Level.
ClassificationItem
A Classification Item represents a Category at a certain Level within a Statistical Classification. It defines the content and the borders of the category. An object/unit can be classified to one and only one Classification Item at each Level of a Statistical Classification.
ClassificationLevel
A Statistical Classification has a structure which is composed of one or several Levels. A Level often is associated with a concept, which defines it. In a hierarchical Statistical Classification the Classification Items of each Level but the highest are aggregated to the nearest higher Level. A linear Statistical Classification has only one Level.
ClassificationMap
A Map is an expression of the relation between a Classification Item in a source Statistical Classification and a corresponding Classification Item in the target Statistical Classification. The Map should specify whether the relationship between the two Classification Items is partial or complete. Depending on the relationship type of the Correspondence Table, there may be several Maps for a single source or target Classification Item.
ClassificationSeries
A Classification Series is an ensemble of one or several consecutive Statistical Classifications under a particular heading (for example ISIC or ISCO).
Code
Associates a value with a Category.
CodeCollection
Represents a collection of Code objects.
CodeDomain
Represents a coded response to be collected by a Question.
CodeList
Provides a description of a set of categories that have a specific relationship, such as the categories Male and Female that can be grouped together as Gender. Categories (e.g., Male and Female) can belong to multiple code lists. The code list also provides the unique code values for each of the categories in the code list.
CodeListGroup
Represents a group of CodeList items.
CodeListScheme
Represents a collection of CodeList objects.
CollectionEvent
Represents information about a data collection event.
ComplianceDefinition
Provides a list of quality concepts in the quality standard.
CompositeWithSingleChildActivityBase
Represents a ControlConstruct with a single child, which is a CustomSequenceActivity.
Concept
Represents a unit of knowledge created by a unique combination of characteristics.
ConceptGroup
Represents a group of Concept items.
ConceptScheme
Represents a collection of Concept objects.
ConceptualComponent
Provides a wrapper to package information describing a statistical activity's conceptual basis.
ConceptualVariable
Represents the concept and universe applicable to a Variable.
ConceptualVariableGroup
Represents a group of ConceptualVariable items.
ConceptualVariableScheme
Represents a collection of ConceptualVariable objects.
Condition
Represents a conditional expression, specified in one or more source code languages.
ControlConstructGroup
Represents a group of ActivityBase items.
ControlConstructScheme
Represents a set of control constructs used in an Instrument.
Country
Represents a country.
CountryCode
Represents a country.
Coverage
Describes the temporal, geographic and topical coverage.
CustomIfElseActivity
Represents a collection of conditional branches in a data collection Instrument.
CustomIfElseBranchActivity
Represents a conditional branch inside a data collection instrument.
CustomLoopActivity
Represents a loop in a data collection instrument.
CustomSequenceActivity
Represents a sequence of items in a data collection instrument.
CustomUntilActivity
Represents a loop that executes until some condition is true in a data collection instrument.
CustomWhileActivity
Represents a loop that executes while some condition is true in a data collection instrument.
DataCollection
Describes information about data collection and post-collection processing.
DataCollectionFrequency
Documents the intended frequency of data collection, for example monthly, yearly, weekly, etc., preferably using an optional controlled vocabulary
DataCollectionItem
Represents a description of an aspect of the data collection process.
DataCollectionMethodology
Describes the methodology used in a data collection process.
DataFileIdentification
Identifies the data file documented in a physical instance and provides information about the file's location.
DataItem
Identifies a physical storage location for an individual data entry, serving as a link between the physical location and the logical content description of each data item.
DataRelationship
Describes the relationships among logical records in the dataset. Date Relationship is needed to create the appropriate link between the logical record and the physical storage description.
DataSource
Describes a source of data.
Date
Represents a single date. Dates may be represented at different levels of precision, for example, date and time, date only, month + year only, year only, etc.
DateRange
Represents a range of Dates.
DateSpecification
Represents a single date or a range of dates, specified at arbitrary levels of precision.
DateTimeDomain
Represents date and time information to be collected by a Question.
DateTimeType
Represents a type of date or time.
DdiInstance
Represents the top-level wrapper of a DDI 3 document.
DdiItemFormatter
Provides methods to get information about DDI item, and to serialize and deserialize items of that particular type.
DdiItemStrings
A strongly-typed resource class, for looking up localized strings, etc.
DdiItemType
Defines identifiers for DDI 3 item types.
DistributionDomain
Allows distributing a number of points to a set of items in a QuestionGrid.
DomainSpecificValue
Value to which a response domain is attached.
Embargo
Provides information about data that are not currently available because of policies established by the principal investigators and/or data producers.
Fingerprint
Represents a digital fingerprint of a data file.
FundingInformation
Represents information about the agency or grants which funded an activity.
GeneralInstructionCoding
Describes coding instructions that pertain to data collection or data processing overall such as handling of non-response to questions, imputation practices, suppression rules, etc. Coding instructions should be listed separately to allow for referencing of specific processes.
GenerationInstructionCoding
Instructions for recodes, derivations from multiple question or variable sources, and derivations based on external sources. Instructions should be listed separately so they can be referenced by variables in the logical product.
GeographicBoundingBox
Represents a rectangle, oriented to the x and y axes, which bounds a geographic feature or a geographic dataset.
GrossFileStructure
Grossly describes a file's structure.
GrossRecordStructure
Provides characteristics of the physical storage of a logical record type as described in a DataRelationship. Used by RecordLayouts to describe the full structure of a PhysicalInstance.
Group
Describes a series of research studies or other statistical activities.
GroupEnumExtensions
Provides extension methods useful for working with the enumerations that descripbe relationships among Group items.
HoldingInformation
Represents information about an archive's holdings.
Individual
Details of an individual including name, contact information
IndividualName
The name of an individual broken out into its component parts
InstantMessaging
Represents an instant messaging address.
InstructionGroup
Represents a group of InterviewerInstruction items.
Instrument
Represents a data collection instrument, such as a survey.
InstrumentGroup
Represents a group of Instrument items.
InstrumentScheme
Represents a collection of Instrument objects.
InterviewerInstruction
Represents an instruction for an interviewer.
InterviewerInstructionScheme
Represents a collection of InterviewerInstruction objects.
Level
Used to describe the levels of the code scheme hierarchy. The level describes the nesting structure of a hierarchical coding structure. A level could have data attached to it (summary of its children) or no data attached to it (the equivalent of creating a category group in 2.0 and earlier versions Note that the attribute levelNumber is used for referencing specific codes to their level identifier.
LevelContext
Level Context provides the depth of a Level within a Statistical Classification together with its membership. Both depth and membership can be specified per Statistical Classification.
Location
Describes a physical location and contact information for an organization.
LogicalProduct
Represents DDI packaging for various information used to describe data. Consider using a ResourcePackage instead.
LogicalRecord
Describes a data record.
ManagedDateTimeRepresentation
Managed Representation for date time
ManagedMissingValuesRepresentation
Represents information about missing values.
ManagedNumericRepresentation
Managed Representation for numerics
ManagedRepresentationBase
Bae class for Managed Representations
ManagedRepresentationGroup
Represents a group of ManagedMissingValuesRepresentation items.
ManagedRepresentationScheme
Represents a collection of ManagedMissingValuesRepresentation objects.
ManagedScaleRepresentation
Managed Representation for scales
ManagedTextRepresentation
Managed Representation for date time
Measurement
Represents a measurement or a field used to collect data.
MeasurementActivity
Represents a control construct in a data collection instrument that presents a Measurement
MethodologyItem
Describes an aspect of the methodology used to collect or process data.
MissingRepresentationCollection
Represents a collection of ResponseDomains that represent missing values. Only TextDomain, CodeDomain, and NumericDomain are allowed.
NCube
Describes an aggregate data cube defined by dimensions and measures.
NCubeGroup
Represents a group of NCube items.
NCubeScheme
Represents a collection of NCube objects.
NeutralAssignment
A block of neutral assignment statements
NeutralAssignmentStatement
An assignment statement
NeutralConditionalLogic
Represents a boolean expression in a non language specific manner
NeutralConditionalLogicGroup
One group of statements and associated group boolean operator
NeutralConditionalLogicStatement
A logical statement
NoDataByDefinition
Defines the cells within a grid that contain no content.
NominalDomain
Captures a marked vs. unmarked response. For example, "check here if...", in a QuestionGrid.
NumericDomain
Represents numeric data to be collected by a Question.
NumericType
Represents a type of number.
Operation
Represents an operation on data, such as cleaning or coding the data.
Organization
Represents an organization.
OrganizationGroup
Represents a group of Agent items.
OrganizationRelationship
Describes a relationship between organizations and/or individuals.
OrganizationScheme
Represents a collection of Organization objects.
OtherMaterialGroup
Represents a group of OtherMaterial items.
OtherMaterialScheme
Represents a collection of OtherMaterial objects.
Parameter
Represents data used as an input to or an output from a question or control construct.
ParameterValue
serialization of the parameter to a function
PhysicalInstance
Provides information about a data file, database, or other store of data.
PhysicalProduct
Provides DDI packaging for information about the physical layout of data. Consider using DataRelationship and/or ResourcePackage instead.
PhysicalStructure
Describes the physical structure of a RecordLayout.
PhysicalStructureScheme
Represents a collection of PhysicalStructure objects.
ProcessingEvent
Describes a step in the data processing pipeline.
ProcessingEventGroup
Represents a group of ProcessingEvent items.
ProcessingEventScheme
Represents a collection of ProcessingEvent objects.
ProcessingInstructionGroup
Represents a group of GeneralInstructionCoding and GenerationInstructionCoding items.
ProcessingInstructionScheme
Represents a collection of GeneralInstructionCoding and GenerationInstructionCoding objects.
QualityStandard
Represents a set of fields used to describe the quality of a study, dataset, or something else. Each field is represented by a quality Concept. QualityStatement items can implement a quality standard to provide the specified information.
QualityStatement
A QualityStatement is used to describe how a study conforms to certain quality concepts.
QualityStatementGroup
Represents a group of QualityStatement items.
QualityStatementItem
Represents a single statement within a QualityStatement's set of statements.
QualityStatementScheme
Represents a collection of QualityStatement objects.
Question
Represents a question or a field used to collect data.
QuestionActivity
Represents a control construct in a data collection instrument that presents a Question, QuestionGrid, or QuestionBlock to the respondent.
QuestionBlock
Represents a series of questions asked about one or more stimulus materials, such as an image.
QuestionBlockMember
Represents a single item in a QuestionBlock. Members can be a stimulus material, a Question, or a QuestionGrid.
QuestionGrid
Represents a grid of questions, defined by question text and one or more dimensions. Dimensions can be pre-defined or rosters of items specified by the respondent.
QuestionGridAttachment
Corresponds to the DDI GridAttachment element. Colectica will serialize and deserialize the GridAttachment, but will not provide any display or user interaction with this information, except through the SDK. We consider this section of the standard ambiguous and do not recommend using it.
QuestionGridDimension
Represents a dimension of a question grid.
QuestionGroup
Represents a group of Question, QuestionGrid, and QuestionBlock items.
QuestionRoster
Represents a roster in a questionnaire. In a roster, the respondent is able to add as many lines as appropriate, and will provide responses for certain inputs for each of those lines.
QuestionScheme
Represents a collection of Question, QuestionGrid, and QuestionBlock objects.
RankingDomain
Allows ranking a set of items in a QuestionGrid.
RecordLayout
Represents the layout of a data record.
RecordLayoutScheme
Represents a collection of RecordLayout objects.
RecordRelationship
Represents a one-to-one relationship between LogicalRecords.
RepresentedVariable
Represents a variable's concept, universe, and data type.
RepresentedVariableGroup
Represents a group of RepresentedVariable items.
RepresentedVariableScheme
Represents a collection of RepresentedVariable objects.
ResourcePackage
Provides a package in which to store many types of metadata items.
ResponseDomain
Represents a type of data that can be collected by a Question.
ResponseText
Represents a ResponseDomain that collects no data. Provides a way to store text to be displayed between other ResponseDomains.
ScaleDomain
Represents a response on a scale to be collected by a Question.
SelectDimension
Part of the GridAttachment implementation. Colectica will serialize and deserialize this, but will not provide any display or user interaction with this information, except through the SDK. We consider this section of the standard ambiguous and do not recommend using it.
SeriesStatement
Represents detailed information about a series of statistical activities.
Software
Describes information about a software application.
SourceCode
Represents source code for a particular language.
SourceCodeCollection
Represents a collection of SourceCode objects.
SpatialCoverage
Represents a description of geographic coverage.
StandardWeightCoding
Represents a standard weighting factor used by all or a group of variables within the data set.
StatementActivity
Represents a statement that occurs in a data collection instrument.
StatementValue
serialization of the right hand operand value
StatisticalClassification
A Statistical Classification is a set of categories which may be assigned to one or more variables registered in statistical surveys or administrative files, and used in the production and dissemination of statistics. The categories at each level of the classification structure must be mutually exclusive and jointly exhaustive of all objects/units in the population of interest. The categories are defined with reference to one or more characteristics of a particular population of units of observation. A Statistical Classification may have a flat, linear structure or may be hierarchically structured, such that all categories at lower Levels are sub-categories of categories at the next Level up. Categories in Statistical Classifications are represented in the information model as Classification Items.
StudyBase
Provides a base class with common informatino for Group and StudyUnit.
StudyUnit
Represents a description of a research study or other statistical activity.
SubGroup
Describes a sub grouping in a series of research studies or other statistical activities.
SummaryStatistic
Represents a summary statistic that describes a variable.
Telephone
Represents a telephone number.
TemporalCoverage
Provides information to describe the time period covered by a study.
TextDomain
Represents text data to be collected by a Question.
TopicalCoverage
Provides information to describe the topical coverage of a study.
UnitType
A Unit Type is a class of objects of interest. A Unit Type is used to describe a class or group of Units based on a single characteristic with no specification of time and geography. For example, the Unit Type of “Person” groups together a set of Units based on the characteristic that they are “Persons”. It concerns not only Unit Types used in dissemination, but anywhere in the statistical process. For example, using administrative data might involve the use of a fiscal unit. “Object class (ISO 11179)” is a synonym of UnitType. [GSIM 1.2]
UnitTypeGroup
Represents a group of UnitType items.
UnitTypeScheme
Represents a collection of UnitType objects.
Universe
Provides information to describe the persons or other elements that data are about, and to which analytic results may refer.
UniverseGroup
Represents a group of Universe items.
UniverseScheme
Represents a collection of Universe objects.
UnknownActivity
Represents a control construct in a data collection instrument of a type that cannot be determined. This is used for internal processing and should not generally be created.
Variable
Represents the logical description of a column of data.
VariableGroup
Represents a group of Variable items.
VariableScheme
Represents a collection of Variable objects.
VariableSet
Represents a set of dependent and independent variables, used for describing aggregate data.
VariableStatistic
Represents summary statistics and frequencies for data described by a logical Variable.
VariableStatisticBase
Represents a statistic that describes a variable.
VariableValue
Represents a value of a piece of data described by a logical Variable.
VersionableGroupBase<T, G>
Provides a base class from which classes implementing DDI item groups may derive.
Interfaces
IBindable
An identified item that supports in and out parameter binding
IVersionableGroup
Provides properties common to all DDI item group types.
Enums
AdditivityType
Describes the additivity of a numeric data item.
AggregationMethodType
Describes a method used to aggregate data.
BooleanType
Type of boolean operator
CategoryRelation
Represents the relationship between categories.
CategoryStatisticType
Describes types of category statistics.
ComparisonType
Describes a type comparison.
DataSetGroupRelationship
Describes the relationship among datasets for StudyUnits in a Group.
DatePrecisionType
The precision of a Date.
DelimiterType
The type of character that separates DataItems in a delimited file format.
FingerprintContent
Describes whether a fingerprint describes a physical file, or the contents of the file.
GeographyGroupRelationship
InstrumentGroupRelationship
Describes the relationship among instruments for StudyUnits in a Group.
InstrumentParameterType
Describes whether a parameter is an input or an output.
IterationCountType
Whether the iteration count is fixed or dynamic.
LanguageGroupRelationship
Describes the language relationship among StudyUnits in a Group.
MultipleChoiceLayout
Describes the layout of a multiple choice question.
MultipleChoiceType
Describes how many items should be selected from the code list in a CodeDomain.
MultipleResponseDomainType
Represents how many answers are expected from a CodeDomain response type.
OperatorType
type of logical operator
PanelGroupRelationship
Describes the panel relationship among StudyUnits in a Group.
QuestionGridType
DEscribes the type of question grid.
RecordRelationshipType
Describes the type of relationship between records.
RelationshipType
Describes the relationships among categories at a particular level.
RepresentationType
Represents the type of data to be collected by a Question.
RosterDisplayStyle
Describes how a roster should be displayed.
SequenceExecutionOrder
Represents the order in which a sequence is executed.
StorageFormatType
The storage format in which a DataItem is held.
SummaryStatisticType
Defines types of summary statistics.
TimeGroupRelationship
Describes the time relationship among StudyUnits in a Group.