JTree - Teil 2 - Wie bringt man Daten in den JTree

[Beni]

JTree - Teil 2 - Wie bringt man Daten in den JTree

1. TreeNode
Die wohl intuitivste Variante Daten in einen JTree zu bringen, sind TreeNodes. Jeder dieser Nodes stellt einen Knoten des Baumes dar, und hat eine beliebige Anzahl Kindknoten. TreeNode selbst ist nur ein Interface. Entweder schreibt man selbst eine Klasse welche das Interface implementiert, oder man benutzt den sehr bequemen DefaultMutableTreeNode.

Die MutableTreeNodes sind nur Wrapper um ein Userobject herum. Das Userobject bestimmt den Wert des Knotens, die Knoten selbst bestimmen die Struktur des Baumes.

Der Baum wird dann schliesslich so aufgebaut:

package jtree;

import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.JTree;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.TreeNode;

public class Demo1 {
    public static void main( String[] args ) {
        // Der Wurzelknoten wird hergestellt
        TreeNode root = createTree();
        
        // Der Wurzelknoten wird dem neuen JTree im Konstruktor übergeben
        JTree tree = new JTree( root );
        
        // Ein Frame herstellen, um den Tree auch anzuzeigen
        JFrame frame = new JFrame( "JTree - Demo" );
        frame.add( new JScrollPane( tree ));
        
        frame.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
        frame.pack();
        frame.setLocationRelativeTo( null );
        frame.setVisible( true );
    }
    
    private static TreeNode createTree(){
        /*
         * Der Baum wird folgende Form haben:
         * Wurzel
         * +- Buchstaben
         * |  +- A
         * |  +- B
         * |  +- C
         * +- Zahlen
         *    +- 1
         *    +- 2
         *    +- 3
         */
        
        // Zuerst werden alle Knoten hergestellt...
        DefaultMutableTreeNode root = new DefaultMutableTreeNode( "Wurzel" );
        
        DefaultMutableTreeNode letters = new DefaultMutableTreeNode( "Buchstaben" );
        DefaultMutableTreeNode digits = new DefaultMutableTreeNode( "Zahlen" );
        
        DefaultMutableTreeNode letterA = new DefaultMutableTreeNode( "A" );
        DefaultMutableTreeNode letterB = new DefaultMutableTreeNode( "B" );
        DefaultMutableTreeNode letterC = new DefaultMutableTreeNode( "C" );
        
        DefaultMutableTreeNode digit1 = new DefaultMutableTreeNode( "1" );
        DefaultMutableTreeNode digit2 = new DefaultMutableTreeNode( "2" );
        DefaultMutableTreeNode digit3 = new DefaultMutableTreeNode( "3" );
        
        // ... dann werden sie verknüpft
        letters.add( letterA );
        letters.add( letterB );
        letters.add( letterC );
        
        digits.add( digit1 );
        digits.add( digit2 );
        digits.add( digit3 );
        
        root.add( letters );
        root.add( digits );
        
        return root;
    }
}

2. TreeModel
Mit TreeNodes kann man einen Baum sehr einfach aufbauen. Intern arbeitet ein JTree aber stets mit einem TreeModel. Das TreeModel enthält alle Informationen über die Struktur des Baumes. Dafür weiss das TreeModel nich, wie die Knoten tatsächlich dargestellt werden.
Das TreeModel kann für jeden Knoten sagen, wieviele Kinder er besitzt, und wer diese Kinder sind.
Die Methode getChildCount gibt für einen Knoten an, wieviele Kinder er besitzt. Alle Kinder eines Knotens sind durchnummeriert (jeder Knoten ist sozusagen eine Liste von Kindknoten), dementsprechend gibt die Methode getChild das Kind mit der Nummer "index" zurück. Achtung: getChild muss für verschiedene Indices (bei gleichbleibendem Vaterknoten) verschiedene Kinderknoten zurückgeben.

Jeder Baum muss eine Wurzel haben, diese Wurzel wird durch getRoot angegeben.

Normalerweise besitzt ein Baum Knoten und Blätter. Als Blätter bezeichnet man Knoten die keine Kinder haben. Z.b. in einem Dateisystem entsprechen Verzeichnisse Knoten, und Dateien entsprechen Blätter.
Der JTree behandelt Blätter und Knoten leicht unterschiedlich: Knoten kann man aufklappen, Blätter nicht. Ob ein Objekt Knoten oder Blatt ist, bestimmt die Methode isLeaf.

Eine reine Hilfsfunktion ist schliesslich getIndexOfChild, die "Umkermethode" von getChild. Sie gibt an, unter welcher Nummer ein Kindknoten bei einem Vaterknoten gespeichert ist.

Der folgende Code zeigt einen Baum, der als Knoten einfach Strings verwendet.

package jtree;

import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.JTree;
import javax.swing.event.TreeModelListener;
import javax.swing.tree.TreeModel;
import javax.swing.tree.TreePath;

public class Demo2 {
    public static void main( String[] args ) {
        // Die Verknüpfungen werden hergestellt
        TreeModel model = createTree();

        // Das Model wird dem Konstruktor des JTrees übergeben
        JTree tree = new JTree( model );
        
        // Ein Frame herstellen, um den Tree auch anzuzeigen
        JFrame frame = new JFrame( "JTree - Demo" );
        frame.add( new JScrollPane( tree ));
        
        frame.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
        frame.pack();
        frame.setLocationRelativeTo( null );
        frame.setVisible( true );
    }
    
    private static TreeModel createTree(){
        /*
         * Der Baum wird folgende Form haben:
         * Wurzel
         * +- Buchstaben
         * |  +- A
         * |  +- B
         * |  +- C
         * +- Zahlen
         *    +- 1
         *    +- 2
         *    +- 3
         */
        
        TreeModel model = new TreeModel(){
            // Diese Methode gibt die Wurzel des Baumes an.
            public Object getRoot() {
                return "Wurzel";
            }

            // Hier wird das index'te Kind des Knotens "parent" bestummen
            public Object getChild( Object parent, int index ) {
                if( parent.equals( "Wurzel" )){
                    switch( index ){
                        case 0: return "Buchstaben";
                        case 1: return "Zahlen";
                    }
                }
                if( parent.equals( "Buchstaben" )){
                    switch( index ){
                        case 0: return "A";
                        case 1: return "B";
                        case 2: return "C";
                    }
                }
                
                if( parent.equals( "Zahlen" )){
                    switch( index ){
                        case 0: return "1";
                        case 1: return "2";
                        case 2: return "3";
                    }
                }
                
                return null;
            }

            // Gibt für jeden Knoten an, wieviele Kinder er hat
            public int getChildCount( Object parent ) {
                if( parent.equals( "Wurzel" ))
                    return 2;
                
                if( parent.equals( "Zahlen" ))
                    return 3;
                
                if( parent.equals( "Buchstaben" ))
                    return 3;
                
                // Dann wars A, B, C, 1, 2 oder 3
                return 0;
            }

            // Gibt an, ob ein Knoten ein Blatt ist. Ein Blatt kann in einem
            // JTree nicht weiter geöffnet werden.
            // Experiment: immer true oder immer false zurückgeben...
            public boolean isLeaf( Object node ) {
                return getChildCount( node ) == 0;
            }

            // Gibt an, welchen Index der Knoten "child" als Kind vom 
            // Knoten "parent" hat. Wenn man folgenden Code ausführt:
            // 'Object result = getChild( parent, getIndexOfChild( parent, child ))',
            // dann muss "result" und "child" dasselbe Objekt sein. 
            public int getIndexOfChild( Object parent, Object child ){
                int max = getChildCount( parent );
                for( int i = 0; i < max; i++ )
                    if( getChild( parent, i ).equals( child ))
                        return i;
                
                return -1;
            }

            public void addTreeModelListener( TreeModelListener listener ) {
                // siehe später
            }

            public void removeTreeModelListener( TreeModelListener listener ) {
                // siehe später
            }

            public void valueForPathChanged( TreePath path, Object value ) {
                // siehe später
            }
        };
        
        return model;
    }
}

3. Bäume mit unendlich vielen Knoten
Nicht immer ist es möglich, denn gesammten Baum zu kennen. Liest man z.B. einen Baum aus einer Datenbank, könnte man schlicht nicht genügend RAM besitzen, um den gesammten Baum zu speichern. Oder das Erstellen eines Knotens dauert solange (und man hat so viele), dass die Berechnung des Baumes Tage dauern würde.

Ein besonders drastisches Beispiel ist ein Baum mit unendlich vielen Knoten. Selbstverständlich wird es niemals möglich sein, diesen Baum ganzheitlich herzustellen. Trotzdem kann man mit dem JTree auch solche Giganten darstellen. Der Trick dabei ist, dass der JTree das TreeModel erst nach einem Knoten fragt, wenn der Knoten tatsächlich gezeichnet werden soll.
Jetzt erstellt man den Knoten halt erst in dem Augenblick, indem der JTree nach ihm fragt, und da der JTree nur eine begrenzte Zahl von Knoten darstellt... (der Benutzer kann nicht alle Knoten aufeinmal öffnen).
Beachten muss man allerdings, dass ein einmal erstellter Knoten nicht mehr gelöscht werden darf. Denn gibt die getChild-Methode bei gleichem Input einen anderen Output, wird der JTree ganz verwirrt (und nichts funktioniert mehr).

Im untenstehen Codeschnippsel besitzt jeder Knoten 10 Unterknoten, die genau dann hergestellt werden, wenn sie das erstemal abgefragt werden:

package jtree;

import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.JTree;
import javax.swing.event.TreeModelListener;
import javax.swing.tree.TreeModel;
import javax.swing.tree.TreePath;

public class Demo3 {
    public static void main( String[] args ) {
        // Das Model mit dem unendlichen Baum wird erstellt
        JTree tree = new JTree( new InfiniteModel() );
        
        // Ein Frame herstellen, um den Tree auch anzuzeigen
        JFrame frame = new JFrame( "JTree - Demo" );
        frame.add( new JScrollPane( tree ));
        
        frame.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
        frame.setSize( 400, 400 );
        frame.setLocationRelativeTo( null );
        frame.setVisible( true );
    }
    
    
}

// Dieses TreeModel stellt einen Baum mit unendlich vielen Knoten dar
class InfiniteModel implements TreeModel{
    private Node root = new Node( "" ){
        @Override
        public String toString() {
            return "Wurzel";
        }
    };
    
    // Der Wurzelknoten
    public Object getRoot() {
        return root;
    }

    // Die Kinder sind in dem parent-Knoten gespeichert
    public Object getChild( Object parent, int index ) {
        Node node = (Node)parent;
        return node.getChild( index );
    }

    // Jeder Knoten in diesem Baum hat exakt 10 Kinder
    public int getChildCount( Object node ) {
        return 10;
    }

    // in diesem Baum haben alle Knoten Kinder
    public boolean isLeaf( Object node ) {
        return false;
    }

    // Den Indes des Kindes bestimmen
    public int getIndexOfChild( Object parent, Object child ) {
        Node node = (Node)parent;
        for( int i = 0; i < 10; i++ )
            if( node.getChild( i ) == child )
                return i;
        
        return -1;
    }

    public void valueForPathChanged( TreePath path, Object node ) {
        // nicht beachten
    }
    
    public void addTreeModelListener( TreeModelListener listener ) {
        // nicht beachten
    }

    public void removeTreeModelListener( TreeModelListener listener ) {
        // nicht beachten
    }
    
    // Der unendliche Baum wird durch diese Node-Objekte dargestellt. Bei
    // Bedarf kann sich so ein Nodeobjekt selbstständig neue Kinder erschaffen.
    private class Node{
        private String name;
        private Node[] children;
        
        public Node( String name ){
            this.name = name;
        }
        
        // Gibt das index'te Kind dieses Nodes zurück
        public Node getChild( int index ){
            ensureChildren();
            return children[ index ];
        }
        
        // Sorgt dafür, dass dieser Knoten wirklich Kinder hat
        private void ensureChildren(){
            if( children == null ){
                children = new Node[ 10 ];
                for( int i = 0; i < 10; i++ )
                    children[i] = new Node( name + i );
            }
        }
        
        // Der JTree ruft die "toString"-Methode auf, um den Namen eines 
        // Knoten-Objektes zu erfahren. ßberschreibt man die Methode, kann
        // man andere Namen anzeigen lassen
        @Override
        public String toString() {
            return name;
        }
    }
}

4. Knoten mehrfach verwenden
Betrachtet man das TreeModel genauer, fällt einem auf, dass man nur mit dem Model alleine nicht herausfinden kann, wer denn der Vater von irgendeinem Knoten ist. Mit anderen Worten: das TreeModel erlaubt es, Knoten an verschiedenen Stellen mehrfach zu verwenden. Eine konkrete Anwendung könnte eine Liste sein, welche auf verschiedene Weisen sortiert ausgegeben werden kann. In diesem Fall gibt es Knoten "Sortiert nach X", "Sortiert nach Y", ... und diese Knoten besitzen jeweils dieselben Kinder, jediglich in unterschiedlicher Reihenfolge.

Eine solche Datenstruktur nennt man Graph. Will man jeden Knoten nur einmal zeichnen, ist ein Graph ist (im Allgemeinen) nicht als Baum darstellbar. Darf man hingegen die Knoten mehr als einmal zeichnen, hat man keine Probleme. Der JTree ist in der Lage, denselben Knoten an verschiedenen Stellen zu zeichnen, kann daher auch Graphen darstellen (auch wenn diese Darstellung nicht unbedingt übersichtlich ist...)

Im Gegensatz zu den anderen Beispielen dieses Kapitels, ist es nicht möglich einen Graph mit TreeNodes darzustellen.

Das folgende Codestück zeigt einen solchen Graphen. Für jeden Knoten gibt es eine ganze Reihe von Folgeknoten, man kann stundenlang Knoten im JTree öffnen, und trotzdem wird man nie mehr als 13 unterschiedliche Knoten zu sehen bekommen.

package jtree;

import java.util.HashMap;
import java.util.Map;

import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.JTree;
import javax.swing.event.TreeModelListener;
import javax.swing.tree.TreeModel;
import javax.swing.tree.TreePath;

public class Demo4 {
    public static void main( String[] args ) {
        // Das Model füllen
        GraphModel model = new GraphModel( "Tagesanbruch" );
        
        model.put( "Tagesanbruch",      "kochen", "schlafen" );
        model.put( "kochen",            "versalzen", "angebrannt" , "gekocht" );
        model.put( "versalzen",         "kochen" );
        model.put( "angebrannt",        "abwaschen", "trotzdem essen" );
        model.put( "trotzdem essen",    "vergiftet" );
        model.put( "vergiftet" );
        model.put( "gekocht",           "essen" );
        model.put( "essen",             "abwaschen", "stehen lassen" );
        model.put( "stehen lassen",     "stehen lassen", "abwaschen" );
        model.put( "abwaschen",         "kochen", "schlafen" );
        model.put( "schlafen",          "schlafen", "schnarchen", "aufwachen" );
        model.put( "schnarchen",        "aufwachen" );
        model.put( "aufwachen",         "schlafen", "kochen" );
        
        // Der Wurzelknoten wird dem neuen JTree im Konstruktor übergeben
        JTree tree = new JTree( model );
        
        // Ein Frame herstellen, um den Tree auch anzuzeigen
        JFrame frame = new JFrame( "JTree - Demo" );
        frame.add( new JScrollPane( tree ));
        
        frame.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
        frame.setSize( 400, 400 );
        frame.setLocationRelativeTo( null );
        frame.setVisible( true );
    }    
}

class GraphModel implements TreeModel{
    // Die Verbindungen, vom Schlüsselknoten (key) kommt man zu allen Kindknoten (value)
    private Map<String, String[]> connections = new HashMap<String, String[]>();
    
    // Die Wurzel
    private String root;
    
    public GraphModel( String root ){
        this.root = root;
    }
    
    public Object getRoot() {
        return root;
    }

    // Für den Knoten "parent" alle möglichen Kinder angeben.
    public void put( String parent, String...children ){
        connections.put( parent, children );
    }
    
    // Das index'te Kind zurückgeben
    public Object getChild( Object parent, int index ) {
        return connections.get( parent )[index];
    }

    // Die Anzahl Kinder bestimmen
    public int getChildCount( Object parent ) {
        return connections.get( parent ).length;
    }

    // Angabe, ob ein Knoten ein Blatt ist
    public boolean isLeaf( Object node ) {
        return getChildCount( node ) == 0;
    }

    // Den Index eines Knotens bestimmen
    public int getIndexOfChild( Object parent, Object child ) {
        String[] children = connections.get( parent );
        for( int i = 0; i < children.length; i++ )
            if( children[i].equals( child ))
                return i;
        
        return -1;
    }


    public void valueForPathChanged( TreePath path, Object node ) {
        // nicht beachten
    }
    
    public void addTreeModelListener( TreeModelListener listener ) {
        // nicht beachten
    }

    public void removeTreeModelListener( TreeModelListener listener ) {
        // nicht beachten
    }
}