source: java/main/src/main/java/com/framsticks/parsers/Schema.java @ 84

Last change on this file since 84 was 84, checked in by psniegowski, 11 years ago

HIGHLIGHTS:

  • simplification of entities management model
  • cleanup around params (improve hierarchy)
  • migrate from JUnit to TestNG
  • introduce FEST to automatically test GUI
  • improve slider control
  • loosen synchronization between gui tree and backend representation
  • and many other bug fixes

NOTICE:

  • a great many of lines is changed only because of substituting spaces with tabs

CHANGELOG (oldest changes at the bottom):

Some cleaning after fix found.

Fix bug with tree.

More changes with TreeNodes?.

Finally fix issue with tree.

Improve gui tree management.

Decouple update of values from fetch request in gui.

Minor changes.

Minor changes.

Minor change.

Change Path construction wording.

More fixes to SliderControl?.

Fix SliderControl?.

Fix SliderControl?.

Minor improvement.

Several changes.

Make NumberParam? a generic class.

Add robot to the gui test.

Setup common testing logging configuration.

Remove Parameters class.

Remove entityOwner from Parameters.

Move name out from Parameters class.

Move configuration to after the construction.

Simplify observers and endpoints.

Remove superfluous configureEntity overrides.

Add dependency on fest-swing-testng.

Use FEST for final print test.

Use FEST for more concise and readable assertions.

Divide test of F0Parser into multiple methods.

Migrate to TestNG

Minor change.

Change convention from LOGGER to log.

Fix reporting of errors during controls filling.

Bound maximal height of SliderControl?.

Minor improvements.

Improve tooltips for controls.

Also use Delimeted in more places.

Move static control utilities to Gui.

Rename package gui.components to controls.

Some cleaning in controls.

Improve Param classes placing.

Move ValueParam?, PrimitiveParam? and CompositeParam? one package up.

Improve ParamBuilder?.

Move getDef to ValueParam? and PrimitiveParam?.

Move getMax and getDef to ValueParam?.

Move getMin to ValueParam?.

Upgrade to laters apache commons versions.

Use filterInstanceof extensively.

Add instanceof filters.

Make ValueParam? in many places of Param.

Place assertions about ValueParam?.

Add ValueParam?

Rename ValueParam? to PrimitiveParam?

Minor changes.

Several improvements to params types.

Add NumberParam?.

Add TextControl? component.

Add .swp files to .gitignore

Greatly improved slider component.

Some improvements.

Make Param.reassign return also a state.

Add IterableIterator?.

Several changes.

  • Move util classes to better packages.
  • Remove warnings from eclim.

Several improvements.

Fix bug with BooleanParam?.

Some experiments with visualization.

Another fix to panel management.

Improve panel management.

Some refactorization around panels.

Add root class for panel.

File size: 9.2 KB
Line 
1package com.framsticks.parsers;
2
3import java.io.IOException;
4import java.io.InputStream;
5import java.util.Collections;
6import java.util.HashMap;
7import java.util.Map;
8
9import com.framsticks.params.*;
10import com.framsticks.util.lang.Numbers;
11import org.apache.log4j.Logger;
12
13import javax.xml.parsers.DocumentBuilder;
14import javax.xml.parsers.DocumentBuilderFactory;
15import javax.xml.parsers.ParserConfigurationException;
16
17import com.framsticks.leftovers.f0.NeuroClass;
18import org.w3c.dom.Document;
19import org.w3c.dom.NamedNodeMap;
20import org.w3c.dom.Node;
21import org.w3c.dom.NodeList;
22import org.xml.sax.SAXException;
23
24/**
25 * The Class Schema, which represent f0 schema (it contains all the possible
26 * classes definitions that can be used in f0 representation). Definitions are
27 * loaded from XML stream.
28 *
29 * @author Jarek Szymczak <name.surname@gmail.com>
30 * (please replace name and surname with my personal data)
31 */
32public class Schema {
33
34        private final static Logger logger = Logger.getLogger(Schema.class);
35
36        protected final Registry registry = new Registry();
37
38        /** The neuro classes (classess representing different types of neurons). */
39        private Map<String, NeuroClass> neuroClasses = new HashMap<String, NeuroClass>();
40
41        public static InputStream getDefaultDefinitionAsStream() {
42                //return new FileInputStream(new File(Schema.class.getResource("/parsers/f0def.xml").getPath()));
43                return Schema.class.getResourceAsStream("/parsers/f0def.xml");
44        }
45
46        /**
47         * Instantiates a new schema.
48         *
49         * @param inputStream
50         *            the xml stream with schema
51         * @throws Exception
52         *             the exception if one occurred while reading the stream
53         */
54        public Schema(InputStream inputStream) throws Exception {
55
56                DocumentBuilderFactory factory;
57                DocumentBuilder db;
58
59                try {
60                        factory = javax.xml.parsers.DocumentBuilderFactory.newInstance();
61                        db = factory.newDocumentBuilder();
62
63                        Document document = db.parse(inputStream);
64                        NodeList classes = document.getElementsByTagName("CLASS");
65
66                        for (int i = 0; i < classes.getLength(); i++) {
67                                Node classNode = classes.item(i);
68                                FramsClass framsClass = processClass(classNode);
69                                registry.putInfoIntoCache(framsClass);
70                        }
71
72                        classes = document.getElementsByTagName("NEUROCLASS");
73
74                        for (int i = 0; i < classes.getLength(); i++) {
75                                Node classNode = classes.item(i);
76                                FramsClass framsClass = processClass(classNode);
77
78                                NamedNodeMap attributes = classNode.getAttributes();
79                                int prefInputs = getIntAttribute(attributes, "INPUTS");
80                                int prefOutput = getIntAttribute(attributes, "OUTPUT");
81                                int prefLocation = getIntAttribute(attributes, "LOCATION");
82                                int visualHints = getIntAttribute(attributes, "VISUALHINTS");
83                                String symbolGlymphString = getAttribute(attributes, "SYMBOL");
84                                int[] symbolGlymph = null;
85
86                                if (symbolGlymphString != null) {
87                                        String[] sgha = symbolGlymphString.split(",");
88                                        int length = sgha.length;
89                                        symbolGlymph = new int[length];
90                                        for (int j = 0; j < length; j++) {
91                                                try {
92                                                        symbolGlymph[j] = Integer.parseInt(sgha[j]);
93                                                } catch (NumberFormatException e) {
94                                                        logger.error("an error occurred while parsing symbol glymph, class getId: "
95                                                                        + framsClass.getId()
96                                                                        + ", glymph offset: " + j);
97                                                }
98                                        }
99                                }
100
101                                neuroClasses.put(framsClass.getId(), new NeuroClass(
102                                                framsClass, prefInputs, prefOutput, prefLocation,
103                                                visualHints, symbolGlymph));
104                        }
105
106                } catch (IOException e) {
107                        logger.fatal("unexpected exception occurred: ", e);
108                        throw e;
109                } catch (ParserConfigurationException e) {
110                        logger.fatal("unexpected exception occurred: ", e);
111                        throw e;
112                } catch (SAXException e) {
113                        logger.fatal("unexpected exception occurred: ", e);
114                        throw e;
115                }
116
117        }
118
119        /**
120         * Method used for convenience, it retrieves the Integer value stored in
121         * node under certain attribute getName. If value is not present or is other
122         * getType than integer 0 is returned.
123         *
124         * @return attribute value if value exists and it's integer (0 otherwise)
125         *
126         */
127        private static int getIntAttribute(NamedNodeMap attributes, String name) {
128                String v = getAttribute(attributes, name);
129                if (v == null) {
130                        return 0;
131                }
132                try {
133                        return Integer.parseInt(v);
134                } catch (NullPointerException e) {
135                        return 0;
136                } catch (NumberFormatException e) {
137                        logger.fatal("attribute " + name
138                                        + " should be numeric: " + v);
139                        return 0;
140                }
141        }
142
143        private static String getAttribute(NamedNodeMap attributes, String name) {
144                Node item = attributes.getNamedItem(name);
145                if (item == null) {
146                        return null;
147                }
148                return item.getNodeValue();
149        }
150
151        /**
152         * Method used for convenience, it retrieves the value stored in node under
153         * certain attribute getName. If value is not present method returns null.
154         *
155         * @param attributeName
156         *            the attribute getName
157         * @param node
158         *            the node
159         * @return attribute value if value exists (null otherwise)
160         *
161         */
162        private static String getAttributeFromNode(String attributeName, Node node) {
163                if (node == null) {
164                        return null;
165                }
166                return getAttribute(node.getAttributes(), attributeName);
167        }
168
169        /**
170         * In this method analysis of single class is performed.
171         *
172         * @param classNode
173         *            the class node
174         * @return the param entry list as a class schema
175         * @throws Exception
176         *             the exception in case of any error
177         */
178        private static FramsClass processClass(Node classNode) throws Exception {
179                String classId = null;
180                String className = "";
181                String classDescription = "";
182                try {
183                        classId = classNode.getAttributes().getNamedItem("ID")
184                                        .getNodeValue();
185                } catch (NullPointerException e) {
186                        throw new Exception("Class getId is not defined!");
187                }
188
189                className = getAttributeFromNode("NAME", classNode);
190                classDescription = getAttributeFromNode("DESCRIPTION", classNode);
191
192                FramsClass framsClass = new FramsClass(classId, className, classDescription);
193
194                NodeList classProperties = classNode.getChildNodes();
195
196                for (int j = 0; j < classProperties.getLength(); j++) {
197                        Node node = classProperties.item(j);
198
199                        if ("GROUP".equals(node.getNodeName())) {
200                                NamedNodeMap attributes = node.getAttributes();
201                                String name = getAttribute(attributes, "NAME");
202                                if (name == null) {
203                                        logger.warn("Group name in class \"" + classId + "\" ("
204                                                        + className + ") is undefined");
205                                } else {
206                                        framsClass.appendGroup(new Group(name));
207                                }
208                        } else if ("PROP".equals(node.getNodeName())
209                                        || "NEUROPROP".equals(node.getNodeName())) {
210
211                                NamedNodeMap attributes = node.getAttributes();
212                                Param param = processParameter(attributes, classId);
213                                framsClass.append(param);
214                        }
215
216                }
217
218                return framsClass;
219        }
220
221        private static <T extends Number> T extractAttribute(NamedNodeMap attributes, String name, Class<T> type) {
222                String value = getAttribute(attributes, name);
223                if (value == null) {
224                        return null;
225                }
226                return Numbers.parse(value, type);
227        }
228        /**
229         * It analyses the single property within the class
230         *
231         * @param attributes
232         *            the attributes of property
233         * @param classId
234         *            the class getId
235         * @return the param entry representing single parameter
236         * @throws Exception
237         *             the exception in case of any error
238         */
239        private static Param processParameter(NamedNodeMap attributes, String classId)
240                        throws Exception {
241
242                String id = getAttribute(attributes, "ID");
243                if (id == null)
244                        throw new Exception("Property ID in class \"" + classId
245                                        + "\" is undefined");
246                String type = getAttribute(attributes, "TYPE");
247                if (type == null)
248                        throw new Exception("TYPE of property \"" + id + "\" is undefined");
249
250                String name = getAttribute(attributes, "NAME");
251                String description = getAttribute(attributes, "DESCRIPTION");
252                int group = getIntAttribute(attributes, "GROUP");
253                String flagsString = getAttribute(attributes, "FLAGS");
254
255                Integer flags = 0;
256
257                try {
258                        if (flagsString != null)
259                                for (String flag : flagsString.split("[^0-9]")) {
260                                        if (flag.trim().equals(""))
261                                                continue;
262                                        flags |= Integer.parseInt(flag);
263                                }
264                } catch (NumberFormatException e) {
265                        logger.warn("FLAGS parameter should be an Integer value or separated Integer values. FLAGS are set to: "
266                                        + flags);
267                }
268
269                ParamBuilder builder = new ParamBuilder();
270                builder.setId(id).setName(name).setHelp(description).setGroup(group).setFlags(flags);
271
272                builder.setType(type);
273
274                if ("d".equals(type)) {
275                        builder.setMin(extractAttribute(attributes, "MIN", Integer.class));
276                        builder.setMax(extractAttribute(attributes, "MAX", Integer.class));
277                        builder.setDef(extractAttribute(attributes, "DEF", Integer.class));
278                } else if ("f".equals(type)) {
279                        builder.setMin(extractAttribute(attributes, "MIN", Double.class));
280                        builder.setMax(extractAttribute(attributes, "MAX", Double.class));
281                        builder.setDef(extractAttribute(attributes, "DEF", Double.class));
282                } else if ("s".equals(type)) {
283                        builder.setMin(extractAttribute(attributes, "MIN", Integer.class));
284                        builder.setMax(extractAttribute(attributes, "MAX", Integer.class));
285                        builder.setDef(extractAttribute(attributes, "DEF", Integer.class));
286                        builder.setDef(getAttribute(attributes, "DEF"));
287                } else {
288                        builder.setType(type);
289                }
290                return builder.build();
291        }
292
293
294        public Map<String, NeuroClass> getNeuroClasses() {
295                return Collections.unmodifiableMap(neuroClasses);
296        }
297
298        public final Registry getRegistry() {
299                return registry;
300        }
301
302
303}
Note: See TracBrowser for help on using the repository browser.