Quiq::Database::Tree - Baum von Datensätzen
Quiq::Hash
Ein Objekt der Klasse repräsentiert eine Menge von Datensätzen, die mittels zweier Attribute $pkColumn und $fkColumn in einer hierarchischen Beziehung zueinander stehen und somit eine Baumstruktur bilden. Die Klasse bietet Methoden, um auf dieser Baumstruktur operieren zu können.
$tree = $class->new($tab,$pkColumn,$fkColumn,@opt);
(Default: 'throwException') Was getan werden soll, wenn der Parent eines Child-Datensatzes in der Ergebnismenge nicht enthalten ist:
Entferne den Datensatz aus der Ergebnismenge.
Setze die Referenz auf NULL (Leerstring). Der Child-Datensatz wird damit logisch zu einem Parent-Datensatz.
Wirf eine Exception.
Die Varianten 'removeRow' und 'removeReference' sind nützlich, wenn die Ergebnismenge nicht alle Sätze enthält, sondern nur eine Teilmenge, z.B. aufgrund einer Selektion mit -limit.
Instantiiere ein Baum-Objekt aus den Datensätzen des ResultSet $tab. Die Datensätze stehen über die Attribute $pkColumn und $fkColumn in einer hierarchischen Beziehung.
Datensätze:
id parent_id name -- --------- ---- 1 NULL A 2 1 B 3 2 C 4 1 D
Pfade:
A A/B A/B/C A/D
Baum:
A +-B | \-C +-D
Aufruf:
$tree = Quiq::Database::Tree->new($tab,'id','parent_id');
$tab = $tree->table;
Liefere das ResultSet-Objekt, das beim Konstruktor angegeben wurde.
$h = $tree->pkIndex;
Liefere eine Referenz auf den Hash, der die Datensätze nach Primary-Key-Index indiziert.
$type = $tree->type;
Liefere den (intern generierten) Typ-Bezeichner, für den die Datensatz-Verknüpfung definiert ist.
@rows|$tab = $tree->childs($row); @rows|$tab = $tree->childs($pk);
Liefere die Liste der Kind-Datensätze - also der unmittelbar untergeordneten Datensätze - zum Datensatz $row bzw. zum Datensatz mit dem Primärschlüssel $pk. Besitzt der Datensatz keine Kind-Datensätze, ist die Liste leer. Im Skalarkontext liefere ein ResultSet-Objekt mit den Datensätzen.
@rows = $tree->childs(1);
Resultat:
id parent_id name -- --------- ---- 2 1 B 4 1 D
@rows = $tree->descendants($row); @rows = $tree->descendants($pk);
Liefere die Liste aller untergeordneten Datensätze zum Datensatz $row bzw. zum Datensatz mit dem Primärschlüssel $pk. Besitzt der Datensatz keine untergeordneten Datensätze, ist die Liste leer. Die Reihenfolge der Datensätze entspricht der einer Tiefensuche. Im Skalarkontext liefere ein ResultSet-Objekt mit den Datensätzen.
@rows = $tree->descendants(1);
id parent_id name -- --------- ---- 2 1 B 3 2 C 4 1 D
$tree->generatePathAttribute($key,$valColumn,$sep);
Füge zu allen Datensätzen das Attribut $key hinzu und setze es auf den Pfad gemäß Datensatz-Attribut $valColumn mit der Trenn-Zeichenkette $sep. Die Methode liefert keinen Wert zurück.
$tree->generatePathAttribute('path','name','/');
Erweitert alle Datensätze um das Attribut 'path':
id parent_id name path -- --------- ---- ----- 1 NULL A A 2 1 B A/B 3 2 C A/B/C 4 1 D A/D
@rows|$rowA = $tree->hierarchy(@opt);
Sortierfunktion für die Kind-Datensätze (die Wurzel-Datensätze bleiben in ihrer gegebenen Reihenfolge).
ACHTUNG: Die Sortierfunktion muss mit Prototype ($$) vereinbart werden, damit die Elemente per Parameter und nicht mittels der globalen Variablen $a und $b übergeben werden. Denn die globalen Variablen befinden sich in einem anderen Package als dem, in dem die Sortierfunktion aufgerufen wird. Beispiel:
-childSort => sub ($$) { $_[0]->id <=> $_[1]->id; }
Setze die hierarchische Reihenfolge auf der zugrunde liegenden Tabelle. D.h. $tree->table->rows() liefert die Datensätze fortan in dieser Reihenfolge.
Liefere die Datensätze der Ergebnismenge in hierarchischer Reihenfolge, also die Kind-Sätze in der Reihenfolge einer Tiefensuche.
$level = $tree->level($pk); $level = $tree->level($row);
$row = $tree->lookup($pk); $row = $tree->lookup($row);
Liefere den Datensatz mit dem Primärschlüssel $pk. Wird ein Datensatz $row übergeben, wird dieser unmittelbar zurückgeliefert. Dies ist nützlich, wenn die Methode genutzt wird um eine Variable zu einem Datensatz aufzulösen, die ein Primärschlüssel oder Datensatz sein kann. Die Klasse selbst nutzt die Methode zu diesem Zweck.
$par = $tree->parent($row); $par = $tree->parent($pk);
Liefere den Eltern-Datensatz zum Datensatz $row bzw. zum Datensatz mit dem Primärschlüssel $pk. Besitzt der Datensatz keinen Eltern-Datensatz, liefere undef.
$row = $tree->parent(3);
Resultat (ein Datensatz):
id parent_id name -- --------- ---- 2 1 B
@rows = $tree->path($row); @rows = $tree->path($pk); @values = $tree->path($row,$key); @values = $tree->path($pk,$key); $path = $tree->path($row,$key,$sep); $path = $tree->path($pk,$key,$sep);
Ermittele die Pfad-Datensätze, die Pfad-Werte oder den Pfad des Datensatzes $row bzw. des Datensatzes mit dem Primärschlüssel $pk gemäß der Datensatz-Hierarchie und liefere das Resultat zurück.
Ist Argument $key angegeben, wird die Liste der Werte des Attributs $key geliefert.
Ist zusätzlich Argument $sep angegeben, wird die Liste der Werte mit $sep getrennt zu einer Zeichenkette zusammengefügt.
Pfad als Liste von id-Werten
@values = $tree->path(3,'id');
(1,2,3)
Datensätze und ihre id-Wert-Pfade:
id parent_id name @values -- --------- ---- ------- 1 NULL A (1) 2 1 B (1,2) 3 2 C (1,2,3) 4 1 D (1,4)
Pfad als Zeichenkette
$path = $tree->path(3,'name','/');
'A/B/C'
Datensätze und ihre name-Pfade:
id parent_id name $path -- --------- ---- ----- 1 NULL A A 2 1 B A/B 3 2 C A/B/C 4 1 D A/D
@rows|$rowA = $tree->rows;
Liefere die Datensätze des Baums. Die Reihenfolge entspricht der Reihenfolge der zugrundeliegenden Tabelle $tab (s. Konstruktor).
@rows|$rowA = $tree->roots;
Liefere die Liste der Wurzel-Datensätze, also alle Datensätze, die keinen Parent haben. Die Reihenfolge entspricht der Reihenfolge der zugrundeliegenden Tabelle $tab (s. Konstruktor).
@rows|$tab = $tree->siblings($row); @rows|$tab = $tree->siblings($pk);
Liefere die Liste der Geschwister-Datensätze zum Datensatz $row bzw. zum Datensatz mit dem Primärschlüssel $pk. Besitzt der Datensatz keine Geschwister-Datensätze, ist die Liste leer. Im Skalarkontext liefere ein ResultSet-Objekt mit den Datensätzen.
1.188
Frank Seitz, http://fseitz.de/
Copyright (C) 2020 Frank Seitz
This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Quiq, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Quiq
CPAN shell
perl -MCPAN -e shell install Quiq
For more information on module installation, please visit the detailed CPAN module installation guide.