Package ch.tocco.nice2.persist.core.api.exec.tasks2

Class AggregateTasks.Sum

java.lang.Object

ch.tocco.nice2.persist.core.api.exec.tasks2.AggregateTasks.Sum

All Implemented Interfaces:

OptionalTask<Iterable<Entity>,BigDecimal>, PersistTask<Iterable<Entity>,BigDecimal>, AggregateTasks.AggregateTask<BigDecimal>

Enclosing class:

AggregateTasks

public static class AggregateTasks.Sum
extends Object
implements OptionalTask<Iterable<Entity>,BigDecimal>, AggregateTasks.AggregateTask<BigDecimal>

Calculates the sum of the values returned when resolving the given path against each entity of the entity list. The path must denote a numeric field or end in a relation. For the latter case it sums up the relation targets. If the path is empty, it is the same as count.

Constructor Summary

Constructors

Constructor	Description
Sum(Path path)
Sum(String path)

Method Summary

Modifier and Type	Method	Description
BigDecimal	doRun(Iterable<Entity> list, CommandContext ctx)
PersistTask<EntityList,BigDecimal>	fromEntityList()
static PersistTask<EntityList,BigDecimal>	fromEntityList(Path path)
static PersistTask<EntityList,BigDecimal>	fromEntityList(String path)
static AggregateTasks.Sum	fromIterable(Path path)
static AggregateTasks.Sum	fromIterable(String path)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.persist.core.api.exec.OptionalTask

run

Methods inherited from interface ch.tocco.nice2.persist.core.api.exec.PersistTask

andThenDo, compose, compose2, composeWhen, discardResult, expand, expand, getDescription, ifElse, logTime, orWhen, orWhenNot, passWhen, passWhenNot, skipErrors, unwrap

Constructor Details

Sum

public Sum(Path path)

Sum

public Sum(String path)

Method Details

fromEntityList

public static PersistTask<EntityList,BigDecimal> fromEntityList(String path)

fromIterable

public static AggregateTasks.Sum fromIterable(String path)

fromEntityList

public static PersistTask<EntityList,BigDecimal> fromEntityList(Path path)

fromIterable

public static AggregateTasks.Sum fromIterable(Path path)

doRun

public BigDecimal doRun(Iterable<Entity> list,
 CommandContext ctx)
                 throws Exception

Specified by:

doRun in interface OptionalTask<Iterable<Entity>,BigDecimal>

Throws:

Exception

fromEntityList

public PersistTask<EntityList,BigDecimal> fromEntityList()

Specified by:

fromEntityList in interface AggregateTasks.AggregateTask<BigDecimal>

toString

public String toString()

Overrides:

toString in class Object