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.policy;
028:
029: /**
030: *
031: **/
032:
033: /**
034: * A ClassRuleParameter is a RuleParameter with specified/protected
035: * Java interface/class that returns an Class that implements that interface
036: * or extends that class
037: */
038: public class ClassRuleParameter implements RuleParameter,
039: java.io.Serializable {
040: protected String my_name;
041: protected Class my_interface = Object.class;
042: protected Class my_value = Object.class;
043:
044: /**
045: * Constructor sets class interface and establishes value as not set
046: */
047: public ClassRuleParameter(String param_name, Class iface) {
048: my_interface = iface;
049: my_value = iface;
050: my_name = param_name;
051: }
052:
053: public ClassRuleParameter(String param_name) {
054: my_name = param_name;
055: }
056:
057: public ClassRuleParameter() {
058: }
059:
060: /**
061: * Parameter type is CLASS
062: */
063: public int ParameterType() {
064: return RuleParameter.CLASS_PARAMETER;
065: }
066:
067: public Class getInterface() {
068: return my_interface;
069: }
070:
071: public void setInterface(Class iface) {
072: my_interface = iface;
073: }
074:
075: public void setInterface(String iface) {
076: try {
077: my_interface = Class.forName(iface);
078: } catch (Exception e) {
079: System.out.println("Couldn't create class " + iface + e);
080: }
081: }
082:
083: public String getName() {
084: return my_name;
085: }
086:
087: public void setName(String name) {
088: my_name = name;
089: }
090:
091: /**
092: * Get parameter value (Class)
093: * @return Object parameter value (Class). Note : could be null.
094: */
095: public Object getValue() {
096: return my_value;
097: }
098:
099: public void setValue(String iface) {
100: try {
101: my_interface = Class.forName(iface);
102: } catch (Exception e) {
103: System.out.println("Couldn't create class " + iface + e);
104: }
105: }
106:
107: /**
108: * Set parameter value
109: * @param new_value : must be Class that implements/extends
110: * given class
111: * @throws RuleParameterIllegalValueException
112: */
113: public void setValue(Object new_value)
114: throws RuleParameterIllegalValueException {
115: boolean success = false;
116: if (new_value instanceof Class) {
117: Class new_class = (Class) new_value;
118: if (my_interface.isAssignableFrom(new_class)) {
119: my_value = new_class;
120: success = true;
121: }
122: }
123: if (!success)
124: throw new RuleParameterIllegalValueException(
125: RuleParameter.CLASS_PARAMETER,
126: "Class must extend/implement " + my_interface);
127: }
128:
129: /**
130: * @param test_value : must be Class
131: * @return true if Object isAssignableFrom Class specified in constructor,
132: * false otherwise
133: */
134: public boolean inRange(Object test_value) {
135: if (test_value instanceof Class) {
136: Class new_class = (Class) test_value;
137: if (my_interface.isAssignableFrom(new_class)) {
138: return true;
139: }
140: }
141: return false;
142: }
143:
144: public String toString() {
145: return "#<CLASS_PARAMETER : " + my_value + " [" + my_interface
146: + "] >";
147: }
148:
149: public Object clone() {
150: ClassRuleParameter crp = new ClassRuleParameter(my_name,
151: my_interface);
152: try {
153: crp.setValue(my_value);
154: } catch (RuleParameterIllegalValueException rpive) {
155: }
156: return crp;
157: }
158:
159: private interface CRP_Interface {
160: }
161:
162: private class CRP_Derived implements CRP_Interface {
163: }
164:
165: public static void Test() {
166: ClassRuleParameter crp = new ClassRuleParameter(
167: "testClassParam", CRP_Interface.class);
168:
169: if (crp.getValue() != null) {
170: System.out
171: .println("Error : Parameter not initialized to null");
172: }
173:
174: try {
175: crp.setValue(Integer.class);
176: System.out.println("Error detecting illegal set condition");
177: } catch (RuleParameterIllegalValueException rpive) {
178: }
179:
180: try {
181: crp.setValue(CRP_Derived.class);
182: } catch (RuleParameterIllegalValueException rpive) {
183: System.out.println("Error detecting legal set condition");
184: }
185:
186: if (crp.getValue() != CRP_Derived.class) {
187: System.out.println("Error retrieving value of parameter");
188: }
189:
190: System.out.println("CRP = " + crp);
191: System.out.println("ClassRuleParameter test complete.");
192:
193: }
194: }
|