de.bsvrz.dav.daf.main
Class HistorySpecification

java.lang.Object
  extended by de.bsvrz.dav.daf.main.HistorySpecification

public class HistorySpecification
extends Object

Diese Klasse dient zur Angabe von Parametern bei der Abfrage von historischen Daten mit der Methode ClientDavInterface.getCachedData(de.bsvrz.dav.daf.main.config.SystemObject[], de.bsvrz.dav.daf.main.DataDescription, de.bsvrz.dav.daf.main.ReceiveOptions, de.bsvrz.dav.daf.main.HistorySpecification).

Author:
Kappich Systemberatung

Field Summary
private  int _count
          Anzahl zu lesender Datensätze.
private  long _fromTime
          Startszeit des Zeitintervalls
private  long _toTime
          Endzeit des Zeitintervalls
private  byte _type
          Typ der Anfrage
 
Constructor Summary
private HistorySpecification(int count)
           
private HistorySpecification(long fromTime, long toTime)
           
 
Method Summary
static HistorySpecification actual()
          Erzeugt ein neues Parameterobjekt zur Abfrage des aktuellen Datensatzes.
static HistorySpecification atTime(long time)
          Erzeugt ein neues Parameterobjekt zur Abfrage des zu einem bestimmten Zeitpunkt gültigen Datensatzes.
static HistorySpecification forTime(long time)
          Erzeugt ein neues Parameterobjekt zur Abfrage der Datensätze in einem Zeitbereich, der über eine spezifizierte Zeitdauer in der unmittelbaren Vergangenheit bis zum aktuellen Zeitpunkt definiert ist.
 int getCount()
          Liefert die spezifizierte Anzahl gewünschter Datensätze zurück.
 long getFromTime()
          Liefert den Anfang des spezifierten Zeitbereichs zurück.
 long getToTime()
          Liefert das Ende des spezifierten Zeitbereichs zurück.
static HistorySpecification inPeriod(long fromTime, long toTime)
          Erzeugt ein neues Parameterobjekt zur Abfrage der in einem bestimmten Zeitbereich gültigen Datensätze.
 boolean isCountSpecification()
          Bestimmt, ob diese Spezifikation über die Anzahl gewünschter Datensätze definiert wurde.
 boolean isTimeSpecification()
          Bestimmt, ob diese Spezifikation über einen Zeitbereich definiert wurde.
static HistorySpecification last(int count)
          Erzeugt ein neues Parameterobjekt zur Abfrage der letzten historischen Datensätze mit Angabe der Anzahl zu lesender Datensätze.
static HistorySpecification sinceTime(long time)
          Erzeugt ein neues Parameterobjekt zur Abfrage der Datensätze in einem Zeitbereich beginnend bei einem angegebenen Zeitpunkt bis zum aktuellen Zeitpunkt.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_type

private byte _type
Typ der Anfrage


_count

private int _count
Anzahl zu lesender Datensätze.


_fromTime

private long _fromTime
Startszeit des Zeitintervalls


_toTime

private long _toTime
Endzeit des Zeitintervalls

Constructor Detail

HistorySpecification

private HistorySpecification(int count)

HistorySpecification

private HistorySpecification(long fromTime,
                             long toTime)
Method Detail

isCountSpecification

public final boolean isCountSpecification()
Bestimmt, ob diese Spezifikation über die Anzahl gewünschter Datensätze definiert wurde.

Returns:
true falls diese Spezifikation über die Anzahl definiert wurde, sonst false.

isTimeSpecification

public final boolean isTimeSpecification()
Bestimmt, ob diese Spezifikation über einen Zeitbereich definiert wurde.

Returns:
true falls diese Spezifikation über einen Zeitbereich definiert wurde, sonst false.

getCount

public final int getCount()
Liefert die spezifizierte Anzahl gewünschter Datensätze zurück.

Returns:
Anzahl gewünschter Datensätze.

getFromTime

public final long getFromTime()
Liefert den Anfang des spezifierten Zeitbereichs zurück.

Returns:
Anfang des spezifierten Zeitbereichs in Millisekunden seit 1970.

getToTime

public final long getToTime()
Liefert das Ende des spezifierten Zeitbereichs zurück.

Returns:
Ende des spezifierten Zeitbereichs in Millisekunden seit 1970.

actual

public static HistorySpecification actual()
Erzeugt ein neues Parameterobjekt zur Abfrage des aktuellen Datensatzes.

Returns:
Parameterobjekt zur Abfrage des aktuellen Datensatzes.

last

public static HistorySpecification last(int count)
Erzeugt ein neues Parameterobjekt zur Abfrage der letzten historischen Datensätze mit Angabe der Anzahl zu lesender Datensätze.

Parameters:
count - Anzahl zu lesender Datensätze.
Returns:
Parameterobjekt zur Abfrage von historischen Daten.

atTime

public static HistorySpecification atTime(long time)
Erzeugt ein neues Parameterobjekt zur Abfrage des zu einem bestimmten Zeitpunkt gültigen Datensatzes.

Parameters:
time - Zeitpunkt, an dem der gewünschte Datensatz gültig war, in Millisekunden seit 1970.
Returns:
Parameterobjekt zur Abfrage von historischen Daten

inPeriod

public static HistorySpecification inPeriod(long fromTime,
                                            long toTime)
Erzeugt ein neues Parameterobjekt zur Abfrage der in einem bestimmten Zeitbereich gültigen Datensätze.

Parameters:
fromTime - Anfangszeitpunkt des Zeitbereichs in Millisekunden seit 1970.
toTime - Endezeitpunkt des Zeitbereichs in Millisekunden seit 1970.
Returns:
Parameterobjekt zur Abfrage von historischen Daten

sinceTime

public static HistorySpecification sinceTime(long time)
Erzeugt ein neues Parameterobjekt zur Abfrage der Datensätze in einem Zeitbereich beginnend bei einem angegebenen Zeitpunkt bis zum aktuellen Zeitpunkt.

Parameters:
time - Anfangszeitpunkt des Zeitbereichs in Millisekunden seit 1970.
Returns:
Parameterobjekt zur Abfrage von historischen Daten

forTime

public static HistorySpecification forTime(long time)
Erzeugt ein neues Parameterobjekt zur Abfrage der Datensätze in einem Zeitbereich, der über eine spezifizierte Zeitdauer in der unmittelbaren Vergangenheit bis zum aktuellen Zeitpunkt definiert ist.

Parameters:
time - Dauer des Zeitbereichs in Millisekunden.
Returns:
Parameterobjekt zur Abfrage von historischen Daten