Class BasicTagHistoryQueryParams

    • Constructor Detail

      • BasicTagHistoryQueryParams

        public BasicTagHistoryQueryParams()
      • BasicTagHistoryQueryParams

        public BasicTagHistoryQueryParams​(TagHistoryQueryParams base,
                                          java.util.List<? extends Path> newPaths)
      • BasicTagHistoryQueryParams

        public BasicTagHistoryQueryParams​(java.util.List<? extends Path> paths,
                                          java.util.Date startDate,
                                          java.util.Date endDate,
                                          int returnSize,
                                          Aggregate aggregationMode,
                                          ReturnFormat returnFormat,
                                          java.util.List<java.lang.String> aliases,
                                          java.util.List<Aggregate> columnAggregationModes)
        This constructor is for non-inteval based returns: on change, natural, or fixed.
      • BasicTagHistoryQueryParams

        public BasicTagHistoryQueryParams​(java.util.List<? extends Path> paths,
                                          java.util.Date startDate,
                                          java.util.Date endDate,
                                          int intervalLength,
                                          TimeUnits intervalUnits,
                                          Aggregate aggregationMode,
                                          ReturnFormat returnFormat,
                                          java.util.List<java.lang.String> aliases,
                                          java.util.List<Aggregate> columnAggregationModes)
        This constructor is for interval based returns. It will calculate the appropriate return size, and adjust the end date to be a perfect multiple.
    • Method Detail

      • 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
      • setPaths

        public void setPaths​(java.util.List<? extends Path> paths)
      • 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
      • setAliases

        public void setAliases​(java.util.List<java.lang.String> aliases)
      • setStartDate

        public void setStartDate​(java.util.Date startDate)
      • 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
      • setEndDate

        public void setEndDate​(java.util.Date endDate)
      • 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
      • setReturnSize

        public void setReturnSize​(int returnSize)
      • 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
      • setAggregationMode

        public void setAggregationMode​(Aggregate aggregationMode)
      • setReturnFormat

        public void setReturnFormat​(ReturnFormat returnFormat)
      • setQueryFlags

        public void setQueryFlags​(Flags queryFlags)
      • 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
      • setColumnAggregationModes

        public void setColumnAggregationModes​(java.util.List<Aggregate> modes)
      • toString

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