Der Begriff Iterator (manchmal auch Cursor) stammt aus dem Bereich der Softwareentwicklung und bezeichnet einen Zeiger, mit dem über die Elemente einer Liste bzw. durch die Elemente einer Menge iteriert werden kann.

Der Iterator steht dabei im Gegensatz zu einem Index oder Schlüssel:

Über einen Iterator kann man direkt auf das zugehörige Element zugreifen ohne die Datenstruktur selber zu kennen. Bei einem Index benötigt man immer Index und Datenstruktur.
Ein Iterator ist nur für genau eine Datenstruktur gültig. Ein Index kann auf andere Datenstrukturen übertragen werden.
Iteratoren lassen sich nicht serialiseren. Sie müssen dazu erst zu einem Index gewandelt werden.

Das Entwurfsmuster Iterator

Da sich die Problematik der Iteration häufig stellt, gibt es entsprechende Entwurfsmuster, die zur Kategorie der Verhaltensmuster (Behavioral Patterns) gehören und sogenannten GoF-Muster sind (siehe Viererbande). Das Muster ist auch als Cursor bekannt. Mitunter wird durch Wahl des einen oder anderen Begriffes ein Unterschied im Verhalten impliziert.

Verwendung

In der Praxis werden häufig Objekte zu einer Sammlung zusammengefasst. Auf die Elemente solch einer Sammlung soll möglichst generisch und ohne Rücksicht auf die Implementierungsdetails zugegriffen werden können.

UML-Diagramm

Das Diagramm ist nur als grobes Beispiel zu sehen. Die konkrete Realisierung kann stark abweichen:

Anstelle der Ableitungspfeile kann z.B. die Realisierung eines Konzeptes stehen. D.h. es gibt gar keine Basisklasse, lediglich eine unverbindliche Vorgabe.
Die Methoden sind nicht in jedem Fall sinnvoll. Zurueck() oder IstFertig() sind nicht immer realisierbar.
Navigationpfeile zwischen Aggregat und Iterator können nur in eine Richtung gehen oder ganz fehlen.

Akteure

Iterator definiert die Schnittstelle zum Zugriff auf die Elemente und zum Traversieren des Aggregates.
Konkreter Iterator implementiert diese Schnittstelle und speichert die Position im Aggregat.
Aggregat definiert die Schnittstelle zum Erzeugen eines Iterators. Oft enthält die Schnittstelle auch Methoden zum Erzeugen von Iteratoren die auf spezielle Elemente zeigen, wie z.B. erstes, letztes oder ein Element mit bestimmten Eigenschaften.
Konkretes Aggregat implementiert diese Schnittstelle.

Vorteile

Die Schnittstelle für Aggregate wird vereinfacht, da im Aggregat Schnittstelle zur Iteration benötigt wird.
Es sind mehrere Iteratoren für ein Aggregat möglich, da jeder Iterator den Zustand über seine Position enthält.
Der Zugriff auf die Elemente einer Sammlung ist unabhängig von der Repräsentation der Elemente in der Sammlung.
Die Art der Traversierung kann durch den Wechsel der Iterator-Klasse geändert werden.

Nachteile

Je nach Variante der Implementierung können sich Nachteile durch erhöhte Laufzeit- und Speicherkosten ergeben.

Bei polymorphen Iteratoren muss man den Preis für virtuelle Methoden zahlen.
Wenn der Iterator sein Aggregat kennt und/oder das Aggregat über seine Iteratoren Buch führt, verteuern sich vor allem das Erzeugen und Vernichten von Aggregaten. (Im Gegenzug erhält man eine höhere Sicherheit)

Implementierung

Aufgrund einiger Designentscheidungen ergeben sich Iterator-Varianten mit verschiedenen Eigenschaften:

Wer steuert die Iteration?

Bei einem externen Iterator steuert der Klient die Iteration. Der Klient muß dafür sorgen, daß der Iterator weiterrückt.

Ein interner Iterator tut dies selbst. Dazu muß ihm die Operation übergeben werden, die er auf das aktuelle Element anwenden soll. Interne Iteratoren werden oft gar nicht als solche erkannt, oder bezeichnet, da die Iteration nicht sichtbar ist oder aber über externe Iteratoren realisiert ist.

(Booch nennt den externen Iterator aktiv und den internen passiv.)

Der Traversionsalgorithmus

kann durch den Iterator oder das Aggregat vorgegeben werden. Im letzteren Fall wird oft von einem Cursor gesprochen.

Robustheit

Wenn das Aggregat während der Traversion verändert wird, kann das zu falschen Ergebnissen oder gar zum Programmabsturz führen. Ein robuster Iterator ist gegen Modifikationen des Aggregats gesichert. Typischerweise werden dazu die Iteratoren beim Aggregat registriert. Das führt zu höheren Kosten beim Erzeugen der Iteratoren, aber auch beim Ändern des Aggregates.

Polymorphie

Polymorphe Iteratoren bieten eine hohe Flexibilität. Da Iteratoren meist in Schleifen verwendet werden, sind die Kosten dafür allerdings sehr hoch.

Nulliteratoren

Je nach Implementation kann es, in Analogie zum Null-Zeiger, einen Nulliterator geben. Dieser signalisiert das Ende einer Iteration oder einen ungültigen Iterator. Das ist recht bequem in der Benutzung, da man einen Iterator seine Gültigkeit "ansieht", aber die Implementation wird dadurch u.U. komplizierter.

Daher wurde z.B. in der STL die Alternative gewählt. Dabei besitzt jedes Aggregat seinen eigenen Nulliterator mit dem man dann den jeweiligen Iterator vergleichen muß.

Privilegien

Ein Iterator kann privilegierten Zugriff auf die Interna des Aggregates besitzen. Das ist bei komplexen Datenstrukturen teilweise nicht zu vermeiden. Allerdings wird dadurch die Implementation neuer Traversionsalgorithmen erschwert oder gar verhindert.

Beispiel

Ein einfacher Fall eines externen Iterators wäre etwa:

 class ObjectIterator
 {
   private Object[] m_source;
   private int m_current;

   public ObjectIterator(Object[] source)
   {
     m_source = source;
   }

   public boolean hasNext()
   {
     return m_current < m_source.length;
   }

   public Object next()
   {
     return m_source[m_current++];
   }
 }

Anwendung:

 Object[] myList = new Object[] {new Integer(1), new Integer(2), new Integer(3)};
 ObjectIterator iterator = new ObjectIterator(myList);
 while(iterator.hasNext())
 {
   System.out.println(iterator.next());
 }

Eine andere Variation dieses Entwurfsmusters wäre ein interner Iterator:

 class MyObjectIterator extends ObjectIterator
 {
   public MyObjectIterator(Object[] source)
   {
     super(source);
   }

   public void print()
   {
     while(hasNext())
     {
       System.out.println(next());
     }
   }

   public void apply(ObjectHandler handler)
   {
     while(hasNext())
     {
       handler.handle(next());
     }
   }
 }

 Interface ObjectHandler
 {
   public void handle(Object o);
 }

Anwendung:

 class MyObjectHandler implements ObjectHandler
 {
   public void handle(Object o)
   {
     System.out.println(o);
   }
 }

 Object[] myList = new Object[] {new Integer(1), new Integer(2), new Integer(3)};
 MyObjectIterator iterator = new MyObjectIterator(myList);
 iterator.print();
 iterator.apply(new MyObjectHandler());

Ein interner Iterator kapselt die Iteration selber und macht sie so im gesamten Programm einfach und konsistent wiederverwendbar, ohne sie wie im Fall eines externen Iterators immer wieder neu programmieren zu müssen. Durch Anwendung des Strategie Entwurfsmusters lässt sich der Algorithmus auch einfach austauschen, wie in der letzten Beispielzeile gezeigt.

Obwohl sich diese Beispiele mit sequentiellem Zugriff begnügen, sind natürlich auch Iteratoren mit wahlfreiem Zugriff möglich. Viele Implementierungen bieten zusätzlich die Möglichkeit die iterierte Sammlung direkt zu verändern, etwa durch Entfernen des aktuellen Elementes.

Die STL enthält Iteratoren für ihre Container.

Iterator (Entwurfsmuster)

Das Entwurfsmuster Iterator

Verwendung

UML-Diagramm

Akteure

Vorteile

Nachteile

Implementierung

Wer steuert die Iteration?

Der Traversionsalgorithmus

Robustheit

Polymorphie

Nulliteratoren

Privilegien

Beispiel

Verwandte Entwurfsmuster