Interface DataIterator
- All Superinterfaces:
java.lang.AutoCloseable
- All Known Implementing Classes:
BucketContainerIterator
,CombineDataIterator
,ContainerDataIterator
,DeletedContainerDataIterator
,DeletedMinMaxIterator
,EmptyDataIterator
,SequentialContainerIterator
,TimeSpecificationCombineDataIterator
public interface DataIterator
extends java.lang.AutoCloseable
Ein Iterator über die Datensätze von mehreren Containern. Der Iterator verhält sich anders als der Standard-Java-iterator und mehr wie
eine Queue.
peek
ruft den aktuellen Datensatz am Kopf der Queue ab, remove
entfernt diesen,
sodass der nächste Datensatz abgerufen werden kann (falls vorhanden). poll(ContainerDataResult)
gibt den aktuellen Datensatz zurück und entfernt ihn in einem Schritt.
Die Iteration mit dieser Klasse erfolg wie beispielsweise folgt:
ContainerDataResult result = new ContainerDataResult()
while(!iter.isEmpty()) {
iter.poll(result);
// tue was mit result
}
iter.close()
oder alternative Vorgehensweise zum Ausgeben aller Datenindizes:
while(!iterator.isEmpty()) {
System.out.println(iterator.peekDataIndex());
iterator.remove();
}
-
Method Summary
Modifier and Type Method Description void
close()
Terminiert das iterieren.static DataIterator
empty()
Gibt einen leeren DataIterator zurückContainerManagementData
getContainerManagementData()
Gibt die Containerheaderdaten des Containers des aktuell betrachteten Datensatzes zurückboolean
isEmpty()
Gibttrue
zurück, wenn der Iterator erschöpft ist.void
peek(ContainerDataResult result)
Kopiert die Daten des aktuellen Elements in das angegebene Result-Objekt.long
peekArchiveTime()
Ruft die aktuelle Archivzeit ab.long
peekDataIndex()
Ruft den aktuellen Datenindex ab.long
peekDataTime()
Ruft die aktuelle Datenzeit ab.ContainerDataResult
peekNext()
Gibt Daten des auf die gültige Sequenz folgenden Datensatzes zurück, damit kann dann unter anderem bestimmt werden, wie lange der Datensatz gültig ist.default void
poll(ContainerDataResult result)
Entspricht dem Aufruf von `peek(result)´ gefolgt von `remove()`.void
remove()
Entfernt das aktuelle Element.
-
Method Details
-
peek
Kopiert die Daten des aktuellen Elements in das angegebene Result-Objekt. Dies ist eine Optimierung, damit nicht ständig neue Result-Objekt angelegt werden müssen.- Parameters:
result
- Ziel-Element- Throws:
java.util.NoSuchElementException
- falls kein Element mehr Verfügbar (isEmpty == true)PersistenceException
-
peekNext
@Nullable ContainerDataResult peekNext() throws PersistenceException, SynchronizationFailedExceptionGibt Daten des auf die gültige Sequenz folgenden Datensatzes zurück, damit kann dann unter anderem bestimmt werden, wie lange der Datensatz gültig ist. Diese Methode darf nur aufgerufen werden, wennisEmpty()
true zurückliefert.- Returns:
- Ziel-Element oder null falls es keinen nächsten Datensatz gibt
- Throws:
java.lang.IllegalStateException
- falls isEmpty != truePersistenceException
SynchronizationFailedException
-
peekDataIndex
long peekDataIndex()Ruft den aktuellen Datenindex ab. Entspricht
ist aber wahrscheinlich performanter.ContainerDataResult result = new ContainerDataResult() this.peek(result) return result.getDataIndex()
- Returns:
- Datenindex des aktuellen Elements
- Throws:
java.util.NoSuchElementException
- falls kein Element mehr Verfügbar (isEmpty == true)
-
peekDataTime
long peekDataTime()Ruft die aktuelle Datenzeit ab. Entspricht
ist aber wahrscheinlich performanter.ContainerDataResult result = new ContainerDataResult() this.peek(result) return result.getDataTime()
- Returns:
- Datenzeit des aktuellen Elements
- Throws:
java.util.NoSuchElementException
- falls kein Element mehr Verfügbar (isEmpty == true)
-
peekArchiveTime
long peekArchiveTime()Ruft die aktuelle Archivzeit ab. Entspricht
ist aber wahrscheinlich performanter.ContainerDataResult result = new ContainerDataResult() this.peek(result) return result.getArchiveTime()
- Returns:
- Archivzeit des aktuellen Elements
- Throws:
java.util.NoSuchElementException
- falls kein Element mehr Verfügbar (isEmpty == true)
-
poll
default void poll(ContainerDataResult result) throws PersistenceException, SynchronizationFailedExceptionEntspricht dem Aufruf von `peek(result)´ gefolgt von `remove()`.- Parameters:
result
- Objekt, in dem das Ergebnis abgelegt wird.- Throws:
PersistenceException
SynchronizationFailedException
-
remove
Entfernt das aktuelle Element. -
isEmpty
boolean isEmpty()Gibttrue
zurück, wenn der Iterator erschöpft ist. Ist das der Fall liefern alle anderen Funktionen außer close()NoSuchElementException
s.- Returns:
true
, wenn der Iterator erschöpft ist, sonstfalse
-
close
void close()Terminiert das iterieren. Hierdurch werden alle ggf. noch offenen Containerdateien geschlossen.- Specified by:
close
in interfacejava.lang.AutoCloseable
-
empty
Gibt einen leeren DataIterator zurück- Returns:
- leerer DataIterator (singleton)
-
getContainerManagementData
Gibt die Containerheaderdaten des Containers des aktuell betrachteten Datensatzes zurück- Returns:
- ContainerManagementData
- Throws:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-