NumericCondition (doov-core 2.1.0 API)

java.lang.Object
- io.doov.core.dsl.impl.DefaultCondition<N>
- - io.doov.core.dsl.impl.NumericCondition<N>

Type Parameters:

N - the type of the field value

All Implemented Interfaces:

Readable

Direct Known Subclasses:

DoubleCondition, FloatCondition, IntegerCondition, LongCondition
```
public abstract class NumericCondition<N extends java.lang.Number>
extends DefaultCondition<N>
```
Base class for numeric conditions.
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
Modifier and Type	Field and Description
`protected DslField`	`field`
`protected java.util.function.BiFunction<DslModel,Context,java.util.Optional<N>>`	`function`
`protected PredicateMetadata`	`metadata`
`protected java.util.function.BiFunction<DslModel,DslField,java.util.Optional<N>>`	`value`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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.
`PredicateMetadata`	`getMetadata()`
`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.
`NumericCondition<N>`	`min(java.util.List<NumericFieldInfo<N>> fields)` Returns a numeric step condition that returns the min value of the given field values.
`protected abstract NumericCondition<N>`	`numericCondition(DslField field, PredicateMetadata metadata, java.util.function.BiFunction<DslModel,Context,java.util.Optional<N>> value)`
`protected StepCondition`	`predicate(LeafMetadata metadata, java.util.function.BiFunction<DslModel,Context,java.util.Optional<N>> value, java.util.function.BiFunction<N,N,java.lang.Boolean> predicate)`
`protected StepCondition`	`predicate(LeafMetadata metadata, java.util.function.Function<N,java.lang.Boolean> predicate)`
`java.lang.String`	`readable()` Returns the human readable version of this object.
`NumericCondition<N>`	`sum(java.util.List<NumericFieldInfo<N>> fields)` Returns a numeric step condition that returns the sum value of the given field values.
`NumericCondition<N>`	`sumConditions(java.util.List<NumericCondition<N>> conditions)` Returns a numeric step condition that returns the sum value of the given condition values.
`NumericCondition<N>`	`times(int multiplier)` Returns a numeric step condition that returns the node value multiplied by the given multiplier.
`protected java.util.Optional<N>`	`value(DslModel model, DslField field)`
`protected java.util.Optional<N>`	`valueModel(DslModel model, DslField field)`
`NumericCondition<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.DefaultCondition
allMatch, allMatch, allMatch, anyMatch, anyMatch, anyMatch, eq, eq, eq, eq, isNotNull, isNull, mapToInt, noneMatch, noneMatch, noneMatch, notEq, notEq, notEq, notEq

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

- Field Detail
  - field
```
protected final DslField field
```
  - metadata
```
protected final PredicateMetadata metadata
```
  - value
```
protected final java.util.function.BiFunction<DslModel,DslField,java.util.Optional<N>> value
```
  - function
```
protected final java.util.function.BiFunction<DslModel,Context,java.util.Optional<N>> function
```
- Method Detail
  - numericCondition
```
protected abstract NumericCondition<N> numericCondition(DslField field,
                                                        PredicateMetadata metadata,
                                                        java.util.function.BiFunction<DslModel,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
  - min
```
public final NumericCondition<N> min(java.util.List<NumericFieldInfo<N>> fields)
```
    Returns a numeric step condition that returns the min value of the given field values.
    
    Parameters:
    
    fields - the field values to minimize
    
    Returns:
    
    the numeric condition
  - sum
```
public final NumericCondition<N> sum(java.util.List<NumericFieldInfo<N>> fields)
```
    Returns a numeric step condition that returns the sum value of the given field values.
    
    Parameters:
    
    fields - the field values to sum
    
    Returns:
    
    the numeric condition
  - sumConditions
```
public final NumericCondition<N> sumConditions(java.util.List<NumericCondition<N>> conditions)
```
    Returns a numeric step condition that returns the sum value of the given condition values.
    
    Parameters:
    
    conditions - the condition values to sum
    
    Returns:
    
    the numeric condition
  - times
```
public final NumericCondition<N> times(int multiplier)
```
    Returns a numeric step condition that returns the node value multiplied by the given multiplier.
    
    Parameters:
    
    multiplier - the multiplier
    
    Returns:
    
    the numeric condition
  - when
```
public final NumericCondition<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
  - valueModel
```
protected java.util.Optional<N> valueModel(DslModel model,
                                           DslField field)
```
  - value
```
protected final java.util.Optional<N> value(DslModel model,
                                            DslField field)
```
  - predicate
```
protected final StepCondition predicate(LeafMetadata metadata,
                                        java.util.function.Function<N,java.lang.Boolean> predicate)
```
  - predicate
```
protected final StepCondition predicate(LeafMetadata metadata,
                                        java.util.function.BiFunction<DslModel,Context,java.util.Optional<N>> value,
                                        java.util.function.BiFunction<N,N,java.lang.Boolean> predicate)
```
  - getMetadata
```
public PredicateMetadata getMetadata()
```
  - readable
```
public java.lang.String readable()
```
    Description copied from interface: Readable
    
    Returns the human readable version of this object.
    
    Specified by:
    
    readable in interface Readable
    
    Returns:
    
    the readable string

Class NumericCondition<N extends java.lang.Number>

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

field

metadata

value

function

Method Detail

numericCondition

lesserThan

lesserThan

lesserOrEquals

lesserOrEquals

greaterThan

greaterThan

greaterOrEquals

greaterOrEquals

between

between

min

sum

sumConditions

times

when

valueModel

value

predicate

predicate

getMetadata

readable