Class ArchiveDataSpecification

java.lang.Object
de.bsvrz.dav.daf.main.archive.ArchiveDataSpecification

public class ArchiveDataSpecification
extends java.lang.Object
Ein Objekt dieser Klasse spiegelt eine Archivanfrage (ohne Priorität) wieder.
  • Constructor Details

    • ArchiveDataSpecification

      public ArchiveDataSpecification​(ArchiveTimeSpecification timeSpec, ArchiveDataKindCombination dataKinds, ArchiveOrder sortOrder, ArchiveRequestOption requestOption, DataDescription dataDescription, SystemObject object)
      Erzeugt eine Definition für eine Archivanfrage, die Archivdaten für ein Systemobjekt abfragt
      Parameters:
      timeSpec - Definition des angefragten Zeitbereichs/Indexbereichs
      dataKinds - Datenarten
      sortOrder - Sortierung
      requestOption - Anfrageart
      dataDescription - Angefragte Datenart (Attributguppe/Aspekt/Simulationsvariante-Kombination)
      object - Systemobjekt, von dem die Daten abgefragt werden sollen
    • ArchiveDataSpecification

      public ArchiveDataSpecification​(ArchiveTimeSpecification timeSpec, ArchiveDataKindCombination dataKinds, ArchiveOrder sortOrder, ArchiveRequestOption requestOption, DataDescription dataDescription, SystemObject object, boolean queryWithPid)
      Erzeugt eine Definition für eine Archivanfrage, die Archivdaten für ein Systemobjekt und optional historische Objekte mit gleicher Pid abfragt. Dieser Konstruktor ist möglicherweise bei älteren DAF nicht vorhanden.
      Parameters:
      timeSpec - Definition des angefragten Zeitbereichs/Indexbereichs
      dataKinds - Datenarten
      sortOrder - Sortierung
      requestOption - Anfrageart
      dataDescription - Angefragte Datenart (Attributguppe/Aspekt/Simulationsvariante-Kombination)
      object - Systemobjekt, von dem die Daten abgefragt werden sollen
      queryWithPid - Bestimmt ob anhand der Objekt-Pid eventuell noch Daten von zusätzlichen historischen Objekten abgefragt werden sollen. Siehe setQueryWithPid().
  • Method Details

    • setQueryWithPid

      public void setQueryWithPid()
      Sorgt dafür, dass anhand der Objekt-Pid eventuell noch Daten von zusätzlichen historischen Objekten abgefragt werden sollen. Archivsystemseitig oder bei Systemobjekten ohne Pid hat dieses Flag keine Funktion. Diese Methode ist möglicherweise bei älteren DAF nicht vorhanden. Es kann daher aus Kompatibilitätsgründen sinnvoll sein, den klassischen Konstruktor ohne queryWithPid-Parameter zu verwenden und nachher diese Funktion in einem try-catch-Block aufzurufen:
      
       ArchiveDataSpecification ads = new ArchiveDataSpecification(...);
       try {
           ads.setQueryWithPid();
       }
       catch(NoSuchMethodError e) {}
       
       
    • getQueryWithPid

      public boolean getQueryWithPid()
      Gibt zurück, ob anhand der Objekt-Pid eventuell noch Daten von zusätzlichen historischen Objekten abgefragt werden sollen. Archivsystemseitig oder bei Systemobjekten ohne Pid hat dieses Flag keine Funktion. Diese Methode ist möglicherweise bei älteren DAF nicht vorhanden.
      Returns:
      true wenn anhand der Pid historische Objekte berücksichtigt werden sollen, sonst false
    • getObject

      public SystemObject getObject()
      Returns:
      SystemObject
    • toString

      public java.lang.String toString()
      String-Repräsentation des Objektes.
      Overrides:
      toString in class java.lang.Object
      Returns:
      Beschreibung des Objektes.
    • getTimeSpec

      public ArchiveTimeSpecification getTimeSpec()
      Returns:
      Zeit/Indexbereich auf den sich die Archivanfrage bezieht
    • getDataKinds

      public ArchiveDataKindCombination getDataKinds()
      Returns:
      Welche Art von Daten sollen in die Archivantwort einbezogen werden (online, onlineDelayed, ...)
    • getSortOrder

      public ArchiveOrder getSortOrder()
      Returns:
      Wie sollen die nachgelieferten Datensätze einsortiert werden (Zeit, Index)
    • getRequestOption

      public ArchiveRequestOption getRequestOption()
      Returns:
      Zustandsanfrage oder Deltaanfrage
    • getDataDescription

      public DataDescription getDataDescription()
      Angefragte Datenart (Attributguppe/Aspekt/Simulationsvariante-Kombination)
      Returns:
      DataDescription