Show / Hide Table of Contents

Class Ddi32Deserializer

Deserializes a DDI 3.2 instance from XML.

Inheritance
object
Ddi32Base
Ddi32Deserializer
Ddi33Deserializer
Inherited Members
Ddi32Base.NamespacePurlDc
Ddi32Base.NamespacePurlDcTerms
Ddi32Base.NamespaceXhtml
Ddi32Base.NamespaceInstance32
Ddi32Base.NamespaceArchive32
Ddi32Base.NamespaceDataCollection32
Ddi32Base.NamespaceGroup32
Ddi32Base.NamespaceReusable32
Ddi32Base.NamespaceConcept32
Ddi32Base.NamespaceLogical32
Ddi32Base.NamespaceStudyUnit32
Ddi32Base.NamespacePhysicalDataProduct32
Ddi32Base.NamespacePhysicalDataProductProprietary32
Ddi32Base.NamespacePhysicalInstance32
Ddi32Base.NamespaceComparative32
Ddi32Base.NamespaceDataset32
Ddi32Base.NamespaceProfile32
Ddi32Base.NamespaceExtensions32
Ddi32Base.NamespaceInstance33
Ddi32Base.NamespaceArchive33
Ddi32Base.NamespaceDataCollection33
Ddi32Base.NamespaceGroup33
Ddi32Base.NamespaceReusable33
Ddi32Base.NamespaceConcept33
Ddi32Base.NamespaceLogical33
Ddi32Base.NamespaceStudyUnit33
Ddi32Base.NamespacePhysicalDataProduct33
Ddi32Base.NamespacePhysicalDataProductProprietary33
Ddi32Base.NamespacePhysicalInstance33
Ddi32Base.NamespaceComparative33
Ddi32Base.NamespaceDataset33
Ddi32Base.NamespaceProfile33
Ddi32Base.NamespaceExtensions33
Ddi32Base.NamespaceInstance
Ddi32Base.NamespaceArchive
Ddi32Base.NamespaceDataCollection
Ddi32Base.NamespaceGroup
Ddi32Base.NamespaceReusable
Ddi32Base.NamespaceConcept
Ddi32Base.NamespaceLogical
Ddi32Base.NamespaceStudyUnit
Ddi32Base.NamespacePhysicalDataProduct
Ddi32Base.NamespacePhysicalDataProductProprietary
Ddi32Base.NamespacePhysicalInstance
Ddi32Base.NamespaceComparative
Ddi32Base.NamespaceDataset
Ddi32Base.NamespaceProfile
Ddi32Base.NamespaceExtensions
Ddi32Base.XhtmlDiv
Ddi32Base.Set33Namespaces()
Ddi32Base.Set32Namespaces()
Ddi32Base.GetNamespaceManager()
Ddi32Base.SchemaVersion
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Algenta.Colectica.Model.Ddi.Serialization
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class Ddi32Deserializer : Ddi32Base

Constructors

Ddi32Deserializer()

Initializes a new instance of the DDIWorkflowDeserializer class.

Declaration
public Ddi32Deserializer()

Ddi32Deserializer(ItemCache)

Initializes a new instance of the Ddi32Deserializer class.

Declaration
public Ddi32Deserializer(ItemCache itemCache)
Parameters
Type Name Description
ItemCache itemCache

The item cache.

Exceptions
Type Condition
ArgumentNullException

itemCache

Properties

ItemCache

Gets or sets the item cache.

Declaration
public ItemCache ItemCache { get; set; }
Property Value
Type Description
ItemCache

Methods

AddVersionInfo(XElement, IVersionable)

Assign Version information to an item based on identification elements in an XElement

Declaration
protected void AddVersionInfo(XElement element, IVersionable item)
Parameters
Type Name Description
XElement element
IVersionable item

GetActionActivity(XElement)

Deserializes a ActionActivity item from a DDI 3.2 node.

Declaration
public ActionActivity GetActionActivity(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ActionActivity

A populated ActionActivity item.

GetArchive(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected Archive GetArchive(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
Archive

item object

GetArchive(XElement)

Deserializes a Archive item from a DDI 3.2 node.

Declaration
public Archive GetArchive(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Archive

A populated Archive item.

GetBindings(IEnumerable<XElement>)

Get the Bindings from a collection of XElements

Declaration
protected IEnumerable<Binding> GetBindings(IEnumerable<XElement> elements)
Parameters
Type Name Description
IEnumerable<XElement> elements
Returns
Type Description
IEnumerable<Binding>

GetCategory(XElement)

Deserializes a Category item from a DDI 3.2 node.

Declaration
public Category GetCategory(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Category

A populated Category item.

GetCategoryGroup(XElement)

Deserializes a CategoryGroup item from a DDI 3.2 node.

Declaration
public CategoryGroup GetCategoryGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CategoryGroup

A populated CategoryGroup item.

GetCategoryScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected CategoryScheme GetCategoryScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
CategoryScheme

item object

GetCategoryScheme(XElement)

Deserializes a CategoryScheme item from a DDI 3.2 node.

Declaration
public CategoryScheme GetCategoryScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CategoryScheme

A populated CategoryScheme item.

GetCodeList(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected CodeList GetCodeList(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
CodeList

item object

GetCodeList(XElement)

Deserializes a CodeList item from a DDI 3.2 node.

Declaration
public CodeList GetCodeList(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CodeList

A populated CodeList item.

GetCodeListGroup(XElement)

Deserializes a CodeListGroup item from a DDI 3.2 node.

Declaration
public CodeListGroup GetCodeListGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CodeListGroup

A populated CodeListGroup item.

GetCodeListScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected CodeListScheme GetCodeListScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
CodeListScheme

item object

GetCodeListScheme(XElement)

Deserializes a CodeListScheme item from a DDI 3.2 node.

Declaration
public CodeListScheme GetCodeListScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CodeListScheme

A populated CodeListScheme item.

GetCodeValueTypes(IEnumerable<XElement>)

Get code values based on a list of XElements

Declaration
protected IEnumerable<CodeValue> GetCodeValueTypes(IEnumerable<XElement> elements)
Parameters
Type Name Description
IEnumerable<XElement> elements
Returns
Type Description
IEnumerable<CodeValue>

GetConcept(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected Concept GetConcept(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
Concept

item object

GetConcept(XElement)

Deserializes a Concept item from a DDI 3.2 node.

Declaration
public Concept GetConcept(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Concept

A populated Concept item.

GetConceptGroup(XElement)

Deserializes a ConcepGroup item from a DDI 3.2 node.

Declaration
public ConceptGroup GetConceptGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ConceptGroup

A populated ConceptGroup item.

GetConceptScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected ConceptScheme GetConceptScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
ConceptScheme

item object

GetConceptScheme(XElement)

Deserializes a ConceptScheme item from a DDI 3.2 node.

Declaration
public ConceptScheme GetConceptScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ConceptScheme

A populated ConceptScheme item.

GetConceptualComponent(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected ConceptualComponent GetConceptualComponent(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
ConceptualComponent

item object

GetConceptualComponent(XElement)

Deserializes a ConceptualComponent item from a DDI 3.2 node.

Declaration
public ConceptualComponent GetConceptualComponent(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ConceptualComponent

A populated ConceptualComponent item.

GetConceptualVariable(XElement)

Deserializes a ConceptualVariable item from a DDI 3.2 node.

Declaration
public ConceptualVariable GetConceptualVariable(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ConceptualVariable

A populated ConceptualVariable item.

GetConceptualVariableGroup(XElement)

Deserializes a ConceptualVariableGroup item from a DDI 3.2 node.

Declaration
public ConceptualVariableGroup GetConceptualVariableGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ConceptualVariableGroup

A populated ConceptualVariableGroup item.

GetConceptualVariableScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected ConceptualVariableScheme GetConceptualVariableScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
ConceptualVariableScheme

item object

GetConceptualVariableScheme(XElement)

Deserializes a ConceptualVariableScheme item from a DDI 3.2 node.

Declaration
public ConceptualVariableScheme GetConceptualVariableScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ConceptualVariableScheme

A populated ConceptualVariableScheme item.

GetControlConstruct(TypedIdTriple)

Get an item instance, either from the cache or new

Declaration
protected ActivityBase GetControlConstruct(TypedIdTriple id)
Parameters
Type Name Description
TypedIdTriple id

Identity of the item

Returns
Type Description
ActivityBase

item object

GetControlConstructGroup(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected ControlConstructGroup GetControlConstructGroup(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
ControlConstructGroup

item object

GetControlConstructGroup(XElement)

Deserializes a ControlConstructGroup item from a DDI 3.2 node.

Declaration
public ControlConstructGroup GetControlConstructGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ControlConstructGroup

A populated ControlConstructGroup item.

GetControlConstructScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected ControlConstructScheme GetControlConstructScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
ControlConstructScheme

item object

GetControlConstructScheme(XElement)

Deserializes a ControlConstructScheme item from a DDI 3.2 node.

Declaration
public ControlConstructScheme GetControlConstructScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ControlConstructScheme

A populated ControlConstructScheme item.

GetDataCollection(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected DataCollection GetDataCollection(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
DataCollection

item object

GetDataCollection(XElement)

Deserializes a DataCollection item from a DDI 3.2 node.

Declaration
public DataCollection GetDataCollection(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
DataCollection

A populated DataCollection item.

GetDataCollectionMethodology(XElement)

Deserializes a DataCollectionMethodology item from a DDI 3.2 node.

Declaration
public DataCollectionMethodology GetDataCollectionMethodology(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
DataCollectionMethodology

A populated DataCollectionMethodology item.

GetDataRelationship(XElement)

Deserializes a DataRelationship item from a DDI 3.2 node.

Declaration
public DataRelationship GetDataRelationship(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
DataRelationship

A populated DataRelationship item.

GetDdiInstance(XElement)

Deserializes a DdiInstance item from a DDI 3.2 node.

Declaration
public DdiInstance GetDdiInstance(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
DdiInstance

A populated DdiInstance item.

GetFundingInformation(XElement)

Get funding information from an XElement

Declaration
protected FundingInformation GetFundingInformation(XElement element)
Parameters
Type Name Description
XElement element
Returns
Type Description
FundingInformation

GetGeneralInstructionCoding(XElement)

Deserializes a GeneralInstruction item from a DDI 3.2 node.

Declaration
public GeneralInstructionCoding GetGeneralInstructionCoding(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
GeneralInstructionCoding

A populated GeneralInstruction item.

GetGenerationInstructionCoding(XElement)

Deserializes a GenerationInstruction item from a DDI 3.2 node.

Declaration
public GenerationInstructionCoding GetGenerationInstructionCoding(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
GenerationInstructionCoding

A populated GenerationInstruction item.

GetGeographicLocation(XElement)

Deserializes a GeographicLocation item from a DDI 3.2 node.

Declaration
public GeographicLocation GetGeographicLocation(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
GeographicLocation

A populated GeographicLocation item.

GetGeographicLocationScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected GeographicLocationScheme GetGeographicLocationScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
GeographicLocationScheme

item object

GetGeographicLocationScheme(XElement)

Deserializes a GeographicLocationScheme item from a DDI 3.2 node.

Declaration
public GeographicLocationScheme GetGeographicLocationScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
GeographicLocationScheme

A populated GeographicLocationScheme item.

GetGroup(XElement)

Deserializes a Group item from a DDI 3.2 node.

Declaration
public Group GetGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Group

A populated Group item.

GetIfElseActivity(XElement)

Deserializes a IfElseActivity item from a DDI 3.2 node.

Declaration
public CustomIfElseActivity GetIfElseActivity(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CustomIfElseActivity

A populated IfElseActivity item.

GetIndividual(IdentifierTriple)

Get an Individual by id

Declaration
protected Individual GetIndividual(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

id

Returns
Type Description
Individual

Individual

GetIndividual(XElement)

Deserializes a Individual item from a DDI 3.2 node.

Declaration
public Individual GetIndividual(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Individual

A populated Individual item.

GetInstrument(XElement)

Deserializes a Instrument item from a DDI 3.2 node.

Declaration
public Instrument GetInstrument(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Instrument

A populated Instrument item.

GetInstrumentGroup(XElement)

Deserializes a InstrumentGroup item from a DDI 3.2 node.

Declaration
public InstrumentGroup GetInstrumentGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
InstrumentGroup

A populated InstrumentGroup item.

GetInstrumentScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected InstrumentScheme GetInstrumentScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
InstrumentScheme

item object

GetInstrumentScheme(XElement)

Deserializes a InstrumentScheme item from a DDI 3.2 node.

Declaration
public InstrumentScheme GetInstrumentScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
InstrumentScheme

A populated InstrumentScheme item.

GetInterviewerInstruction(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected InterviewerInstruction GetInterviewerInstruction(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
InterviewerInstruction

item object

GetInterviewerInstruction(XElement)

Deserializes a InterviewerInstruction item from a DDI 3.2 node.

Declaration
public InterviewerInstruction GetInterviewerInstruction(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
InterviewerInstruction

A populated InterviewerInstruction item.

GetInterviewerInstructionGroup(XElement)

Deserializes a InstructionGroup item from a DDI 3.2 node.

Declaration
public InstructionGroup GetInterviewerInstructionGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
InstructionGroup

A populated InstructionGroup item.

GetInterviewerInstructionScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected InterviewerInstructionScheme GetInterviewerInstructionScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
InterviewerInstructionScheme

item object

GetInterviewerInstructionScheme(XElement)

Deserializes a InterviewerInstructionScheme item from a DDI 3.2 node.

Declaration
public InterviewerInstructionScheme GetInterviewerInstructionScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
InterviewerInstructionScheme

A populated InterviewerInstructionScheme item.

GetItemUserAttributes(XElement, IHasCustomFields)

Get a list of all user attribute pairs. Add any custom fields that are found as well.

Declaration
protected List<UserAttribute> GetItemUserAttributes(XElement element, IHasCustomFields item)
Parameters
Type Name Description
XElement element
IHasCustomFields item
Returns
Type Description
List<UserAttribute>

All user attributes

GetLogicalProduct(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected LogicalProduct GetLogicalProduct(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
LogicalProduct

item object

GetLogicalProduct(XElement)

Deserializes a LogicalProduct item from a DDI 3.2 node.

Declaration
public LogicalProduct GetLogicalProduct(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
LogicalProduct

A populated LogicalProduct item.

GetLoopActivity(XElement)

Deserializes a LoopActivity item from a DDI 3.2 node.

Declaration
public CustomLoopActivity GetLoopActivity(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CustomLoopActivity

A populated LoopActivity item.

GetManagedDateTimeRepresentation(XElement)

Deserializes a ManagedDateTimeRepresentation item from a DDI 3.2 node.

Declaration
public ManagedDateTimeRepresentation GetManagedDateTimeRepresentation(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ManagedDateTimeRepresentation

A populated ManagedDateTimeRepresentation item.

GetManagedMissingValuesRepresentation(XElement)

Deserializes a ManagedMissingValuesRepresentation item from a DDI 3.2 node.

Declaration
public ManagedMissingValuesRepresentation GetManagedMissingValuesRepresentation(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ManagedMissingValuesRepresentation

A populated ManagedMissingValuesRepresentation item.

GetManagedNumericRepresentation(XElement)

Deserializes a ManagedNumericRepresentation item from a DDI 3.2 node.

Declaration
public ManagedNumericRepresentation GetManagedNumericRepresentation(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ManagedNumericRepresentation

A populated ManagedNumericRepresentation item.

GetManagedRepresentationGroup(XElement)

Deserializes a ManagedRepresentationGroup item from a DDI 3.2 node.

Declaration
public ManagedRepresentationGroup GetManagedRepresentationGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ManagedRepresentationGroup

A populated ManagedRepresentationGroup item.

GetManagedRepresentationScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected ManagedRepresentationScheme GetManagedRepresentationScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
ManagedRepresentationScheme

item object

GetManagedRepresentationScheme(XElement)

Deserializes a ManagedRepresentationScheme item from a DDI 3.2 node.

Declaration
public ManagedRepresentationScheme GetManagedRepresentationScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ManagedRepresentationScheme

A populated ManagedRepresentationScheme item.

GetManagedScaleRepresentation(XElement)

Deserializes a ManagedScaleRepresentation item from a DDI 3.2 node.

Declaration
public ManagedScaleRepresentation GetManagedScaleRepresentation(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ManagedScaleRepresentation

A populated ManagedScaleRepresentation item.

GetManagedTextRepresentation(XElement)

Deserializes a ManagedTextRepresentation item from a DDI 3.2 node.

Declaration
public ManagedTextRepresentation GetManagedTextRepresentation(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ManagedTextRepresentation

A populated ManagedTextRepresentation item.

GetNCube(XElement)

Deserializes a NCube item from a DDI 3.2 node.

Declaration
public NCube GetNCube(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
NCube

A populated NCube item.

GetNCubeGroup(XElement)

Deserializes a NCubeGroup item from a DDI 3.2 node.

Declaration
public NCubeGroup GetNCubeGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
NCubeGroup

A populated NCubeGroup item.

GetNCubeScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected NCubeScheme GetNCubeScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
NCubeScheme

item object

GetNCubeScheme(XElement)

Deserializes a NCubeScheme item from a DDI 3.2 node.

Declaration
public NCubeScheme GetNCubeScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
NCubeScheme

A populated NCubeScheme item.

GetOrganization(IdentifierTriple)

Get an Organization by id

Declaration
protected Organization GetOrganization(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

id

Returns
Type Description
Organization

Organization

GetOrganization(XElement)

Deserializes a Organization item from a DDI 3.2 node.

Declaration
public Organization GetOrganization(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Organization

A populated Organization item.

GetOrganizationGroup(XElement)

Deserializes a OrganizationGroup item from a DDI 3.2 node.

Declaration
public OrganizationGroup GetOrganizationGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
OrganizationGroup

A populated OrganizationGroup item.

GetOrganizationScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected OrganizationScheme GetOrganizationScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
OrganizationScheme

item object

GetOrganizationScheme(XElement)

Deserializes a OrganizationScheme item from a DDI 3.2 node.

Declaration
public OrganizationScheme GetOrganizationScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
OrganizationScheme

A populated OrganizationScheme item.

GetOtherMaterial32(XElement)

Parse a DDI 3.2 other material

Declaration
public virtual OtherMaterial GetOtherMaterial32(XElement element)
Parameters
Type Name Description
XElement element
Returns
Type Description
OtherMaterial

GetOtherMaterial33(IdentifierTriple)

Get an other material based on an identifier

Declaration
protected OtherMaterial GetOtherMaterial33(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple
Returns
Type Description
OtherMaterial

GetOtherMaterial33(XElement)

Deserializes a OtherMaterial item from a DDI 3.3 node.

Declaration
public OtherMaterial GetOtherMaterial33(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.3 node.

Returns
Type Description
OtherMaterial

A populated OtherMaterial item.

GetOtherMaterialsFromWrapper(XElement)

Get an other material

Declaration
protected OtherMaterial GetOtherMaterialsFromWrapper(XElement wrapper)
Parameters
Type Name Description
XElement wrapper
Returns
Type Description
OtherMaterial

GetOtherMaterialsFromWrappers(IEnumerable<XElement>)

Get a list of other materials

Declaration
protected IEnumerable<OtherMaterial> GetOtherMaterialsFromWrappers(IEnumerable<XElement> wrappers)
Parameters
Type Name Description
IEnumerable<XElement> wrappers
Returns
Type Description
IEnumerable<OtherMaterial>

GetParameters(IEnumerable<XElement>)

Get the Parameters from a list of XElements

Declaration
protected IEnumerable<Parameter> GetParameters(IEnumerable<XElement> elements)
Parameters
Type Name Description
IEnumerable<XElement> elements
Returns
Type Description
IEnumerable<Parameter>

GetPhysicalDataProduct(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected PhysicalProduct GetPhysicalDataProduct(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
PhysicalProduct

item object

GetPhysicalDataProduct(XElement)

Deserializes a PhysicalDataProduct item from a DDI 3.2 node.

Declaration
public PhysicalProduct GetPhysicalDataProduct(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
PhysicalProduct

A populated PhysicalDataProduct item.

GetPhysicalInstance(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected PhysicalInstance GetPhysicalInstance(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
PhysicalInstance

item object

GetPhysicalInstance(XElement)

Deserializes a PhysicalInstance item from a DDI 3.2 node.

Declaration
public PhysicalInstance GetPhysicalInstance(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
PhysicalInstance

A populated PhysicalInstance item.

GetPhysicalStructure(XElement)

Deserializes a PhysicalStructure item from a DDI 3.2 node.

Declaration
public PhysicalStructure GetPhysicalStructure(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
PhysicalStructure

A populated PhysicalStructure item.

GetPhysicalStructureScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected PhysicalStructureScheme GetPhysicalStructureScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
PhysicalStructureScheme

item object

GetPhysicalStructureScheme(XElement)

Deserializes a PhysicalStructureScheme item from a DDI 3.2 node.

Declaration
public PhysicalStructureScheme GetPhysicalStructureScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
PhysicalStructureScheme

A populated PhysicalStructureScheme item.

GetProcessingEvent(XElement)

Deserializes a ProcessingEvent item from a DDI 3.2 node.

Declaration
public ProcessingEvent GetProcessingEvent(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ProcessingEvent

A populated ProcessingEvent item.

GetProcessingEventGroup(XElement)

Deserializes a ProcessingEventGroup item from a DDI 3.2 node.

Declaration
public ProcessingEventGroup GetProcessingEventGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ProcessingEventGroup

A populated ProcessingEventGroup item.

GetProcessingEventScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected ProcessingEventScheme GetProcessingEventScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
ProcessingEventScheme

item object

GetProcessingEventScheme(XElement)

Deserializes a ProcessingEventScheme item from a DDI 3.2 node.

Declaration
public ProcessingEventScheme GetProcessingEventScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ProcessingEventScheme

A populated ProcessingEventScheme item.

GetProcessingInstructionGroup(XElement)

Deserializes a ProcessingInstructionGroup item from a DDI 3.2 node.

Declaration
public ProcessingInstructionGroup GetProcessingInstructionGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ProcessingInstructionGroup

A populated ProcessingInstructionGroup item.

GetProcessingInstructionScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected ProcessingInstructionScheme GetProcessingInstructionScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
ProcessingInstructionScheme

item object

GetProcessingInstructionScheme(XElement)

Deserializes a ProcessingInstructionScheme item from a DDI 3.2 node.

Declaration
public ProcessingInstructionScheme GetProcessingInstructionScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ProcessingInstructionScheme

A populated ProcessingInstructionScheme item.

GetQualityStandard(XElement)

Deserializes a QualityStandard item from a DDI 3.2 node.

Declaration
public QualityStandard GetQualityStandard(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
QualityStandard

A populated QualityStandard item.

GetQualityStatement(XElement)

Deserializes a QualityStatement item from a DDI 3.2 node.

Declaration
public QualityStatement GetQualityStatement(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
QualityStatement

A populated QualityStatement item.

GetQualityStatementGroup(XElement)

Deserializes a QualityStatementGroup item from a DDI 3.2 node.

Declaration
public QualityStatementGroup GetQualityStatementGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
QualityStatementGroup

A populated QualityStatementGroup item.

GetQualityStatementScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected QualityStatementScheme GetQualityStatementScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
QualityStatementScheme

item object

GetQualityStatementScheme(XElement)

Deserializes a QualityStatementScheme item from a DDI 3.2 node.

Declaration
public QualityStatementScheme GetQualityStatementScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
QualityStatementScheme

A populated QualityStatementScheme item.

GetQuestion(XElement)

Deserializes a Question item from a DDI 3.2 node.

Declaration
public Question GetQuestion(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Question

A populated Question item.

GetQuestionActivity(XElement)

Deserializes a QuestionActivity item from a DDI 3.2 node.

Declaration
public QuestionActivity GetQuestionActivity(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
QuestionActivity

A populated QuestionActivity item.

GetQuestionBlock(XElement)

Deserializes a QuestionBlock item from a DDI 3.2 node.

Declaration
public QuestionBlock GetQuestionBlock(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
QuestionBlock

A populated QuestionBlock item.

GetQuestionGrid(XElement)

Deserializes a QuestionGrid item from a DDI 3.2 node.

Declaration
public QuestionGrid GetQuestionGrid(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
QuestionGrid

A populated QuestionGrid item.

GetQuestionGroup(XElement)

Deserializes a QuestionGroup item from a DDI 3.2 node.

Declaration
public QuestionGroup GetQuestionGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
QuestionGroup

A populated QuestionGroup item.

GetQuestionScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected QuestionScheme GetQuestionScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
QuestionScheme

item object

GetQuestionScheme(XElement)

Deserializes a QuestionScheme item from a DDI 3.2 node.

Declaration
public QuestionScheme GetQuestionScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
QuestionScheme

A populated QuestionScheme item.

GetRecordLayout(XElement)

Deserializes a RecordLayout item from a DDI 3.2 node.

Declaration
public RecordLayout GetRecordLayout(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
RecordLayout

A populated RecordLayout item.

GetRecordLayoutScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected RecordLayoutScheme GetRecordLayoutScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
RecordLayoutScheme

item object

GetRecordLayoutScheme(XElement)

Deserializes a RecordLayoutScheme item from a DDI 3.2 node.

Declaration
public RecordLayoutScheme GetRecordLayoutScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
RecordLayoutScheme

A populated RecordLayoutScheme item.

GetRepresentationType(XElement)

Get the response domains within an XElement parent

Declaration
protected List<ResponseDomain> GetRepresentationType(XElement parent)
Parameters
Type Name Description
XElement parent
Returns
Type Description
List<ResponseDomain>

GetRepresentedVariable(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected RepresentedVariable GetRepresentedVariable(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
RepresentedVariable

item object

GetRepresentedVariable(XElement)

Deserializes a RepresentedVariable item from a DDI 3.2 node.

Declaration
public RepresentedVariable GetRepresentedVariable(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
RepresentedVariable

A populated RepresentedVariable item.

GetRepresentedVariableGroup(XElement)

Deserializes a RepresentedVariableGroup item from a DDI 3.2 node.

Declaration
public RepresentedVariableGroup GetRepresentedVariableGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
RepresentedVariableGroup

A populated RepresentedVariableGroup item.

GetRepresentedVariableScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected RepresentedVariableScheme GetRepresentedVariableScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
RepresentedVariableScheme

item object

GetRepresentedVariableScheme(XElement)

Deserializes a RepresentedVariableScheme item from a DDI 3.2 node.

Declaration
public RepresentedVariableScheme GetRepresentedVariableScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
RepresentedVariableScheme

A populated RepresentedVariableScheme item.

GetResourcePackage(XElement)

Deserializes a ResourcePackage item from a DDI 3.2 node.

Declaration
public ResourcePackage GetResourcePackage(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
ResourcePackage

A populated ResourcePackage item.

GetSequence(XElement)

Deserializes a CustomSequenceActivity item from a DDI 3.2 node.

Declaration
public CustomSequenceActivity GetSequence(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CustomSequenceActivity

A populated CustomSequenceActivity item.

GetStatementActivity(XElement)

Deserializes a StatementActivity item from a DDI 3.2 node.

Declaration
public StatementActivity GetStatementActivity(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
StatementActivity

A populated StatementActivity item.

GetStudyUnit(XElement)

Deserializes a StudyUnit item from a DDI 3.2 node.

Declaration
public StudyUnit GetStudyUnit(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
StudyUnit

A populated StudyUnit item.

GetSubGroup(XElement)

Deserializes a SubGroup item from a DDI 3.2 node.

Declaration
public SubGroup GetSubGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
SubGroup

A populated SubGroup item.

GetUniverse(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected Universe GetUniverse(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
Universe

item object

GetUniverse(XElement)

Deserializes a Universe item from a DDI 3.2 node.

Declaration
public Universe GetUniverse(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Universe

A populated Universe item.

GetUniverseGroup(XElement)

Deserializes a UniverseGroup item from a DDI 3.2 node.

Declaration
public UniverseGroup GetUniverseGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
UniverseGroup

A populated UniverseGroup item.

GetUniverseScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected UniverseScheme GetUniverseScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
UniverseScheme

item object

GetUniverseScheme(XElement)

Deserializes a UniverseScheme item from a DDI 3.2 node.

Declaration
public UniverseScheme GetUniverseScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
UniverseScheme

A populated UniverseScheme item.

GetUntilActivity(XElement)

Deserializes a CustomUntilActivity item from a DDI 3.2 node.

Declaration
public CustomUntilActivity GetUntilActivity(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CustomUntilActivity

A populated CustomUntilActivity item.

GetVariable(XElement)

Deserializes a Variable item from a DDI 3.2 node.

Declaration
public Variable GetVariable(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
Variable

A populated Variable item.

GetVariableGroup(XElement)

Deserializes a VariableGroup item from a DDI 3.2 node.

Declaration
public VariableGroup GetVariableGroup(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
VariableGroup

A populated VariableGroup item.

GetVariableScheme(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected VariableScheme GetVariableScheme(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
VariableScheme

item object

GetVariableScheme(XElement)

Deserializes a VariableScheme item from a DDI 3.2 node.

Declaration
public VariableScheme GetVariableScheme(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
VariableScheme

A populated VariableScheme item.

GetVariableStatistics(XElement)

Deserializes a VariableStatistic item from a DDI 3.2 node.

Declaration
public VariableStatistic GetVariableStatistics(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
VariableStatistic

A populated VariableStatistic item.

GetVersionInfo(XElement)

Read the version information from an xml element

Declaration
protected IdentifierTriple GetVersionInfo(XElement element)
Parameters
Type Name Description
XElement element

element

Returns
Type Description
IdentifierTriple

id

GetWeightingMethodology(IdentifierTriple)

Get an item instance, either from the cache or new

Declaration
protected WeightingMethodology GetWeightingMethodology(IdentifierTriple triple)
Parameters
Type Name Description
IdentifierTriple triple

Identity of the item

Returns
Type Description
WeightingMethodology

item object

GetWeightingMethodology(XElement)

Deserializes a WeightingMethodology item from a DDI 3.2 node.

Declaration
public WeightingMethodology GetWeightingMethodology(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
WeightingMethodology

A populated WeightingMethodology item.

GetWhileActivity(XElement)

Deserializes a CustomWhileActivity item from a DDI 3.2 node.

Declaration
public CustomWhileActivity GetWhileActivity(XElement element)
Parameters
Type Name Description
XElement element

The DDI 3.2 node.

Returns
Type Description
CustomWhileActivity

A populated CustomWhileActivity item.

HarmonizeIdentifiers(XDocument, DdiFileFormat, IIdentifierService)

Perform second level validation on a schema validated XDoc with included post schema validation infoset

Declaration
public HarmonizationResult HarmonizeIdentifiers(XDocument doc, DdiFileFormat format, IIdentifierService identifierService = null)
Parameters
Type Name Description
XDocument doc

Validated XDocument

DdiFileFormat format

DDI file format

IIdentifierService identifierService

Service to assign uuids based on a context string

Returns
Type Description
HarmonizationResult

LoadFragments(XDocument)

Loads a DDI Fragment Document

Declaration
public FragmentInstance LoadFragments(XDocument doc)
Parameters
Type Name Description
XDocument doc

The Document to load.

Returns
Type Description
FragmentInstance

A DDI FragmentInstance.

NormalizeCultureCode(string)

Normalize a culture string in accordance with BCP 47

Declaration
public static string NormalizeCultureCode(string rawCulture)
Parameters
Type Name Description
string rawCulture

non-normalized culture string

Returns
Type Description
string

ParseItemUrn(string)

Parses a URN into an IdentifierTriple.

Declaration
public static IdentifierTriple ParseItemUrn(string urn)
Parameters
Type Name Description
string urn
Returns
Type Description
IdentifierTriple

PopulateCultureAndAudiences(XElement, MultilingualString, string)

Populate one language into a multilingual string

Declaration
public virtual void PopulateCultureAndAudiences(XElement element, MultilingualString multilingualString, string culture)
Parameters
Type Name Description
XElement element
MultilingualString multilingualString
string culture
In this article
Back to top Generated by DocFX