Class DDIWorkflowDeserializer
Deserializes a DDI 3 instance from XML.
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi.Serialization
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class DDIWorkflowDeserializer : DDIWorkflowBaseExamples
string fileName = "myFile.ddi3.xml";
DdiValidator validator = new DdiValidator(fileName);
bool isValid = validator.Validate();
if (isValid)
{
DDIWorkflowDeserializer deserializer = new DDIWorkflowDeserializer();
XmlDocument doc = validator.ValidatedXml;
instance = deserializer.GetDdiInstance(doc.DocumentElement);
}Constructors
DDIWorkflowDeserializer()
Initializes a new instance of the DDIWorkflowDeserializer class.
Declaration
public DDIWorkflowDeserializer()DDIWorkflowDeserializer(ItemCache)
Initializes a new instance of the DDIWorkflowDeserializer class.
Declaration
public DDIWorkflowDeserializer(ItemCache itemCache)Parameters
| Type | Name | Description |
|---|---|---|
| ItemCache | itemCache | The item cache. |
Properties
ItemCache
Gets or sets the item cache.
Declaration
public ItemCache ItemCache { get; set; }Property Value
| Type | Description |
|---|---|
| ItemCache |
Methods
GetActionActivity(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public ActionActivity GetActionActivity(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| ActionActivity | The populated item. |
GetArchive(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Archive GetArchive(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| Archive | The populated item. |
GetCategory(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Category GetCategory(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| Category | The populated item. |
GetCategoryScheme(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public CategoryScheme GetCategoryScheme(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| CategoryScheme | The populated item. |
GetCodeScheme(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public CodeList GetCodeScheme(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| CodeList | The populated item. |
GetCollectionEvent(XmlNode)
Deserializes a CollectionEvent item from a DDI 3.1 node.
Declaration
public CollectionEvent GetCollectionEvent(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| CollectionEvent | A populated CollectionEvent item. |
GetConcept(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Concept GetConcept(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| Concept | The populated item. |
GetConceptScheme(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public ConceptScheme GetConceptScheme(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| ConceptScheme | The populated item. |
GetConceptualComponent(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public ConceptualComponent GetConceptualComponent(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| ConceptualComponent | The populated item. |
GetControlConstructScheme(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public ControlConstructScheme GetControlConstructScheme(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| ControlConstructScheme | The populated item. |
GetCustomLoopActivity(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public CustomLoopActivity GetCustomLoopActivity(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| CustomLoopActivity | The populated item. |
GetCustomUntilActivity(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public CustomUntilActivity GetCustomUntilActivity(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| CustomUntilActivity | The populated item. |
GetCustomWhileActivity(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public CustomWhileActivity GetCustomWhileActivity(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| CustomWhileActivity | The populated item. |
GetDataCollection(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public DataCollection GetDataCollection(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| DataCollection | The populated item. |
GetDataRelationship(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public DataRelationship GetDataRelationship(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| DataRelationship | The populated item. |
GetDdiInstance(XmlNode)
Deserializes a DDIInstance from a DDI 3.1 node.
Declaration
public DdiInstance GetDdiInstance(XmlNode instanceElement)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | instanceElement | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| DdiInstance | A populated DDIInstance. |
GetGroup(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Group GetGroup(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| Group | The populated item. |
GetIfElseActivity(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public CustomIfElseActivity GetIfElseActivity(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| CustomIfElseActivity | The populated item. |
GetInstrument(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Instrument GetInstrument(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| Instrument | The populated item. |
GetInterviewerInstruction(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public InterviewerInstruction GetInterviewerInstruction(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| InterviewerInstruction | The populated item. |
GetInterviewerInstructionScheme(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public InterviewerInstructionScheme GetInterviewerInstructionScheme(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| InterviewerInstructionScheme | The populated item. |
GetLanguagesFromXml(XmlElement)
Detects all languages present in an XML element and its descendents.
Declaration
public Collection<string> GetLanguagesFromXml(XmlElement element)Parameters
| Type | Name | Description |
|---|---|---|
| XmlElement | element | The XML element to search for languages. |
Returns
| Type | Description |
|---|---|
| Collection<System.String> | A collection of languages found in the XML. |
GetLogicalProduct(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public LogicalProduct GetLogicalProduct(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| LogicalProduct | The populated item. |
GetLogicalRecord(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Ddi31LogicalRecord GetLogicalRecord(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| Ddi31LogicalRecord | The populated item. |
GetNoteType(XmlNode)
Deserializes a Note from a DDI 3.1 node.
Declaration
public Note GetNoteType(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| Note | A populated Note. |
GetOrganization(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Organization GetOrganization(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| Organization | The populated item. |
GetOrganizationRelationship(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public OrganizationRelationship GetOrganizationRelationship(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| OrganizationRelationship | The populated item. |
GetOrganizationScheme(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public OrganizationScheme GetOrganizationScheme(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| OrganizationScheme | The populated item. |
GetOtherMaterial(XmlNode)
Deserializes an OtherMaterial item from a DDI 3.1 node.
Declaration
public OtherMaterial GetOtherMaterial(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| OtherMaterial | A populated OtherMaterial item. |
GetPhysicalDataProduct(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public PhysicalProduct GetPhysicalDataProduct(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| PhysicalProduct | The populated item. |
GetPhysicalInstance(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public PhysicalInstance GetPhysicalInstance(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| PhysicalInstance | The populated item. |
GetPhysicalStructure(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public PhysicalStructure GetPhysicalStructure(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| PhysicalStructure | The populated item. |
GetPhysicalStructureScheme(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public PhysicalStructureScheme GetPhysicalStructureScheme(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| PhysicalStructureScheme | The populated item. |
GetQualityStandard(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public QualityStandard GetQualityStandard(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| QualityStandard | The populated item. |
GetQualityStandard(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public QualityStandard GetQualityStandard(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| QualityStandard | The populated item. |
GetQualityStatement(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public QualityStatement GetQualityStatement(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| QualityStatement | The populated item. |
GetQualityStatement(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public QualityStatement GetQualityStatement(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| QualityStatement | The populated item. |
GetQualityStatementScheme(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public QualityStatementScheme GetQualityStatementScheme(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| QualityStatementScheme | The populated item. |
GetQualityStatementScheme(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public QualityStatementScheme GetQualityStatementScheme(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| QualityStatementScheme | The populated item. |
GetQuestion(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Question GetQuestion(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| Question | The populated item. |
GetQuestionActivity(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public QuestionActivity GetQuestionActivity(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| QuestionActivity | The populated item. |
GetQuestionScheme(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public QuestionScheme GetQuestionScheme(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| QuestionScheme | The populated item. |
GetRecordLayout(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public RecordLayout GetRecordLayout(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| RecordLayout | The populated item. |
GetRecordLayoutScheme(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public RecordLayoutScheme GetRecordLayoutScheme(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| RecordLayoutScheme | The populated item. |
GetRecordRelationship(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Ddi31RecordRelationship GetRecordRelationship(XmlNode node, Collection<Note> notes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | notes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| Ddi31RecordRelationship | The populated item. |
GetReferenceType(XmlNode)
Deserializes a reference from a DDI 3.1 node.
Declaration
public IdentifierTriple GetReferenceType(XmlNode parent)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | parent | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| IdentifierTriple | A composite identifier to which the reference refers. |
GetResourcePackage(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public ResourcePackage GetResourcePackage(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| ResourcePackage | The populated item. |
GetSequenceActivity(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public CustomSequenceActivity GetSequenceActivity(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| CustomSequenceActivity | The populated item. |
GetSoftware(XmlNode)
Deserializes a Software item from a DDI 3.1 node.
Declaration
public Software GetSoftware(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| Software | A populated Software item. |
GetStatementActivity(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public StatementActivity GetStatementActivity(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| StatementActivity | The populated item. |
GetStudyUnit(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public StudyUnit GetStudyUnit(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| StudyUnit | The populated item. |
GetUniverse(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Universe GetUniverse(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| Universe | The populated item. |
GetUniverseScheme(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public UniverseScheme GetUniverseScheme(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| UniverseScheme | The populated item. |
GetVariable(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public Variable GetVariable(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| Variable | The populated item. |
GetVariableGroup(XmlNode)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public VariableGroup GetVariableGroup(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
Returns
| Type | Description |
|---|---|
| VariableGroup | The populated item. |
GetVariableScheme(XmlNode, Collection<Note>)
Creates an item for the DDI 3.1 XML node, stores the item a cache, and populates the item with content from the node.
Declaration
public VariableScheme GetVariableScheme(XmlNode node, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
Returns
| Type | Description |
|---|---|
| VariableScheme | The populated item. |
HarmonizeIdentifiers(XmlElement, XmlDocument)
Ensures that all identifiers are UUIDs. When an identifier is not a UUID, a UUID is assigned and the original identifier is stored in a UserID.
Declaration
public HarmonizationResult HarmonizeIdentifiers(XmlElement element, XmlDocument doc)Parameters
| Type | Name | Description |
|---|---|---|
| XmlElement | element | The element to process. |
| XmlDocument | doc | The top-level XML document. |
Returns
| Type | Description |
|---|---|
| HarmonizationResult | The results of the processing. |
InstantiatePopulateOrganizations(XmlNode)
Find all Organizations below a node and instantiate them.
Declaration
public void InstantiatePopulateOrganizations(XmlNode rootNode)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | rootNode | The root node. |
LoadDdiFile(String)
Loads an XML file with a DDIInstance root element.
Declaration
public DdiInstance LoadDdiFile(string filename)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filename | The file to load. |
Returns
| Type | Description |
|---|---|
| DdiInstance | A DDIInstance. |
LoadFragmentFile(String)
Loads a DDI Fragment file.
Declaration
public FragmentInstance LoadFragmentFile(string filename)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filename | The file to load. |
Returns
| Type | Description |
|---|---|
| FragmentInstance | A DDI FragmentInstance. |
LoadFragments(XmlDocument)
Loads a DDI Fragment document
Declaration
public FragmentInstance LoadFragments(XmlDocument doc)Parameters
| Type | Name | Description |
|---|---|---|
| XmlDocument | doc | The document to load. |
Returns
| Type | Description |
|---|---|
| FragmentInstance | A DDI FragmentInstance. |
ParseIrdi(String)
Parses an identifier string of the form [agency]:[identifier]:[version].
Declaration
public static IdentifierTriple ParseIrdi(string irdi)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | irdi | The string to parse. |
Returns
| Type | Description |
|---|---|
| IdentifierTriple | The composite identifier. |
ParseTypedIdTriple(String)
Parses a typed identifier string of the form [agency]:[identifier]:[version]:[type ID].
Declaration
public static TypedIdTriple ParseTypedIdTriple(string str)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | str | The string to parse. |
Returns
| Type | Description |
|---|---|
| TypedIdTriple | The typed composite identifier. |
PopulateActionActivity(XmlNode, Collection<Note>, ActionActivity)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateActionActivity(XmlNode node, Collection<Note> itemNotes, ActionActivity activity)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
| ActionActivity | activity | The item to populate. |
PopulateArchive(XmlNode, Archive, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateArchive(XmlNode node, Archive item, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Archive | item | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateCategory(XmlNode, Category)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateCategory(XmlNode node, Category category)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Category | category | The item to populate. |
PopulateCategoryScheme(XmlNode, CategoryScheme)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateCategoryScheme(XmlNode node, CategoryScheme scheme)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| CategoryScheme | scheme | The item to populate. |
PopulateCodeScheme(XmlNode, CodeList)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateCodeScheme(XmlNode node, CodeList scheme)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| CodeList | scheme | The item to populate. |
PopulateConcept(XmlNode, Concept, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateConcept(XmlNode node, Concept concept, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Concept | concept | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateConceptScheme(XmlNode, ConceptScheme, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateConceptScheme(XmlNode node, ConceptScheme scheme, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| ConceptScheme | scheme | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateConceptualComponent(XmlNode, ConceptualComponent)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateConceptualComponent(XmlNode node, ConceptualComponent conceptualComponent)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| ConceptualComponent | conceptualComponent | The item to populate. |
PopulateControlConstructScheme(XmlNode, ControlConstructScheme, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateControlConstructScheme(XmlNode node, ControlConstructScheme scheme, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| ControlConstructScheme | scheme | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateCultureAndAudiences(XmlNode, MultilingualString, String)
Populate one language into a multilingual string
Declaration
public static void PopulateCultureAndAudiences(XmlNode node, MultilingualString multilingualString, string culture)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | |
| MultilingualString | multilingualString | |
| System.String | culture |
PopulateCustomLoopActivity(XmlNode, CustomLoopActivity)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateCustomLoopActivity(XmlNode node, CustomLoopActivity activity)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| CustomLoopActivity | activity | The item to populate. |
PopulateCustomUntilActivity(XmlNode, CustomUntilActivity)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateCustomUntilActivity(XmlNode node, CustomUntilActivity activity)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| CustomUntilActivity | activity | The item to populate. |
PopulateCustomWhileActivity(XmlNode, CustomWhileActivity)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateCustomWhileActivity(XmlNode node, CustomWhileActivity activity)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| CustomWhileActivity | activity | The item to populate. |
PopulateDataCollection(XmlNode, DataCollection)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateDataCollection(XmlNode node, DataCollection dataCollection)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| DataCollection | dataCollection | The item to populate. |
PopulateDataRelationship(XmlNode, DataRelationship, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateDataRelationship(XmlNode node, DataRelationship item, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| DataRelationship | item | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateDdiInstance(XmlNode)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public DdiInstance PopulateDdiInstance(XmlNode node)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
Returns
| Type | Description |
|---|---|
| DdiInstance | The populated DDIInstance. |
PopulateDdiInstance(XmlNode, DdiInstance)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateDdiInstance(XmlNode node, DdiInstance instance)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| DdiInstance | instance | The item to populate. |
PopulateGroup(XmlNode, Group)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateGroup(XmlNode node, Group group)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Group | group | The item to populate. |
PopulateIfElseActivity(XmlNode, CustomIfElseActivity)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateIfElseActivity(XmlNode node, CustomIfElseActivity activity)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| CustomIfElseActivity | activity | The item to populate. |
PopulateInstrument(XmlNode, Instrument, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateInstrument(XmlNode node, Instrument instrument, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Instrument | instrument | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateInterviewerInstruction(XmlNode, InterviewerInstruction)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateInterviewerInstruction(XmlNode node, InterviewerInstruction instruction)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| InterviewerInstruction | instruction | The item to populate. |
PopulateInterviewerInstructionScheme(XmlNode, InterviewerInstructionScheme)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateInterviewerInstructionScheme(XmlNode node, InterviewerInstructionScheme scheme)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| InterviewerInstructionScheme | scheme | The item to populate. |
PopulateLogicalProduct(XmlNode, LogicalProduct)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateLogicalProduct(XmlNode node, LogicalProduct logicalProduct)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| LogicalProduct | logicalProduct | The item to populate. |
PopulateLogicalRecord(XmlNode, Ddi31LogicalRecord)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateLogicalRecord(XmlNode node, Ddi31LogicalRecord item)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Ddi31LogicalRecord | item | The item to populate. |
PopulateMethodology(XmlNode, DataCollectionMethodology)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateMethodology(XmlNode node, DataCollectionMethodology methodology)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| DataCollectionMethodology | methodology | The item to populate. |
PopulateOrganization(XmlNode, Organization, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateOrganization(XmlNode node, Organization org, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Organization | org | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateOrganizationScheme(XmlNode, OrganizationScheme, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateOrganizationScheme(XmlNode node, OrganizationScheme scheme, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| OrganizationScheme | scheme | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulatePhysicalDataProduct(XmlNode, PhysicalProduct)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulatePhysicalDataProduct(XmlNode node, PhysicalProduct item)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| PhysicalProduct | item | The item to populate. |
PopulatePhysicalInstance(XmlNode, PhysicalInstance)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulatePhysicalInstance(XmlNode node, PhysicalInstance item)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| PhysicalInstance | item | The item to populate. |
PopulatePhysicalStructure(XmlNode, PhysicalStructure)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulatePhysicalStructure(XmlNode node, PhysicalStructure item)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| PhysicalStructure | item | The item to populate. |
PopulatePhysicalStructureScheme(XmlNode, PhysicalStructureScheme)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulatePhysicalStructureScheme(XmlNode node, PhysicalStructureScheme item)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| PhysicalStructureScheme | item | The item to populate. |
PopulateQualityStandard(XmlNode, QualityStandard, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateQualityStandard(XmlNode node, QualityStandard qualityStandard, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| QualityStandard | qualityStandard | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateQualityStatement(XmlNode, QualityStatement, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateQualityStatement(XmlNode node, QualityStatement qualityStatement, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| QualityStatement | qualityStatement | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateQualityStatementScheme(XmlNode, QualityStatementScheme, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateQualityStatementScheme(XmlNode node, QualityStatementScheme scheme, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| QualityStatementScheme | scheme | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateQuestion(XmlNode, Question, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateQuestion(XmlNode node, Question q, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Question | q | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateQuestionActivity(XmlNode, QuestionActivity)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateQuestionActivity(XmlNode node, QuestionActivity activity)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| QuestionActivity | activity | The item to populate. |
PopulateQuestionScheme(XmlNode, QuestionScheme, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateQuestionScheme(XmlNode node, QuestionScheme scheme, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| QuestionScheme | scheme | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateRecordLayout(XmlNode, RecordLayout)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateRecordLayout(XmlNode node, RecordLayout item)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| RecordLayout | item | The item to populate. |
PopulateRecordLayoutScheme(XmlNode, RecordLayoutScheme)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateRecordLayoutScheme(XmlNode node, RecordLayoutScheme item)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| RecordLayoutScheme | item | The item to populate. |
PopulateRecordRelationship(XmlNode, Ddi31RecordRelationship, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateRecordRelationship(XmlNode node, Ddi31RecordRelationship item, Collection<Note> notes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Ddi31RecordRelationship | item | The item to populate. |
| Collection<Note> | notes | A collection of notes about the item. |
PopulateResourcePackage(XmlNode, ResourcePackage)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateResourcePackage(XmlNode node, ResourcePackage library)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| ResourcePackage | library | The item to populate. |
PopulateSequenceActivity(XmlNode, Collection<Note>, CustomSequenceActivity)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateSequenceActivity(XmlNode node, Collection<Note> itemNotes, CustomSequenceActivity activity)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
| CustomSequenceActivity | activity | The item to populate. |
PopulateStatementActivity(XmlNode, StatementActivity, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateStatementActivity(XmlNode node, StatementActivity activity, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| StatementActivity | activity | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateStudyUnit(XmlNode, StudyUnit)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateStudyUnit(XmlNode node, StudyUnit studyUnit)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| StudyUnit | studyUnit | The item to populate. |
PopulateUniverse(XmlNode, Universe, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateUniverse(XmlNode node, Universe universe, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Universe | universe | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateUniverseScheme(XmlNode, UniverseScheme, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateUniverseScheme(XmlNode node, UniverseScheme scheme, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| UniverseScheme | scheme | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateVariable(XmlNode, Variable, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateVariable(XmlNode node, Variable variable, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| Variable | variable | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |
PopulateVariableGroup(XmlNode, VariableGroup)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateVariableGroup(XmlNode node, VariableGroup group)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| VariableGroup | group | The item to populate. |
PopulateVariableScheme(XmlNode, VariableScheme, Collection<Note>)
Populates the item with the contents of the DDI 3.1 XML node.
Declaration
public void PopulateVariableScheme(XmlNode node, VariableScheme scheme, Collection<Note> itemNotes)Parameters
| Type | Name | Description |
|---|---|---|
| XmlNode | node | The DDI 3.1 XML node. |
| VariableScheme | scheme | The item to populate. |
| Collection<Note> | itemNotes | A collection of notes about the item. |