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.List;
31:
32: /**
33: * Objects implementing this interface embody the nucleus of aggregation
34: * functionality. That is, they combine multiple data atoms based on the
35: * embodied aggregation rule. Typically, the result is a single atom, but
36: * the API allows zero or multiple atoms to accomodate a variety of needs.
37: */
38: public interface DataAtomMelder extends Serializable {
39: /**
40: * Combine the data atoms in the list provided according to the implemented
41: * aggregation scheme. Atoms produced in this manner should be appended to
42: * the output list. Any other modification of the list should be avoided.
43: * The list of idNames and the CompoundKey refer to the aggregation. If
44: * multiple aggregated atoms are going to be produced, then additional id
45: * keys must be used to distinguish them (otherwise, only one will be kept
46: * in the resultant data set.
47: *
48: * @param idNames a list of names, in order of appearance, of the id values
49: * found in the id key
50: * @param id the compound id key values associated with the aggregation
51: * @param atoms a List of ResultSetDataAtoms that should be combined
52: * @param output a List into which the produced ResultSetDataAtoms should be
53: * placed
54: */
55: public void meld(List idNames, CompoundKey id, List atoms,
56: List output);
57: }
|