01: /*
02: * <copyright>
03: *
04: * Copyright 2001-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: package org.cougaar.logistics.plugin.trans.tools;
27:
28: import java.util.Collection;
29: import java.util.Set;
30:
31: import org.cougaar.planning.ldm.PlanningFactory;
32:
33: import org.cougaar.glm.callback.GLMLocationListener;
34:
35: import org.cougaar.glm.ldm.asset.TransportationRoute;
36:
37: import org.cougaar.glm.ldm.plan.GeolocLocation;
38:
39: import org.cougaar.planning.ldm.plan.Location;
40: import org.cougaar.planning.ldm.plan.Task;
41:
42: /**
43: * An object for finding the correct POE or POD for a given geoloc
44: */
45: public interface Locator extends GLMLocationListener {
46:
47: /**
48: * For a given Geoloc, finds the corresponding locations in
49: * the locator that is closest.
50: */
51: GeolocLocation getNearestLocation(GeolocLocation geoloc);
52:
53: /** get nearest, but not from among set of exceptions */
54: GeolocLocation getNearestLocationExcept(GeolocLocation geoloc,
55: Collection exceptions);
56:
57: Location getPOENearestToFromLoc(Task parentTask);
58:
59: Location getPOENearestToFromLoc(Task parentTask,
60: Collection exceptions);
61:
62: int getNumKnownLocations();
63:
64: void setFactory(PlanningFactory ldmf);
65:
66: TransportationRoute getRoute(GeolocLocation fromGeoloc,
67: GeolocLocation toGeoloc,
68: // boolean fromIsPOE, boolean toIsPOD,
69: Collection exceptions);
70:
71: boolean isKnownGeolocCode(String geoloc);
72:
73: Set knownGeolocCodes();
74:
75: Object getAssetAtGeolocCode(String geoloc);
76:
77: Location getLocationForGeolocCode(String geoloc);
78:
79: Location getLocationOfAsset(Object asset);
80:
81: void addLocationOfAsset(Object asset, Location loc);
82: }
|