Material localization support
[debian/openrocket] / core / src / net / sf / openrocket / file / openrocket / importt / OpenRocketLoader.java
1 package net.sf.openrocket.file.openrocket.importt;
2
3 import java.io.IOException;
4 import java.io.InputStream;
5 import java.lang.reflect.Constructor;
6 import java.lang.reflect.InvocationTargetException;
7 import java.util.ArrayList;
8 import java.util.HashMap;
9 import java.util.List;
10 import java.util.Locale;
11 import java.util.regex.Matcher;
12 import java.util.regex.Pattern;
13
14 import net.sf.openrocket.aerodynamics.Warning;
15 import net.sf.openrocket.aerodynamics.WarningSet;
16 import net.sf.openrocket.database.Databases;
17 import net.sf.openrocket.document.OpenRocketDocument;
18 import net.sf.openrocket.document.Simulation;
19 import net.sf.openrocket.document.Simulation.Status;
20 import net.sf.openrocket.document.StorageOptions;
21 import net.sf.openrocket.file.AbstractRocketLoader;
22 import net.sf.openrocket.file.MotorFinder;
23 import net.sf.openrocket.file.RocketLoadException;
24 import net.sf.openrocket.file.simplesax.AbstractElementHandler;
25 import net.sf.openrocket.file.simplesax.ElementHandler;
26 import net.sf.openrocket.file.simplesax.PlainTextHandler;
27 import net.sf.openrocket.file.simplesax.SimpleSAX;
28 import net.sf.openrocket.logging.LogHelper;
29 import net.sf.openrocket.material.Material;
30 import net.sf.openrocket.motor.Motor;
31 import net.sf.openrocket.preset.ComponentPreset;
32 import net.sf.openrocket.rocketcomponent.BodyComponent;
33 import net.sf.openrocket.rocketcomponent.BodyTube;
34 import net.sf.openrocket.rocketcomponent.Bulkhead;
35 import net.sf.openrocket.rocketcomponent.CenteringRing;
36 import net.sf.openrocket.rocketcomponent.ClusterConfiguration;
37 import net.sf.openrocket.rocketcomponent.Clusterable;
38 import net.sf.openrocket.rocketcomponent.EllipticalFinSet;
39 import net.sf.openrocket.rocketcomponent.EngineBlock;
40 import net.sf.openrocket.rocketcomponent.ExternalComponent;
41 import net.sf.openrocket.rocketcomponent.ExternalComponent.Finish;
42 import net.sf.openrocket.rocketcomponent.FinSet;
43 import net.sf.openrocket.rocketcomponent.FinSet.TabRelativePosition;
44 import net.sf.openrocket.rocketcomponent.FreeformFinSet;
45 import net.sf.openrocket.rocketcomponent.IllegalFinPointException;
46 import net.sf.openrocket.rocketcomponent.InnerTube;
47 import net.sf.openrocket.rocketcomponent.InternalComponent;
48 import net.sf.openrocket.rocketcomponent.LaunchLug;
49 import net.sf.openrocket.rocketcomponent.MassComponent;
50 import net.sf.openrocket.rocketcomponent.MassObject;
51 import net.sf.openrocket.rocketcomponent.MotorMount;
52 import net.sf.openrocket.rocketcomponent.NoseCone;
53 import net.sf.openrocket.rocketcomponent.Parachute;
54 import net.sf.openrocket.rocketcomponent.RadiusRingComponent;
55 import net.sf.openrocket.rocketcomponent.RecoveryDevice;
56 import net.sf.openrocket.rocketcomponent.ReferenceType;
57 import net.sf.openrocket.rocketcomponent.RingComponent;
58 import net.sf.openrocket.rocketcomponent.Rocket;
59 import net.sf.openrocket.rocketcomponent.RocketComponent;
60 import net.sf.openrocket.rocketcomponent.RocketComponent.Position;
61 import net.sf.openrocket.rocketcomponent.ShockCord;
62 import net.sf.openrocket.rocketcomponent.Stage;
63 import net.sf.openrocket.rocketcomponent.Streamer;
64 import net.sf.openrocket.rocketcomponent.StructuralComponent;
65 import net.sf.openrocket.rocketcomponent.SymmetricComponent;
66 import net.sf.openrocket.rocketcomponent.ThicknessRingComponent;
67 import net.sf.openrocket.rocketcomponent.Transition;
68 import net.sf.openrocket.rocketcomponent.TrapezoidFinSet;
69 import net.sf.openrocket.rocketcomponent.TubeCoupler;
70 import net.sf.openrocket.simulation.FlightData;
71 import net.sf.openrocket.simulation.FlightDataBranch;
72 import net.sf.openrocket.simulation.FlightDataType;
73 import net.sf.openrocket.simulation.FlightEvent;
74 import net.sf.openrocket.simulation.FlightEvent.Type;
75 import net.sf.openrocket.simulation.SimulationOptions;
76 import net.sf.openrocket.simulation.customexpression.CustomExpression;
77 import net.sf.openrocket.startup.Application;
78 import net.sf.openrocket.unit.UnitGroup;
79 import net.sf.openrocket.util.BugException;
80 import net.sf.openrocket.util.Color;
81 import net.sf.openrocket.util.Coordinate;
82 import net.sf.openrocket.util.GeodeticComputationStrategy;
83 import net.sf.openrocket.util.LineStyle;
84 import net.sf.openrocket.util.Reflection;
85
86 import org.xml.sax.InputSource;
87 import org.xml.sax.SAXException;
88
89
90 /**
91  * Class that loads a rocket definition from an OpenRocket rocket file.
92  * <p>
93  * This class uses SAX to read the XML file format.  The 
94  * #loadFromStream(InputStream) method simply sets the system up and 
95  * starts the parsing, while the actual logic is in the private inner class
96  * <code>OpenRocketHandler</code>.
97  * 
98  * @author Sampo Niskanen <sampo.niskanen@iki.fi>
99  */
100 public class OpenRocketLoader extends AbstractRocketLoader {
101         private static final LogHelper log = Application.getLogger();
102         
103         
104         @Override
105         public OpenRocketDocument loadFromStream(InputStream source, MotorFinder motorFinder) throws RocketLoadException,
106                         IOException {
107                 log.info("Loading .ork file");
108                 DocumentLoadingContext context = new DocumentLoadingContext();
109                 context.setMotorFinder(motorFinder);
110                 
111                 InputSource xmlSource = new InputSource(source);
112                 OpenRocketHandler handler = new OpenRocketHandler(context);
113                 
114                 
115                 try {
116                         SimpleSAX.readXML(xmlSource, handler, warnings);
117                 } catch (SAXException e) {
118                         log.warn("Malformed XML in input");
119                         throw new RocketLoadException("Malformed XML in input.", e);
120                 }
121                 
122                 
123                 OpenRocketDocument doc = handler.getDocument();
124                 doc.getDefaultConfiguration().setAllStages();
125                 
126                 // Deduce suitable time skip
127                 double timeSkip = StorageOptions.SIMULATION_DATA_NONE;
128                 for (Simulation s : doc.getSimulations()) {
129                         if (s.getStatus() == Simulation.Status.EXTERNAL ||
130                                         s.getStatus() == Simulation.Status.NOT_SIMULATED)
131                                 continue;
132                         if (s.getSimulatedData() == null)
133                                 continue;
134                         if (s.getSimulatedData().getBranchCount() == 0)
135                                 continue;
136                         FlightDataBranch branch = s.getSimulatedData().getBranch(0);
137                         if (branch == null)
138                                 continue;
139                         List<Double> list = branch.get(FlightDataType.TYPE_TIME);
140                         if (list == null)
141                                 continue;
142                         
143                         double previousTime = Double.NaN;
144                         for (double time : list) {
145                                 if (time - previousTime < timeSkip)
146                                         timeSkip = time - previousTime;
147                                 previousTime = time;
148                         }
149                 }
150                 // Round value
151                 timeSkip = Math.rint(timeSkip * 100) / 100;
152                 
153                 doc.getDefaultStorageOptions().setSimulationTimeSkip(timeSkip);
154                 doc.getDefaultStorageOptions().setCompressionEnabled(false); // Set by caller if compressed
155                 doc.getDefaultStorageOptions().setExplicitlySet(false);
156                 
157                 doc.clearUndo();
158                 log.info("Loading done");
159                 return doc;
160         }
161         
162 }
163
164
165
166 class DocumentConfig {
167         
168         /* Remember to update OpenRocketSaver as well! */
169         public static final String[] SUPPORTED_VERSIONS = { "1.0", "1.1", "1.2", "1.3", "1.4", "1.5" };
170         
171         /**
172          * Divisor used in converting an integer version to the point-represented version.
173          * The integer version divided by this value is the major version and the remainder is
174          * the minor version.  For example 101 corresponds to file version "1.1".
175          */
176         public static final int FILE_VERSION_DIVISOR = 100;
177         
178         
179         ////////  Component constructors
180         static final HashMap<String, Constructor<? extends RocketComponent>> constructors = new HashMap<String, Constructor<? extends RocketComponent>>();
181         static {
182                 try {
183                         // External components
184                         constructors.put("bodytube", BodyTube.class.getConstructor(new Class<?>[0]));
185                         constructors.put("transition", Transition.class.getConstructor(new Class<?>[0]));
186                         constructors.put("nosecone", NoseCone.class.getConstructor(new Class<?>[0]));
187                         constructors.put("trapezoidfinset", TrapezoidFinSet.class.getConstructor(new Class<?>[0]));
188                         constructors.put("ellipticalfinset", EllipticalFinSet.class.getConstructor(new Class<?>[0]));
189                         constructors.put("freeformfinset", FreeformFinSet.class.getConstructor(new Class<?>[0]));
190                         constructors.put("launchlug", LaunchLug.class.getConstructor(new Class<?>[0]));
191                         
192                         // Internal components
193                         constructors.put("engineblock", EngineBlock.class.getConstructor(new Class<?>[0]));
194                         constructors.put("innertube", InnerTube.class.getConstructor(new Class<?>[0]));
195                         constructors.put("tubecoupler", TubeCoupler.class.getConstructor(new Class<?>[0]));
196                         constructors.put("bulkhead", Bulkhead.class.getConstructor(new Class<?>[0]));
197                         constructors.put("centeringring", CenteringRing.class.getConstructor(new Class<?>[0]));
198                         
199                         constructors.put("masscomponent", MassComponent.class.getConstructor(new Class<?>[0]));
200                         constructors.put("shockcord", ShockCord.class.getConstructor(new Class<?>[0]));
201                         constructors.put("parachute", Parachute.class.getConstructor(new Class<?>[0]));
202                         constructors.put("streamer", Streamer.class.getConstructor(new Class<?>[0]));
203                         
204                         // Other
205                         constructors.put("stage", Stage.class.getConstructor(new Class<?>[0]));
206                         
207                 } catch (NoSuchMethodException e) {
208                         throw new BugException(
209                                         "Error in constructing the 'constructors' HashMap.");
210                 }
211         }
212         
213         
214         ////////  Parameter setters
215         /*
216          * The keys are of the form Class:param, where Class is the class name and param
217          * the element name.  Setters are searched for in descending class order.
218          * A setter of null means setting the parameter is not allowed.
219          */
220         static final HashMap<String, Setter> setters = new HashMap<String, Setter>();
221         static {
222                 // RocketComponent
223                 setters.put("RocketComponent:name", new StringSetter(
224                                 Reflection.findMethod(RocketComponent.class, "setName", String.class)));
225                 setters.put("RocketComponent:color", new ColorSetter(
226                                 Reflection.findMethod(RocketComponent.class, "setColor", Color.class)));
227                 setters.put("RocketComponent:linestyle", new EnumSetter<LineStyle>(
228                                 Reflection.findMethod(RocketComponent.class, "setLineStyle", LineStyle.class),
229                                 LineStyle.class));
230                 setters.put("RocketComponent:position", new PositionSetter());
231                 setters.put("RocketComponent:overridemass", new OverrideSetter(
232                                 Reflection.findMethod(RocketComponent.class, "setOverrideMass", double.class),
233                                 Reflection.findMethod(RocketComponent.class, "setMassOverridden", boolean.class)));
234                 setters.put("RocketComponent:overridecg", new OverrideSetter(
235                                 Reflection.findMethod(RocketComponent.class, "setOverrideCGX", double.class),
236                                 Reflection.findMethod(RocketComponent.class, "setCGOverridden", boolean.class)));
237                 setters.put("RocketComponent:overridesubcomponents", new BooleanSetter(
238                                 Reflection.findMethod(RocketComponent.class, "setOverrideSubcomponents", boolean.class)));
239                 setters.put("RocketComponent:comment", new StringSetter(
240                                 Reflection.findMethod(RocketComponent.class, "setComment", String.class)));
241                 setters.put("RocketComponent:preset", new ComponentPresetSetter(
242                                 Reflection.findMethod(RocketComponent.class, "loadPreset", ComponentPreset.class)));
243                 
244                 // ExternalComponent
245                 setters.put("ExternalComponent:finish", new EnumSetter<Finish>(
246                                 Reflection.findMethod(ExternalComponent.class, "setFinish", Finish.class),
247                                 Finish.class));
248                 setters.put("ExternalComponent:material", new MaterialSetter(
249                                 Reflection.findMethod(ExternalComponent.class, "setMaterial", Material.class),
250                                 Material.Type.BULK));
251                 
252                 // BodyComponent
253                 setters.put("BodyComponent:length", new DoubleSetter(
254                                 Reflection.findMethod(BodyComponent.class, "setLength", double.class)));
255                 
256                 // SymmetricComponent
257                 setters.put("SymmetricComponent:thickness", new DoubleSetter(
258                                 Reflection.findMethod(SymmetricComponent.class, "setThickness", double.class),
259                                 "filled",
260                                 Reflection.findMethod(SymmetricComponent.class, "setFilled", boolean.class)));
261                 
262                 // BodyTube
263                 setters.put("BodyTube:radius", new DoubleSetter(
264                                 Reflection.findMethod(BodyTube.class, "setOuterRadius", double.class),
265                                 "auto",
266                                 Reflection.findMethod(BodyTube.class, "setOuterRadiusAutomatic", boolean.class)));
267                 
268                 // Transition
269                 setters.put("Transition:shape", new EnumSetter<Transition.Shape>(
270                                 Reflection.findMethod(Transition.class, "setType", Transition.Shape.class),
271                                 Transition.Shape.class));
272                 setters.put("Transition:shapeclipped", new BooleanSetter(
273                                 Reflection.findMethod(Transition.class, "setClipped", boolean.class)));
274                 setters.put("Transition:shapeparameter", new DoubleSetter(
275                                 Reflection.findMethod(Transition.class, "setShapeParameter", double.class)));
276                 
277                 setters.put("Transition:foreradius", new DoubleSetter(
278                                 Reflection.findMethod(Transition.class, "setForeRadius", double.class),
279                                 "auto",
280                                 Reflection.findMethod(Transition.class, "setForeRadiusAutomatic", boolean.class)));
281                 setters.put("Transition:aftradius", new DoubleSetter(
282                                 Reflection.findMethod(Transition.class, "setAftRadius", double.class),
283                                 "auto",
284                                 Reflection.findMethod(Transition.class, "setAftRadiusAutomatic", boolean.class)));
285                 
286                 setters.put("Transition:foreshoulderradius", new DoubleSetter(
287                                 Reflection.findMethod(Transition.class, "setForeShoulderRadius", double.class)));
288                 setters.put("Transition:foreshoulderlength", new DoubleSetter(
289                                 Reflection.findMethod(Transition.class, "setForeShoulderLength", double.class)));
290                 setters.put("Transition:foreshoulderthickness", new DoubleSetter(
291                                 Reflection.findMethod(Transition.class, "setForeShoulderThickness", double.class)));
292                 setters.put("Transition:foreshouldercapped", new BooleanSetter(
293                                 Reflection.findMethod(Transition.class, "setForeShoulderCapped", boolean.class)));
294                 
295                 setters.put("Transition:aftshoulderradius", new DoubleSetter(
296                                 Reflection.findMethod(Transition.class, "setAftShoulderRadius", double.class)));
297                 setters.put("Transition:aftshoulderlength", new DoubleSetter(
298                                 Reflection.findMethod(Transition.class, "setAftShoulderLength", double.class)));
299                 setters.put("Transition:aftshoulderthickness", new DoubleSetter(
300                                 Reflection.findMethod(Transition.class, "setAftShoulderThickness", double.class)));
301                 setters.put("Transition:aftshouldercapped", new BooleanSetter(
302                                 Reflection.findMethod(Transition.class, "setAftShoulderCapped", boolean.class)));
303                 
304                 // NoseCone - disable disallowed elements
305                 setters.put("NoseCone:foreradius", null);
306                 setters.put("NoseCone:foreshoulderradius", null);
307                 setters.put("NoseCone:foreshoulderlength", null);
308                 setters.put("NoseCone:foreshoulderthickness", null);
309                 setters.put("NoseCone:foreshouldercapped", null);
310                 
311                 // FinSet
312                 setters.put("FinSet:fincount", new IntSetter(
313                                 Reflection.findMethod(FinSet.class, "setFinCount", int.class)));
314                 setters.put("FinSet:rotation", new DoubleSetter(
315                                 Reflection.findMethod(FinSet.class, "setBaseRotation", double.class), Math.PI / 180.0));
316                 setters.put("FinSet:thickness", new DoubleSetter(
317                                 Reflection.findMethod(FinSet.class, "setThickness", double.class)));
318                 setters.put("FinSet:crosssection", new EnumSetter<FinSet.CrossSection>(
319                                 Reflection.findMethod(FinSet.class, "setCrossSection", FinSet.CrossSection.class),
320                                 FinSet.CrossSection.class));
321                 setters.put("FinSet:cant", new DoubleSetter(
322                                 Reflection.findMethod(FinSet.class, "setCantAngle", double.class), Math.PI / 180.0));
323                 setters.put("FinSet:tabheight", new DoubleSetter(
324                                 Reflection.findMethod(FinSet.class, "setTabHeight", double.class)));
325                 setters.put("FinSet:tablength", new DoubleSetter(
326                                 Reflection.findMethod(FinSet.class, "setTabLength", double.class)));
327                 setters.put("FinSet:tabposition", new FinTabPositionSetter());
328                 
329                 // TrapezoidFinSet
330                 setters.put("TrapezoidFinSet:rootchord", new DoubleSetter(
331                                 Reflection.findMethod(TrapezoidFinSet.class, "setRootChord", double.class)));
332                 setters.put("TrapezoidFinSet:tipchord", new DoubleSetter(
333                                 Reflection.findMethod(TrapezoidFinSet.class, "setTipChord", double.class)));
334                 setters.put("TrapezoidFinSet:sweeplength", new DoubleSetter(
335                                 Reflection.findMethod(TrapezoidFinSet.class, "setSweep", double.class)));
336                 setters.put("TrapezoidFinSet:height", new DoubleSetter(
337                                 Reflection.findMethod(TrapezoidFinSet.class, "setHeight", double.class)));
338                 
339                 // EllipticalFinSet
340                 setters.put("EllipticalFinSet:rootchord", new DoubleSetter(
341                                 Reflection.findMethod(EllipticalFinSet.class, "setLength", double.class)));
342                 setters.put("EllipticalFinSet:height", new DoubleSetter(
343                                 Reflection.findMethod(EllipticalFinSet.class, "setHeight", double.class)));
344                 
345                 // FreeformFinSet points handled as a special handler
346                 
347                 // LaunchLug
348                 setters.put("LaunchLug:radius", new DoubleSetter(
349                                 Reflection.findMethod(LaunchLug.class, "setOuterRadius", double.class)));
350                 setters.put("LaunchLug:length", new DoubleSetter(
351                                 Reflection.findMethod(LaunchLug.class, "setLength", double.class)));
352                 setters.put("LaunchLug:thickness", new DoubleSetter(
353                                 Reflection.findMethod(LaunchLug.class, "setThickness", double.class)));
354                 setters.put("LaunchLug:radialdirection", new DoubleSetter(
355                                 Reflection.findMethod(LaunchLug.class, "setRadialDirection", double.class),
356                                 Math.PI / 180.0));
357                 
358                 // InternalComponent - nothing
359                 
360                 // StructuralComponent
361                 setters.put("StructuralComponent:material", new MaterialSetter(
362                                 Reflection.findMethod(StructuralComponent.class, "setMaterial", Material.class),
363                                 Material.Type.BULK));
364                 
365                 // RingComponent
366                 setters.put("RingComponent:length", new DoubleSetter(
367                                 Reflection.findMethod(RingComponent.class, "setLength", double.class)));
368                 setters.put("RingComponent:radialposition", new DoubleSetter(
369                                 Reflection.findMethod(RingComponent.class, "setRadialPosition", double.class)));
370                 setters.put("RingComponent:radialdirection", new DoubleSetter(
371                                 Reflection.findMethod(RingComponent.class, "setRadialDirection", double.class),
372                                 Math.PI / 180.0));
373                 
374                 // ThicknessRingComponent - radius on separate components due to differing automatics
375                 setters.put("ThicknessRingComponent:thickness", new DoubleSetter(
376                                 Reflection.findMethod(ThicknessRingComponent.class, "setThickness", double.class)));
377                 
378                 // EngineBlock
379                 setters.put("EngineBlock:outerradius", new DoubleSetter(
380                                 Reflection.findMethod(EngineBlock.class, "setOuterRadius", double.class),
381                                 "auto",
382                                 Reflection.findMethod(EngineBlock.class, "setOuterRadiusAutomatic", boolean.class)));
383                 
384                 // TubeCoupler
385                 setters.put("TubeCoupler:outerradius", new DoubleSetter(
386                                 Reflection.findMethod(TubeCoupler.class, "setOuterRadius", double.class),
387                                 "auto",
388                                 Reflection.findMethod(TubeCoupler.class, "setOuterRadiusAutomatic", boolean.class)));
389                 
390                 // InnerTube
391                 setters.put("InnerTube:outerradius", new DoubleSetter(
392                                 Reflection.findMethod(InnerTube.class, "setOuterRadius", double.class)));
393                 setters.put("InnerTube:clusterconfiguration", new ClusterConfigurationSetter());
394                 setters.put("InnerTube:clusterscale", new DoubleSetter(
395                                 Reflection.findMethod(InnerTube.class, "setClusterScale", double.class)));
396                 setters.put("InnerTube:clusterrotation", new DoubleSetter(
397                                 Reflection.findMethod(InnerTube.class, "setClusterRotation", double.class),
398                                 Math.PI / 180.0));
399                 
400                 // RadiusRingComponent
401                 
402                 // Bulkhead
403                 setters.put("RadiusRingComponent:innerradius", new DoubleSetter(
404                                 Reflection.findMethod(RadiusRingComponent.class, "setInnerRadius", double.class)));
405                 setters.put("Bulkhead:outerradius", new DoubleSetter(
406                                 Reflection.findMethod(Bulkhead.class, "setOuterRadius", double.class),
407                                 "auto",
408                                 Reflection.findMethod(Bulkhead.class, "setOuterRadiusAutomatic", boolean.class)));
409                 
410                 // CenteringRing
411                 setters.put("CenteringRing:innerradius", new DoubleSetter(
412                                 Reflection.findMethod(CenteringRing.class, "setInnerRadius", double.class),
413                                 "auto",
414                                 Reflection.findMethod(CenteringRing.class, "setInnerRadiusAutomatic", boolean.class)));
415                 setters.put("CenteringRing:outerradius", new DoubleSetter(
416                                 Reflection.findMethod(CenteringRing.class, "setOuterRadius", double.class),
417                                 "auto",
418                                 Reflection.findMethod(CenteringRing.class, "setOuterRadiusAutomatic", boolean.class)));
419                 
420                 
421                 // MassObject
422                 setters.put("MassObject:packedlength", new DoubleSetter(
423                                 Reflection.findMethod(MassObject.class, "setLength", double.class)));
424                 setters.put("MassObject:packedradius", new DoubleSetter(
425                                 Reflection.findMethod(MassObject.class, "setRadius", double.class)));
426                 setters.put("MassObject:radialposition", new DoubleSetter(
427                                 Reflection.findMethod(MassObject.class, "setRadialPosition", double.class)));
428                 setters.put("MassObject:radialdirection", new DoubleSetter(
429                                 Reflection.findMethod(MassObject.class, "setRadialDirection", double.class),
430                                 Math.PI / 180.0));
431                 
432                 // MassComponent
433                 setters.put("MassComponent:mass", new DoubleSetter(
434                                 Reflection.findMethod(MassComponent.class, "setComponentMass", double.class)));
435                 
436                 // ShockCord
437                 setters.put("ShockCord:cordlength", new DoubleSetter(
438                                 Reflection.findMethod(ShockCord.class, "setCordLength", double.class)));
439                 setters.put("ShockCord:material", new MaterialSetter(
440                                 Reflection.findMethod(ShockCord.class, "setMaterial", Material.class),
441                                 Material.Type.LINE));
442                 
443                 // RecoveryDevice
444                 setters.put("RecoveryDevice:cd", new DoubleSetter(
445                                 Reflection.findMethod(RecoveryDevice.class, "setCD", double.class),
446                                 "auto",
447                                 Reflection.findMethod(RecoveryDevice.class, "setCDAutomatic", boolean.class)));
448                 setters.put("RecoveryDevice:deployevent", new EnumSetter<RecoveryDevice.DeployEvent>(
449                                 Reflection.findMethod(RecoveryDevice.class, "setDeployEvent", RecoveryDevice.DeployEvent.class),
450                                 RecoveryDevice.DeployEvent.class));
451                 setters.put("RecoveryDevice:deployaltitude", new DoubleSetter(
452                                 Reflection.findMethod(RecoveryDevice.class, "setDeployAltitude", double.class)));
453                 setters.put("RecoveryDevice:deploydelay", new DoubleSetter(
454                                 Reflection.findMethod(RecoveryDevice.class, "setDeployDelay", double.class)));
455                 setters.put("RecoveryDevice:material", new MaterialSetter(
456                                 Reflection.findMethod(RecoveryDevice.class, "setMaterial", Material.class),
457                                 Material.Type.SURFACE));
458                 
459                 // Parachute
460                 setters.put("Parachute:diameter", new DoubleSetter(
461                                 Reflection.findMethod(Parachute.class, "setDiameter", double.class)));
462                 setters.put("Parachute:linecount", new IntSetter(
463                                 Reflection.findMethod(Parachute.class, "setLineCount", int.class)));
464                 setters.put("Parachute:linelength", new DoubleSetter(
465                                 Reflection.findMethod(Parachute.class, "setLineLength", double.class)));
466                 setters.put("Parachute:linematerial", new MaterialSetter(
467                                 Reflection.findMethod(Parachute.class, "setLineMaterial", Material.class),
468                                 Material.Type.LINE));
469                 
470                 // Streamer
471                 setters.put("Streamer:striplength", new DoubleSetter(
472                                 Reflection.findMethod(Streamer.class, "setStripLength", double.class)));
473                 setters.put("Streamer:stripwidth", new DoubleSetter(
474                                 Reflection.findMethod(Streamer.class, "setStripWidth", double.class)));
475                 
476                 // Rocket
477                 // <motorconfiguration> handled by separate handler
478                 setters.put("Rocket:referencetype", new EnumSetter<ReferenceType>(
479                                 Reflection.findMethod(Rocket.class, "setReferenceType", ReferenceType.class),
480                                 ReferenceType.class));
481                 setters.put("Rocket:customreference", new DoubleSetter(
482                                 Reflection.findMethod(Rocket.class, "setCustomReferenceLength", double.class)));
483                 setters.put("Rocket:designer", new StringSetter(
484                                 Reflection.findMethod(Rocket.class, "setDesigner", String.class)));
485                 setters.put("Rocket:revision", new StringSetter(
486                                 Reflection.findMethod(Rocket.class, "setRevision", String.class)));
487                 
488                 // Stage
489                 setters.put("Stage:separationevent", new EnumSetter<Stage.SeparationEvent>(
490                                 Reflection.findMethod(Stage.class, "setSeparationEvent", Stage.SeparationEvent.class),
491                                 Stage.SeparationEvent.class));
492                 setters.put("Stage:separationdelay", new DoubleSetter(
493                                 Reflection.findMethod(Stage.class, "setSeparationDelay", double.class)));
494                 
495         }
496         
497         
498         /**
499          * Search for a enum value that has the corresponding name as an XML value.  The current
500          * conversion from enum name to XML value is to lowercase the name and strip out all 
501          * underscore characters.  This method returns a match to these criteria, or <code>null</code>
502          * if no such enum exists.
503          * 
504          * @param <T>                   then enum type.
505          * @param name                  the XML value, null ok.
506          * @param enumClass             the class of the enum.
507          * @return                              the found enum value, or <code>null</code>.
508          */
509         public static <T extends Enum<T>> Enum<T> findEnum(String name,
510                         Class<? extends Enum<T>> enumClass) {
511                 
512                 if (name == null)
513                         return null;
514                 name = name.trim();
515                 for (Enum<T> e : enumClass.getEnumConstants()) {
516                         if (e.name().toLowerCase(Locale.ENGLISH).replace("_", "").equals(name)) {
517                                 return e;
518                         }
519                 }
520                 return null;
521         }
522         
523         
524         /**
525          * Convert a string to a double including formatting specifications of the OpenRocket
526          * file format.  This accepts all formatting that is valid for 
527          * <code>Double.parseDouble(s)</code> and a few others as well ("Inf", "-Inf").
528          * 
529          * @param s             the string to parse.
530          * @return              the numerical value.
531          * @throws NumberFormatException        the the string cannot be parsed.
532          */
533         public static double stringToDouble(String s) throws NumberFormatException {
534                 if (s == null)
535                         throw new NumberFormatException("null string");
536                 if (s.equalsIgnoreCase("NaN"))
537                         return Double.NaN;
538                 if (s.equalsIgnoreCase("Inf"))
539                         return Double.POSITIVE_INFINITY;
540                 if (s.equalsIgnoreCase("-Inf"))
541                         return Double.NEGATIVE_INFINITY;
542                 return Double.parseDouble(s);
543         }
544 }
545
546
547
548
549
550 /**
551  * The starting point of the handlers.  Accepts a single <openrocket> element and hands
552  * the contents to be read by a OpenRocketContentsHandler.
553  */
554 class OpenRocketHandler extends AbstractElementHandler {
555         private final DocumentLoadingContext context;
556         private OpenRocketContentHandler handler = null;
557         
558         public OpenRocketHandler(DocumentLoadingContext context) {
559                 this.context = context;
560         }
561         
562         /**
563          * Return the OpenRocketDocument read from the file, or <code>null</code> if a document
564          * has not been read yet.
565          * 
566          * @return      the document read, or null.
567          */
568         public OpenRocketDocument getDocument() {
569                 return handler.getDocument();
570         }
571         
572         @Override
573         public ElementHandler openElement(String element, HashMap<String, String> attributes,
574                         WarningSet warnings) {
575                 
576                 // Check for unknown elements
577                 if (!element.equals("openrocket")) {
578                         warnings.add(Warning.fromString("Unknown element " + element + ", ignoring."));
579                         return null;
580                 }
581                 
582                 // Check for first call
583                 if (handler != null) {
584                         warnings.add(Warning.fromString("Multiple document elements found, ignoring later "
585                                         + "ones."));
586                         return null;
587                 }
588                 
589                 // Check version number
590                 String version = null;
591                 String creator = attributes.remove("creator");
592                 String docVersion = attributes.remove("version");
593                 for (String v : DocumentConfig.SUPPORTED_VERSIONS) {
594                         if (v.equals(docVersion)) {
595                                 version = v;
596                                 break;
597                         }
598                 }
599                 if (version == null) {
600                         String str = "Unsupported document version";
601                         if (docVersion != null)
602                                 str += " " + docVersion;
603                         if (creator != null && !creator.trim().equals(""))
604                                 str += " (written using '" + creator.trim() + "')";
605                         str += ", attempting to read file anyway.";
606                         warnings.add(str);
607                 }
608                 
609                 context.setFileVersion(parseVersion(docVersion));
610                 
611                 handler = new OpenRocketContentHandler(context);
612                 return handler;
613         }
614         
615         
616         private int parseVersion(String docVersion) {
617                 if (docVersion == null)
618                         return 0;
619                 
620                 Matcher m = Pattern.compile("^([0-9]+)\\.([0-9]+)$").matcher(docVersion);
621                 if (m.matches()) {
622                         int major = Integer.parseInt(m.group(1));
623                         int minor = Integer.parseInt(m.group(2));
624                         return major * DocumentConfig.FILE_VERSION_DIVISOR + minor;
625                 } else {
626                         return 0;
627                 }
628         }
629         
630         @Override
631         public void closeElement(String element, HashMap<String, String> attributes,
632                         String content, WarningSet warnings) throws SAXException {
633                 attributes.remove("version");
634                 attributes.remove("creator");
635                 super.closeElement(element, attributes, content, warnings);
636         }
637         
638         
639 }
640
641
642 /**
643  * Handles the content of the <openrocket> tag.
644  */
645 class OpenRocketContentHandler extends AbstractElementHandler {
646         private final DocumentLoadingContext context;
647         private final OpenRocketDocument doc;
648         private final Rocket rocket;
649         
650         private boolean rocketDefined = false;
651         private boolean simulationsDefined = false;
652         private boolean datatypesDefined = false;
653         
654         public OpenRocketContentHandler(DocumentLoadingContext context) {
655                 this.context = context;
656                 this.rocket = new Rocket();
657                 this.doc = new OpenRocketDocument(rocket);
658         }
659         
660         public OpenRocketDocument getDocument() {
661                 if (!rocketDefined)
662                         return null;
663                 return doc;
664         }
665         
666         @Override
667         public ElementHandler openElement(String element, HashMap<String, String> attributes,
668                         WarningSet warnings) {
669                 
670                 if (element.equals("rocket")) {
671                         if (rocketDefined) {
672                                 warnings.add(Warning
673                                                 .fromString("Multiple rocket designs within one document, "
674                                                                 + "ignoring later ones."));
675                                 return null;
676                         }
677                         rocketDefined = true;
678                         return new ComponentParameterHandler(rocket, context);
679                 }
680                 
681                 if (element.equals("datatypes")) {
682                         if (datatypesDefined) {
683                                 warnings.add(Warning.fromString("Multiple datatype blocks. Ignoring later ones."));
684                                 return null;
685                         }
686                         datatypesDefined = true;
687                         return new DatatypeHandler(this, context);
688                 }
689                 
690                 if (element.equals("simulations")) {
691                         if (simulationsDefined) {
692                                 warnings.add(Warning
693                                                 .fromString("Multiple simulation definitions within one document, "
694                                                                 + "ignoring later ones."));
695                                 return null;
696                         }
697                         simulationsDefined = true;
698                         return new SimulationsHandler(doc, context);
699                 }
700                 
701                 warnings.add(Warning.fromString("Unknown element " + element + ", ignoring."));
702                 
703                 return null;
704         }
705 }
706
707
708
709 class DatatypeHandler extends AbstractElementHandler {
710         private final DocumentLoadingContext context;
711         private final OpenRocketContentHandler contentHandler;
712         private CustomExpressionHandler customExpressionHandler = null;
713         
714         public DatatypeHandler(OpenRocketContentHandler contentHandler, DocumentLoadingContext context) {
715                 this.context = context;
716                 this.contentHandler = contentHandler;
717         }
718         
719         @Override
720         public ElementHandler openElement(String element,
721                         HashMap<String, String> attributes, WarningSet warnings)
722                         throws SAXException {
723                 
724                 if (element.equals("type") && attributes.get("source").equals("customexpression")) {
725                         customExpressionHandler = new CustomExpressionHandler(contentHandler, context);
726                         return customExpressionHandler;
727                 }
728                 else {
729                         warnings.add(Warning.fromString("Unknown datatype " + element + " defined, ignoring"));
730                 }
731                 
732                 return this;
733         }
734         
735         @Override
736         public void closeElement(String element, HashMap<String, String> attributes, String content, WarningSet warnings) throws SAXException {
737                 attributes.remove("source");
738                 super.closeElement(element, attributes, content, warnings);
739                 
740                 if (customExpressionHandler != null) {
741                         contentHandler.getDocument().addCustomExpression(customExpressionHandler.currentExpression);
742                 }
743                 
744         }
745         
746 }
747
748 class CustomExpressionHandler extends AbstractElementHandler {
749         private final DocumentLoadingContext context;
750         private final OpenRocketContentHandler contentHandler;
751         public CustomExpression currentExpression;
752         
753         public CustomExpressionHandler(OpenRocketContentHandler contentHandler, DocumentLoadingContext context) {
754                 this.context = context;
755                 this.contentHandler = contentHandler;
756                 currentExpression = new CustomExpression(contentHandler.getDocument());
757                 
758         }
759         
760         @Override
761         public ElementHandler openElement(String element,
762                         HashMap<String, String> attributes, WarningSet warnings)
763                         throws SAXException {
764                 
765                 return this;
766         }
767         
768         @Override
769         public void closeElement(String element, HashMap<String, String> attributes,
770                         String content, WarningSet warnings) throws SAXException {
771                 
772                 if (element.equals("type")) {
773                         contentHandler.getDocument().addCustomExpression(currentExpression);
774                 }
775                 
776                 if (element.equals("name")) {
777                         currentExpression.setName(content);
778                 }
779                 
780                 if (element.equals("symbol")) {
781                         currentExpression.setSymbol(content);
782                 }
783                 
784                 if (element.equals("unit") && attributes.get("unittype").equals("auto")) {
785                         currentExpression.setUnit(content);
786                 }
787                 
788                 if (element.equals("expression")) {
789                         currentExpression.setExpression(content);
790                 }
791         }
792 }
793
794 /**
795  * A handler that creates components from the corresponding elements.  The control of the
796  * contents is passed on to ComponentParameterHandler.
797  */
798 class ComponentHandler extends AbstractElementHandler {
799         private final DocumentLoadingContext context;
800         private final RocketComponent parent;
801         
802         public ComponentHandler(RocketComponent parent, DocumentLoadingContext context) {
803                 this.parent = parent;
804                 this.context = context;
805         }
806         
807         @Override
808         public ElementHandler openElement(String element, HashMap<String, String> attributes,
809                         WarningSet warnings) {
810                 
811                 // Attempt to construct new component
812                 Constructor<? extends RocketComponent> constructor = DocumentConfig.constructors
813                                 .get(element);
814                 if (constructor == null) {
815                         warnings.add(Warning.fromString("Unknown element " + element + ", ignoring."));
816                         return null;
817                 }
818                 
819                 RocketComponent c;
820                 try {
821                         c = constructor.newInstance();
822                 } catch (InstantiationException e) {
823                         throw new BugException("Error constructing component.", e);
824                 } catch (IllegalAccessException e) {
825                         throw new BugException("Error constructing component.", e);
826                 } catch (InvocationTargetException e) {
827                         throw Reflection.handleWrappedException(e);
828                 }
829                 
830                 parent.addChild(c);
831                 
832                 return new ComponentParameterHandler(c, context);
833         }
834 }
835
836
837 /**
838  * A handler that populates the parameters of a previously constructed rocket component.
839  * This uses the setters, or delegates the handling to another handler for specific
840  * elements.
841  */
842 class ComponentParameterHandler extends AbstractElementHandler {
843         private final DocumentLoadingContext context;
844         private final RocketComponent component;
845         
846         public ComponentParameterHandler(RocketComponent c, DocumentLoadingContext context) {
847                 this.component = c;
848                 this.context = context;
849         }
850         
851         @Override
852         public ElementHandler openElement(String element, HashMap<String, String> attributes,
853                         WarningSet warnings) {
854                 
855                 // Check for specific elements that contain other elements
856                 if (element.equals("subcomponents")) {
857                         return new ComponentHandler(component, context);
858                 }
859                 if (element.equals("motormount")) {
860                         if (!(component instanceof MotorMount)) {
861                                 warnings.add(Warning.fromString("Illegal component defined as motor mount."));
862                                 return null;
863                         }
864                         return new MotorMountHandler((MotorMount) component, context);
865                 }
866                 if (element.equals("finpoints")) {
867                         if (!(component instanceof FreeformFinSet)) {
868                                 warnings.add(Warning.fromString("Illegal component defined for fin points."));
869                                 return null;
870                         }
871                         return new FinSetPointHandler((FreeformFinSet) component, context);
872                 }
873                 if (element.equals("motorconfiguration")) {
874                         if (!(component instanceof Rocket)) {
875                                 warnings.add(Warning.fromString("Illegal component defined for motor configuration."));
876                                 return null;
877                         }
878                         return new MotorConfigurationHandler((Rocket) component, context);
879                 }
880                 
881                 
882                 return PlainTextHandler.INSTANCE;
883         }
884         
885         @Override
886         public void closeElement(String element, HashMap<String, String> attributes,
887                         String content, WarningSet warnings) {
888                 
889                 if (element.equals("subcomponents") || element.equals("motormount") ||
890                                 element.equals("finpoints") || element.equals("motorconfiguration")) {
891                         return;
892                 }
893                 
894                 // Search for the correct setter class
895                 
896                 Class<?> c;
897                 for (c = component.getClass(); c != null; c = c.getSuperclass()) {
898                         String setterKey = c.getSimpleName() + ":" + element;
899                         Setter s = DocumentConfig.setters.get(setterKey);
900                         if (s != null) {
901                                 // Setter found
902                                 s.set(component, content, attributes, warnings);
903                                 break;
904                         }
905                         if (DocumentConfig.setters.containsKey(setterKey)) {
906                                 // Key exists but is null -> invalid parameter
907                                 c = null;
908                                 break;
909                         }
910                 }
911                 if (c == null) {
912                         warnings.add(Warning.fromString("Unknown parameter type '" + element + "' for "
913                                         + component.getComponentName() + ", ignoring."));
914                 }
915         }
916 }
917
918
919 /**
920  * A handler that reads the <point> specifications within the freeformfinset's
921  * <finpoints> elements.
922  */
923 class FinSetPointHandler extends AbstractElementHandler {
924         @SuppressWarnings("unused")
925         private final DocumentLoadingContext context;
926         private final FreeformFinSet finset;
927         private final ArrayList<Coordinate> coordinates = new ArrayList<Coordinate>();
928         
929         public FinSetPointHandler(FreeformFinSet finset, DocumentLoadingContext context) {
930                 this.finset = finset;
931                 this.context = context;
932         }
933         
934         @Override
935         public ElementHandler openElement(String element, HashMap<String, String> attributes,
936                         WarningSet warnings) {
937                 return PlainTextHandler.INSTANCE;
938         }
939         
940         
941         @Override
942         public void closeElement(String element, HashMap<String, String> attributes,
943                         String content, WarningSet warnings) throws SAXException {
944                 
945                 String strx = attributes.remove("x");
946                 String stry = attributes.remove("y");
947                 if (strx == null || stry == null) {
948                         warnings.add(Warning.fromString("Illegal fin points specification, ignoring."));
949                         return;
950                 }
951                 try {
952                         double x = Double.parseDouble(strx);
953                         double y = Double.parseDouble(stry);
954                         coordinates.add(new Coordinate(x, y));
955                 } catch (NumberFormatException e) {
956                         warnings.add(Warning.fromString("Illegal fin points specification, ignoring."));
957                         return;
958                 }
959                 
960                 super.closeElement(element, attributes, content, warnings);
961         }
962         
963         @Override
964         public void endHandler(String element, HashMap<String, String> attributes,
965                         String content, WarningSet warnings) {
966                 try {
967                         finset.setPoints(coordinates.toArray(new Coordinate[0]));
968                 } catch (IllegalFinPointException e) {
969                         warnings.add(Warning.fromString("Freeform fin set point definitions illegal, ignoring."));
970                 }
971         }
972 }
973
974
975 class MotorMountHandler extends AbstractElementHandler {
976         private final DocumentLoadingContext context;
977         private final MotorMount mount;
978         private MotorHandler motorHandler;
979         
980         public MotorMountHandler(MotorMount mount, DocumentLoadingContext context) {
981                 this.mount = mount;
982                 this.context = context;
983                 mount.setMotorMount(true);
984         }
985         
986         @Override
987         public ElementHandler openElement(String element, HashMap<String, String> attributes,
988                         WarningSet warnings) {
989                 
990                 if (element.equals("motor")) {
991                         motorHandler = new MotorHandler(context);
992                         return motorHandler;
993                 }
994                 
995                 if (element.equals("ignitionevent") ||
996                                 element.equals("ignitiondelay") ||
997                                 element.equals("overhang")) {
998                         return PlainTextHandler.INSTANCE;
999                 }
1000                 
1001                 warnings.add(Warning.fromString("Unknown element '" + element + "' encountered, ignoring."));
1002                 return null;
1003         }
1004         
1005         
1006         
1007         @Override
1008         public void closeElement(String element, HashMap<String, String> attributes,
1009                         String content, WarningSet warnings) throws SAXException {
1010                 
1011                 if (element.equals("motor")) {
1012                         String id = attributes.get("configid");
1013                         if (id == null || id.equals("")) {
1014                                 warnings.add(Warning.fromString("Illegal motor specification, ignoring."));
1015                                 return;
1016                         }
1017                         
1018                         Motor motor = motorHandler.getMotor(warnings);
1019                         mount.setMotor(id, motor);
1020                         mount.setMotorDelay(id, motorHandler.getDelay(warnings));
1021                         return;
1022                 }
1023                 
1024                 if (element.equals("ignitionevent")) {
1025                         MotorMount.IgnitionEvent event = null;
1026                         for (MotorMount.IgnitionEvent e : MotorMount.IgnitionEvent.values()) {
1027                                 if (e.name().toLowerCase(Locale.ENGLISH).replaceAll("_", "").equals(content)) {
1028                                         event = e;
1029                                         break;
1030                                 }
1031                         }
1032                         if (event == null) {
1033                                 warnings.add(Warning.fromString("Unknown ignition event type '" + content + "', ignoring."));
1034                                 return;
1035                         }
1036                         mount.setIgnitionEvent(event);
1037                         return;
1038                 }
1039                 
1040                 if (element.equals("ignitiondelay")) {
1041                         double d;
1042                         try {
1043                                 d = Double.parseDouble(content);
1044                         } catch (NumberFormatException nfe) {
1045                                 warnings.add(Warning.fromString("Illegal ignition delay specified, ignoring."));
1046                                 return;
1047                         }
1048                         mount.setIgnitionDelay(d);
1049                         return;
1050                 }
1051                 
1052                 if (element.equals("overhang")) {
1053                         double d;
1054                         try {
1055                                 d = Double.parseDouble(content);
1056                         } catch (NumberFormatException nfe) {
1057                                 warnings.add(Warning.fromString("Illegal overhang specified, ignoring."));
1058                                 return;
1059                         }
1060                         mount.setMotorOverhang(d);
1061                         return;
1062                 }
1063                 
1064                 super.closeElement(element, attributes, content, warnings);
1065         }
1066 }
1067
1068
1069
1070
1071 class MotorConfigurationHandler extends AbstractElementHandler {
1072         @SuppressWarnings("unused")
1073         private final DocumentLoadingContext context;
1074         private final Rocket rocket;
1075         private String name = null;
1076         private boolean inNameElement = false;
1077         
1078         public MotorConfigurationHandler(Rocket rocket, DocumentLoadingContext context) {
1079                 this.rocket = rocket;
1080                 this.context = context;
1081         }
1082         
1083         @Override
1084         public ElementHandler openElement(String element, HashMap<String, String> attributes,
1085                         WarningSet warnings) {
1086                 
1087                 if (inNameElement || !element.equals("name")) {
1088                         warnings.add(Warning.FILE_INVALID_PARAMETER);
1089                         return null;
1090                 }
1091                 inNameElement = true;
1092                 
1093                 return PlainTextHandler.INSTANCE;
1094         }
1095         
1096         @Override
1097         public void closeElement(String element, HashMap<String, String> attributes,
1098                         String content, WarningSet warnings) {
1099                 name = content;
1100         }
1101         
1102         @Override
1103         public void endHandler(String element, HashMap<String, String> attributes,
1104                         String content, WarningSet warnings) throws SAXException {
1105                 
1106                 String configid = attributes.remove("configid");
1107                 if (configid == null || configid.equals("")) {
1108                         warnings.add(Warning.FILE_INVALID_PARAMETER);
1109                         return;
1110                 }
1111                 
1112                 if (!rocket.addMotorConfigurationID(configid)) {
1113                         warnings.add("Duplicate motor configuration ID used.");
1114                         return;
1115                 }
1116                 
1117                 if (name != null && name.trim().length() > 0) {
1118                         rocket.setMotorConfigurationName(configid, name);
1119                 }
1120                 
1121                 if ("true".equals(attributes.remove("default"))) {
1122                         rocket.getDefaultConfiguration().setMotorConfigurationID(configid);
1123                 }
1124                 
1125                 super.closeElement(element, attributes, content, warnings);
1126         }
1127 }
1128
1129
1130 class MotorHandler extends AbstractElementHandler {
1131         /** File version where latest digest format was introduced */
1132         private static final int MOTOR_DIGEST_VERSION = 104;
1133         
1134         private final DocumentLoadingContext context;
1135         private Motor.Type type = null;
1136         private String manufacturer = null;
1137         private String designation = null;
1138         private String digest = null;
1139         private double diameter = Double.NaN;
1140         private double length = Double.NaN;
1141         private double delay = Double.NaN;
1142         
1143         public MotorHandler(DocumentLoadingContext context) {
1144                 this.context = context;
1145         }
1146         
1147         
1148         @Override
1149         public ElementHandler openElement(String element, HashMap<String, String> attributes,
1150                         WarningSet warnings) {
1151                 return PlainTextHandler.INSTANCE;
1152         }
1153         
1154         
1155         /**
1156          * Return the motor to use, or null.
1157          */
1158         public Motor getMotor(WarningSet warnings) {
1159                 return context.getMotorFinder().findMotor(type, manufacturer, designation, diameter, length, digest, warnings);
1160         }
1161         
1162         /**
1163          * Return the delay to use for the motor.
1164          */
1165         public double getDelay(WarningSet warnings) {
1166                 if (Double.isNaN(delay)) {
1167                         warnings.add(Warning.fromString("Motor delay not specified, assuming no ejection charge."));
1168                         return Motor.PLUGGED;
1169                 }
1170                 return delay;
1171         }
1172         
1173         
1174         @Override
1175         public void closeElement(String element, HashMap<String, String> attributes,
1176                         String content, WarningSet warnings) throws SAXException {
1177                 
1178                 content = content.trim();
1179                 
1180                 if (element.equals("type")) {
1181                         
1182                         // Motor type
1183                         type = null;
1184                         for (Motor.Type t : Motor.Type.values()) {
1185                                 if (t.name().toLowerCase(Locale.ENGLISH).equals(content.trim())) {
1186                                         type = t;
1187                                         break;
1188                                 }
1189                         }
1190                         if (type == null) {
1191                                 warnings.add(Warning.fromString("Unknown motor type '" + content + "', ignoring."));
1192                         }
1193                         
1194                 } else if (element.equals("manufacturer")) {
1195                         
1196                         // Manufacturer
1197                         manufacturer = content.trim();
1198                         
1199                 } else if (element.equals("designation")) {
1200                         
1201                         // Designation
1202                         designation = content.trim();
1203                         
1204                 } else if (element.equals("digest")) {
1205                         
1206                         // Digest is used only for file versions saved using the same digest algorithm
1207                         if (context.getFileVersion() >= MOTOR_DIGEST_VERSION) {
1208                                 digest = content.trim();
1209                         }
1210                         
1211                 } else if (element.equals("diameter")) {
1212                         
1213                         // Diameter
1214                         diameter = Double.NaN;
1215                         try {
1216                                 diameter = Double.parseDouble(content.trim());
1217                         } catch (NumberFormatException e) {
1218                                 // Ignore
1219                         }
1220                         if (Double.isNaN(diameter)) {
1221                                 warnings.add(Warning.fromString("Illegal motor diameter specified, ignoring."));
1222                         }
1223                         
1224                 } else if (element.equals("length")) {
1225                         
1226                         // Length
1227                         length = Double.NaN;
1228                         try {
1229                                 length = Double.parseDouble(content.trim());
1230                         } catch (NumberFormatException ignore) {
1231                         }
1232                         
1233                         if (Double.isNaN(length)) {
1234                                 warnings.add(Warning.fromString("Illegal motor diameter specified, ignoring."));
1235                         }
1236                         
1237                 } else if (element.equals("delay")) {
1238                         
1239                         // Delay
1240                         delay = Double.NaN;
1241                         if (content.equals("none")) {
1242                                 delay = Motor.PLUGGED;
1243                         } else {
1244                                 try {
1245                                         delay = Double.parseDouble(content.trim());
1246                                 } catch (NumberFormatException ignore) {
1247                                 }
1248                                 
1249                                 if (Double.isNaN(delay)) {
1250                                         warnings.add(Warning.fromString("Illegal motor delay specified, ignoring."));
1251                                 }
1252                                 
1253                         }
1254                         
1255                 } else {
1256                         super.closeElement(element, attributes, content, warnings);
1257                 }
1258         }
1259         
1260 }
1261
1262
1263
1264 class SimulationsHandler extends AbstractElementHandler {
1265         private final DocumentLoadingContext context;
1266         private final OpenRocketDocument doc;
1267         private SingleSimulationHandler handler;
1268         
1269         public SimulationsHandler(OpenRocketDocument doc, DocumentLoadingContext context) {
1270                 this.doc = doc;
1271                 this.context = context;
1272         }
1273         
1274         @Override
1275         public ElementHandler openElement(String element, HashMap<String, String> attributes,
1276                         WarningSet warnings) {
1277                 
1278                 if (!element.equals("simulation")) {
1279                         warnings.add("Unknown element '" + element + "', ignoring.");
1280                         return null;
1281                 }
1282                 
1283                 handler = new SingleSimulationHandler(doc, context);
1284                 return handler;
1285         }
1286         
1287         @Override
1288         public void closeElement(String element, HashMap<String, String> attributes,
1289                         String content, WarningSet warnings) throws SAXException {
1290                 attributes.remove("status");
1291                 super.closeElement(element, attributes, content, warnings);
1292         }
1293         
1294         
1295 }
1296
1297 class SingleSimulationHandler extends AbstractElementHandler {
1298         
1299         private final DocumentLoadingContext context;
1300         
1301         private final OpenRocketDocument doc;
1302         
1303         private String name;
1304         
1305         private SimulationConditionsHandler conditionHandler;
1306         private FlightDataHandler dataHandler;
1307         
1308         private final List<String> listeners = new ArrayList<String>();
1309         
1310         public SingleSimulationHandler(OpenRocketDocument doc, DocumentLoadingContext context) {
1311                 this.doc = doc;
1312                 this.context = context;
1313         }
1314         
1315         public OpenRocketDocument getDocument() {
1316                 return doc;
1317         }
1318         
1319         @Override
1320         public ElementHandler openElement(String element, HashMap<String, String> attributes,
1321                         WarningSet warnings) {
1322                 
1323                 if (element.equals("name") || element.equals("simulator") ||
1324                                 element.equals("calculator") || element.equals("listener")) {
1325                         return PlainTextHandler.INSTANCE;
1326                 } else if (element.equals("conditions")) {
1327                         conditionHandler = new SimulationConditionsHandler(doc.getRocket(), context);
1328                         return conditionHandler;
1329                 } else if (element.equals("flightdata")) {
1330                         dataHandler = new FlightDataHandler(this, context);
1331                         return dataHandler;
1332                 } else {
1333                         warnings.add("Unknown element '" + element + "', ignoring.");
1334                         return null;
1335                 }
1336         }
1337         
1338         @Override
1339         public void closeElement(String element, HashMap<String, String> attributes,
1340                         String content, WarningSet warnings) {
1341                 
1342                 if (element.equals("name")) {
1343                         name = content;
1344                 } else if (element.equals("simulator")) {
1345                         if (!content.trim().equals("RK4Simulator")) {
1346                                 warnings.add("Unknown simulator '" + content.trim() + "' specified, ignoring.");
1347                         }
1348                 } else if (element.equals("calculator")) {
1349                         if (!content.trim().equals("BarrowmanCalculator")) {
1350                                 warnings.add("Unknown calculator '" + content.trim() + "' specified, ignoring.");
1351                         }
1352                 } else if (element.equals("listener") && content.trim().length() > 0) {
1353                         listeners.add(content.trim());
1354                 }
1355                 
1356         }
1357         
1358         @Override
1359         public void endHandler(String element, HashMap<String, String> attributes,
1360                         String content, WarningSet warnings) {
1361                 
1362                 String s = attributes.get("status");
1363                 Simulation.Status status = (Status) DocumentConfig.findEnum(s, Simulation.Status.class);
1364                 if (status == null) {
1365                         warnings.add("Simulation status unknown, assuming outdated.");
1366                         status = Simulation.Status.OUTDATED;
1367                 }
1368                 
1369                 SimulationOptions conditions;
1370                 if (conditionHandler != null) {
1371                         conditions = conditionHandler.getConditions();
1372                 } else {
1373                         warnings.add("Simulation conditions not defined, using defaults.");
1374                         conditions = new SimulationOptions(doc.getRocket());
1375                 }
1376                 
1377                 if (name == null)
1378                         name = "Simulation";
1379                 
1380                 FlightData data;
1381                 if (dataHandler == null)
1382                         data = null;
1383                 else
1384                         data = dataHandler.getFlightData();
1385                 
1386                 Simulation simulation = new Simulation(doc.getRocket(), status, name,
1387                                 conditions, listeners, data);
1388                 
1389                 doc.addSimulation(simulation);
1390         }
1391 }
1392
1393 class SimulationConditionsHandler extends AbstractElementHandler {
1394         private final DocumentLoadingContext context;
1395         private SimulationOptions conditions;
1396         private AtmosphereHandler atmosphereHandler;
1397         
1398         public SimulationConditionsHandler(Rocket rocket, DocumentLoadingContext context) {
1399                 this.context = context;
1400                 conditions = new SimulationOptions(rocket);
1401                 // Set up default loading settings (which may differ from the new defaults)
1402                 conditions.setGeodeticComputation(GeodeticComputationStrategy.FLAT);
1403         }
1404         
1405         public SimulationOptions getConditions() {
1406                 return conditions;
1407         }
1408         
1409         @Override
1410         public ElementHandler openElement(String element, HashMap<String, String> attributes,
1411                         WarningSet warnings) {
1412                 if (element.equals("atmosphere")) {
1413                         atmosphereHandler = new AtmosphereHandler(attributes.get("model"), context);
1414                         return atmosphereHandler;
1415                 }
1416                 return PlainTextHandler.INSTANCE;
1417         }
1418         
1419         @Override
1420         public void closeElement(String element, HashMap<String, String> attributes,
1421                         String content, WarningSet warnings) {
1422                 
1423                 double d = Double.NaN;
1424                 try {
1425                         d = Double.parseDouble(content);
1426                 } catch (NumberFormatException ignore) {
1427                 }
1428                 
1429                 
1430                 if (element.equals("configid")) {
1431                         if (content.equals("")) {
1432                                 conditions.setMotorConfigurationID(null);
1433                         } else {
1434                                 conditions.setMotorConfigurationID(content);
1435                         }
1436                 } else if (element.equals("launchrodlength")) {
1437                         if (Double.isNaN(d)) {
1438                                 warnings.add("Illegal launch rod length defined, ignoring.");
1439                         } else {
1440                                 conditions.setLaunchRodLength(d);
1441                         }
1442                 } else if (element.equals("launchrodangle")) {
1443                         if (Double.isNaN(d)) {
1444                                 warnings.add("Illegal launch rod angle defined, ignoring.");
1445                         } else {
1446                                 conditions.setLaunchRodAngle(d * Math.PI / 180);
1447                         }
1448                 } else if (element.equals("launchroddirection")) {
1449                         if (Double.isNaN(d)) {
1450                                 warnings.add("Illegal launch rod direction defined, ignoring.");
1451                         } else {
1452                                 conditions.setLaunchRodDirection(d * Math.PI / 180);
1453                         }
1454                 } else if (element.equals("windaverage")) {
1455                         if (Double.isNaN(d)) {
1456                                 warnings.add("Illegal average windspeed defined, ignoring.");
1457                         } else {
1458                                 conditions.setWindSpeedAverage(d);
1459                         }
1460                 } else if (element.equals("windturbulence")) {
1461                         if (Double.isNaN(d)) {
1462                                 warnings.add("Illegal wind turbulence intensity defined, ignoring.");
1463                         } else {
1464                                 conditions.setWindTurbulenceIntensity(d);
1465                         }
1466                 } else if (element.equals("launchaltitude")) {
1467                         if (Double.isNaN(d)) {
1468                                 warnings.add("Illegal launch altitude defined, ignoring.");
1469                         } else {
1470                                 conditions.setLaunchAltitude(d);
1471                         }
1472                 } else if (element.equals("launchlatitude")) {
1473                         if (Double.isNaN(d)) {
1474                                 warnings.add("Illegal launch latitude defined, ignoring.");
1475                         } else {
1476                                 conditions.setLaunchLatitude(d);
1477                         }
1478                 } else if (element.equals("launchlongitude")) {
1479                         if (Double.isNaN(d)) {
1480                                 warnings.add("Illegal launch longitude.");
1481                         } else {
1482                                 conditions.setLaunchLongitude(d);
1483                         }
1484                 } else if (element.equals("geodeticmethod")) {
1485                         GeodeticComputationStrategy gcs =
1486                                         (GeodeticComputationStrategy) DocumentConfig.findEnum(content, GeodeticComputationStrategy.class);
1487                         if (gcs != null) {
1488                                 conditions.setGeodeticComputation(gcs);
1489                         } else {
1490                                 warnings.add("Unknown geodetic computation method '" + content + "'");
1491                         }
1492                 } else if (element.equals("atmosphere")) {
1493                         atmosphereHandler.storeSettings(conditions, warnings);
1494                 } else if (element.equals("timestep")) {
1495                         if (Double.isNaN(d)) {
1496                                 warnings.add("Illegal time step defined, ignoring.");
1497                         } else {
1498                                 conditions.setTimeStep(d);
1499                         }
1500                 }
1501         }
1502 }
1503
1504
1505 class AtmosphereHandler extends AbstractElementHandler {
1506         @SuppressWarnings("unused")
1507         private final DocumentLoadingContext context;
1508         private final String model;
1509         private double temperature = Double.NaN;
1510         private double pressure = Double.NaN;
1511         
1512         public AtmosphereHandler(String model, DocumentLoadingContext context) {
1513                 this.model = model;
1514                 this.context = context;
1515         }
1516         
1517         @Override
1518         public ElementHandler openElement(String element, HashMap<String, String> attributes,
1519                         WarningSet warnings) {
1520                 return PlainTextHandler.INSTANCE;
1521         }
1522         
1523         @Override
1524         public void closeElement(String element, HashMap<String, String> attributes,
1525                         String content, WarningSet warnings) throws SAXException {
1526                 
1527                 double d = Double.NaN;
1528                 try {
1529                         d = Double.parseDouble(content);
1530                 } catch (NumberFormatException ignore) {
1531                 }
1532                 
1533                 if (element.equals("basetemperature")) {
1534                         if (Double.isNaN(d)) {
1535                                 warnings.add("Illegal base temperature specified, ignoring.");
1536                         }
1537                         temperature = d;
1538                 } else if (element.equals("basepressure")) {
1539                         if (Double.isNaN(d)) {
1540                                 warnings.add("Illegal base pressure specified, ignoring.");
1541                         }
1542                         pressure = d;
1543                 } else {
1544                         super.closeElement(element, attributes, content, warnings);
1545                 }
1546         }
1547         
1548         
1549         public void storeSettings(SimulationOptions cond, WarningSet warnings) {
1550                 if (!Double.isNaN(pressure)) {
1551                         cond.setLaunchPressure(pressure);
1552                 }
1553                 if (!Double.isNaN(temperature)) {
1554                         cond.setLaunchTemperature(temperature);
1555                 }
1556                 
1557                 if ("isa".equals(model)) {
1558                         cond.setISAAtmosphere(true);
1559                 } else if ("extendedisa".equals(model)) {
1560                         cond.setISAAtmosphere(false);
1561                 } else {
1562                         cond.setISAAtmosphere(true);
1563                         warnings.add("Unknown atmospheric model, using ISA.");
1564                 }
1565         }
1566         
1567 }
1568
1569
1570 class FlightDataHandler extends AbstractElementHandler {
1571         private final DocumentLoadingContext context;
1572         
1573         private FlightDataBranchHandler dataHandler;
1574         private WarningSet warningSet = new WarningSet();
1575         private List<FlightDataBranch> branches = new ArrayList<FlightDataBranch>();
1576         
1577         private SingleSimulationHandler simHandler;
1578         private FlightData data;
1579         
1580         
1581         public FlightDataHandler(SingleSimulationHandler simHandler, DocumentLoadingContext context) {
1582                 this.context = context;
1583                 this.simHandler = simHandler;
1584         }
1585         
1586         public FlightData getFlightData() {
1587                 return data;
1588         }
1589         
1590         @Override
1591         public ElementHandler openElement(String element, HashMap<String, String> attributes,
1592                         WarningSet warnings) {
1593                 
1594                 if (element.equals("warning")) {
1595                         return PlainTextHandler.INSTANCE;
1596                 }
1597                 if (element.equals("databranch")) {
1598                         if (attributes.get("name") == null || attributes.get("types") == null) {
1599                                 warnings.add("Illegal flight data definition, ignoring.");
1600                                 return null;
1601                         }
1602                         dataHandler = new FlightDataBranchHandler(attributes.get("name"),
1603                                         attributes.get("types"),
1604                                         simHandler, context);
1605                         return dataHandler;
1606                 }
1607                 
1608                 warnings.add("Unknown element '" + element + "' encountered, ignoring.");
1609                 return null;
1610         }
1611         
1612         
1613         @Override
1614         public void closeElement(String element, HashMap<String, String> attributes,
1615                         String content, WarningSet warnings) {
1616                 
1617                 if (element.equals("databranch")) {
1618                         FlightDataBranch branch = dataHandler.getBranch();
1619                         if (branch.getLength() > 0) {
1620                                 branches.add(branch);
1621                         }
1622                 } else if (element.equals("warning")) {
1623                         warningSet.add(Warning.fromString(content));
1624                 }
1625         }
1626         
1627         
1628         @Override
1629         public void endHandler(String element, HashMap<String, String> attributes,
1630                         String content, WarningSet warnings) {
1631                 
1632                 if (branches.size() > 0) {
1633                         data = new FlightData(branches.toArray(new FlightDataBranch[0]));
1634                 } else {
1635                         double maxAltitude = Double.NaN;
1636                         double maxVelocity = Double.NaN;
1637                         double maxAcceleration = Double.NaN;
1638                         double maxMach = Double.NaN;
1639                         double timeToApogee = Double.NaN;
1640                         double flightTime = Double.NaN;
1641                         double groundHitVelocity = Double.NaN;
1642                         double launchRodVelocity = Double.NaN;
1643                         double deploymentVelocity = Double.NaN;
1644                         
1645                         try {
1646                                 maxAltitude = DocumentConfig.stringToDouble(attributes.get("maxaltitude"));
1647                         } catch (NumberFormatException ignore) {
1648                         }
1649                         try {
1650                                 maxVelocity = DocumentConfig.stringToDouble(attributes.get("maxvelocity"));
1651                         } catch (NumberFormatException ignore) {
1652                         }
1653                         try {
1654                                 maxAcceleration = DocumentConfig.stringToDouble(attributes.get("maxacceleration"));
1655                         } catch (NumberFormatException ignore) {
1656                         }
1657                         try {
1658                                 maxMach = DocumentConfig.stringToDouble(attributes.get("maxmach"));
1659                         } catch (NumberFormatException ignore) {
1660                         }
1661                         try {
1662                                 timeToApogee = DocumentConfig.stringToDouble(attributes.get("timetoapogee"));
1663                         } catch (NumberFormatException ignore) {
1664                         }
1665                         try {
1666                                 flightTime = DocumentConfig.stringToDouble(attributes.get("flighttime"));
1667                         } catch (NumberFormatException ignore) {
1668                         }
1669                         try {
1670                                 groundHitVelocity =
1671                                                 DocumentConfig.stringToDouble(attributes.get("groundhitvelocity"));
1672                         } catch (NumberFormatException ignore) {
1673                         }
1674                         try {
1675                                 launchRodVelocity = DocumentConfig.stringToDouble(attributes.get("launchrodvelocity"));
1676                         } catch (NumberFormatException ignore) {
1677                         }
1678                         try {
1679                                 deploymentVelocity = DocumentConfig.stringToDouble(attributes.get("deploymentvelocity"));
1680                         } catch (NumberFormatException ignore) {
1681                         }
1682                         
1683                         data = new FlightData(maxAltitude, maxVelocity, maxAcceleration, maxMach,
1684                                         timeToApogee, flightTime, groundHitVelocity, launchRodVelocity, deploymentVelocity);
1685                 }
1686                 
1687                 data.getWarningSet().addAll(warningSet);
1688                 data.immute();
1689         }
1690         
1691         
1692 }
1693
1694
1695 class FlightDataBranchHandler extends AbstractElementHandler {
1696         @SuppressWarnings("unused")
1697         private final DocumentLoadingContext context;
1698         private final FlightDataType[] types;
1699         private final FlightDataBranch branch;
1700         
1701         private static final LogHelper log = Application.getLogger();
1702         private final SingleSimulationHandler simHandler;
1703         
1704         public FlightDataBranchHandler(String name, String typeList, SingleSimulationHandler simHandler, DocumentLoadingContext context) {
1705                 this.simHandler = simHandler;
1706                 this.context = context;
1707                 String[] split = typeList.split(",");
1708                 types = new FlightDataType[split.length];
1709                 for (int i = 0; i < split.length; i++) {
1710                         String typeName = split[i];
1711                         FlightDataType matching = findFlightDataType(typeName);
1712                         types[i] = matching;
1713                         //types[i] = FlightDataType.getType(typeName, matching.getSymbol(), matching.getUnitGroup());
1714                 }
1715                 
1716                 // TODO: LOW: May throw an IllegalArgumentException
1717                 branch = new FlightDataBranch(name, types);
1718         }
1719         
1720         // Find the full flight data type given name only
1721         // Note: this way of doing it requires that custom expressions always come before flight data in the file,
1722         // not the nicest but this is always the case anyway.
1723         private FlightDataType findFlightDataType(String name) {
1724                 
1725                 // Kevins version with lookup by key. Not using right now
1726                 /*
1727                 if ( key != null ) {
1728                         for (FlightDataType t : FlightDataType.ALL_TYPES){
1729                                 if (t.getKey().equals(key) ){
1730                                         return t;
1731                                 }
1732                         }
1733                 }
1734                 */
1735                 
1736                 // Look in built in types
1737                 for (FlightDataType t : FlightDataType.ALL_TYPES) {
1738                         if (t.getName().equals(name)) {
1739                                 return t;
1740                         }
1741                 }
1742                 
1743                 // Look in custom expressions
1744                 for (CustomExpression exp : simHandler.getDocument().getCustomExpressions()) {
1745                         if (exp.getName().equals(name)) {
1746                                 return exp.getType();
1747                         }
1748                 }
1749                 
1750                 log.warn("Could not find the flight data type '" + name + "' used in the XML file. Substituted type with unknown symbol and units.");
1751                 return FlightDataType.getType(name, "Unknown", UnitGroup.UNITS_NONE);
1752         }
1753         
1754         public FlightDataBranch getBranch() {
1755                 branch.immute();
1756                 return branch;
1757         }
1758         
1759         @Override
1760         public ElementHandler openElement(String element, HashMap<String, String> attributes,
1761                         WarningSet warnings) {
1762                 
1763                 if (element.equals("datapoint"))
1764                         return PlainTextHandler.INSTANCE;
1765                 if (element.equals("event"))
1766                         return PlainTextHandler.INSTANCE;
1767                 
1768                 warnings.add("Unknown element '" + element + "' encountered, ignoring.");
1769                 return null;
1770         }
1771         
1772         
1773         @Override
1774         public void closeElement(String element, HashMap<String, String> attributes,
1775                         String content, WarningSet warnings) {
1776                 
1777                 if (element.equals("event")) {
1778                         double time;
1779                         FlightEvent.Type type;
1780                         
1781                         try {
1782                                 time = DocumentConfig.stringToDouble(attributes.get("time"));
1783                         } catch (NumberFormatException e) {
1784                                 warnings.add("Illegal event specification, ignoring.");
1785                                 return;
1786                         }
1787                         
1788                         type = (Type) DocumentConfig.findEnum(attributes.get("type"), FlightEvent.Type.class);
1789                         if (type == null) {
1790                                 warnings.add("Illegal event specification, ignoring.");
1791                                 return;
1792                         }
1793                         
1794                         branch.addEvent(new FlightEvent(type, time));
1795                         return;
1796                 }
1797                 
1798                 if (!element.equals("datapoint")) {
1799                         warnings.add("Unknown element '" + element + "' encountered, ignoring.");
1800                         return;
1801                 }
1802                 
1803                 // element == "datapoint"
1804                 
1805                 
1806                 // Check line format
1807                 String[] split = content.split(",");
1808                 if (split.length != types.length) {
1809                         warnings.add("Data point did not contain correct amount of values, ignoring point.");
1810                         return;
1811                 }
1812                 
1813                 // Parse the doubles
1814                 double[] values = new double[split.length];
1815                 for (int i = 0; i < values.length; i++) {
1816                         try {
1817                                 values[i] = DocumentConfig.stringToDouble(split[i]);
1818                         } catch (NumberFormatException e) {
1819                                 warnings.add("Data point format error, ignoring point.");
1820                                 return;
1821                         }
1822                 }
1823                 
1824                 // Add point to branch
1825                 branch.addPoint();
1826                 for (int i = 0; i < types.length; i++) {
1827                         branch.setValue(types[i], values[i]);
1828                 }
1829         }
1830 }
1831
1832
1833
1834
1835
1836 /////////////////    Setters implementation
1837
1838
1839 ////  Interface
1840 interface Setter {
1841         /**
1842          * Set the specified value to the given component.
1843          * 
1844          * @param component             the component to which to set.
1845          * @param value                 the value within the element.
1846          * @param attributes    attributes for the element.
1847          * @param warnings              the warning set to use.
1848          */
1849         public void set(RocketComponent component, String value,
1850                         HashMap<String, String> attributes, WarningSet warnings);
1851 }
1852
1853
1854 ////  StringSetter - sets the value to the contained String
1855 class StringSetter implements Setter {
1856         private final Reflection.Method setMethod;
1857         
1858         public StringSetter(Reflection.Method set) {
1859                 setMethod = set;
1860         }
1861         
1862         @Override
1863         public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1864                         WarningSet warnings) {
1865                 setMethod.invoke(c, s);
1866         }
1867 }
1868
1869 ////  IntSetter - set an integer value
1870 class IntSetter implements Setter {
1871         private final Reflection.Method setMethod;
1872         
1873         public IntSetter(Reflection.Method set) {
1874                 setMethod = set;
1875         }
1876         
1877         @Override
1878         public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1879                         WarningSet warnings) {
1880                 try {
1881                         int n = Integer.parseInt(s);
1882                         setMethod.invoke(c, n);
1883                 } catch (NumberFormatException e) {
1884                         warnings.add(Warning.FILE_INVALID_PARAMETER);
1885                 }
1886         }
1887 }
1888
1889
1890 //// BooleanSetter - set a boolean value
1891 class BooleanSetter implements Setter {
1892         private final Reflection.Method setMethod;
1893         
1894         public BooleanSetter(Reflection.Method set) {
1895                 setMethod = set;
1896         }
1897         
1898         @Override
1899         public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1900                         WarningSet warnings) {
1901                 
1902                 s = s.trim();
1903                 if (s.equalsIgnoreCase("true")) {
1904                         setMethod.invoke(c, true);
1905                 } else if (s.equalsIgnoreCase("false")) {
1906                         setMethod.invoke(c, false);
1907                 } else {
1908                         warnings.add(Warning.FILE_INVALID_PARAMETER);
1909                 }
1910         }
1911 }
1912
1913
1914
1915 ////  DoubleSetter - sets a double value or (alternatively) if a specific string is encountered
1916 ////  calls a setXXX(boolean) method.
1917 class DoubleSetter implements Setter {
1918         private final Reflection.Method setMethod;
1919         private final String specialString;
1920         private final Reflection.Method specialMethod;
1921         private final double multiplier;
1922         
1923         /**
1924          * Set only the double value.
1925          * @param set   set method for the double value. 
1926          */
1927         public DoubleSetter(Reflection.Method set) {
1928                 this.setMethod = set;
1929                 this.specialString = null;
1930                 this.specialMethod = null;
1931                 this.multiplier = 1.0;
1932         }
1933         
1934         /**
1935          * Multiply with the given multiplier and set the double value.
1936          * @param set   set method for the double value.
1937          * @param mul   multiplier.
1938          */
1939         public DoubleSetter(Reflection.Method set, double mul) {
1940                 this.setMethod = set;
1941                 this.specialString = null;
1942                 this.specialMethod = null;
1943                 this.multiplier = mul;
1944         }
1945         
1946         /**
1947          * Set the double value, or if the value equals the special string, use the
1948          * special setter and set it to true.
1949          * 
1950          * @param set                   double setter.
1951          * @param special               special string
1952          * @param specialMethod boolean setter.
1953          */
1954         public DoubleSetter(Reflection.Method set, String special,
1955                         Reflection.Method specialMethod) {
1956                 this.setMethod = set;
1957                 this.specialString = special;
1958                 this.specialMethod = specialMethod;
1959                 this.multiplier = 1.0;
1960         }
1961         
1962         
1963         @Override
1964         public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1965                         WarningSet warnings) {
1966                 
1967                 s = s.trim();
1968                 
1969                 // Check for special case
1970                 if (specialMethod != null && s.equalsIgnoreCase(specialString)) {
1971                         specialMethod.invoke(c, true);
1972                         return;
1973                 }
1974                 
1975                 // Normal case
1976                 try {
1977                         double d = Double.parseDouble(s);
1978                         setMethod.invoke(c, d * multiplier);
1979                 } catch (NumberFormatException e) {
1980                         warnings.add(Warning.FILE_INVALID_PARAMETER);
1981                 }
1982         }
1983 }
1984
1985
1986 class OverrideSetter implements Setter {
1987         private final Reflection.Method setMethod;
1988         private final Reflection.Method enabledMethod;
1989         
1990         public OverrideSetter(Reflection.Method set, Reflection.Method enabledMethod) {
1991                 this.setMethod = set;
1992                 this.enabledMethod = enabledMethod;
1993         }
1994         
1995         @Override
1996         public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1997                         WarningSet warnings) {
1998                 
1999                 try {
2000                         double d = Double.parseDouble(s);
2001                         setMethod.invoke(c, d);
2002                         enabledMethod.invoke(c, true);
2003                 } catch (NumberFormatException e) {
2004                         warnings.add(Warning.FILE_INVALID_PARAMETER);
2005                 }
2006         }
2007 }
2008
2009 ////  EnumSetter  -  sets a generic enum type
2010 class EnumSetter<T extends Enum<T>> implements Setter {
2011         private final Reflection.Method setter;
2012         private final Class<T> enumClass;
2013         
2014         public EnumSetter(Reflection.Method set, Class<T> enumClass) {
2015                 this.setter = set;
2016                 this.enumClass = enumClass;
2017         }
2018         
2019         @Override
2020         public void set(RocketComponent c, String name, HashMap<String, String> attributes,
2021                         WarningSet warnings) {
2022                 
2023                 Enum<?> setEnum = DocumentConfig.findEnum(name, enumClass);
2024                 if (setEnum == null) {
2025                         warnings.add(Warning.FILE_INVALID_PARAMETER);
2026                         return;
2027                 }
2028                 
2029                 setter.invoke(c, setEnum);
2030         }
2031 }
2032
2033
2034 ////  ColorSetter  -  sets a Color value
2035 class ColorSetter implements Setter {
2036         private final Reflection.Method setMethod;
2037         
2038         public ColorSetter(Reflection.Method set) {
2039                 setMethod = set;
2040         }
2041         
2042         @Override
2043         public void set(RocketComponent c, String s, HashMap<String, String> attributes,
2044                         WarningSet warnings) {
2045                 
2046                 String red = attributes.get("red");
2047                 String green = attributes.get("green");
2048                 String blue = attributes.get("blue");
2049                 
2050                 if (red == null || green == null || blue == null) {
2051                         warnings.add(Warning.FILE_INVALID_PARAMETER);
2052                         return;
2053                 }
2054                 
2055                 int r, g, b;
2056                 try {
2057                         r = Integer.parseInt(red);
2058                         g = Integer.parseInt(green);
2059                         b = Integer.parseInt(blue);
2060                 } catch (NumberFormatException e) {
2061                         warnings.add(Warning.FILE_INVALID_PARAMETER);
2062                         return;
2063                 }
2064                 
2065                 if (r < 0 || g < 0 || b < 0 || r > 255 || g > 255 || b > 255) {
2066                         warnings.add(Warning.FILE_INVALID_PARAMETER);
2067                         return;
2068                 }
2069                 
2070                 Color color = new Color(r, g, b);
2071                 setMethod.invoke(c, color);
2072                 
2073                 if (!s.trim().equals("")) {
2074                         warnings.add(Warning.FILE_INVALID_PARAMETER);
2075                 }
2076         }
2077 }
2078
2079 ////ComponentPresetSetter  -  sets a ComponentPreset value
2080 class ComponentPresetSetter implements Setter {
2081         private final Reflection.Method setMethod;
2082         
2083         public ComponentPresetSetter(Reflection.Method set) {
2084                 this.setMethod = set;
2085         }
2086         
2087         @Override
2088         public void set(RocketComponent c, String name, HashMap<String, String> attributes,
2089                         WarningSet warnings) {
2090                 String manufacturerName = attributes.get("manufacturer");
2091                 if (manufacturerName == null) {
2092                         warnings.add(Warning.fromString("Invalid ComponentPreset for component " + c.getName() + ", no manufacturer specified.  Ignored"));
2093                         return;
2094                 }
2095                 
2096                 String productNo = attributes.get("partno");
2097                 if (productNo == null) {
2098                         warnings.add(Warning.fromString("Invalid ComponentPreset for component " + c.getName() + ", no partno specified.  Ignored"));
2099                         return;
2100                 }
2101                 
2102                 String digest = attributes.get("digest");
2103                 if (digest == null) {
2104                         warnings.add(Warning.fromString("Invalid ComponentPreset for component " + c.getName() + ", no digest specified."));
2105                 }
2106                 
2107                 String type = attributes.get("type");
2108                 if (type == null) {
2109                         warnings.add(Warning.fromString("Invalid ComponentPreset for component " + c.getName() + ", no type specified."));
2110                 }
2111                 
2112                 List<ComponentPreset> presets = Application.getComponentPresetDao().find(manufacturerName, productNo);
2113                 
2114                 ComponentPreset matchingPreset = null;
2115                 
2116                 for (ComponentPreset preset : presets) {
2117                         if (digest != null && preset.getDigest().equals(digest)) {
2118                                 // Found one with matching digest.  Take it.
2119                                 matchingPreset = preset;
2120                                 break;
2121                         }
2122                         if (type != null && preset.getType().name().equals(type) && matchingPreset != null) {
2123                                 // Found the first one with matching type.
2124                                 matchingPreset = preset;
2125                         }
2126                 }
2127                 
2128                 // Was any found?
2129                 if (matchingPreset == null) {
2130                         warnings.add(Warning.fromString("No matching ComponentPreset for component " + c.getName() + " found matching " + manufacturerName + " " + productNo));
2131                         return;
2132                 }
2133                 
2134                 if (digest != null && !matchingPreset.getDigest().equals(digest)) {
2135                         warnings.add(Warning.fromString("ComponentPreset for component " + c.getName() + " has wrong digest"));
2136                 }
2137                 
2138                 setMethod.invoke(c, matchingPreset);
2139         }
2140 }
2141
2142
2143 ////MaterialSetter  -  sets a Material value
2144 class MaterialSetter implements Setter {
2145         private final Reflection.Method setMethod;
2146         private final Material.Type type;
2147         
2148         public MaterialSetter(Reflection.Method set, Material.Type type) {
2149                 this.setMethod = set;
2150                 this.type = type;
2151         }
2152         
2153         @Override
2154         public void set(RocketComponent c, String name, HashMap<String, String> attributes,
2155                         WarningSet warnings) {
2156                 
2157                 Material mat;
2158                 
2159                 // Check name != ""
2160                 name = name.trim();
2161                 if (name.equals("")) {
2162                         warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2163                         return;
2164                 }
2165                 
2166                 // Parse density
2167                 double density;
2168                 String str;
2169                 str = attributes.remove("density");
2170                 if (str == null) {
2171                         warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2172                         return;
2173                 }
2174                 try {
2175                         density = Double.parseDouble(str);
2176                 } catch (NumberFormatException e) {
2177                         warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2178                         return;
2179                 }
2180                 
2181                 // Parse thickness
2182                 //              double thickness = 0;
2183                 //              str = attributes.remove("thickness");
2184                 //              try {
2185                 //                      if (str != null)
2186                 //                              thickness = Double.parseDouble(str);
2187                 //              } catch (NumberFormatException e){
2188                 //                      warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2189                 //                      return;
2190                 //              }
2191                 
2192                 // Check type if specified
2193                 str = attributes.remove("type");
2194                 if (str != null && !type.name().toLowerCase(Locale.ENGLISH).equals(str)) {
2195                         warnings.add(Warning.fromString("Illegal material type specified, ignoring."));
2196                         return;
2197                 }
2198                 
2199                 mat = Databases.findMaterial(type, name, density);
2200                 
2201                 setMethod.invoke(c, mat);
2202         }
2203 }
2204
2205
2206
2207
2208
2209 class PositionSetter implements Setter {
2210         
2211         @Override
2212         public void set(RocketComponent c, String value, HashMap<String, String> attributes,
2213                         WarningSet warnings) {
2214                 
2215                 RocketComponent.Position type = (Position) DocumentConfig.findEnum(attributes.get("type"),
2216                                 RocketComponent.Position.class);
2217                 if (type == null) {
2218                         warnings.add(Warning.FILE_INVALID_PARAMETER);
2219                         return;
2220                 }
2221                 
2222                 double pos;
2223                 try {
2224                         pos = Double.parseDouble(value);
2225                 } catch (NumberFormatException e) {
2226                         warnings.add(Warning.FILE_INVALID_PARAMETER);
2227                         return;
2228                 }
2229                 
2230                 if (c instanceof FinSet) {
2231                         ((FinSet) c).setRelativePosition(type);
2232                         c.setPositionValue(pos);
2233                 } else if (c instanceof LaunchLug) {
2234                         ((LaunchLug) c).setRelativePosition(type);
2235                         c.setPositionValue(pos);
2236                 } else if (c instanceof InternalComponent) {
2237                         ((InternalComponent) c).setRelativePosition(type);
2238                         c.setPositionValue(pos);
2239                 } else {
2240                         warnings.add(Warning.FILE_INVALID_PARAMETER);
2241                 }
2242                 
2243         }
2244 }
2245
2246
2247 class FinTabPositionSetter extends DoubleSetter {
2248         
2249         public FinTabPositionSetter() {
2250                 super(Reflection.findMethod(FinSet.class, "setTabShift", double.class));
2251         }
2252         
2253         @Override
2254         public void set(RocketComponent c, String s, HashMap<String, String> attributes,
2255                         WarningSet warnings) {
2256                 
2257                 if (!(c instanceof FinSet)) {
2258                         throw new IllegalStateException("FinTabPositionSetter called for component " + c);
2259                 }
2260                 
2261                 String relative = attributes.get("relativeto");
2262                 FinSet.TabRelativePosition position =
2263                                 (TabRelativePosition) DocumentConfig.findEnum(relative,
2264                                                 FinSet.TabRelativePosition.class);
2265                 
2266                 if (position != null) {
2267                         
2268                         ((FinSet) c).setTabRelativePosition(position);
2269                         
2270                 } else {
2271                         if (relative == null) {
2272                                 warnings.add("Required attribute 'relativeto' not found for fin tab position.");
2273                         } else {
2274                                 warnings.add("Illegal attribute value '" + relative + "' encountered.");
2275                         }
2276                 }
2277                 
2278                 super.set(c, s, attributes, warnings);
2279         }
2280         
2281         
2282 }
2283
2284
2285 class ClusterConfigurationSetter implements Setter {
2286         
2287         @Override
2288         public void set(RocketComponent component, String value, HashMap<String, String> attributes,
2289                         WarningSet warnings) {
2290                 
2291                 if (!(component instanceof Clusterable)) {
2292                         warnings.add("Illegal component defined as cluster.");
2293                         return;
2294                 }
2295                 
2296                 ClusterConfiguration config = null;
2297                 for (ClusterConfiguration c : ClusterConfiguration.CONFIGURATIONS) {
2298                         if (c.getXMLName().equals(value)) {
2299                                 config = c;
2300                                 break;
2301                         }
2302                 }
2303                 
2304                 if (config == null) {
2305                         warnings.add("Illegal cluster configuration specified.");
2306                         return;
2307                 }
2308                 
2309                 ((Clusterable) component).setClusterConfiguration(config);
2310         }
2311 }