VB.Net Sample : Simple Sequence
In This Topic
VB.Net Sample : Simple Sequence
| Schema Summary This sample shows an element containing a sequence of simple elements and attributes. Schema Details The Element DVD contains a sequence of simple elements (simple because they are represented by primitives). All of these elements are required, and they must appear in the correct order. In addition the DVD element contains 2 attributes Genre and Cost. Genre is optional, Cost is Mandatory. Because Genre is optional, and contains primitive data, an IsValidGenre method is added to the generated DVD object. This allows you to determine if Genre was set or not. The generated classes take car of outputting the child elements in the correct order. Sample Description The sample demonstrates the element with some of the optional elements missing. Note Genre is an optional primitive, so we should check it using the IsValid flag before accessing it |
Sample XML File
  Sample1.xml |
<?xml version="1.0" encoding="UTF-8"?>
<DVD xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="..\Schema\SimpleSequence.xsd" Cost="12.99">
<Title>From Hell</Title>
<Description>A film about Jack the Ripper</Description>
<ReleaseDate>2001-08-15</ReleaseDate>
</DVD>
|
Sample Code
| Read Sample |
|
SampleRead(Module1.SamplePath + "SimpleSequence\Samples\Sample1.xml")
Public Shared Sub SampleRead(ByVal FilePath As String)
' Create DVD object
Dim dvd As SimpleSequenceLib.DVD = New SimpleSequenceLib.DVD()
' Load data into the object from a file
dvd.FromXmlFile(FilePath)
' Now we can look at the data
Console.WriteLine("DVD Title = {0}", dvd.Title)
Console.WriteLine("DVD Description = {0}", dvd.Description)
Console.WriteLine("DVD Release Date = {0}", dvd.ReleaseDate.ToString())
Console.WriteLine("DVD Cost = {0}", dvd.Cost)
If (Not dvd.Genre Is Nothing) Then
Console.WriteLine("DVD Genre = {0}", dvd.Genre)
End If
|
| Write Sample |
|
' Create DVD object
Dim dvd As SimpleSequenceLib.DVD = New SimpleSequenceLib.DVD()
' Now we can look at the data
dvd.Title = "From Hell"
dvd.Description = "A film about Jack the Ripper"
dvd.ReleaseDate.SetDate(2001, 8, 15)
dvd.Cost = 12.99
' Now we can look at the XML from this object
Console.WriteLine(dvd.ToXml(True, System.Xml.Formatting.Indented, LiquidTechnologies.Runtime.EOLType.CRLF))
|
XSD Source Files
| SimpleSequence.xsd |
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:element name="DVD">
<xs:complexType>
<xs:sequence>
<xs:element name="Title" type="xs:string"/>
<xs:element name="Description" type="xs:string"/>
<xs:element name="ReleaseDate" type="xs:date"/>
</xs:sequence>
<xs:attribute name="Genre" type="xs:string" use="optional"/>
<xs:attribute name="Cost" type="xs:double" use="required"/>
</xs:complexType>
</xs:element>
</xs:schema>
|
| Schema Diagrams |
 |
Generated Files
| DVD.vb |
Option Explicit On
Option Strict On
Imports System
Imports System.Xml
'**********************************************************************************************
'* Copyright (c) 2001-2023 Liquid Technologies Limited. All rights reserved.
'* See www.liquid-technologies.com for product details.
'*
'* Please see products End User License Agreement for distribution permissions.
'*
'* WARNING: THIS FILE IS GENERATED
'* Changes made outside of ##HAND_CODED_BLOCK_START blocks will be overwritten
'*
'* Generation : by Liquid XML Data Binder 19.0.14.11049
'* Using Schema: SimpleSequence.xsd
'**********************************************************************************************
Namespace SimpleSequenceLib
''' <summary>
''' This class represents the Element DVD
''' </summary>
<LiquidTechnologies.Runtime.XmlObjectInfo(LiquidTechnologies.Runtime.XmlObjectBase.XmlElementGroupType.Sequence, _
LiquidTechnologies.Runtime.XmlObjectBase.XmlElementType.Element, _
"DVD", "", true, false, false)> _
Public Partial Class DVD
Inherits SimpleSequenceLib.XmlCommonBase
#Region "Constructors"
''' <summary>
''' Constructor for DVD
''' </summary>
''' <remarks>
''' The class is created with all the mandatory fields populated with the
''' default data.
''' All Collection object are created.
''' However any 1-n relationships (these are represented as collections) are
''' empty. To comply with the schema these must be populated before the xml
''' obtained from ToXml is valid against the schema SimpleSequence.xsd
''' </remarks>
Public Sub New()
_elementName = "DVD"
Init()
End Sub
Public Sub New(ByVal elementName As String)
_elementName = elementName
Init()
End Sub
#End Region
#Region "Initialization methods for the class"
''' <summary>
''' Initializes the class
''' </summary>
''' <remarks>
''' This creates all the mandatory fields (populated with the default data)
''' All Collection object are created.
''' However any 1-n relationships (these are represented as collections) are
''' empty. To comply with the schema these must be populated before the xml
''' obtained from ToXml is valid against the schema SimpleSequence.xsd.
''' </remarks>
Protected Overrides Sub Init()
SimpleSequenceLib.Registration.iRegistrationIndicator = 0 ' causes registration to take place
_Genre = Nothing
_Cost = 0
_Title = ""
_Description = ""
_ReleaseDate = New LiquidTechnologies.Runtime.XmlDateTime(LiquidTechnologies.Runtime.XmlDateTime.DateType.date)
' ##HAND_CODED_BLOCK_START ID="Additional Inits"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
' Add Additional initialization code here...
' ##HAND_CODED_BLOCK_END ID="Additional Inits"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
End Sub
#End Region
#Region "ICloneable Interface"
''' <summary>
''' Allows the class to be copied
''' </summary>
''' <remarks>
''' Performs a 'deep copy' of all the data in the class (and its children)
''' </remarks>
Public Overrides Function Clone() As Object
Dim newObject As New SimpleSequenceLib.DVD(_elementName)
Dim o As Object
newObject._Genre = _Genre
newObject._Cost = _Cost
newObject._Title = _Title
newObject._Description = _Description
newObject._ReleaseDate = CType(_ReleaseDate.Clone(), LiquidTechnologies.Runtime.XmlDateTime)
o = Nothing
' ##HAND_CODED_BLOCK_START ID="Additional clone"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
' Add Additional clone code here...
' ##HAND_CODED_BLOCK_END ID="Additional clone"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
Return newObject
End Function
#End Region
#Region "Member variables"
Protected Overrides Readonly Property TargetNamespace() As String
Get
Return ""
End Get
End Property
#Region "Attribute - Genre"
''' <summary>
''' Represents an optional Attribute in the XML document
''' </summary>
''' <remarks>
''' This property is represented as an Attribute in the XML.
''' It is optional, initially it is not valid.
''' </remarks>
<LiquidTechnologies.Runtime.AttributeInfoPrimitive("Genre", "", True, LiquidTechnologies.Runtime.Conversions.ConversionType.type_string, Nothing, LiquidTechnologies.Runtime.WhitespaceUtils.WhitespaceRule.Preserve, "", -1, -1, "", "", "", "", -1, -1, -1, Nothing)> _
Public Property Genre() As String
Get
Return _Genre
End Get
Set(ByVal value As String)
If value Is Nothing Then
_Genre = Nothing
Else
' Apply whitespace rules appropriately
value = LiquidTechnologies.Runtime.WhitespaceUtils.Preserve(value)
_Genre = value
End If
End Set
End Property
Protected _Genre As String
#End Region
#Region "Attribute - Cost"
''' <summary>
''' Represents a mandatory Attribute in the XML document
''' </summary>
''' <remarks>
''' This property is represented as an Attribute in the XML.
''' It is mandatory and therefore must be populated within the XML.
''' It is defaulted to 0.
''' </remarks>
<LiquidTechnologies.Runtime.AttributeInfoPrimitive("Cost", "", LiquidTechnologies.Runtime.Conversions.ConversionType.type_r8, Nothing, LiquidTechnologies.Runtime.WhitespaceUtils.WhitespaceRule.Collapse, "", -1, -1, "", "", "", "", -1, -1, -1, Nothing)> _
Public Property Cost() As Double
Get
Return _Cost
End Get
Set(ByVal value As Double)
_Cost = value
End Set
End Property
Protected _Cost As Double
#End Region
#Region "Attribute - Title"
''' <summary>
''' Represents a mandatory Element in the XML document
''' </summary>
''' <remarks>
''' This property is represented as an Element in the XML.
''' It is mandatory and therefore must be populated within the XML.
''' It is defaulted to "".
''' </remarks>
<LiquidTechnologies.Runtime.ElementInfoSeqPrimMnd("Title", "", Nothing, LiquidTechnologies.Runtime.Conversions.ConversionType.type_string, Nothing, LiquidTechnologies.Runtime.WhitespaceUtils.WhitespaceRule.Preserve, "", -1, -1, "", "", "", "", -1, -1, -1, Nothing)> _
Public Property Title() As String
Get
Return _Title
End Get
Set(ByVal value As String)
' Apply whitespace rules appropriately
value = LiquidTechnologies.Runtime.WhitespaceUtils.Preserve(value)
_Title = value
End Set
End Property
Protected _Title As String
#End Region
#Region "Attribute - Description"
''' <summary>
''' Represents a mandatory Element in the XML document
''' </summary>
''' <remarks>
''' This property is represented as an Element in the XML.
''' It is mandatory and therefore must be populated within the XML.
''' It is defaulted to "".
''' </remarks>
<LiquidTechnologies.Runtime.ElementInfoSeqPrimMnd("Description", "", Nothing, LiquidTechnologies.Runtime.Conversions.ConversionType.type_string, Nothing, LiquidTechnologies.Runtime.WhitespaceUtils.WhitespaceRule.Preserve, "", -1, -1, "", "", "", "", -1, -1, -1, Nothing)> _
Public Property Description() As String
Get
Return _Description
End Get
Set(ByVal value As String)
' Apply whitespace rules appropriately
value = LiquidTechnologies.Runtime.WhitespaceUtils.Preserve(value)
_Description = value
End Set
End Property
Protected _Description As String
#End Region
#Region "Attribute - ReleaseDate"
''' <summary>
''' Represents a mandatory Element in the XML document
''' </summary>
''' <remarks>
''' This property is represented as an Element in the XML.
''' It is mandatory and therefore must be populated within the XML.
''' It is defaulted to New LiquidTechnologies.Runtime.XmlDateTime(LiquidTechnologies.Runtime.XmlDateTime.DateType.date).
''' </remarks>
<LiquidTechnologies.Runtime.ElementInfoSeqPrimMnd("ReleaseDate", "", Nothing, LiquidTechnologies.Runtime.Conversions.ConversionType.type_date, Nothing, LiquidTechnologies.Runtime.WhitespaceUtils.WhitespaceRule.Collapse, "", -1, -1, "", "", "", "", -1, -1, -1, Nothing)> _
Public Property ReleaseDate() As LiquidTechnologies.Runtime.XmlDateTime
Get
Return _ReleaseDate
End Get
Set(ByVal value As LiquidTechnologies.Runtime.XmlDateTime)
_ReleaseDate.SetDateTime(value, _ReleaseDate.Type)
End Set
End Property
Protected _ReleaseDate As LiquidTechnologies.Runtime.XmlDateTime
#End Region
#Region "Attribute - Namespace"
Public Overrides Readonly Property [Namespace]() As String
Get
Return ""
End Get
End Property
#End Region
#Region "Attribute - GetBase"
Public Overrides Function GetBase() As LiquidTechnologies.Runtime.XmlObjectBase
Return Me
End Function
#End Region
#End Region
' ##HAND_CODED_BLOCK_START ID="Additional Methods"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
' Add Additional Methods and members here...
' ##HAND_CODED_BLOCK_END ID="Additional Methods"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
End Class
End Namespace
|
| Main Menu | Samples List |