BasicTagHistoryQueryParams (ignition 7.9.0-beta1 API)

java.lang.Object
- com.inductiveautomation.ignition.common.sqltags.history.BasicTagHistoryQueryParams

All Implemented Interfaces:: TagHistoryQueryParams, java.io.Serializable

public class BasicTagHistoryQueryParams
extends java.lang.Object
implements TagHistoryQueryParams, java.io.Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description
`BasicTagHistoryQueryParams()`
`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(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.
`BasicTagHistoryQueryParams(TagHistoryQueryParams copy)`
`BasicTagHistoryQueryParams(TagHistoryQueryParams base, java.util.List<? extends Path> newPaths)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Aggregate`	`getAggregationMode()` Specifies how aggregation should occur.
`java.util.List<java.lang.String>`	`getAliases()` If not null, must be a 1-to-1 list corresponding to tag paths.
`java.util.List<Aggregate>`	`getColumnAggregationModes()` If not null, must be 1-to-1 list corresponding to tag paths, specifying the aggregation mode for the column.
`java.util.Date`	`getEndDate()` The ending range of the query.
`java.util.List<? extends Path>`	`getPaths()` The paths to query.
`Flags`	`getQueryFlags()` Optional flags that provide additional query settings.
`ReturnFormat`	`getReturnFormat()` Specifies the desired format of the resulting dataset.
`int`	`getReturnSize()` How many results are desired.
`java.util.Date`	`getStartDate()` The starting range of the query.
`void`	`setAggregationMode(Aggregate aggregationMode)`
`void`	`setAliases(java.util.List<java.lang.String> aliases)`
`void`	`setColumnAggregationModes(java.util.List<Aggregate> modes)`
`void`	`setEndDate(java.util.Date endDate)`
`void`	`setPaths(java.util.List<? extends Path> paths)`
`void`	`setQueryFlags(Flags queryFlags)`
`void`	`setReturnFormat(ReturnFormat returnFormat)`
`void`	`setReturnSize(int returnSize)`
`void`	`setStartDate(java.util.Date startDate)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BasicTagHistoryQueryParams
```
public BasicTagHistoryQueryParams()
```
  - BasicTagHistoryQueryParams
```
public BasicTagHistoryQueryParams(TagHistoryQueryParams copy)
```
  - 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.
    
    Parameters:
    
    paths -
    
    startDate -
    
    endDate -
    
    returnSize -
    
    aggregationMode -
    
    returnFormat -
    
    aliases -
  - 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.
    
    Parameters:
    
    paths -
    
    startDate -
    
    endDate -
    
    intervalLength -
    
    intervalUnits -
    
    aggregationMode -
    
    returnFormat -
    
    aliases -
- 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
    
    Returns:
  - 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
    
    Returns:
  - setAliases
```
public void setAliases(java.util.List<java.lang.String> aliases)
```
  - getStartDate
```
public java.util.Date getStartDate()
```
    Description copied from interface: TagHistoryQueryParams
    
    The starting range of the query.
    
    Specified by:
    
    getStartDate in interface TagHistoryQueryParams
    
    Returns:
  - 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
    
    Returns:
  - 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
    
    Returns:
  - 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
    
    Returns:
  - 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
    
    Returns:
  - 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
    
    Returns:
  - 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

Class BasicTagHistoryQueryParams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicTagHistoryQueryParams

BasicTagHistoryQueryParams

BasicTagHistoryQueryParams

BasicTagHistoryQueryParams

BasicTagHistoryQueryParams

Method Detail

getPaths

setPaths

getAliases

setAliases

getStartDate

setStartDate

getEndDate

setEndDate

getReturnSize

setReturnSize

getAggregationMode

setAggregationMode

getReturnFormat

setReturnFormat

getQueryFlags

setQueryFlags

getColumnAggregationModes

setColumnAggregationModes

toString