001: /*
002: * <copyright>
003: *
004: * Copyright 1997-2004 BBNT Solutions, LLC
005: * under sponsorship of the Defense Advanced Research Projects
006: * Agency (DARPA).
007: *
008: * You can redistribute this software and/or modify it under the
009: * terms of the Cougaar Open Source License as published on the
010: * Cougaar Open Source Website (www.cougaar.org).
011: *
012: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
013: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
014: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
015: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
016: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
017: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
018: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
019: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
020: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
021: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
022: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
023: *
024: * </copyright>
025: */
026:
027: package org.cougaar.planning.ldm.plan;
028:
029: import java.util.Vector;
030:
031: /** AllocationResultDistributor is a class which specifies how allocation results
032: * should be distributed amongst 'parent' tasks of a Composition.
033: * Distributes all aspect values amongst all parent tasks, divides COST and
034: * QUANTITY aspects evenly among all parent tasks.
035: * Distributes all AuxiliaryQueryTypes and data to all parent tasks.
036: * @see org.cougaar.planning.ldm.plan.AllocationResult
037: **/
038:
039: public interface AllocationResultDistributor extends AspectType // for Constants
040: {
041:
042: /** Calculate seperate AllocationResults for each parent task of
043: * the Composition.
044: * @param parents Vector of Parent Tasks.
045: * @param aggregateAllocationResult The allocationResult of the subtask.
046: * @return distributedresults
047: * @see org.cougaar.planning.ldm.plan.Composition
048: * @see org.cougaar.planning.ldm.plan.TaskScoreTable
049: * @see org.cougaar.planning.ldm.plan.AllocationResult
050: */
051: TaskScoreTable calculate(Vector parents,
052: AllocationResult aggregateAllocationResult);
053:
054: /* static accessor for a default distributor */
055: AllocationResultDistributor DEFAULT = new DefaultDistributor();
056:
057: // implementation of the default distributor
058: /** Default distributor makes the best guess computation possible
059: * without examining the details of the parent or sub tasks.
060: * In particular all result values are copied to the values passed
061: * to the parent, except for COST and QUANTITY, whose values are
062: * distributed equally among the parents. This may or may not be
063: * the right thing, depending on what sort of tasks are being
064: * aggregated.
065: **/
066:
067: class DefaultDistributor implements AllocationResultDistributor {
068: public DefaultDistributor() {
069: }
070:
071: public TaskScoreTable calculate(Vector parents,
072: AllocationResult ar) {
073: int l = parents.size();
074:
075: if (l == 0 || ar == null)
076: return null;
077:
078: AspectValue[] avs = ar.getAspectValueResults(); // get a new AVR copy
079:
080: for (int x = 0; x < avs.length; x++) {
081: AspectValue av = avs[x];
082: int type = av.getType();
083: // if the aspect is COST or QUANTITY divide evenly across parents
084: if ((type == COST) || (type == QUANTITY)) {
085: avs[x] = av.dupAspectValue(av.floatValue() / l);
086: } else {
087: // it is ok already - just propagate it through
088: }
089: }
090:
091: AllocationResult newar = new AllocationResult(ar
092: .getConfidenceRating(), ar.isSuccess(), avs);
093: // fill in the auxiliaryquery info
094: // each of the new allocationresults(for the parents) will have the SAME
095: // auxiliaryquery info that the allocationresult (of the child) has.
096: for (int aq = 0; aq < AuxiliaryQueryType.AQTYPE_COUNT; aq++) {
097: String info = ar.auxiliaryQuery(aq);
098: if (info != null) {
099: newar.addAuxiliaryQueryInfo(aq, info);
100: }
101: }
102:
103: AllocationResult results[] = new AllocationResult[l];
104: for (int i = 0; i < l; i++) {
105: results[i] = newar;
106: }
107:
108: Task tasks[] = new Task[l];
109: parents.copyInto(tasks);
110:
111: return new TaskScoreTable(tasks, results);
112: }
113: } // end of DefaultDistributor inner class
114:
115: }
|