Package org.openhab.core.items

Interface GroupFunction

All Known Subinterfaces:

ArithmeticGroupFunction, DateTimeGroupFunction, QuantityTypeArithmeticGroupFunction

All Known Implementing Classes:

ArithmeticGroupFunction.And, ArithmeticGroupFunction.Avg, ArithmeticGroupFunction.Count, ArithmeticGroupFunction.Max, ArithmeticGroupFunction.Median, ArithmeticGroupFunction.Min, ArithmeticGroupFunction.NAnd, ArithmeticGroupFunction.NOr, ArithmeticGroupFunction.Or, ArithmeticGroupFunction.Sum, ArithmeticGroupFunction.Xor, DateTimeGroupFunction.Earliest, DateTimeGroupFunction.Latest, GroupFunction.Equality, QuantityTypeArithmeticGroupFunction.Avg, QuantityTypeArithmeticGroupFunction.DimensionalGroupFunction, QuantityTypeArithmeticGroupFunction.Max, QuantityTypeArithmeticGroupFunction.Median, QuantityTypeArithmeticGroupFunction.Min, QuantityTypeArithmeticGroupFunction.Sum

@NonNullByDefault
public interface GroupFunction

Group functions are used by active group items to calculate a state for the group out of the states of all its member items.

Author:

Kai Kreuzer - Initial contribution

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GroupFunction.Equality	This is the default group function that does nothing else than to check if all member items have the same state.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AND
static final String	AVG
static final String	COUNT
static final String	DEFAULT
static final String	EARLIEST
static final String	EQUALITY
static final String	LATEST
static final String	MAX
static final String	MEDIAN
static final String	MIN
static final String	NAND
static final String	NOR
static final String	OR
static final String	SUM
static final Set<String>	VALID_FUNCTIONS
static final String	XOR

Method Summary

Modifier and Type	Method	Description
State	calculate(@Nullable Set<Item> items)	Determines the current state of a group based on a list of items
State[]	getParameters()	Returns the parameters of the function as an array.
<T extends State> @Nullable T	getStateAs(@Nullable Set<Item> items, Class<T> stateClass)	Calculates the group state and returns it as a state of the requested type.

Field Details

EQUALITY

static final String EQUALITY

See Also:

• Constant Field Values

AND

static final String AND

See Also:

• Constant Field Values

OR

static final String OR

See Also:

• Constant Field Values

NAND

static final String NAND

See Also:

• Constant Field Values

NOR

static final String NOR

See Also:

• Constant Field Values

XOR

static final String XOR

See Also:

• Constant Field Values

COUNT

static final String COUNT

See Also:

• Constant Field Values

AVG

static final String AVG

See Also:

• Constant Field Values

MEDIAN

static final String MEDIAN

See Also:

• Constant Field Values

SUM

static final String SUM

See Also:

• Constant Field Values

MIN

static final String MIN

See Also:

• Constant Field Values

MAX

static final String MAX

See Also:

• Constant Field Values

LATEST

static final String LATEST

See Also:

• Constant Field Values

EARLIEST

static final String EARLIEST

See Also:

• Constant Field Values

DEFAULT

static final String DEFAULT

See Also:

• Constant Field Values

VALID_FUNCTIONS

static final Set<String> VALID_FUNCTIONS

Method Details

calculate

State calculate(@Nullable Set<Item> items)

Determines the current state of a group based on a list of items

Parameters:

items - the items to calculate a group state for

Returns:

the calculated group state

getStateAs

<T extends State> @Nullable T getStateAs(@Nullable Set<Item> items,
 Class<T> stateClass)

Calculates the group state and returns it as a state of the requested type.

Parameters:

items - the items to calculate a group state for

stateClass - the type in which the state should be returned

Returns:

the calculated group state of the requested type or null, if type is not supported

getParameters

State[] getParameters()

Returns the parameters of the function as an array.

Returns:

the parameters of this function