de.ipcon.schema

Interface AggregateFunctionI

All Known Subinterfaces:

ParameterizedAggregateFunctionI

All Known Implementing Classes:

BasicAggregate

public interface AggregateFunctionI

Interface for aggregate functions that process data and return a single result.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getResult() Returns the result of the aggregation based on the objects that have been processed.
boolean	isIgnoreDeleted() Returns whether the aggregate function is currently configured to ignore deleted BOIs.
AggregateFunctionI	put(java.lang.Object o) Adds an object to the aggregate function for processing.
void	setIgnoreDeleted() Sets the aggregate function to ignore BOIs marked as deleted.

Method Detail

setIgnoreDeleted

void setIgnoreDeleted()

Sets the aggregate function to ignore BOIs marked as deleted.

isIgnoreDeleted

boolean isIgnoreDeleted()

Returns whether the aggregate function is currently configured to ignore deleted BOIs.

Returns:

true if deleted BOIs are to be ignored, false otherwise.

put

AggregateFunctionI put(java.lang.Object o)

Adds an object to the aggregate function for processing. The specific aggregation logic is determined by the implementing class.

Parameters:

o - The object to add to the aggregation (can also be a Map, Collection or array of BOIs).

Returns:

The current instance of the AggregateFunctionI, allowing for method chaining.

getResult

java.lang.Object getResult()

Returns the result of the aggregation based on the objects that have been processed. The type of the returned object depends on the specific aggregate function.

Returns:

The aggregated result.