GAMBAS BOOK 3.14

The class Collection (gb) implements a hash table whose elements consist of a value-key pair.

• The keys are generally of type String and the associated values of data type Variant.
• A collection is to be understood as a data collection or data container.
• NULL is used as a value if no element is assigned to a specific key. Consequently, assigning NULL for a given key is the same as if the data were removed from the collection.
• The size of the internal hash table grows dynamically with the number of elements inserted.
• The Collection class has two properties and five methods.
• Generally, a collection is used if you want to identify data in a container by names instead of natural numbers, as is the case with arrays, for example.

Properties of the class Collection:

Table 7.5.0.1.1.1: Class Collection properties

The Collection class has the following methods:

Table 7.5.0.2.1: Methods of the Collection class

There are different ways to create a collection:

(A) declaration of a variable of the data type collection and subsequent assignment of the element
(B) declaration of a variable of the data type collection with direct value assignment
(C) inline collection create
(D) copy of a collection

The following examples implement the options listed in the previous chapter.

(A) declaration of a variable of the data type collection and subsequent assignment of elements

Dim hCollection As Collection 

hCollection = New Collection ( [ Mode As Integer ] ) 

A new collection is created. Specifying mode is optional. The gb.binary mode is the default. The mode describes the method used for comparing keys and applies using the two gambas constants:

gb.Binary: 
This constant represents 0 and indicates that capitalization is case-sensitive. 
gb.IgnoreCase: 
This constant represents 1 --> upper and lower case is ignored.

Example 1

Public Sub btnAddMethod_Click()
  Dim cCollection As New Collection(gb.IgnoreCase)
  Dim vValue, vElement As Variant  
  Dim aNames As String[]
  Dim icount As Integer
 
  aNames = ["Adam", "Ben", "Charlie"]
 
' cCollection.Add(Value As Variant, Key As String) → First the value and then the key  
  cCollection.Add("a", "a")
  cCollection.Add(3, "A")
  cCollection.Add(aNames, "v") ' The value is a string array
  cCollection.Add(False, "d")
  cCollection.Add(8.44, "e")
  cCollection.Add(Format(Date(Now), "d. mmmm yyyy"), "f")
 
  For Each vValue In cCollection
    If cCollection.Key = "v" Then 
       For iCount = 0 To vValue.Max
         Print cCollection.Key & (icount + 1); " --> "; vValue[iCount]  
       Next ' iCount
    Else
       Print cCollection.Key; " --> "; vValue
    Endif ' cCollection.Key = "v" ?
  Next ' vValue
 
End ' btnAddMethod_Click()

The output in the console of the Gambas IDE also demonstrates how to read the values associated with the key:

a  --> 3
v1 --> Adam
v2 --> Ben
v3 --> Charlie
d  --> False
e  --> 8,44
f  --> 7. April 2014

The capitalization of the key is ignored in this mode. The first element is therefore overwritten. The key “A” becomes “a” with the value 3, because two values are noted for the same key.

This also provides a clear answer to the question “Can you use different data types for the values in a collection?”:“ Yes - each value of a collection is of the type Variant and a variant can carry everything - independent of the collection and independent of the other values in a collection”.

Example 2

In example 1, you could also assign the values to the keys in this way:

' cCollection[Key As String] = Value As Variant → First the key and then the value  
  cCollection["a"] = "a"
  cCollection["A"] = "3"
  cCollection["v"] = aNames ' The value is a string array
  cCollection["d"] = False
  cCollection["e"] = 8.44
  cCollection["f"] = Format(Date(Now), "d. mmmm yyyy")

Hint:

The !-operator is a special operator for container objects that allow access to their elements using a' String' type key –> chapter 8.6. A collection is also included. The key string is written after the !-operator, so that for example cCollection! name is synonymous with cCollection[“Name”]. Note that the quotation marks around the key string are omitted when using the !-operator. In both cases, the return value is the value in the collection with the key “Name”.

sCurrent.Name = cCollection["Name"] 
sCurrent.Name = cCollection!Name ' Alternative notation

(B) Inline Collection

Since revision #1699 (November 2008) there is a new syntax for creating a collection in Gambas. With this compact inline syntax, the key is noted first and then the value:

  Dim cNames As New Collection
  Dim vValue, vElement As Variant  
 
' Syntax: Collection = [ Key: Expression [ , ... ] ]  
  cNames = ["w": ["Anna", "Brit", "Claudia", "Doreen"],
           "m": ["Adam", "Bruno", "Clemens"],
           "Nachname": ["Adler", "Fuchs", "Katze", "Wiesel", "Zebra"]]
 
' Output to the Gambas IDE console
  For Each vValue In cNames
      For Each vElement In cNames[cNames.Key]
          Print cNames.Key; " -> "; vElement
      Next ' vElement
  Next ' vValue

(C) Declaration of a variable of the data type collection with direct value assignment.

This variant uses the inline syntax:

Dim cCollection As Collection = ["Blue": &H0000FF&, "White": &HFFFFFF&, "Red": &HFF0000&]

(D) Copy of a collection

When you create a copy of an existing collection using the Collection. Copy () method, this copy is a standalone collection object:

  Dim cNames, cNamesCopy As New Collection
 
  cNames = ["w": ["Anna", "Brit"], "m": ["Adam", "Bruno"], "Nachname": ["Adler", "Katze"]] 
  cNames["Nachname"].Add("Maus", 1) ' Einfügen nach dem Adler (Index = 0)...
 
  cNames.Name = "cNAME"
 
  If cNames.Count > 0 Then
     cNamesCopy = cNames.Copy()
  Else ' Count = 0
     Message.Error(„Die Collection '” & cNames.Name & „' hat keine Elemente”)
  Endif ' cNames.Count > 0
 

The statement cNames.Name = “cNAME” is described in –> section 7.5.0.7.

You can access individual values of a collection, which requires precise knowledge of the key or all values:

  Dim cColor As New Collection
  Dim vValue As Variant  
 
  cColor.Add("&HC3DDFF", "TFarbe")
  cColor.Add("&HD6D4D2", "HFarbe")
  cColor.Add("&HF5FFE6", "EFarbe")
 
  Print "Die Hintergrund-Farbe ist "; cColor["HFarbe"] ' Displaying an element
' Print "Die Hintergrund-Farbe ist "; cColor!HFarbe → Alternative 
 
  For Each vValue In cColor
    Print cColor.Key, String.Chr(187), vValue ' Show all elements (key value pairs)
  Next ' vValue

A gambas-specific memory management is used, with which you can save a collection in a file (data export) or import the contents of a file into a collection (data import). Further information can be found in chapter 7.2.2.2.3 Data export and data import.

Data export
The following procedure saves a collection in a binary, gambas-specific file:

Parameter1: File path to the export file
Parameter2: Reference to the selected collection

Public hFile As File
Public sFilePath As String = Application.Path &/ "url.list"
Public cData As New Collection
 
Public Sub Form_Open()
...
  If Exist(sFilePath) Then
     cData = ImportCData(sFilePath)
     For Each vValue In cData
         lsbURL.Add(cData.Key)
     Next
  Else
     cData["http://mp3channels.webradio.rockantenne.de/classic-perlen"] = "ROCK ANTENNE"
     lsbURL.Add("http://mp3channels.webradio.rockantenne.de/classic-perlen")
  Endif ' Exist(sFilePath) ?
End ' Form_Open()
 
Public Sub ExportCData(sPath As String, cExport As Collection) 
 
  If cExport.Count = 0 Then 
     Return 
  Else 
     hFile = Open sPath For Write Create ' The export file is always created anew
     Write #hFile, cExport As Collection 
     Close #hFile 
     Catch 
     Message.Error("The data export was incorrect!" & gb.NewLine & "ERROR: " & Error.Text) 
  Endif ' c.Count = 0 ? 
 
End ' ExportCData(...)

This function imports the contents of a collection from a binary, gambas-specific file and returns a collection as a function value:

Parameter: File path to import file

Public Function ImportCData(sPath As String) As Collection 
  Dim cTempImport As Collection 
 
  hFile = Open sPath For Read 
  cTempImport = Read #hFile As Collection 
  Close #hFile 
  Return cTempImport 
  Catch 
  Message.Error("The data import was incorrect!" & gb.NewLine & "ERROR: " & Error.Text) 
 
End ' ImportCData(...) 

If you want a collection to have a name - which it does not have - then expand the collection class by adding a class' Collection. class' to your project, exporting it and then adding the new' Name' property to the Collection class - the original class will be extended. Here follows the content of the newly created class file' Collection. class':

' Gambas class file 
 
Export 
Property Name As String 
Private $sName As String 
 
Private Sub Name_Read() As String 
  Return $sName 
End 
 
Private Sub Name_Write(Value As String) 
  $sName = Value 
End 

Now you can assign an object name to each collection in your project and query it in the program. This is the only way to provide informative messages of the following type:

Dim cURL As New Collection
 
cURL.Name = "TX_URL" 
 
If cURL.Count = 0 Then 
   Message.Warning("The collection '" & cURL.Name & "' exist, but is empty!") 
Endif ' cURL.Count = 0 ?

Details on extending or changing classes can be found in chapter 26? classes, modules and libraries.

Die Klasse Collection (gb) implementiert eine Hash-Tabelle, deren Elemente aus einem Wert-Schlüssel-Paar bestehen.

• Die Schlüssel sind generell vom Typ String und die assoziierten Werte vom Daten-Typ Variant.
• Eine Collection ist als Daten-Sammlung oder Daten-Container aufzufassen.
• Es wird NULL als Wert verwendet, wenn kein Element einem bestimmten Schlüssel zugeordnet ist. Folglich ist das Zuordnen von NULL für einen gegebenen Schlüssel das gleiche, als würden die Daten aus der Collection entfernt.
• Die Größe der internen Hash-Tabelle wächst dynamisch mit der Anzahl der eingefügten Elemente.
• Die Klasse Collection verfügt über zwei Eigenschaften und fünf Methoden.
• Generell benutzt man eine Collection, wenn Daten in einem Container über Namen statt fortlaufender natürlicher Zahlen identifiziert werden sollen, wie das zum Beispiel bei Arrays der Fall ist.

Eigenschaften der Klasse Collection:

Tabelle 7.5.0.1.1 : Eigenschaften der Klasse Collection

Die Klasse Collection besitzt die folgenden Methoden:

Tabelle 7.5.0.2.1 : Methoden der Klasse Collection

Es gibt unterschiedliche Möglichkeiten um eine Collection zu erzeugen:

(A) Deklaration einer Variablen vom Daten-Typ Collection und spätere Zuweisung der Elemente
(B) Deklaration einer Variablen vom Daten-Typ Collection mit direkter Wertzuweisung
(C) Inline-Collection erzeugen
(D) Kopie einer Collection

Die folgenden Beispiele setzen die im voran gegangenen Kapitel aufgeführten Möglichkeiten um.

(A) Deklaration einer Variablen vom Daten-Typ Collection und spätere Zuweisung der Elemente

Dim hCollection As Collection 

hCollection = New Collection ( [ Mode As Integer ] ) 

Es wird eine neue Collection erzeugt. Die Angabe von Mode ist optional. Der Modus gb.binary ist der Standard. Der Modus beschreibt die verwendete Methode für den Vergleich von Schlüsseln und es gilt unter Verwendung der zwei Gambas-Konstanten:

gb.Binary: 
Diese Konstante repräsentiert 0 und gibt an, dass Groß- und Kleinschreibung beachtet wird. 
gb.IgnoreCase: 
Diese Konstante repräsentiert 1 → Groß- und Kleinschreibung wird nicht beachtet.

Beispiel 1

Public Sub btnAddMethod_Click()
  Dim cCollection As New Collection(gb.IgnoreCase)
  Dim vValue, vElement As Variant  
  Dim aNames As String[]
  Dim icount As Integer
 
  aNames = ["Adam", "Ben", "Charlie"]
 
' cCollection.Add(Value As Variant, Key As String) → Zuerst der Wert und dann der Schlüssel  
  cCollection.Add("a", "a")
  cCollection.Add(3, "A")
  cCollection.Add(aNames, "v") ' Der Wert ist ein String-Array
  cCollection.Add(False, "d")
  cCollection.Add(8.44, "e")
  cCollection.Add(Format(Date(Now), "d. mmmm yyyy"), "f")
 
  For Each vValue In cCollection
    If cCollection.Key = "v" Then 
       For iCount = 0 To vValue.Max
         Print cCollection.Key & (icount + 1); " --> "; vValue[iCount]  
       Next ' iCount
    Else
       Print cCollection.Key; " --> "; vValue
    Endif ' cCollection.Key = "v" ?
  Next ' vValue
 
End ' btnAddMethod_Click()

Die Ausgabe in der Konsole der Gambas-IDE demonstriert auch das Auslesen der mit dem Schlüssel assoziierten Werte:

a  --> 3
v1 --> Adam
v2 --> Ben
v3 --> Charlie
d  --> False
e  --> 8,44
f  --> 7. April 2014

Die Groß- und Kleinschreibung des Schlüssels wird in diesem Modus ignoriert. Das erste Element wird deshalb überschrieben. Aus dem Key “A” wird “a” mit dem Wert 3, weil für den gleichen Schlüssel zwei Werte notiert sind.

Damit findet auch die Frage “Kann man in einer Collection unterschiedliche Daten-Typen für die Werte verwenden?” eine klare Antwort: “Ja - jeder Wert einer Collection ist vom Typ Variant und ein Variant kann alles tragen – unabhängig von der Collection und unabhängig von den anderen Werten in einer Collection”. Beispiel 2

Im Beispiel 1 könnte man die Zuweisung der Werte zu den Schlüsseln auch alternativ so vornehmen:

' cCollection[Key As String] = Value As Variant → Zuerst der Schlüssel und dann der Wert  
  cCollection["a"] = "a"
  cCollection["A"] = "3"
  cCollection["v"] = aNames ' Der Wert ist ein String-Array
  cCollection["d"] = False
  cCollection["e"] = 8.44
  cCollection["f"] = Format(Date(Now), "d. mmmm yyyy")

Hinweis:

Der !-Operator ist ein spezieller Operator für Container-Objekte, die Zugriff auf ihre Elemente anhand eines Schlüssels vom Typ 'String' erlauben → Kapitel 8.6. Eine Collection gehört auch dazu. Dabei wird der Schlüssel-String nach dem !-Operator notiert, so dass zum Beispiel cCollection!Name gleichbedeutend ist mit cCollection[“Name”]. Beachten Sie, dass die Anführungszeichen um den Schlüssel-String beim Einsatz des !-Operators entfallen. Der Rückgabewert ist in beiden Fällen der Wert in der Collection mit dem Schlüssel “Name”.

sCurrent.Name = cCollection["Name"] 
sCurrent.Name = cCollection!Name ' Alternative Schreibweise

(B) Inline-Collection

Seit der Revision #1699 (November 2008) gibt es in Gambas diese neue Syntax zum Anlegen einer Collection. Es wird bei dieser kompakten Inline-Syntax erst der Schlüssel notiert und dann der Wert:

  Dim cNames As New Collection
  Dim vValue, vElement As Variant  
 
' Syntax: Collection = [ Key: Expression [ , ... ] ]  
  cNames = ["w": ["Anna", "Brit", "Claudia", "Doreen"],
           "m": ["Adam", "Bruno", "Clemens"],
           "Nachname": ["Adler", "Fuchs", "Katze", "Wiesel", "Zebra"]]
 
' Ausgabe in der Konsole der Gambas-IDE
  For Each vValue In cNames
      For Each vElement In cNames[cNames.Key]
          Print cNames.Key; " -> "; vElement
      Next ' vElement
  Next ' vValue

(C) Deklaration einer Variablen vom Daten-Typ Collection mit direkter Wertzuweisung.

Diese Variante nutzt die Inline-Syntax:

Dim cCollection As Collection = ["Blue": &H0000FF&, "White": &HFFFFFF&, "Red": &HFF0000&]

(D) Kopie einer Collection

Wenn Sie eine Kopie einer existierenden Collection mit der Methode Collection.Copy() erzeugen, ist diese Kopie ein eigenständiges Collection-Objekt:

  Dim cNames, cNamesCopy As New Collection
 
  cNames = ["w": ["Anna", "Brit"], "m": ["Adam", "Bruno"], "Nachname": ["Adler", "Katze"]] 
  cNames["Nachname"].Add("Maus", 1) ' Einfügen nach dem Adler (Index = 0)...
 
  cNames.Name = "cNAME"
 
  If cNames.Count > 0 Then
     cNamesCopy = cNames.Copy()
  Else ' Count = 0
     Message.Error(„Die Collection '” & cNames.Name & „' hat keine Elemente”)
  Endif ' cNames.Count > 0
 

Die Anweisung cNames.Name = “cNAME” wird im Abschnitt 7.5.0.7 näher beschrieben.

Sie können auf einzelne Werte einer Collection zugreifen, was die genaue Kenntnis des Schlüssels voraussetzt oder auf alle Werte:

  Dim cColor As New Collection
  Dim vValue As Variant  
 
  cColor.Add("&HC3DDFF", "TFarbe")
  cColor.Add("&HD6D4D2", "HFarbe")
  cColor.Add("&HF5FFE6", "EFarbe")
 
  Print "Die Hintergrund-Farbe ist "; cColor["HFarbe"] ' Ein Element anzeigen
' Print "Die Hintergrund-Farbe ist "; cColor!HFarbe → Alternative 
 
  For Each vValue In cColor
    Print cColor.Key, String.Chr(187), vValue ' Alle Elemente (Schlüssel-Wert-Paare) anzeigen
  Next ' vValue

Es wird ein gambas-spezifisches Speicher-Management verwendet, mit dem Sie eine Collection in einer Datei abspeichern können (Daten-Export) oder den Inhalt einer Datei in eine Collection einlesen können (Daten-Import). Weitere Informationen finden Sie im Kapitel 7.2.2.3 Daten-Export und Daten-Import.

Daten-Export
Die folgende Prozedur speichert eine Collection in einer binären, gambas-spezifischen Datei:

Parameter1: Datei-Pfad zur Export-Datei Parameter2: Referenz auf die ausgewählte Collection

Public hFile As File
Public sFilePath As String = Application.Path &/ "url.list"
Public cData As New Collection
 
Public Sub Form_Open()
...
  If Exist(sFilePath) Then
     cData = ImportCData(sFilePath)
     For Each vValue In cData
         lsbURL.Add(cData.Key)
     Next
  Else
     cData["http://mp3channels.webradio.rockantenne.de/classic-perlen"] = "ROCK ANTENNE"
     lsbURL.Add("http://mp3channels.webradio.rockantenne.de/classic-perlen")
  Endif ' Exist(sFilePath) ?
End ' Form_Open()
 
Public Sub ExportCData(sPath As String, cExport As Collection) 
 
  If cExport.Count = 0 Then 
     Return 
  Else 
     hFile = Open sPath For Write Create ' Die Exportdatei wird stets neu angelegt 
     Write #hFile, cExport As Collection 
     Close #hFile 
     Catch 
     Message.Error("Der Daten-Export war fehlerhaft!" & gb.NewLine & "Fehler: " & Error.Text) 
  Endif ' c.Count = 0 ? 
 
End ' ExportCData(...)

Daten-Import
Diese u.a. Funktion importiert den Inhalt einer Collection aus einer binären, gambas-spezifischen Datei und gibt als Funktionswert eine Collection zurück:

Parameter: Datei-Pfad zur Import-Datei

Public Function ImportCData(sPath As String) As Collection 
  Dim cTempImport As Collection 
 
  hFile = Open sPath For Read 
  cTempImport = Read #hFile As Collection 
  Close #hFile 
  Return cTempImport 
  Catch 
  Message.Error("Der Daten-Import war fehlerhaft!" & gb.NewLine & "Fehler: " & Error.Text) 
 
End ' ImportCData(...) 

Möchten Sie, dass eine Collection einen Namen bekommt – den sie p.d. nicht besitzt – dann erweitern Sie die Collection-Klasse, indem Sie eine Klasse 'Collection.class' in ihr Projekt einfügen, diese exportieren und dann die neue Eigenschaft 'Name' zur Klasse Collection hinzufügen – die originale Klasse wird erweitert. Hier folgt der Inhalt der neu angelegten Klassen-Datei 'Collection.class':

' Gambas class file 
 
Export 
Property Name As String 
Private $sName As String 
 
Private Sub Name_Read() As String 
  Return $sName 
End 
 
Private Sub Name_Write(Value As String) 
  $sName = Value 
End 

Jetzt können Sie jeder Collection in ihrem Projekt einen Objekt-Namen zuweisen und diesen im Programm abfragen. Nur so sind informative Meldungen der folgenden Art möglich:

Dim cURL As New Collection
 
cURL.Name = "TX_URL" 
 
If cURL.Count = 0 Then 
   Message.Warning("Die Collection '" & cURL.Name & "' existiert, ist aber leer!") 
Endif ' cURL.Count = 0 ?

Details zur Erweiterung oder Änderung von Klassen finden Sie im Kapitel 26 → Klassen, Module und Bibliotheken.