TemporalFunction (doov-core 2.7.8 API)

java.lang.Object
- io.doov.core.dsl.impl.DefaultFunction<N,PredicateMetadata>
- - io.doov.core.dsl.impl.time.TemporalFunction<N>

Type Parameters:

N - the type of the field value

All Implemented Interfaces:

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

Direct Known Subclasses:

LocalDateFunction, LocalDateTimeFunction, LocalTimeFunction
```
public abstract class TemporalFunction<N extends java.time.temporal.Temporal>
extends DefaultFunction<N,PredicateMetadata>
implements TemporalOperators<N>
```
Base class for temporal function.
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
Modifier	Constructor and Description
`protected`	`TemporalFunction(PredicateMetadata metadata, java.util.function.BiFunction<FieldModel,Context,java.util.Optional<N>> value)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`StepCondition`	`after(N value)` Returns a condition checking if the node value is after the value.
`StepCondition`	`after(java.util.function.Supplier<N> value)` Returns a condition checking if the node value is after the supplier value.
`StepCondition`	`after(TemporalFieldInfo<N> value)` Returns a condition checking if the node value is after the field value.
`StepCondition`	`after(TemporalFunction<N> value)` Returns a condition checking if the node value is after the condition value.
`StepCondition`	`afterOrEq(N value)` Returns a condition checking if the node value is after or equals the value.
`StepCondition`	`afterOrEq(java.util.function.Supplier<N> value)` Returns a condition checking if the node value is after or equals the supplier value.
`StepCondition`	`afterOrEq(TemporalFieldInfo<N> value)` Returns a condition checking if the node value is after the field value.
`StepCondition`	`afterOrEq(TemporalFunction<N> value)` Returns a condition checking if the node value is after or equals the condition value.
`NumericFunction<java.lang.Integer>`	`ageAt(N value)` Returns a numeric function that returns the age at the given value.
`NumericFunction<java.lang.Integer>`	`ageAt(java.util.function.Supplier<N> value)` Returns a numeric function that returns the age of this node value at the given supplier value.
`NumericFunction<java.lang.Integer>`	`ageAt(TemporalFieldInfo<N> value)` Returns a numeric function that returns the age of this node value at the given field value.
`NumericFunction<java.lang.Integer>`	`ageAt(TemporalFunction<N> value)` Returns a numeric function that returns the age of this node value at the given condition value.
`StepCondition`	`before(N value)` Returns a condition checking if the node value is before the given value.
`StepCondition`	`before(java.util.function.Supplier<N> value)` Returns a condition checking if the node value is before the supplier value.
`StepCondition`	`before(TemporalFieldInfo<N> value)` Returns a condition checking if the node value is before the given field value.
`StepCondition`	`before(TemporalFunction<N> value)` Returns a condition checking if the node value is before the condition value.
`StepCondition`	`beforeOrEq(N value)` Returns a condition checking if the node value is before or equals the value.
`StepCondition`	`beforeOrEq(java.util.function.Supplier<N> value)` Returns a condition checking if the node value is before or equals the supplier value.
`StepCondition`	`beforeOrEq(TemporalFieldInfo<N> value)` Returns a condition checking if the node value is before the given field value.
`StepCondition`	`beforeOrEq(TemporalFunction<N> value)` Returns a condition checking if the node value is before or equals the condition value.
`StepCondition`	`between(N minIncluded, N maxExcluded)` Returns a condition checking if the node value is between the given min inclusive and max exclusive values.
`StepCondition`	`between(java.util.function.Supplier<N> minIncluded, java.util.function.Supplier<N> maxExcluded)` Returns a condition checking if the node value is between the given min inclusive and max exclusive supplier values.
`StepCondition`	`between(TemporalFunction<N> minIncluded, TemporalFunction<N> maxExcluded)` Returns a condition checking if the node value is between the given min inclusive and max exclusive condition values.
`NumericFunction<java.lang.Integer>`	`daysBetween(N value)` Returns a numeric function that returns the days between this node value and the given value.
`NumericFunction<java.lang.Integer>`	`daysBetween(java.util.function.Supplier<N> value)` Returns a numeric function that returns the days between this node value and the given supplier value.
`NumericFunction<java.lang.Integer>`	`daysBetween(TemporalFieldInfo<N> value)` Returns a numeric function that returns the days between this node value and the given field value.
`NumericFunction<java.lang.Integer>`	`daysBetween(TemporalFunction<N> value)` Returns a numeric function that returns the days between this node value and the given condition value.
`StepCondition`	`eq(TemporalFunction<N> value)` Returns a condition checking if the node value is equal to the given condition value.
`TemporalFunction<N>`	`minus(int value, java.time.temporal.TemporalUnit unit)` Returns a temporal function that returns the node value minus given temporal value and unit.
`TemporalFunction<N>`	`minus(NumericFieldInfo<java.lang.Integer> value, java.time.temporal.TemporalUnit unit)` Returns a temporal function that returns the node value minus given temporal field value and unit.
`TemporalFunction<N>`	`minus(NumericFunction<java.lang.Integer> function, java.time.temporal.TemporalUnit unit)` Returns a temporal function that returns the node value minus given temporal field value and unit.
`NumericFunction<java.lang.Integer>`	`monthsBetween(N value)` Returns a numeric function that returns the months between this node value and the given value.
`NumericFunction<java.lang.Integer>`	`monthsBetween(java.util.function.Supplier<N> value)` Returns a numeric function that returns the months between this node value and the given supplier value.
`NumericFunction<java.lang.Integer>`	`monthsBetween(TemporalFieldInfo<N> value)` Returns a numeric function that returns the months between this node value and the given field value.
`NumericFunction<java.lang.Integer>`	`monthsBetween(TemporalFunction<N> value)` Returns a numeric function that returns the months between this node value and the given condition value.
`StepCondition`	`notBetween(N minIncluded, N maxExcluded)` Returns a condition checking if the node value is not between the given min inclusive and max exclusive values.
`StepCondition`	`notBetween(java.util.function.Supplier<N> minIncluded, java.util.function.Supplier<N> maxExcluded)` Returns a condition checking if the node value is not between the given min inclusive and max exclusive supplier values.
`StepCondition`	`notBetween(TemporalFunction<N> minIncluded, TemporalFunction<N> maxExcluded)` Returns a condition checking if the node value is not between the given min inclusive and max exclusive condition values.
`TemporalFunction<N>`	`plus(int value, java.time.temporal.TemporalUnit unit)` Returns a temporal function that returns the node value plus given temporal value and unit.
`TemporalFunction<N>`	`plus(NumericFieldInfo<java.lang.Integer> value, java.time.temporal.TemporalUnit unit)` Returns a temporal function that returns the node value plus given temporal field value and unit.
`TemporalFunction<N>`	`plus(NumericFunction<java.lang.Integer> function, java.time.temporal.TemporalUnit unit)` Returns a temporal function that returns the node value plus given temporal field value and unit.
`protected abstract TemporalFunction<N>`	`temporalFunction(PredicateMetadata metadata, java.util.function.BiFunction<FieldModel,Context,java.util.Optional<N>> value)`
`TemporalFunction<N>`	`with(TemporalAdjuster adjuster)` Returns a temporal function that returns the node value with given temporal adjuster applied.
`NumericFunction<java.lang.Integer>`	`yearsBetween(N value)` Returns a numeric function that returns the years between this node value and the given value.
`NumericFunction<java.lang.Integer>`	`yearsBetween(java.util.function.Supplier<N> value)` Returns a numeric condition that returns the years between this node value and the given supplier value.
`NumericFunction<java.lang.Integer>`	`yearsBetween(TemporalFieldInfo<N> value)` Returns a numeric function that returns the years between this node value and the given field value.
`NumericFunction<java.lang.Integer>`	`yearsBetween(TemporalFunction<N> value)` Returns a numeric function that returns the years between this node value and the given condition value.

Methods inherited from class io.doov.core.dsl.impl.DefaultFunction
allMatch, allMatch, allMatch, anyMatch, anyMatch, anyMatch, eq, eq, eq, eq, getFunction, getMetadata, isNotNull, isNull, map, mapToInt, mapToInt, mapToString, mapToString, mapUsing, noneMatch, noneMatch, noneMatch, notEq, 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.time.TemporalOperators
afterFunction, afterOrEqualsFunction, beforeFunction, beforeOrEqualsFunction, betweenFunction, minusFunction, plusFunction, withFunction

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
  - TemporalFunction
```
protected TemporalFunction(PredicateMetadata metadata,
                           java.util.function.BiFunction<FieldModel,Context,java.util.Optional<N>> value)
```
- Method Detail
  - temporalFunction
```
protected abstract TemporalFunction<N> temporalFunction(PredicateMetadata metadata,
                                                        java.util.function.BiFunction<FieldModel,Context,java.util.Optional<N>> value)
```
  - eq
```
public final StepCondition eq(TemporalFunction<N> value)
```
    Returns a condition checking if the node value is equal to the given condition value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - before
```
public final StepCondition before(N value)
```
    Returns a condition checking if the node value is before the given value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - before
```
public final StepCondition before(TemporalFieldInfo<N> value)
```
    Returns a condition checking if the node value is before the given field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - before
```
public final StepCondition before(java.util.function.Supplier<N> value)
```
    Returns a condition checking if the node value is before the supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - before
```
public final StepCondition before(TemporalFunction<N> value)
```
    Returns a condition checking if the node value is before the condition value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - beforeOrEq
```
public final StepCondition beforeOrEq(N value)
```
    Returns a condition checking if the node value is before or equals the value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - beforeOrEq
```
public final StepCondition beforeOrEq(TemporalFieldInfo<N> value)
```
    Returns a condition checking if the node value is before the given field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - beforeOrEq
```
public final StepCondition beforeOrEq(java.util.function.Supplier<N> value)
```
    Returns a condition checking if the node value is before or equals the supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - beforeOrEq
```
public final StepCondition beforeOrEq(TemporalFunction<N> value)
```
    Returns a condition checking if the node value is before or equals the condition value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - after
```
public final StepCondition after(N value)
```
    Returns a condition checking if the node value is after the value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - after
```
public final StepCondition after(TemporalFieldInfo<N> value)
```
    Returns a condition checking if the node value is after the field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - after
```
public final StepCondition after(java.util.function.Supplier<N> value)
```
    Returns a condition checking if the node value is after the supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - after
```
public final StepCondition after(TemporalFunction<N> value)
```
    Returns a condition checking if the node value is after the condition value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - afterOrEq
```
public final StepCondition afterOrEq(N value)
```
    Returns a condition checking if the node value is after or equals the value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - afterOrEq
```
public final StepCondition afterOrEq(TemporalFieldInfo<N> value)
```
    Returns a condition checking if the node value is after the field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - afterOrEq
```
public final StepCondition afterOrEq(java.util.function.Supplier<N> value)
```
    Returns a condition checking if the node value is after or equals the supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - afterOrEq
```
public final StepCondition afterOrEq(TemporalFunction<N> value)
```
    Returns a condition checking if the node value is after or equals the condition value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - between
```
public final StepCondition between(N minIncluded,
                                   N maxExcluded)
```
    Returns a condition checking if the node value is between the given min inclusive and max exclusive values.
    
    Parameters:
    
    minIncluded - the min value included
    
    maxExcluded - the max value excluded
    
    Returns:
    
    the step condition
  - between
```
public final StepCondition between(java.util.function.Supplier<N> minIncluded,
                                   java.util.function.Supplier<N> maxExcluded)
```
    Returns a condition checking if the node value is between the given min inclusive and max exclusive supplier values.
    
    Parameters:
    
    minIncluded - the min value included
    
    maxExcluded - the max value excluded
    
    Returns:
    
    the step condition
  - between
```
public final StepCondition between(TemporalFunction<N> minIncluded,
                                   TemporalFunction<N> maxExcluded)
```
    Returns a condition checking if the node value is between the given min inclusive and max exclusive condition values.
    
    Parameters:
    
    minIncluded - the min value included
    
    maxExcluded - the max value excluded
    
    Returns:
    
    the step condition
  - notBetween
```
public final StepCondition notBetween(N minIncluded,
                                      N maxExcluded)
```
    Returns a condition checking if the node value is not between the given min inclusive and max exclusive values.
    
    Parameters:
    
    minIncluded - the min value included
    
    maxExcluded - the max value excluded
    
    Returns:
    
    the step condition
  - notBetween
```
public final StepCondition notBetween(java.util.function.Supplier<N> minIncluded,
                                      java.util.function.Supplier<N> maxExcluded)
```
    Returns a condition checking if the node value is not between the given min inclusive and max exclusive supplier values.
    
    Parameters:
    
    minIncluded - the min value included
    
    maxExcluded - the max value excluded
    
    Returns:
    
    the step condition
  - notBetween
```
public final StepCondition notBetween(TemporalFunction<N> minIncluded,
                                      TemporalFunction<N> maxExcluded)
```
    Returns a condition checking if the node value is not between the given min inclusive and max exclusive condition values.
    
    Parameters:
    
    minIncluded - the min value included
    
    maxExcluded - the max value excluded
    
    Returns:
    
    the step condition
  - with
```
public final TemporalFunction<N> with(TemporalAdjuster adjuster)
```
    Returns a temporal function that returns the node value with given temporal adjuster applied.
    
    Parameters:
    
    adjuster - the adjuster
    
    Returns:
    
    the temporal function
  - minus
```
public final TemporalFunction<N> minus(int value,
                                       java.time.temporal.TemporalUnit unit)
```
    Returns a temporal function that returns the node value minus given temporal value and unit.
    
    Parameters:
    
    value - the minus value
    
    unit - the minus unit
    
    Returns:
    
    the temporal function
  - minus
```
public final TemporalFunction<N> minus(NumericFieldInfo<java.lang.Integer> value,
                                       java.time.temporal.TemporalUnit unit)
```
    Returns a temporal function that returns the node value minus given temporal field value and unit.
    
    Parameters:
    
    value - the minus field value
    
    unit - the minus unit
    
    Returns:
    
    the temporal function
  - minus
```
public final TemporalFunction<N> minus(NumericFunction<java.lang.Integer> function,
                                       java.time.temporal.TemporalUnit unit)
```
    Returns a temporal function that returns the node value minus given temporal field value and unit.
    
    Parameters:
    
    function - the minus field value
    
    unit - the minus unit
    
    Returns:
    
    the temporal function
  - plus
```
public final TemporalFunction<N> plus(int value,
                                      java.time.temporal.TemporalUnit unit)
```
    Returns a temporal function that returns the node value plus given temporal value and unit.
    
    Parameters:
    
    value - the plus value
    
    unit - the plus unit
    
    Returns:
    
    the temporal function
  - plus
```
public final TemporalFunction<N> plus(NumericFieldInfo<java.lang.Integer> value,
                                      java.time.temporal.TemporalUnit unit)
```
    Returns a temporal function that returns the node value plus given temporal field value and unit.
    
    Parameters:
    
    value - the plus field value
    
    unit - the plus unit
    
    Returns:
    
    the temporal function
  - plus
```
public final TemporalFunction<N> plus(NumericFunction<java.lang.Integer> function,
                                      java.time.temporal.TemporalUnit unit)
```
    Returns a temporal function that returns the node value plus given temporal field value and unit.
    
    Parameters:
    
    function - the plus field value
    
    unit - the plus unit
    
    Returns:
    
    the temporal function
  - ageAt
```
public final NumericFunction<java.lang.Integer> ageAt(N value)
```
    Returns a numeric function that returns the age at the given value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - ageAt
```
public final NumericFunction<java.lang.Integer> ageAt(TemporalFieldInfo<N> value)
```
    Returns a numeric function that returns the age of this node value at the given field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - ageAt
```
public final NumericFunction<java.lang.Integer> ageAt(TemporalFunction<N> value)
```
    Returns a numeric function that returns the age of this node value at the given condition value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - ageAt
```
public final NumericFunction<java.lang.Integer> ageAt(java.util.function.Supplier<N> value)
```
    Returns a numeric function that returns the age of this node value at the given supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - daysBetween
```
public final NumericFunction<java.lang.Integer> daysBetween(N value)
```
    Returns a numeric function that returns the days between this node value and the given value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - daysBetween
```
public final NumericFunction<java.lang.Integer> daysBetween(TemporalFieldInfo<N> value)
```
    Returns a numeric function that returns the days between this node value and the given field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - daysBetween
```
public final NumericFunction<java.lang.Integer> daysBetween(TemporalFunction<N> value)
```
    Returns a numeric function that returns the days between this node value and the given condition value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - daysBetween
```
public final NumericFunction<java.lang.Integer> daysBetween(java.util.function.Supplier<N> value)
```
    Returns a numeric function that returns the days between this node value and the given supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - monthsBetween
```
public final NumericFunction<java.lang.Integer> monthsBetween(N value)
```
    Returns a numeric function that returns the months between this node value and the given value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - monthsBetween
```
public final NumericFunction<java.lang.Integer> monthsBetween(TemporalFieldInfo<N> value)
```
    Returns a numeric function that returns the months between this node value and the given field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - monthsBetween
```
public final NumericFunction<java.lang.Integer> monthsBetween(TemporalFunction<N> value)
```
    Returns a numeric function that returns the months between this node value and the given condition value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - monthsBetween
```
public final NumericFunction<java.lang.Integer> monthsBetween(java.util.function.Supplier<N> value)
```
    Returns a numeric function that returns the months between this node value and the given supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - yearsBetween
```
public final NumericFunction<java.lang.Integer> yearsBetween(N value)
```
    Returns a numeric function that returns the years between this node value and the given value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - yearsBetween
```
public final NumericFunction<java.lang.Integer> yearsBetween(TemporalFieldInfo<N> value)
```
    Returns a numeric function that returns the years between this node value and the given field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - yearsBetween
```
public final NumericFunction<java.lang.Integer> yearsBetween(TemporalFunction<N> value)
```
    Returns a numeric function that returns the years between this node value and the given condition value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric function
  - yearsBetween
```
public final NumericFunction<java.lang.Integer> yearsBetween(java.util.function.Supplier<N> value)
```
    Returns a numeric condition that returns the years between this node value and the given supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the numeric condition

Class TemporalFunction<N extends java.time.temporal.Temporal>

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface io.doov.core.dsl.impl.time.TemporalOperators

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

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

Constructor Detail

TemporalFunction

Method Detail

temporalFunction

eq

before

before

before

before

beforeOrEq

beforeOrEq

beforeOrEq

beforeOrEq

after

after

after

after

afterOrEq

afterOrEq

afterOrEq

afterOrEq

between

between

between

notBetween

notBetween

notBetween

with

minus

minus

minus

plus

plus

plus

ageAt

ageAt

ageAt

ageAt

daysBetween

daysBetween

daysBetween

daysBetween

monthsBetween

monthsBetween

monthsBetween

monthsBetween

yearsBetween

yearsBetween

yearsBetween

yearsBetween