Class BasicScanclassHistorySet

    • Field Summary

      • Fields inherited from class java.util.AbstractList

        modCount
    • Constructor Summary

      Constructors 
      Constructor Description
      BasicScanclassHistorySet​(java.lang.String providerName, java.lang.String scName, int execRate)  
      BasicScanclassHistorySet​(java.lang.String gatewayName, java.lang.String providerName, java.lang.String scName, int execRate)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean add​(HistoricalTagValue e)  
      protected void addToCache​(HistoricalTagValue htv)  
      HistoricalData badData()  
      boolean contains​(java.lang.Object o)  
      java.lang.Exception failureReason()  
      int getDataCount()
      This is a fairly ambiguous number, but basically indicates how many rows will ultimately be inserted in the database.
      int getExecRate()
      The rate that the scan class is executing at.
      java.util.Date getExecutionTime()  
      HistoryFlavor getFlavor()
      The very broad "flavor" designator, used to get the data to the correct sink.
      java.lang.String getGatewayName()
      Returns the name of the source gateway.
      java.lang.String getGroupId()
      A string identifing the "group" of the data.
      java.lang.String getLoggerName()
      Returns the name of the logger that should be notified when something happens to this data.
      java.lang.String getProviderName()
      Returns the name of the tag provider that generated this set.
      java.lang.String getSetName()
      The name of the scan class
      java.lang.String getSignature()
      The signature is a static string that describes this data as uniquely as possible.
      GroupableData groupData​(GroupableData other)
      Merge another piece of similar data into this one.
      boolean isRetry()  
      void markAsBad​(HistoricalTagValue value)  
      void setExecutionTime​(java.util.Date execTime)  
      void setFailureReason​(java.lang.Exception failureReason)  
      void setRetry​(boolean isRetry)  
      java.lang.String toString()  
      boolean usingBadData()  
      void usingBadData​(boolean usingBadData)  
      • Methods inherited from class java.util.ArrayList

        add, addAll, addAll, clear, clone, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
      • Methods inherited from class java.util.AbstractCollection

        containsAll
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.util.Collection

        parallelStream, removeIf, stream, toArray
      • Methods inherited from interface java.lang.Iterable

        forEach
      • Methods inherited from interface java.util.List

        add, addAll, addAll, clear, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray
    • Constructor Detail

      • BasicScanclassHistorySet

        public BasicScanclassHistorySet​(java.lang.String providerName,
                                        java.lang.String scName,
                                        int execRate)
      • BasicScanclassHistorySet

        public BasicScanclassHistorySet​(java.lang.String gatewayName,
                                        java.lang.String providerName,
                                        java.lang.String scName,
                                        int execRate)
    • Method Detail

      • getLoggerName

        public java.lang.String getLoggerName()
        Description copied from interface: HistoricalData
        Returns the name of the logger that should be notified when something happens to this data. If null or empty, notifications won't occur (errors, however, may still be logged to the general logger).
        Specified by:
        getLoggerName in interface HistoricalData
      • getFlavor

        public HistoryFlavor getFlavor()
        Description copied from interface: HistoricalData
        The very broad "flavor" designator, used to get the data to the correct sink. That is, different sinks support different types of data, and this is used to match them up.
        Specified by:
        getFlavor in interface HistoricalData
      • getSignature

        public java.lang.String getSignature()
        Description copied from interface: HistoricalData
        The signature is a static string that describes this data as uniquely as possible. This will be used to group data in the data cache (for example, when displaying quarantined data), as well as uniquely identifying cacheable schemas, etc.

        Basically, the golden rule is that if two pieces of data have the same signature, the came from the same place, and are going to the same place, and in theory could be grouped together (note: they won't be, that is done with the GroupableData interface).

        Specified by:
        getSignature in interface HistoricalData
      • getDataCount

        public int getDataCount()
        Description copied from interface: HistoricalData
        This is a fairly ambiguous number, but basically indicates how many rows will ultimately be inserted in the database. Used for judging transaction size.
        Specified by:
        getDataCount in interface HistoricalData
      • getExecRate

        public int getExecRate()
        Description copied from interface: ScanclassHistorySet
        The rate that the scan class is executing at. Returns 0 to indicate a non-direct scan class (one that doesn't execute regularly)
        Specified by:
        getExecRate in interface ScanclassHistorySet
      • setExecutionTime

        public void setExecutionTime​(java.util.Date execTime)
      • setRetry

        public void setRetry​(boolean isRetry)
        Specified by:
        setRetry in interface RetryHistoricalData
        Parameters:
        isRetry - true when an attempt to process data has failed at least once
      • isRetry

        public boolean isRetry()
        Specified by:
        isRetry in interface RetryHistoricalData
        Returns:
        true when an attempt to process this data has failed at least once
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.util.AbstractCollection<HistoricalTagValue>
      • contains

        public boolean contains​(java.lang.Object o)
        Specified by:
        contains in interface java.util.Collection<HistoricalTagValue>
        Specified by:
        contains in interface java.util.List<HistoricalTagValue>
        Overrides:
        contains in class java.util.ArrayList<HistoricalTagValue>
      • getGroupId

        public java.lang.String getGroupId()
        Description copied from interface: GroupableData
        A string identifing the "group" of the data. In other words, any piece of data from this group can be merged together.
        Specified by:
        getGroupId in interface GroupableData