Class ProtocolData

  • All Implemented Interfaces:
    de.bsvrz.dav.daf.main.Data, java.lang.Iterable<de.bsvrz.dav.daf.main.Data>
    Direct Known Subclasses:
    ArrayProtocolData, AttributeGroupProtocolData, AttributeProtocolData, MultiColumnProtocolData

    public abstract class ProtocolData
    extends java.lang.Object
    implements de.bsvrz.dav.daf.main.Data
    Bietet eine Kapselung der Protokolldaten in ein Interface, wie es Dav-Daten benutzen. Anders als Dav-Daten sind diese Daten nicht streng an die verwendete Attributgruppe bzw. das verwendete Attribut gebunden (sofern überhaupt eines existiert). Je nach Anwendungsfall bieten sich daher auch Abfragen nach Data.isDefined(), Data.isPlain() usw. an, auch wenn die Attributgruppe diese Daten eigentlich nicht unterstützen würde. Besonders wichtig ist dies bei Fehlermeldungen von PuA (wie z.B. einer Division durch 0, oder einem "Keine Daten"-Datensatz), da hier die Meldung unabhängig vom Attributtyp über Data.asTextValue() abgerufen werden kann.
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface de.bsvrz.dav.daf.main.Data

        de.bsvrz.dav.daf.main.Data.Array, de.bsvrz.dav.daf.main.Data.FormatException, de.bsvrz.dav.daf.main.Data.NumberArray, de.bsvrz.dav.daf.main.Data.NumberValue, de.bsvrz.dav.daf.main.Data.ReferenceArray, de.bsvrz.dav.daf.main.Data.ReferenceValue, de.bsvrz.dav.daf.main.Data.TextArray, de.bsvrz.dav.daf.main.Data.TextValue, de.bsvrz.dav.daf.main.Data.TimeArray, de.bsvrz.dav.daf.main.Data.TimeValue
    • Constructor Summary

      Constructors 
      Constructor Description
      ProtocolData()  
    • Method Summary

      Modifier and Type Method Description
      static java.util.List<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.String,​de.bsvrz.dav.daf.main.Data>> convertDataToList​(de.bsvrz.dav.daf.main.Data data)
      Konvertiert die Baumstruktur eines Data-Objektes in eine flache Struktur (Liste), die sich zum Beispiel einfacher in Tabellen darstellen lässt.
      de.bsvrz.dav.daf.main.Data createModifiableCopy()  
      boolean equals​(de.bsvrz.dav.daf.main.Data other)  
      boolean equals​(java.lang.Object obj)  
      de.bsvrz.dav.daf.main.Data.Array getArray​(java.lang.String itemName)  
      protected abstract java.util.List<de.bsvrz.dav.daf.main.Data> getChildrenList()  
      de.bsvrz.dav.daf.main.Data.ReferenceArray getReferenceArray​(java.lang.String itemName)  
      de.bsvrz.dav.daf.main.Data.ReferenceValue getReferenceValue​(java.lang.String itemName)  
      de.bsvrz.dav.daf.main.Data.NumberArray getScaledArray​(java.lang.String itemName)  
      de.bsvrz.dav.daf.main.Data.NumberValue getScaledValue​(java.lang.String itemName)  
      de.bsvrz.dav.daf.main.Data.TextArray getTextArray​(java.lang.String itemName)  
      de.bsvrz.dav.daf.main.Data.TextValue getTextValue​(java.lang.String itemName)  
      de.bsvrz.dav.daf.main.Data.TimeArray getTimeArray​(java.lang.String itemName)  
      de.bsvrz.dav.daf.main.Data.TimeValue getTimeValue​(java.lang.String itemName)  
      de.bsvrz.dav.daf.main.Data.NumberArray getUnscaledArray​(java.lang.String itemName)  
      de.bsvrz.dav.daf.main.Data.NumberValue getUnscaledValue​(java.lang.String itemName)  
      int hashCode()  
      abstract boolean isError()
      Gibt true zurück, wenn es sich um einen von PuA generierten Fehlerwert handelt.
      abstract boolean isNoChange()
      Gibt true zurück, wenn es sich bei diesem Wert um eine NoChange-Markierung handelt.
      static boolean isNoChange​(de.bsvrz.dav.daf.main.Data data)
      Gibt true zurück, wenn es sich bei dem übergebenen Wert um eine NoChange-Markierung handelt.
      java.util.Iterator<de.bsvrz.dav.daf.main.Data> iterator()  
      void setToDefault()  
      java.lang.String toString()  
      java.lang.String valueToString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface de.bsvrz.dav.daf.main.Data

        asArray, asReferenceArray, asReferenceValue, asScaledArray, asScaledValue, asTextArray, asTextValue, asTimeArray, asTimeValue, asUnscaledArray, asUnscaledValue, containsItem, createUnmodifiableCopy, getAttributeGroup, getAttributeType, getItem, getName, isArray, isDefined, isList, isPlain, updated
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Constructor Detail

      • ProtocolData

        public ProtocolData()
    • Method Detail

      • createModifiableCopy

        public de.bsvrz.dav.daf.main.Data createModifiableCopy()
        Specified by:
        createModifiableCopy in interface de.bsvrz.dav.daf.main.Data
      • setToDefault

        public void setToDefault()
        Specified by:
        setToDefault in interface de.bsvrz.dav.daf.main.Data
      • getTextValue

        public de.bsvrz.dav.daf.main.Data.TextValue getTextValue​(java.lang.String itemName)
        Specified by:
        getTextValue in interface de.bsvrz.dav.daf.main.Data
      • getTimeValue

        public de.bsvrz.dav.daf.main.Data.TimeValue getTimeValue​(java.lang.String itemName)
        Specified by:
        getTimeValue in interface de.bsvrz.dav.daf.main.Data
      • getScaledValue

        public de.bsvrz.dav.daf.main.Data.NumberValue getScaledValue​(java.lang.String itemName)
        Specified by:
        getScaledValue in interface de.bsvrz.dav.daf.main.Data
      • getUnscaledValue

        public de.bsvrz.dav.daf.main.Data.NumberValue getUnscaledValue​(java.lang.String itemName)
        Specified by:
        getUnscaledValue in interface de.bsvrz.dav.daf.main.Data
      • getReferenceValue

        public de.bsvrz.dav.daf.main.Data.ReferenceValue getReferenceValue​(java.lang.String itemName)
        Specified by:
        getReferenceValue in interface de.bsvrz.dav.daf.main.Data
      • getTextArray

        public de.bsvrz.dav.daf.main.Data.TextArray getTextArray​(java.lang.String itemName)
        Specified by:
        getTextArray in interface de.bsvrz.dav.daf.main.Data
      • getArray

        public de.bsvrz.dav.daf.main.Data.Array getArray​(java.lang.String itemName)
        Specified by:
        getArray in interface de.bsvrz.dav.daf.main.Data
      • getTimeArray

        public de.bsvrz.dav.daf.main.Data.TimeArray getTimeArray​(java.lang.String itemName)
        Specified by:
        getTimeArray in interface de.bsvrz.dav.daf.main.Data
      • getScaledArray

        public de.bsvrz.dav.daf.main.Data.NumberArray getScaledArray​(java.lang.String itemName)
        Specified by:
        getScaledArray in interface de.bsvrz.dav.daf.main.Data
      • getUnscaledArray

        public de.bsvrz.dav.daf.main.Data.NumberArray getUnscaledArray​(java.lang.String itemName)
        Specified by:
        getUnscaledArray in interface de.bsvrz.dav.daf.main.Data
      • getReferenceArray

        public de.bsvrz.dav.daf.main.Data.ReferenceArray getReferenceArray​(java.lang.String itemName)
        Specified by:
        getReferenceArray in interface de.bsvrz.dav.daf.main.Data
      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface de.bsvrz.dav.daf.main.Data
        Overrides:
        toString in class java.lang.Object
      • valueToString

        public java.lang.String valueToString()
        Specified by:
        valueToString in interface de.bsvrz.dav.daf.main.Data
      • isError

        public abstract boolean isError()
        Gibt true zurück, wenn es sich um einen von PuA generierten Fehlerwert handelt. Dieser kann beispielsweise in einem temporären Attribut bei einer Division durch 0 entstehen.
        Returns:
        true, wenn es sich um einen von PuA generierten Fehlerwert handelt, sonst false
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • equals

        public boolean equals​(de.bsvrz.dav.daf.main.Data other)
      • iterator

        public java.util.Iterator<de.bsvrz.dav.daf.main.Data> iterator()
        Specified by:
        iterator in interface de.bsvrz.dav.daf.main.Data
        Specified by:
        iterator in interface java.lang.Iterable<de.bsvrz.dav.daf.main.Data>
      • getChildrenList

        protected abstract java.util.List<de.bsvrz.dav.daf.main.Data> getChildrenList()
      • convertDataToList

        public static java.util.List<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.String,​de.bsvrz.dav.daf.main.Data>> convertDataToList​(de.bsvrz.dav.daf.main.Data data)
        Konvertiert die Baumstruktur eines Data-Objektes in eine flache Struktur (Liste), die sich zum Beispiel einfacher in Tabellen darstellen lässt.
        Parameters:
        data - Data-Objekt das konvertiert werden soll (wird nicht verändert)
        Returns:
        flache Kopie des Data-Objektes (Liste von Spaltennamen-Daten-Paaren). Alle enthaltenen Data-Objekte sind Atomar.
      • isNoChange

        public abstract boolean isNoChange()
        Gibt true zurück, wenn es sich bei diesem Wert um eine NoChange-Markierung handelt. NoChange-Markierungen dieser Art werden PuA-Seitig generiert, wenn es sich um ein Zustandsprotokoll handelt und die NoChange-Datensätze pro Zelle (statt pro ganzer Zeile) gebildet werden sollen.
        Returns:
        true, wenn es sich um eine NoChange-Markierung handelt, sonst false
      • isNoChange

        public static boolean isNoChange​(de.bsvrz.dav.daf.main.Data data)
        Gibt true zurück, wenn es sich bei dem übergebenen Wert um eine NoChange-Markierung handelt. NoChange-Markierungen dieser Art werden PuA-Seitig generiert, wenn es sich um ein Zustandsprotokoll handelt und die NoChange-Datensätze pro Zelle (statt pro ganzer Zeile) gebildet werden sollen.
        Parameters:
        data - Data-objekt, das geprüft werden soll
        Returns:
        true, wenn es sich um eine NoChange-Markierung handelt, sonst false