Package com.inductiveautomation.ignition.common.sqltags.history

Class BasicTagHistoryQueryParams

java.lang.Object
com.inductiveautomation.ignition.common.sqltags.history.BasicTagHistoryQueryParams
All Implemented Interfaces:
TagHistoryQueryParams, Serializable
Direct Known Subclasses:
RealtimeTagHistoryQueryParams
public class BasicTagHistoryQueryParams extends Object implements TagHistoryQueryParams, Serializable
See Also:

  • Constructor Details

    • BasicTagHistoryQueryParams

      public BasicTagHistoryQueryParams()

    • BasicTagHistoryQueryParams

      public BasicTagHistoryQueryParams(TagHistoryQueryParams copy)

    • BasicTagHistoryQueryParams

      public BasicTagHistoryQueryParams(TagHistoryQueryParams base, List<? extends Path> newPaths)

    • BasicTagHistoryQueryParams

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

    • BasicTagHistoryQueryParams

      public BasicTagHistoryQueryParams(List<? extends Path> paths, Date startDate, Date endDate, int intervalLength, TimeUnits intervalUnits, Aggregate aggregationMode, ReturnFormat returnFormat, List<String> aliases, 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 Details

    • getPaths

      @NotNull public 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(List<? extends Path> paths)

    • getAliases

      public List<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(List<String> aliases)

    • getStartDate

      public Date getStartDate()
      Description copied from interface: TagHistoryQueryParams
      The starting range of the query.
      Specified by:
      getStartDate in interface TagHistoryQueryParams

    • setStartDate

      public void setStartDate(Date startDate)

    • getEndDate

      public 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(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)

    • getReturnFormat

      public ReturnFormat getReturnFormat()
      Description copied from interface: TagHistoryQueryParams
      Specifies the desired format of the resulting dataset. "Wide" results provide a column per row, "tall" instead has columns for path, time, value, and quality.
      Specified by:
      getReturnFormat in interface TagHistoryQueryParams

    • setReturnFormat

      public void setReturnFormat(ReturnFormat returnFormat)

    • getQueryFlags

      public Flags getQueryFlags()
      Description copied from interface: TagHistoryQueryParams
      Optional flags that provide additional query settings. Tag provider dependent, though some reserved flags are defined in TagHistoryQueryFlags
      Specified by:
      getQueryFlags in interface TagHistoryQueryParams

    • setQueryFlags

      public void setQueryFlags(Flags queryFlags)

    • getColumnAggregationModes

      public 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(List<Aggregate> modes)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object