io.doov.core.dsl.impl.num

Class NumericFunction<N extends java.lang.Number>

java.lang.Object

io.doov.core.dsl.impl.DefaultFunction<N,PredicateMetadata>

io.doov.core.dsl.impl.num.NumericFunction<N>

Type Parameters:

N - the type of the field value

All Implemented Interfaces:

ContextAccessor<N>, Function<N>, NumericOperators<N>, DSLBuilder, MappingInput<N>, Readable

Direct Known Subclasses:

DoubleFunction, FloatFunction, IntegerFunction, LongFunction

public abstract class NumericFunction<N extends java.lang.Number>
extends DefaultFunction<N,PredicateMetadata>
implements NumericOperators<N>

Base class for numeric functions.

It contains a DslField to get the value from the model, a PredicateMetadata to describe this node, and a BiFunction to take the value from the model and return an optional value.

Field Summary

Fields inherited from class io.doov.core.dsl.impl.DefaultFunction

function, metadata

Constructor Summary

Constructors

Constructor and Description
NumericFunction(PredicateMetadata metadata, java.util.function.BiFunction<FieldModel,Context,java.util.Optional<N>> value)

Method Summary

Modifier and Type	Method and Description
StepCondition	between(N minIncluded, N maxExcluded) Returns a step condition checking if the node value is between the given min included and max excluded values.
StepCondition	between(NumericFieldInfo<N> minIncluded, NumericFieldInfo<N> maxExcluded) Returns a step condition checking if the node value is between the given min included and max excluded field values.
StepCondition	greaterOrEquals(N value) Returns a step condition checking if the node value is greater or equals the given value.
StepCondition	greaterOrEquals(NumericFieldInfo<N> value) Returns a step condition checking if the node value is greater or equals the given field value.
StepCondition	greaterThan(N value) Returns a step condition checking if the node value is greater than the given value.
StepCondition	greaterThan(NumericFieldInfo<N> value) Returns a step condition checking if the node value is greater than the given field value.
StepCondition	lesserOrEquals(N value) Returns a step condition checking if the node value is lesser or equals the given value.
StepCondition	lesserOrEquals(NumericFieldInfo<N> value) Returns a step condition checking if the node value is lesser or equals the given field value.
StepCondition	lesserThan(N value) Returns a step condition checking if the node value is lesser than the given value.
StepCondition	lesserThan(NumericFieldInfo<N> value) Returns a step condition checking if the node value is lesser than the given field value.
NumericFunction<N>	min(java.util.List<NumericFieldInfo<N>> fields) Returns a numeric function that returns the min value of the given field values.
NumericFunction<N>	minus(N value) Returns a numeric function that returns the node value sum with the node value param.
NumericFunction<N>	minus(NumericFieldInfo<N> field) Returns a numeric function that returns the node value sum with the node value param.
NumericFunction<N>	minus(NumericFunction<N> numericFunction) Returns a numeric function that returns the node value sum with the node value param.
protected abstract NumericFunction<N>	numericFunction(PredicateMetadata metadata, java.util.function.BiFunction<FieldModel,Context,java.util.Optional<N>> value)
NumericFunction<N>	plus(N value) Returns a numeric function that returns the node value sum with the node value param.
NumericFunction<N>	plus(NumericFieldInfo<N> field) Returns a numeric function that returns the node value sum with the node value param.
NumericFunction<N>	plus(NumericFunction<N> numericFunction) Returns a numeric function that returns the node value sum with the node value param.
NumericFunction<N>	sum(java.util.List<NumericFieldInfo<N>> fields) Returns a numeric function that returns the sum value of the given field values.
NumericFunction<N>	sumConditions(java.util.List<NumericFunction<N>> conditions) Returns a numeric function that returns the sum value of the given condition values.
NumericFunction<N>	times(int multiplier) Returns a numeric function that returns the node value multiplied by the given multiplier.
NumericFunction<N>	when(StepCondition condition) Returns a numeric step condition that returns the node value if the condition evaluates to true.

Methods inherited from class io.doov.core.dsl.impl.DefaultFunction

allMatch, allMatch, allMatch, anyMatch, anyMatch, eq, eq, eq, getFunction, getMetadata, isNotNull, isNull, map, mapToInt, mapToString, mapUsing, noneMatch, noneMatch, noneMatch, notEq, notEq, notEq, position, readable, tags, value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.doov.core.dsl.impl.num.NumericOperators

greaterOrEqualsFunction, greaterThanFunction, identity, lesserOrEqualsFunction, lesserThanFunction, minFunction, minusFunction, sumFunction, timesFunction

Methods inherited from interface io.doov.core.dsl.field.types.Function

metadata, read, validate

Methods inherited from interface io.doov.core.dsl.lang.DSLBuilder

isUsing, markdown, markdown, readable

Constructor Detail

NumericFunction

public NumericFunction(PredicateMetadata metadata,
                       java.util.function.BiFunction<FieldModel,Context,java.util.Optional<N>> value)

Method Detail

numericFunction

protected abstract NumericFunction<N> numericFunction(PredicateMetadata metadata,
                                                      java.util.function.BiFunction<FieldModel,Context,java.util.Optional<N>> value)

lesserThan

public final StepCondition lesserThan(N value)

Returns a step condition checking if the node value is lesser than the given value.

Parameters:

value - the right side value

Returns:

the step condition

lesserThan

public final StepCondition lesserThan(NumericFieldInfo<N> value)

Returns a step condition checking if the node value is lesser than the given field value.

Parameters:

value - the right side value

Returns:

the step condition

lesserOrEquals

public final StepCondition lesserOrEquals(N value)

Returns a step condition checking if the node value is lesser or equals the given value.

Parameters:

value - the right side value

Returns:

the step condition

lesserOrEquals

public final StepCondition lesserOrEquals(NumericFieldInfo<N> value)

Returns a step condition checking if the node value is lesser or equals the given field value.

Parameters:

value - the right side value

Returns:

the step condition

greaterThan

public final StepCondition greaterThan(N value)

Returns a step condition checking if the node value is greater than the given value.

Parameters:

value - the right side value

Returns:

the step condition

greaterThan

public final StepCondition greaterThan(NumericFieldInfo<N> value)

Returns a step condition checking if the node value is greater than the given field value.

Parameters:

value - the right side value

Returns:

the step condition

greaterOrEquals

public final StepCondition greaterOrEquals(N value)

Returns a step condition checking if the node value is greater or equals the given value.

Parameters:

value - the right side value

Returns:

the step condition

greaterOrEquals

public final StepCondition greaterOrEquals(NumericFieldInfo<N> value)

Returns a step condition checking if the node value is greater or equals the given field value.

Parameters:

value - the right side value

Returns:

the step condition

between

public final StepCondition between(N minIncluded,
                                   N maxExcluded)

Returns a step condition checking if the node value is between the given min included and max excluded values.

Parameters:

minIncluded - the min value included

maxExcluded - the max value excluded

Returns:

the step condition

between

public final StepCondition between(NumericFieldInfo<N> minIncluded,
                                   NumericFieldInfo<N> maxExcluded)

Returns a step condition checking if the node value is between the given min included and max excluded field values.

Parameters:

minIncluded - the min value included

maxExcluded - the max value excluded

Returns:

the step condition

times

public final NumericFunction<N> times(int multiplier)

Returns a numeric function that returns the node value multiplied by the given multiplier.

Parameters:

multiplier - the multiplier

Returns:

the numeric function

plus

public final NumericFunction<N> plus(NumericFieldInfo<N> field)

Returns a numeric function that returns the node value sum with the node value param.

Parameters:

field - the field to sum

Returns:

the numeric function

plus

public final NumericFunction<N> plus(N value)

Returns a numeric function that returns the node value sum with the node value param.

Parameters:

value - to sum

Returns:

the numeric function

plus

public final NumericFunction<N> plus(NumericFunction<N> numericFunction)

Returns a numeric function that returns the node value sum with the node value param.

Parameters:

numericFunction - function to sum

Returns:

the numeric function

minus

public final NumericFunction<N> minus(NumericFieldInfo<N> field)

Returns a numeric function that returns the node value sum with the node value param.

Parameters:

field - the field to subtract

Returns:

the numeric function

minus

public final NumericFunction<N> minus(N value)

Returns a numeric function that returns the node value sum with the node value param.

Parameters:

value - to subtract

Returns:

the numeric function

minus

public final NumericFunction<N> minus(NumericFunction<N> numericFunction)

Returns a numeric function that returns the node value sum with the node value param.

Parameters:

numericFunction - function to subtract

Returns:

the numeric function

min

public final NumericFunction<N> min(java.util.List<NumericFieldInfo<N>> fields)

Returns a numeric function that returns the min value of the given field values.

Parameters:

fields - the field values to minimize

Returns:

the numeric function

sum

public final NumericFunction<N> sum(java.util.List<NumericFieldInfo<N>> fields)

Returns a numeric function that returns the sum value of the given field values.

Parameters:

fields - the field values to sum

Returns:

the numeric function

sumConditions

public final NumericFunction<N> sumConditions(java.util.List<NumericFunction<N>> conditions)

Returns a numeric function that returns the sum value of the given condition values.

Parameters:

conditions - the condition values to sum

Returns:

the numeric function

when

public final NumericFunction<N> when(StepCondition condition)

Returns a numeric step condition that returns the node value if the condition evaluates to true.

Parameters:

condition - the condition to test

Returns:

the numeric condition