Class TagHistoryPenDatasource

    • Constructor Detail

      • TagHistoryPenDatasource

        public TagHistoryPenDatasource​(AggregationMode aggMode)
    • Method Detail

      • addPen

        public void addPen​(PenData penData)
        Description copied from interface: IPenDatasource
        Adds a pen to this datasource. All pens will be added before startup() is called for the first time.
        Specified by:
        addPen in interface IPenDatasource
      • initRefs

        public void initRefs​(java.util.Map<java.lang.String,​PenData> allPens)
        Description copied from interface: IPenDatasource
        Gives the datasource a chance to install references to other pens
        Specified by:
        initRefs in interface IPenDatasource
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getQuasiPropertyName

        protected java.lang.String getQuasiPropertyName()
        Description copied from class: AbstractChartQuery
        Generate a unique string for the query, independent of any values that may change (date ranges, for example.) Used as the "property key" for the quality system in case the query fails.
        Specified by:
        getQuasiPropertyName in class AbstractChartQuery
      • getNumDatapoints

        public int getNumDatapoints()
        Description copied from interface: IPenDatasource
        Return the number of datapoints currently loaded in this source
        Specified by:
        getNumDatapoints in interface IPenDatasource
      • isZoomTracking

        public boolean isZoomTracking()
        Description copied from interface: IPenDatasource
        True if this datasource should be restarted when the zoom level changes.
        Specified by:
        isZoomTracking in interface IPenDatasource
      • getAggregationMode

        public Aggregate getAggregationMode()
        Description copied from interface: TagHistoryQueryParams
        Specifies how aggregation should occur. Aggregation is how data is handled when multiple values exist for a certain window of time. The window is defined as the time range divided by the number of results, and therefore this setting doesn't apply when using raw result mode.
        Specified by:
        getAggregationMode in interface TagHistoryQueryParams
      • getColumnAggregationModes

        public java.util.List<Aggregate> getColumnAggregationModes()
        Description copied from interface: TagHistoryQueryParams
        If not null, must be 1-to-1 list corresponding to tag paths, specifying the aggregation mode for the column. If the list is null, or a particular entry is null, the general aggregation mode will be used instead.
        Specified by:
        getColumnAggregationModes in interface TagHistoryQueryParams
      • getPaths

        public java.util.List<? extends Path> getPaths()
        Description copied from interface: TagHistoryQueryParams
        The paths to query. The "source" field of the tag path is the historical provider that contains the tag. Tags from multiple providers may be requested at the same time.
        Specified by:
        getPaths in interface TagHistoryQueryParams
      • getAliases

        public java.util.List<java.lang.String> getAliases()
        Description copied from interface: TagHistoryQueryParams
        If not null, must be a 1-to-1 list corresponding to tag paths. Specifies names that will be used when representing the tag instead of the tag path. In other words, these are the values that will be used for column names in Wide return mode, or "Tag names" in tall return mode.
        Specified by:
        getAliases in interface TagHistoryQueryParams
      • getReturnSize

        public int getReturnSize()
        Description copied from interface: TagHistoryQueryParams
        How many results are desired. -1 means "raw", 0 means "natural", and positive numbers are fixed rows. The definitions of "-1" and "0" may vary according to provider.
        Specified by:
        getReturnSize in interface TagHistoryQueryParams
      • getEndDate

        public java.util.Date getEndDate()
        Description copied from interface: TagHistoryQueryParams
        The ending range of the query. If null, the query will be considered "realtime", and will cover up to the current time.
        Specified by:
        getEndDate in interface TagHistoryQueryParams