Aggregation

All Superinterfaces:: Builtin

All Known Implementing Classes:: AbstractAggregation, CollatingCompose, Compose, Compose, Compose, ContainsSequence2, Count, CountUnique, Max, Mean, Mean, Min, PerformanceTest0.ContainsSequence, Set, Sum, Sum, Sum, Variance

public interface Aggregation extends Builtin

Interface for aggregations.
Aggregations are built-ins which take a set of values
to compute a result. Examples are max, min, mean,....

Method Summary

Modifier and Type

Method

Description

boolean

deliversOneResultOnly()

aggregation delivers only one result at argument position.

void

evaluate(BuiltinReceiver receiver)

Evaluate the aggregation.

void

input(long[] input)

feed aggregation with input tuple

void

start(BitSet grounds)

start feeding the aggregation with input.

void

stop()

stop feeding the aggregation with input

Methods inherited from interface com.semedy.reasoner.api.builtin.Builtin
clear, cloneBuiltin, evaluationFinished, getArgumentDescriptions, getArity, getDescription, getName, getType, getWeight, init, isEvaluable, isInternal, objectGeneratingArguments, readsSymbolTable, setProperties, setSymbolTable, writesSymbolTable

Method Details
- start
  
  void start(BitSet grounds) throws SemReasonerException, InterruptedException
  
  start feeding the aggregation with input. Grounds indicates which arguments are ground
  
  Parameters:
  
  grounds - , which arguments must be instantiated
  
  Throws:
  
  SemReasonerException
  
  InterruptedException
- input
  
  void input(long[] input) throws InterruptedException, IOException, SemReasonerException
  
  feed aggregation with input tuple
  
  Parameters:
  
  input - , the coded input tuple
  
  Throws:
  
  InterruptedException
  
  IOException
  
  SemReasonerException
- stop
  
  void stop() throws SemReasonerException, InterruptedException
  
  stop feeding the aggregation with input
  
  Throws:
  
  SemReasonerException
  
  InterruptedException
- evaluate
  
  void evaluate(BuiltinReceiver receiver) throws InterruptedException, IOException, SemReasonerException
  
  Evaluate the aggregation.
  For every result tuple the method "send" in receiver is called
  
  Parameters:
  
  receiver - , the receiver getting the results
  
  Throws:
  
  InterruptedException
  
  IOException
  
  SemReasonerException
- deliversOneResultOnly
  
  boolean deliversOneResultOnly()
  
  aggregation delivers only one result at argument position.
  For instance count delivers one result at argument position 1.
  
  Returns:
  
  true if it delivers one result only