01: /*
02: * <copyright>
03: *
04: * Copyright 2003-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.lib.aggagent.query;
28:
29: import java.io.Serializable;
30: import java.util.Iterator;
31: import java.util.List;
32:
33: /**
34: * Objects implementing this interface are capable of transforming an
35: * AggregationResultSet in arbitrary ways. For most purposes, it is expected
36: * that the BatchAggregator class combined with a DataAtomMelder (q.v.)
37: * implementation will suffice, and will be easier to use. However, for some
38: * of the more esoteric combinations, this class may be used to exercise
39: * complete control over the calculations.
40: */
41: public interface Aggregator extends Serializable {
42: /**
43: * Derive a new set of ResultSetDataAtoms from those contained in the
44: * specified AggregationResultSet.
45: *
46: * @param atomIterator an iterator that iterates through raw, unaggregated
47: * data atoms
48: * @param output a List into which the produced ResultSetDataAtoms should be
49: * placed
50: */
51: public void aggregate(Iterator atomIterator, List output);
52: }
|