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.ArrayList;
030: import java.util.List;
031:
032: /** BulkEstimate Implementation
033: * A BulkEstimate is similar to but not a subclass of PlanElement.
034: * A BulkEstimate allows for a Plugin to specify a Task with a collection
035: * of Preference sets and get back a collection of AllocationResults.
036: * Each AllocationResult will represent the results of allocating the Task
037: * with one of the Preference sets.
038: *
039: **/
040:
041: public class BulkEstimateImpl implements BulkEstimate, NewBulkEstimate {
042: private Task task;
043: private List prefsets;
044: private AllocationResult[] theresults;
045: private boolean iscomplete;
046: private double conf;
047:
048: /** Constructor that takes the task and preference sets.
049: * @param thetask
050: * @param thepreferencesets
051: * @param confrating the confidence rating to be reached by each allocation
052: */
053: public BulkEstimateImpl(Task thetask, List thepreferencesets,
054: double confrating) {
055: this .task = thetask;
056: this .prefsets = new ArrayList(thepreferencesets);
057: this .iscomplete = false;
058: conf = confrating;
059: // initialize the allocationresult array in case we want to add
060: // them singularly
061: this .theresults = new AllocationResult[prefsets.size()];
062: }
063:
064: /** @return The task to be allocated */
065: public Task getTask() {
066: return task;
067: }
068:
069: /** @return The collection of preference sets. Each set will be
070: * represented by a Preference Array.
071: */
072: public List getPreferenceSets() {
073: return new ArrayList(prefsets);
074: }
075:
076: /** @return The Array of AllocationResults.
077: * Note that this collection will be changing until isComplete()
078: */
079: public AllocationResult[] getAllocationResults() {
080: return (AllocationResult[]) theresults.clone();
081: }
082:
083: /** @return Will be set to true once all of the AllocationResults
084: * for each preference set have been gathered.
085: */
086: public boolean isComplete() {
087: return iscomplete;
088: }
089:
090: /** @return The confidence rating of each AllocationResult that
091: * must be reached before the result is valid and the next preference set
092: * can be tested. The confidence rating should be between 0.0 and 1.0 with
093: * 1.0 being the most complete of allocations.
094: */
095: public double getConfidenceRating() {
096: return conf;
097: }
098:
099: /** @param allresults The complete Array of AllocationResults. */
100: public void setAllocationResults(AllocationResult[] allresults) {
101: // make sure that the number of results equal the number of preference sets.
102: if (allresults.length == prefsets.size()) {
103: theresults = (AllocationResult[]) allresults.clone();
104: } else {
105: throw new IllegalArgumentException(
106: "The number of AllocationResults passed to "
107: + "NewBulkEstimate.setAllocationResults(AllocationResult[] allresults) "
108: + "does not match the number of prefrence sets specified by the BulkEstimate.");
109: }
110: }
111:
112: /** set a single AllocationResult
113: * @param index The position of the result in the overall result array.
114: * This position should correspond to the preference set position.
115: * @param aresult
116: */
117: public void setSingleResult(int index, AllocationResult aresult) {
118: if (index >= 0 && index < theresults.length) {
119: theresults[index] = aresult;
120: } else {
121: throw new IllegalArgumentException(
122: "An out of bounds index was passed to NewBulkEstimate.setSingleResult(int index, AllocationResult aresult).");
123: }
124: }
125:
126: /** @param complete Should be set to true once all of the AllocationResults
127: * for each preference set have been gathered.
128: */
129: public void setIsComplete(boolean complete) {
130: iscomplete = complete;
131: }
132:
133: }
|