Class ResultData

  • All Implemented Interfaces:
    Dataset

    public class ResultData
    extends java.lang.Object
    implements Dataset
    Ergebnisdatensatz zum Zugriff auf ein empfangenes Datentelegramm und zum Erzeugen eines zu versendenden Datentelegramms. Neben den konkreten Attributwerten der jeweiligen Attributgruppe enthält ein Ergebnisdatensatz Headerinformationen, die in jedem Datentelegramm enthalten sind wie z.B Fehlerstatus, laufende Datensatznummer, Zeitstempel, Systemobjekt und Datenbeschreibung des Datensatzes sowie eine Kennzeichnung ob der Datensatz aktuell oder nachgeliefert ist.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Data getData()
      Bestimmt den im Ergebnis enthaltenen Datensatz.
      DataDescription getDataDescription()
      Bestimmt die Beschreibung der im Ergebnis enthaltenen Daten.
      long getDataIndex()
      Bestimmt die laufende Nummer dieses Datensatzes.
      ArchiveDataKind getDataKind()
      Bestimmt die Datensatzart dieses Datensatzes.
      DataState getDataState()
      Liefert den Datensatzzustand dieses Datensatzes.
      long getDataTime()
      Bestimmt den Zeitstempel dieses Datensatzes.
      DataState getDataType()
      Bestimmt den Datensatztyp dieses Datensatzes.
      SystemObject getObject()
      Bestimmt das System-Objekt zu dem die im Ergebnis enthaltenen Daten gehören.
      boolean hasData()
      Bestimmt ob im Ergebnis ein Datensatz enthalten ist.
      boolean isDelayedData()
      Bestimmt ob es sich bei den im Ergebnis enthaltenen Daten um nachgelieferte Daten handelt.
      boolean isNoDataAvailable()
      Bestimmt ob keine Daten enthalten sind, weil die Quelle keine Daten ermitteln konnte.
      boolean isNoRightsAvailable()
      Bestimmt ob keine Daten enthalten sind, weil keine Rechte zum Zugriff vorlagen.
      boolean isNoSourceAvailable()
      Bestimmt ob keine Daten enthalten sind, weil die Quelle nicht verfügbar ist.
      boolean isNoValidSubscription()
      Bestimmt ob keine Daten enthalten sind, weil die Anmeldung der Daten im Konflikt mit anderen Anmeldungen steht (z.B. mehrere Senken für die gleichen Daten).
      boolean isSourceAvailable()
      Bestimmt ob das Ergebnis von der Quelle generiert wurde.
      void setDataTime​(long time)
      Setzt den Zeitstempel dieses Datensatzes.
      java.lang.String toString()
      Liefert eine textuelle Beschreibung dieses Objekts zurück.
      • Methods inherited from class java.lang.Object

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

      • ResultData

        public ResultData​(SystemObject object,
                          DataDescription dataDescription,
                          long time,
                          Data data,
                          boolean delayedData)
        Erzeugt ein neues Ergebnis mit den übergebenen Eigenschaften. Die konkreten Attributwerte müssen in einem Data-Objekt zur Verfügung gestellt werden. Ein solches Datensatzobjekt kann mit der Methode ClientDavInterface.createData(de.bsvrz.dav.daf.main.config.AttributeGroup) erzeugt werden.
        Parameters:
        object - Das System-Objekt zu dem die Daten gehören.
        dataDescription - Beschreibende Informationen der zu versendenden Daten
        time - Zeitstempel dieses Datensatzes in Millisekunden seit 1970.
        data - Datensatz mit den Attributwerten des Ergebnisses oder null, wenn kein Datensatz zur Verfügung gestellt werden kann.
        delayedData - true, wenn der im Ergebnis enthaltene Datensatz als nachgeliefert gekennzeichnet werden soll.
        See Also:
        ClientDavInterface.createData(de.bsvrz.dav.daf.main.config.AttributeGroup)
      • ResultData

        public ResultData​(SystemObject object,
                          DataDescription dataDescription,
                          long time,
                          Data data,
                          boolean delayedData,
                          DataState dataState)
        Erzeugt ein neues Ergebnis mit den übergebenen Eigenschaften. Die konkreten Attributwerte müssen in einem Data-Objekt zur Verfügung gestellt werden. Ein solches Datensatzobjekt kann mit der Methode ClientDavInterface.createData(de.bsvrz.dav.daf.main.config.AttributeGroup) erzeugt werden.
        Parameters:
        object - Das System-Objekt zu dem die Daten gehören.
        dataDescription - Beschreibende Informationen der zu versendenden Daten
        time - Zeitstempel dieses Datensatzes in Millisekunden seit 1970.
        data - Datensatz mit den Attributwerten des Ergebnisses oder null, wenn kein Datensatz zur Verfügung gestellt werden kann.
        delayedData - true, wenn der im Ergebnis enthaltene Datensatz als nachgeliefert gekennzeichnet werden soll.
        dataState - Gibt den Zustand des Datensatzes an.
        See Also:
        ClientDavInterface.createData(de.bsvrz.dav.daf.main.config.AttributeGroup)
      • ResultData

        public ResultData​(SystemObject object,
                          DataDescription dataDescription,
                          long time,
                          Data data)
        Erzeugt ein neues Ergebnis mit den übergebenen Eigenschaften. Die konkreten Attributwerte müssen in einem Data-Objekt zur Verfügung gestellt werden. Ein solches Datensatzobjekt kann mit der Methode ClientDavInterface.createData(de.bsvrz.dav.daf.main.config.AttributeGroup) erzeugt werden. Der erzeugte Datensatz wird nicht als nachgeliefert markiert.
        Parameters:
        object - Das System-Objekt zu dem die Daten gehören.
        dataDescription - Beschreibende Informationen der zu versendenden Daten
        time - Zeitstempel dieses Datensatzes in Millisekunden seit 1970.
        data - Datensatz mit den Attributwerten des Ergebnisses oder null, wenn kein Datensatz zur Verfügung gestellt werden kann.
      • ResultData

        public ResultData​(SystemObject object,
                          DataDescription dataDescription,
                          boolean delayedData,
                          long dataIndex,
                          long time,
                          byte errorFlag,
                          Data data)
        Erzeugt ein neues Ergebnis mit den übergebenen Eigenschaften.
        Parameters:
        object - Das System-Objekt zu dem die Daten gehören.
        dataDescription - Beschreibende Informationen der zu versendenden Daten
        delayedData - true, wenn der im Ergebnis enthaltene Datensatz als nachgeliefert gekennzeichnet werden soll.
        dataIndex - die laufende Nummer des Datensatzes
        time - Zeitstempel dieses Datensatzes in Millisekunden seit 1970.
        errorFlag - Fehlerkennung der Anwendungsdaten
        data - Datensatz mit den Attributwerten des Ergebnisses oder null, wenn kein Datensatz zur Verfügung gestellt werden kann.
    • Method Detail

      • getObject

        public final SystemObject getObject()
        Bestimmt das System-Objekt zu dem die im Ergebnis enthaltenen Daten gehören.
        Specified by:
        getObject in interface Dataset
        Returns:
        System-Objekt die enthaltenen Daten
      • getDataDescription

        public final DataDescription getDataDescription()
        Bestimmt die Beschreibung der im Ergebnis enthaltenen Daten.
        Specified by:
        getDataDescription in interface Dataset
        Returns:
        Beschreibung der Daten
      • isDelayedData

        public final boolean isDelayedData()
        Bestimmt ob es sich bei den im Ergebnis enthaltenen Daten um nachgelieferte Daten handelt.
        Returns:
        true bei Nachgelieferten Daten, sonst false.
      • hasData

        public final boolean hasData()
        Bestimmt ob im Ergebnis ein Datensatz enthalten ist.
        Returns:
        true wenn ein Datensatz enthalten ist, sonst false.
      • isSourceAvailable

        public final boolean isSourceAvailable()
        Bestimmt ob das Ergebnis von der Quelle generiert wurde.
        Returns:
        true wenn das Ergebnis von der Quelle generiert wurde, sonst false.
      • getDataTime

        public final long getDataTime()
        Bestimmt den Zeitstempel dieses Datensatzes.
        Specified by:
        getDataTime in interface Dataset
        Returns:
        Absolute Zeitangabe in Millisekunden seit dem 01.01.1970
      • setDataTime

        public final void setDataTime​(long time)
        Setzt den Zeitstempel dieses Datensatzes.
        Parameters:
        time - Absolute Zeitangabe in Millisekunden seit dem 01.01.1970
      • getDataIndex

        public final long getDataIndex()
        Bestimmt die laufende Nummer dieses Datensatzes. Mit der laufenden Nummer wird ein Datensatz eindeutig (je Objekt und Datenbeschreibung) identifiziert.
        Specified by:
        getDataIndex in interface Dataset
        Returns:
        Laufende Nummer des Datensatzes.
      • getData

        public final Data getData()
        Bestimmt den im Ergebnis enthaltenen Datensatz.
        Specified by:
        getData in interface Dataset
        Returns:
        Datensatz oder null, wenn kein Datensatz im Ergebnis enthalten ist.
      • isNoDataAvailable

        public final boolean isNoDataAvailable()
        Bestimmt ob keine Daten enthalten sind, weil die Quelle keine Daten ermitteln konnte.
        Returns:
        true wenn keine Daten vorliegen, weil die Quelle keine Daten ermitteln konnte, sonst false
      • isNoSourceAvailable

        public final boolean isNoSourceAvailable()
        Bestimmt ob keine Daten enthalten sind, weil die Quelle nicht verfügbar ist.
        Returns:
        true wenn keine Daten vorliegen, weil die Quelle nicht verfügbar ist, sonst false
      • isNoRightsAvailable

        public final boolean isNoRightsAvailable()
        Bestimmt ob keine Daten enthalten sind, weil keine Rechte zum Zugriff vorlagen.
        Returns:
        true wenn keine Daten vorliegen, weil keine Rechte zum Zugriff vorlagen, sonst false
      • isNoValidSubscription

        public final boolean isNoValidSubscription()
        Bestimmt ob keine Daten enthalten sind, weil die Anmeldung der Daten im Konflikt mit anderen Anmeldungen steht (z.B. mehrere Senken für die gleichen Daten).
        Returns:
        true wenn keine Daten vorliegen, weil die Anmeldung im Konflikt mit anderen Anmeldungen steht, sonst false
      • getDataState

        public final DataState getDataState()
        Liefert den Datensatzzustand dieses Datensatzes.
        Returns:
        Datensatzzustand dieses Datensatzes.
      • toString

        public java.lang.String toString()
        Liefert eine textuelle Beschreibung dieses Objekts zurück. Das genaue Format ist nicht festgelegt und kann sich ändern.
        Overrides:
        toString in class java.lang.Object
        Returns:
        Beschreibung dieses Objekts.
      • getDataType

        public DataState getDataType()
        Bestimmt den Datensatztyp dieses Datensatzes.
        Specified by:
        getDataType in interface Dataset
        Returns:
        Datensatztyp.
      • getDataKind

        public ArchiveDataKind getDataKind()
        Bestimmt die Datensatzart dieses Datensatzes.
        Specified by:
        getDataKind in interface Dataset
        Returns:
        Datensatzart.