Class ArchiveTimeSpecification


  • public class ArchiveTimeSpecification
    extends java.lang.Object
    Ein Objekt dieser Klasse bestimmt den Zeitbereich/Indexbereich (Intervall) einer Archivanfrage. Bei der Bestimmung des Intervalls können folgende 6 Fälle unterschieden werden:
    Anfangs- und Endzeitpunkt bzgl. Datenzeit
    Anfangs- und Endzeitpunkt bzgl. Archivzeit
    Anfangs- und Enddatenindex
    Endzeitpunkt bzgl. Datenzeit, Anfang durch Anzahl Datensätze
    Endzeitpunkt bzgl. Archivzeit, Anfang durch Anzahl Datensätze
    Enddatenindex, Anfang durch Anzahl Datensätze
    • Constructor Summary

      Constructors 
      Constructor Description
      ArchiveTimeSpecification​(TimingType timingType, boolean startRelative, long intervalStart, long intervalEnd)
      Erzeugt eine ArchiveTimeSpecification, mit der ein Intervall beschrieben werden kann, für das eine Archivanfrage gilt.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long getIntervalEnd()
      Das Intervallende einer Archivanfrage.
      long getIntervalStart()
      Der Rückgabewert ist entweder ein absoluter Wert oder eine Anzahl Datensätze, die vor dem Intervalende liegen
      TimingType getTimingType()
      Auf welchen Typ (Datenzeit, Archivzeit, Datenindex) beziehen sich die Intervallangaben.
      boolean isStartRelative()
      Der Rückgabewert bestimmt, ob der Intervallstart als relativer Wert interpretiert werden muss.
      java.lang.String toString()
      Liefert eine String-Repräsentation dieser Klasse zurück.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ArchiveTimeSpecification

        public ArchiveTimeSpecification​(TimingType timingType,
                                        boolean startRelative,
                                        long intervalStart,
                                        long intervalEnd)
        Erzeugt eine ArchiveTimeSpecification, mit der ein Intervall beschrieben werden kann, für das eine Archivanfrage gilt.
        Parameters:
        timingType - Typ der Intervallangabe in den folgenden Parametern. Je nach Wert beziehen sich die Angaben in intervalStart und intervalEnd auf den Datenzeitstempel, den Archivzeitstempel oder den Datensatzindex.
        intervalStart - Start des Intervalls. Positive Werte dieses Parameters beziehen sich je nach Wert des Parameters timingType auf den Datenzeitstempel, den Archivzeitstempel oder den Datensatzindex. Wenn startRelative auf true gesetzt wurde, wird der Wert als Anzahl Datensätze vor dem intervalEnd interpretiert, unabhängig vom gewählten timingType. In diesem Fall sollten die Anzahl an Datensätzen nicht zu groß gewählt werden, da
        • das Archivsystem die Anzahl der angefragten Datensätze typischerweise auf 16000 begrenzt
        • bei Anfragen mit Pid (ArchiveDataSpecification.setQueryWithPid()) möglicherweise sehr viele Daten angefragt werden müssen, die dann unter hohem Aufwand und Speicherverbrauch entsprechend gefiltert werden müssen.
        intervalEnd - Ende des Intervalls. Dieser Wert bezieht sich je nach timingType auf den Datenzeitstempel, den Archivzeitstempel oder den Datensatzindex.
        startRelative - Wenn true wird der Wert in intervalStart als Anzahl Datensätze interpretiert, die vor dem intervalEnd liegen, sonst werden intervalStart und intervalEnd als absolute Werte interpretiert.
    • Method Detail

      • getTimingType

        public TimingType getTimingType()
        Auf welchen Typ (Datenzeit, Archivzeit, Datenindex) beziehen sich die Intervallangaben.
        Returns:
        Typ des Intervalls
      • isStartRelative

        public boolean isStartRelative()
        Der Rückgabewert bestimmt, ob der Intervallstart als relativer Wert interpretiert werden muss.
        Returns:
        true = Der Intervallstart wird als Anzahl Datensätze interpretiert, die vor dem Intervallende liegen müssen; false = Der Intervallstart wird als absoluter Wert interpretiert
      • getIntervalStart

        public long getIntervalStart()
        Der Rückgabewert ist entweder ein absoluter Wert oder eine Anzahl Datensätze, die vor dem Intervalende liegen. (isStartRelative()).
        Returns:
        absoluter Wert oder Anzahl Datensätze
      • getIntervalEnd

        public long getIntervalEnd()
        Das Intervallende einer Archivanfrage.
        Returns:
        abolutes Intervallende
      • toString

        public java.lang.String toString()
        Liefert eine String-Repräsentation dieser Klasse zurück.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String-Repräsentation dieser Klasse