GAMBAS-BUCH 3.19.1

Die Klasse XmlReader (gb.xml) repräsentiert einen XML-Stream-Reader, der die SAX-API implementiert. Diese Klasse beerbt die virtuelle Klasse _XmlReader.

Ein Objekt der Klasse XmlReader (gb.xml) können Sie erzeugen:

Dim hXmlReader As XmlReader 
hXmlReader = New XmlReader() 

Wesentliche Eigenschaften der Klasse XmlReader:

Tabelle 27.3.1.1 : Eigenschaften der Klasse XmlReader

Im folgenden Beispiel sehen Sie, wie Sie auf einfache Art den Inhalt einer XML-Datei in einer TextArea anzeigen können:

Public xmlReader As XmlReader 
Public sXMLPath As String = "files/example.xml" 
 
Public Sub Form_Open() 
 
  Dim sLine As String 
 
  xmlReader = New XmlReader  
  xmlReader.Open(sXMLPath)  
    For Each sLine In XmlReader.InputStream.Lines
      txaXML.Insert(sLine & gb.NewLine) 
    Next 
  xmlReader.Close() 
 
  txaXML.Pos = 0 
 
End 

Wenn Sie sich beim sequentiellen Lesen einer XML-Datei nur für die Attribute interessieren, dann können Sie ausgewählte Knoten-Typen wie Elemente, EndElement und Text so ausblenden:

XmlReader.ReadFlags[XmlReaderNodeType.Attribute] = True 
XmlReader.ReadFlags[XmlReaderNodeType.Element] = False
XmlReader.ReadFlags[XmlReaderNodeType.Text] = False
XmlReader.ReadFlags[XmlReaderNodeType.EndElement] = False

Unter https://gambas-playground.proko.eu/?gist=b90eeff3dacbec0548d01701f3c05133 hat Adrien Prokopowicz ein passendes interaktives Beispiel hinterlegt.

Hier finden Sie die Übersicht zu den Eigenschaften der virtuellen Klasse .XmlReader.Node

Tabelle 27.3.1.1.1 : Eigenschaften der Klasse XmlReader.Node

Die Klasse XmlReader.Node verhält sich wie ein Nur-Lesen-Array:

Dim hXmlReader.Node As XmlReader.Node 
Dim sString As String 
sString = hXmlReader.Node.Attributes[Name As String]

und ist aufzählbar über eine For-Each-Kontrollstruktur:

Dim hXmlReader.Node As XmlReader.Node 
Dim sString As String 
For Each sString In hXmlReader.Node.Attributes 
  ... 
Next

Die virtuelle Klasse .XmlReader.Node.Attributes verfügt über drei Eigenschaften:

Tabelle 27.3.1.2.1 : Eigenschaften der Klasse XmlReader.Node.Attributes

Die Klasse XmlReader.Node.Attributes besitzt nur eine Methode:

Function Exist(Name As String) As Boolean

Die Funktion gibt True zurück, wenn ein Attribut mit dem angegebenen Namen 'Name' für den aktuellen Knoten existiert.

Die Klasse XmlReaderNodeType ist statisch und enthält nur Konstanten:

Attribute (8), CDATA (4), Comment (3), Document (0), DocumentFragment (0), DocumentType (0), Element (0), EndElement (6), EndEntity (0), EndStream (7), Entity (0), EntityReference (0), None (0), Notation (0), ProcessingInstruction (0), SignificantWhitespace (0), Text (2), Whitespace (0), XmlDeclaration (0)

Hier finden Sie die Übersicht zu den vier Methoden der Klasse XmlReader:

Tabelle 27.3.2.1 : Ausgewählte Methoden der Klasse XmlReader

Im vorgestellten Beispiel sollen aus Kontaktdaten – gespeichert in einer XML-Datei – ausgewählte Daten ausgelesen werden und dann in einer TextArea angezeigt werden. Die ausgelesenen, aufbereiteten und in einer Text-Datei abgespeicherten Daten könnten zum Beispiel als Basis für den Druck von Adress-Aufklebern dienen:

Abbildung 27.3.3.1: GUI des Beispiel-Projektes 'XML-Parser'

Der Quelltext wird vollständig angegeben, wobei Sie besonders auf den Quelltext der Funktion GetRecords() achten sollten:

' Gambas class file
 
Public hXMLReader As XmlReader 
Public sXMLPath As String = "files/list.xml" 
 
Public Sub Form_Open()
  ShowXMLContent()  
  txaXML.Pos = 0 
  HSplit1.Layout = [3, 2]
End
 
Public Sub btnShowRecords_Click()
 
  Dim i, j As Integer
  Dim asMatrix As String[]
  Dim avRecords As New Variant[]
  Dim sSpace As String = String$(4, " ")
 
  avRecords = GetRecords()
 
  For i = 0 To avRecords.Max
    asMatrix = New String[]
    asMatrix = avRecords[i]
    txaList.Insert(sSpace & asMatrix[0] & gb.NewLine)
    txaList.Insert(sSpace & asMatrix[1] & " " & asMatrix[2] & gb.NewLine)
    txaList.Insert(sSpace & asMatrix[3] & gb.NewLine)
    txaList.Insert(sSpace & asMatrix[4] & " " & asMatrix[5] & gb.NewLine)
    txaList.Insert(gb.NewLine)
  Next
 
  File.Save(Application.Path &/ "files/addresslist.txt", txaList.Text)  
End
 
Private Sub ShowXMLContent()
 
  Dim sLine As String 
 
  hXMLReader = New XmlReader  
  hXMLReader.Open(sXMLPath)  
    For Each sLine In hXMLReader.InputStream.Lines
      txaXML.Insert(sLine & gb.NewLine) 
    Next 
  hXMLReader.Close() 
 
End
 
Private Function GetRecords() As Variant[]
 
  Dim asRecord As String[]
  Dim avRecords As New Variant[]
 
  txaList.Clear()
  asRecord = New String[]
 
  hXMLReader = New XmlReader  
  hXMLReader.Open(sXMLPath)  
  hXMLReader.Read()
 
  While Not hXMLReader.Eof    
    Select Case hXmlReader.Node.Type
      Case XMLReaderNodeType.Element
        If hXmlReader.Node.Name = "mw" Then 
           hXMLReader.Read()
           If hXmlReader.Node.Value = "w" Then 
              asRecord.Add("Frau", 0)
           Else
              asRecord.Add("Herr", 0)
           Endif
           avRecords.Add(asRecord)
           asRecord = New String[]
        Endif
        If hXmlReader.Node.Name = "vorname" Then 
           hXMLReader.Read()
           asRecord.Add(hXmlReader.Node.Value, 1)
        Endif
        If hXmlReader.Node.Name = "nachname" Then 
           hXMLReader.Read()
           asRecord.Add(hXmlReader.Node.Value, 2)
        Endif
        If hXmlReader.Node.Name = "strasse" Then 
           hXMLReader.Read()
           asRecord.Add(hXmlReader.Node.Value, 3)
        Endif 
        If hXmlReader.Node.Name = "wohnort" Then
           For Each hXmlReader.Node.Attributes ' Zuerst die Attribute auslesen!
             Select Case hXmlReader.Node.Attributes.Name
               Case "plz"
                asRecord.Add(hXmlReader.Node.Attributes.Value, 4)
             End Select
           Next
           hXMLReader.Read()
           asRecord.Add(hXmlReader.Node.Value, 5)
        Endif
    End Select
    hXMLReader.Read()
  Wend  
  hXMLReader.Close() 
 
  Return avRecords
 
End