Package net.solarnetwork.domain.datum

Class DatumSamplesExpressionRoot

java.lang.Object

java.util.AbstractMap<String,Object>

net.solarnetwork.domain.datum.DatumSamplesExpressionRoot

All Implemented Interfaces:

Map<String,Object>, DatumExpressionRoot, DatumMathFunctions

public class DatumSamplesExpressionRoot
extends AbstractMap<String,Object>
implements DatumExpressionRoot, DatumMathFunctions

An expression root object implementation that acts like a composite map of parameters, sample data, and datum properties.

The Map implementation treats the given Datum, DatumSamplesOperations, and parameter Map as a single Map, where keys are handled by returning the first found non-null value in the following order:

1. parameter Map
2. the DatumSamplesOperations sample, following the Instantaneous, Accumulating, and Status priority defined in DatumSamplesOperations.findSampleValue(String)
3. if the Datum implements Datum, then call Datum.asSampleOperations() and follow the DatumSamplesOperations.findSampleValue(String) rules again on that

Since:

1.71

Version:

2.1

Author:

matt

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
DatumSamplesExpressionRoot(Datum datum, DatumSamplesOperations sample, Map<String,?> parameters)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Object key)
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
Map<String,?>	getData()	Get the data map.
Datum	getDatum()	Get the datum.
Map<String,?>	getParameters()	Get optional additional parameters.
Map<String,?>	getProps()	Get the property map.
DatumSamplesOperations	getSamples()	Get the samples.
final Collection<? extends Number>	group(String pattern)	Group a set of properties matching a pattern into a collection.
boolean	has(Object key)	An alias for containsKey(Object)

Methods inherited from class java.util.AbstractMap

clear, clone, containsValue, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.domain.datum.DatumMathFunctions

and, andNot, avg, ceil, ceil, decimal, down, down, floor, floor, integer, max, max, min, min, mround, narrow, narrow16, narrow32, narrow64, narrow8, not, or, round, round, roundDown, roundUp, shiftLeft, shiftRight, sum, testBit, up, up, xor

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsValue, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Details

DatumSamplesExpressionRoot

public DatumSamplesExpressionRoot(Datum datum,
 DatumSamplesOperations sample,
 Map<String,?> parameters)

Constructor.

Parameters:

datum - the datum currently being populated

sample - the samples

parameters - the parameters

Method Details

getDatum

public Datum getDatum()

Description copied from interface: DatumExpressionRoot

Get the datum.

Specified by:

getDatum in interface DatumExpressionRoot

Returns:

the datum; may be null

getSamples

public DatumSamplesOperations getSamples()

Get the samples.

This may or may not be the same samples as returned by Datum.asSampleOperations() on the Datum returned by getDatum().

Returns:

the datum samples; may be null

getParameters

public Map<String,?> getParameters()

Get optional additional parameters.

Returns:

the parameters; may be null

getData

public Map<String,?> getData()

Get the data map.

This method returns this object.

Specified by:

getData in interface DatumExpressionRoot

Returns:

this object

getProps

public Map<String,?> getProps()

Get the property map.

This method returns this object.

Specified by:

getProps in interface DatumExpressionRoot

Returns:

this object

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

Overrides:

containsKey in class AbstractMap<String,Object>

has

public boolean has(Object key)

An alias for containsKey(Object)

Parameters:

key - the key to search for

Returns:

true if a property with the given key exists

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class AbstractMap<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

Specified by:

entrySet in class AbstractMap<String,Object>

group

public final Collection<? extends Number> group(String pattern)

Group a set of properties matching a pattern into a collection.

Parameters:

pattern - the property name pattern to group

Returns:

the group of matching properties, never null

Since:

2.1