source: tmcsimulator-scriptbuilder/trunk/src/scriptbuilder/structures/XMLWriter.java @ 138

Revision 138, 9.0 KB checked in by bmcguffin, 8 years ago (diff)

Added support for incident color. Color is now read from the xml file; if no color field exists, it picks a random one. Upon saving the file, color is written out in RGB format. The DTD now contains a new field, COLOR, with three attributes: r, g, b.
Line 
1package scriptbuilder.structures;
2
3/**
4 *
5 * @author Bryan McGuffin
6 */
7public class XMLWriter
8{
9
10    /**
11     * XML-style opening tag. Example: if given string "my_tag", returns
12     * "<my_tag>".
13     *
14     * @param s the XML element to be included in the tag.
15     * @return the properly formatted tag
16     */
17    public static String openTag(String s)
18    {
19        return "<" + s + ">";
20    }
21
22    /**
23     * XML-style closing tag. Example: if given string "my_tag", returns
24     * "</my_tag>".
25     *
26     * @param s the XML element to be included in the tag.
27     * @return the properly formatted tag
28     */
29    public static String closeTag(String s)
30    {
31        return "</" + s + ">\n";
32    }
33
34    /**
35     * XML-style empty tag. Example: if given string "my_tag", returns
36     * "<my_tag/>".
37     *
38     * @param s the XML element to be included in the tag.
39     * @return the properly formatted tag
40     */
41    public static String emptyTag(String s)
42    {
43        return "<" + s + "/>\n";
44    }
45
46    /**
47     * Creates a pair of XML open and close tags to wrap a simple line of data.
48     * Useful if only one element need be enclosed in this particular tag.
49     *
50     * @param s the data to be wrapped
51     * @param e the XML element represented by the data
52     * @return an XML string of the format <my_tag>some_data_goes_here</my_tag>
53     */
54    public static String simpleTag(String s, ELEMENT e)
55    {
56        String output = "";
57        if (s == null)
58        {
59            s = "";
60        }
61
62        output += openTag(e.tag);
63        output += s;
64        output += closeTag(e.tag);
65
66        return output;
67    }
68
69    /**
70     * Generates the internal DTD for XML script files.
71     *
72     * @return
73     */
74    public static String internalDTD()
75    {
76        String output = "";
77        output += "<!DOCTYPE TMC_SCRIPT [\n";
78        output += "<!ELEMENT TMC_SCRIPT (SCRIPT_DATA | SCRIPT_EVENT)*>\n"
79                + "<!ATTLIST TMC_SCRIPT title CDATA #REQUIRED>\n"
80                + "<!ELEMENT SCRIPT_DATA (NEW_UNIT*, CARDFILE*)>\n"
81                + "<!ELEMENT NEW_UNIT (ID | STATUS | MASTER_INC_NUM | PRIMARY | OOS | TYPE | \n"
82                + "CURR_LOC | DESTINATION | MISC_INFO | STACK | AREA | OFFICER | BADGE_NUM | TIMER | \n"
83                + "OFFICE | P | AGY | ALIAS | UNIT_STATUS)*>\n"
84                + "<!ATTLIST NEW_UNIT UnitNum CDATA #REQUIRED>\n"
85                + "<!ELEMENT ID (#PCDATA)>\n"
86                + "<!ELEMENT STATUS (#PCDATA)>\n"
87                + "<!ELEMENT MASTER_INC_NUM (#PCDATA)>\n"
88                + "<!ELEMENT PRIMARY (#PCDATA)>\n"
89                + "<!ELEMENT OOS (#PCDATA)>\n"
90                + "<!ELEMENT TYPE (#PCDATA)>\n"
91                + "<!ELEMENT CURR_LOC (#PCDATA)>\n"
92                + "<!ELEMENT DESTINATION (#PCDATA)>\n"
93                + "<!ELEMENT MISC_INFO (#PCDATA)>\n"
94                + "<!ELEMENT STACK (#PCDATA)>\n"
95                + "<!ELEMENT AREA (#PCDATA)>\n"
96                + "<!ELEMENT BADGE_NUM (#PCDATA)>\n"
97                + "<!ELEMENT OFFICER (#PCDATA)>\n"
98                + "<!ELEMENT OFFICE (#PCDATA)>\n"
99                + "<!ELEMENT TIMER (#PCDATA)>\n"
100                + "<!ELEMENT P (#PCDATA)>\n"
101                + "<!ELEMENT AGY (#PCDATA)>\n"
102                + "<!ELEMENT ALIAS (#PCDATA)>\n"
103                + "<!ELEMENT UNIT_STATUS (#PCDATA)>\n"
104                + "<!ELEMENT CARDFILE (NAME | ADDRESS | CITY | STATE | ZIP | PHONE | FAX | COMMENT)*>\n"
105                + "<!ATTLIST CARDFILE Category CDATA #REQUIRED>\n"
106                + "<!ELEMENT NAME (#PCDATA)>\n"
107                + "<!ELEMENT ADDRESS (#PCDATA)>\n"
108                + "<!ELEMENT CITY (#PCDATA)>\n"
109                + "<!ELEMENT STATE (#PCDATA)>\n"
110                + "<!ELEMENT ZIP (#PCDATA)>\n"
111                + "<!ELEMENT PHONE (#PCDATA)>\n"
112                + "<!ELEMENT FAX (#PCDATA)>\n"
113                + "<!ELEMENT COMMENT (#PCDATA)>\n"
114                + "<!ELEMENT SCRIPT_EVENT (TIME_INDEX | INCIDENT | COLOR | CAD_DATA | GENERAL_INFO |\n"
115                + "ATMS_EVALUATION | CAD_EVALUATION | ACTIVITY_LOG_EVALUATION | FACILITATOR_EVALUATION |\n"
116                + "RADIO_EVALUATION | CHP_RADIO | MAINTENANCE_RADIO | CMS_EVALUATION | TMT_RADIO | \n"
117                + "TELEPHONE | CMS_EVALUATION)*>\n"
118                + "<!ELEMENT TIME_INDEX (#PCDATA)>\n"
119                + "<!ELEMENT INCIDENT (#PCDATA)>\n"
120                + "<!ATTLIST INCIDENT LogNum CDATA #REQUIRED>\n"
121                + "<!ELEMENT COLOR EMPTY>\n"
122                + "<!ATTLIST COLOR r CDATA #REQUIRED>\n"
123                + "<!ATTLIST COLOR g CDATA #REQUIRED>\n"
124                + "<!ATTLIST COLOR b CDATA #REQUIRED>\n"
125                + "<!ELEMENT CAD_DATA (HEADER_INFO | CAD_INCIDENT_EVENT | LOCATION_INFO | MASTER_INC_NUM |\n"
126                + "P | ADDITIONAL_INFO | LOCATION | GENERAL)*>\n"
127                + "<!ELEMENT HEADER_INFO (Type | Beat | TruncLoc | FullLoc)*>\n"
128                + "<!ELEMENT Type (#PCDATA)>\n"
129                + "<!ELEMENT Beat (#PCDATA)>\n"
130                + "<!ELEMENT TruncLoc (#PCDATA)>\n"
131                + "<!ELEMENT FullLoc (#PCDATA)>\n"
132                + "<!ELEMENT CAD_INCIDENT_EVENT (DETAIL | AUDIO | UNIT | PARAMICS |\n"
133                + "TOW | WITNESS | SERVICE | CCTV_INFO)*>\n"
134                + "<!ELEMENT DETAIL (#PCDATA)>\n"
135                + "<!ELEMENT AUDIO EMPTY>\n"
136                + "<!ATTLIST AUDIO Length CDATA #REQUIRED>\n"
137                + "<!ATTLIST AUDIO Path CDATA #REQUIRED>\n"
138                + "<!ELEMENT UNIT EMPTY>\n"
139                + "<!ATTLIST UNIT UnitNum CDATA #REQUIRED>\n"
140                + "<!ATTLIST UNIT Status CDATA #REQUIRED>\n"
141                + "<!ATTLIST UNIT Primary CDATA #REQUIRED>\n"
142                + "<!ATTLIST UNIT Active CDATA #REQUIRED>\n"
143                + "<!ELEMENT PARAMICS (Status | Incident_type | Lane_number)*>\n"
144                + "<!ATTLIST PARAMICS LocationID CDATA #REQUIRED>\n"
145                + "<!ELEMENT Status (#PCDATA)>\n"
146                + "<!ELEMENT Incident_type (#PCDATA)>\n"
147                + "<!ELEMENT Lane_number (#PCDATA)>\n"
148                + "<!ELEMENT TOW EMPTY>\n"
149                + "<!ATTLIST TOW Company CDATA #REQUIRED>\n"
150                + "<!ATTLIST TOW ConfNum CDATA #REQUIRED>\n"
151                + "<!ATTLIST TOW PubNum CDATA #REQUIRED>\n"
152                + "<!ATTLIST TOW Beat CDATA #REQUIRED>\n"
153                + "<!ELEMENT WITNESS EMPTY>\n"
154                + "<!ATTLIST WITNESS Name CDATA #REQUIRED>\n"
155                + "<!ATTLIST WITNESS Address CDATA #REQUIRED>\n"
156                + "<!ATTLIST WITNESS PhoneNum CDATA #REQUIRED>\n"
157                + "<!ELEMENT SERVICE (#PCDATA)>\n"
158                + "<!ELEMENT CCTV_INFO (#PCDATA)>\n"
159                + "<!ELEMENT LOCATION_INFO (Route | Direction | Postmile | Location_type)*>\n"
160                + "<!ATTLIST LOCATION_INFO ID CDATA #REQUIRED>\n"
161                + "<!ELEMENT Route (#PCDATA)>\n"
162                + "<!ELEMENT Direction (#PCDATA)>\n"
163                + "<!ELEMENT Postmile (#PCDATA)>\n"
164                + "<!ELEMENT Location_type (#PCDATA)>\n"
165                + "<!ELEMENT ADDITIONAL_INFO (TYPE_CODE, TYPE)>\n"
166                + "<!ELEMENT TYPE_CODE (#PCDATA)>\n"
167                + "<!ELEMENT LOCATION (#PCDATA | BEAT | ADDRESS | LOC | CITY | AREA | FIRE | LAW | EMS)*>\n"
168                + "<!ELEMENT BEAT (#PCDATA)>\n"
169                + "<!ELEMENT LOC (#PCDATA)>\n"
170                + "<!ELEMENT FIRE (#PCDATA)>\n"
171                + "<!ELEMENT LAW (#PCDATA)>\n"
172                + "<!ELEMENT EMS (#PCDATA)>\n"
173                + "<!ELEMENT GENERAL (AGY)>\n"
174                + "<!ELEMENT GENERAL_INFO (TITLE, TEXT)>\n"
175                + "<!ELEMENT TITLE (#PCDATA)>\n"
176                + "<!ELEMENT TEXT (#PCDATA)>\n"
177                + "<!ELEMENT ATMS_EVALUATION (EXPECTED_ACTION*)>\n"
178                + "<!ELEMENT CAD_EVALUATION (EXPECTED_ACTION*)>\n"
179                + "<!ELEMENT ACTIVITY_LOG_EVALUATION (EXPECTED_ACTION*)>\n"
180                + "<!ELEMENT FACILITATOR_EVALUATION (EXPECTED_ACTION*)>\n"
181                + "<!ELEMENT RADIO_EVALUATION (EXPECTED_ACTION*)>\n"
182                + "<!ELEMENT EXPECTED_ACTION (#PCDATA)>\n"
183                + "<!ELEMENT CHP_RADIO (DIALOG)>\n"
184                + "<!ATTLIST CHP_RADIO RadioFile CDATA #REQUIRED>\n"
185                + "<!ELEMENT DIALOG (LINE*)>\n"
186                + "<!ELEMENT LINE (#PCDATA)>\n"
187                + "<!ATTLIST LINE Role CDATA #REQUIRED>\n"
188                + "<!ELEMENT MAINTENANCE_RADIO (#PCDATA)>\n"
189                + "<!ELEMENT TMT_RADIO (#PCDATA)>\n"
190                + "<!ELEMENT TELEPHONE (INSTRUCTOR | STUDENT)*>\n"
191                + "<!ELEMENT INSTRUCTOR (#PCDATA)>\n"
192                + "<!ATTLIST INSTRUCTOR Role CDATA #REQUIRED>\n"
193                + "<!ELEMENT STUDENT (#PCDATA)>\n"
194                + "<!ELEMENT CMS_EVALUATION (LOCATION | SAMPLE_MESSAGE)*>\n"
195                + "<!ATTLIST CMS_EVALUATION cmsID CDATA #REQUIRED>\n"
196                + "<!ATTLIST CMS_EVALUATION type CDATA #REQUIRED>\n"
197                + "<!ELEMENT SAMPLE_MESSAGE (CMS_LINE*)>\n"
198                + "<!ELEMENT CMS_LINE (#PCDATA)>";
199
200        output += "]>\n";
201        return output;
202    }
203}
Note: See TracBrowser for help on using the repository browser.