Package com.inductiveautomation.ignition.gateway.sqltags.history.query.processing

Class BlockContext

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.inductiveautomation.ignition.gateway.sqltags.history.query.processing.BlockContext

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class BlockContext
extends HashMap<String,Object>

A BlockContext provides some information about a specific aggregation "block", or window of time, but it also provides a spot for aggregation functions to store data for the window, if they want. It also provides a series of useful functions for aggregation functions.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
BlockContext(long blockStart, long blockEnd, int blockId, QualifiedValue prevRaw, QualifiedValue[] prevRes)

Method Summary

Modifier and Type	Method	Description
Object	get(String key, Object def)
long	getBlockEnd()
int	getBlockId()	Returns an integer that roughly corresponds to the rowid of the result that this block would represent.
long	getBlockStart()
Date	getBlockTimestamp()
Object	getReturnValue()
boolean	insideBlock(long time)
boolean	insideBlock(Date time)
QualifiedValue[]	previousBlockResults()	Returns the results from the previous aggregation function
QualifiedValue	previousRawValue()	Returns the last raw value received previous to this block.
void	setReturn(Object object)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

BlockContext

public BlockContext(long blockStart,
 long blockEnd,
 int blockId,
 QualifiedValue prevRaw,
 QualifiedValue[] prevRes)

Method Details

getBlockId

public int getBlockId()

Returns an integer that roughly corresponds to the rowid of the result that this block would represent. It is "roughly" because it doesn't take into account aggregates that return multiple values for one block.

getBlockTimestamp

public Date getBlockTimestamp()

getBlockStart

public long getBlockStart()

getBlockEnd

public long getBlockEnd()

previousRawValue

public QualifiedValue previousRawValue()

Returns the last raw value received previous to this block.

previousBlockResults

public QualifiedValue[] previousBlockResults()

Returns the results from the previous aggregation function

insideBlock

public boolean insideBlock(long time)

insideBlock

public boolean insideBlock(Date time)

get

public Object get(String key,
 Object def)

setReturn

public void setReturn(Object object)

getReturnValue

public Object getReturnValue()