Interface IndexResult<E extends java.lang.Enum<E>>

All Known Implementing Classes:
BinaryIndexResult

public interface IndexResult<E extends java.lang.Enum<E>>
Ergebnis einer Index-Abfrage, entspricht einer Tabellen-Darstellung mit dem Typ-Parameter E als "Spaltenkopf".

Werte können mit get(int, Enum) abgefragt werden, wobei der erste parameter die Zeile und der zweite die Spalte ist.

  • Method Summary

    Modifier and Type Method Description
    static <T extends java.lang.Enum<T>>
    IndexResult<T>
    empty()
    Gibt ein leeres Indexergebnis zurück.
    long get​(int index, E value)
    Gibt eine einzelne Information als Long-Wert zurück
    boolean getBoolean​(int index, E containerHeaderParam)
    Gibt eine einzelne Information als Boolean-Wert zurück
    java.util.List<IndexContentDescriptor.IndexColumn> getColumns()
    Gibt die Spalten des Ergebnisses zurück.
    long getMax​(E value)
    Gibt den maximalen Wert einer Spalte innerhalb des Ergebnisses zurück
    long getMin​(E value)
    Gibt den minimalen Wert einer Spalte innerhalb des Ergebnisses zurück
    long getNext​(E value)
    Gibt einen Wert aus dem ersten nach dem Anfragebereich liegenden Datensatz zurück
    int getSignedInt​(int index, E value)
    Gibt eine einzelne Information als Integer-Wert mit Vorzeichen zurück
    java.lang.String getString​(int index, E value)
    Gibt eine einzelne Information als String-Wert zurück
    boolean hasNext()
    Gibt true zurück, wenn ein nächster Datensatz nach dem Anfragebereich ermittelt wurde
    boolean isEmpty()
    Gibt true zurück, wenn das Ergebnis leer ist
    int size()
    Gibt die Anzahl Datensätze zurück.
    java.lang.String toString()  
  • Method Details

    • empty

      static <T extends java.lang.Enum<T>> IndexResult<T> empty()
      Gibt ein leeres Indexergebnis zurück. Dieses Ergebnis enthält keine Daten und ist als Singleton implementiert.
      Type Parameters:
      T - Generischer Typ (beliebig)
      Returns:
      Dummy-Indexergebnis ohne Werte (immutable)
    • size

      int size()
      Gibt die Anzahl Datensätze zurück. Der Datensatz hinter dem Anfragebereich wird nicht mitgezählt.
      Returns:
      die Anzahl Datensätze
    • get

      long get​(int index, E value)
      Gibt eine einzelne Information als Long-Wert zurück
      Parameters:
      index - Zeilen/Datensatzindex im Ergebnis. 0 gibt den ersten Eintrag zurück, 1 den zweiten usw.
      value - Wert/Spalte, der abgefragt werden soll
      Returns:
      Information als Long-Wert oder -1 wenn der entsprechende Wert nicht indiziert wurde.
      Throws:
      java.lang.IllegalArgumentException - bei ungültigen Anfragen außerhalb des Bereichs
    • getSignedInt

      int getSignedInt​(int index, E value)
      Gibt eine einzelne Information als Integer-Wert mit Vorzeichen zurück
      Parameters:
      index - Zeilen/Datensatzindex im Ergebnis. 0 gibt den ersten Eintrag zurück, 1 den zweiten usw.
      value - Wert/Spalte, der abgefragt werden soll
      Returns:
      Information als Integer-Wert oder -1 wenn der entsprechende Wert nicht indiziert wurde.
      Throws:
      java.lang.IllegalArgumentException - bei ungültigen Anfragen außerhalb des Bereichs
    • getString

      java.lang.String getString​(int index, E value)
      Gibt eine einzelne Information als String-Wert zurück
      Parameters:
      index - Zeilen/Datensatzindex im Ergebnis. 0 gibt den ersten Eintrag zurück, 1 den zweiten usw.
      value - Wert/Spalte, der abgefragt werden soll
      Returns:
      Information als String-Wert oder `null` wenn der entsprechende Wert nicht indiziert wurde.
      Throws:
      java.lang.IllegalArgumentException - bei ungültigen Anfragen außerhalb des Bereichs
    • getBoolean

      boolean getBoolean​(int index, E containerHeaderParam)
      Gibt eine einzelne Information als Boolean-Wert zurück
      Parameters:
      index - Zeilen/Datensatzindex im Ergebnis. 0 gibt den ersten Eintrag zurück, 1 den zweiten usw.
      containerHeaderParam - Wert/Spalte, der abgefragt werden soll
      Returns:
      Information als Boolean-Wert oder false wenn der entsprechende Wert nicht indiziert wurde.
      Throws:
      java.lang.IllegalArgumentException - bei ungültigen Anfragen außerhalb des Bereichs
    • hasNext

      boolean hasNext()
      Gibt true zurück, wenn ein nächster Datensatz nach dem Anfragebereich ermittelt wurde
      Returns:
      true, wenn ein nächster Datensatz nach dem Anfragebereich ermittelt wurde, sonst false
    • getNext

      long getNext​(E value)
      Gibt einen Wert aus dem ersten nach dem Anfragebereich liegenden Datensatz zurück
      Parameters:
      value - Spalte
      Returns:
      einen Wert aus dem nächsten Datensatz
    • isEmpty

      boolean isEmpty()
      Gibt true zurück, wenn das Ergebnis leer ist
      Returns:
      true, wenn das Ergebnis leer ist, sonst false
    • getMin

      long getMin​(E value)
      Gibt den minimalen Wert einer Spalte innerhalb des Ergebnisses zurück
      Parameters:
      value - Spalte
      Returns:
      den minimalen Wert einer Spalte innerhalb des Ergebnisses
    • getMax

      long getMax​(E value)
      Gibt den maximalen Wert einer Spalte innerhalb des Ergebnisses zurück
      Parameters:
      value - Spalte
      Returns:
      den maximalen Wert einer Spalte innerhalb des Ergebnisses
    • getColumns

      java.util.List<IndexContentDescriptor.IndexColumn> getColumns()
      Gibt die Spalten des Ergebnisses zurück. Dies entspricht den im Index definierten Spalten.
      Returns:
      die Spalten des Ergebnisses
    • toString

      java.lang.String toString()
      Overrides:
      toString in class java.lang.Object