001package org.cpsolver.studentsct; 002 003import java.io.File; 004import java.util.ArrayList; 005import java.util.BitSet; 006import java.util.HashSet; 007import java.util.HashMap; 008import java.util.Iterator; 009import java.util.List; 010import java.util.Map; 011import java.util.Set; 012 013import org.cpsolver.coursett.model.Placement; 014import org.cpsolver.coursett.model.RoomLocation; 015import org.cpsolver.coursett.model.TimeLocation; 016import org.cpsolver.ifs.assignment.Assignment; 017import org.cpsolver.ifs.model.Constraint; 018import org.cpsolver.ifs.util.DistanceMetric; 019import org.cpsolver.ifs.util.Progress; 020import org.cpsolver.studentsct.filter.StudentFilter; 021import org.cpsolver.studentsct.model.AcademicAreaCode; 022import org.cpsolver.studentsct.model.Choice; 023import org.cpsolver.studentsct.model.Config; 024import org.cpsolver.studentsct.model.Course; 025import org.cpsolver.studentsct.model.CourseRequest; 026import org.cpsolver.studentsct.model.Enrollment; 027import org.cpsolver.studentsct.model.FreeTimeRequest; 028import org.cpsolver.studentsct.model.Offering; 029import org.cpsolver.studentsct.model.Request; 030import org.cpsolver.studentsct.model.RequestGroup; 031import org.cpsolver.studentsct.model.Section; 032import org.cpsolver.studentsct.model.Student; 033import org.cpsolver.studentsct.model.Subpart; 034import org.cpsolver.studentsct.reservation.CourseReservation; 035import org.cpsolver.studentsct.reservation.CurriculumReservation; 036import org.cpsolver.studentsct.reservation.DummyReservation; 037import org.cpsolver.studentsct.reservation.GroupReservation; 038import org.cpsolver.studentsct.reservation.IndividualReservation; 039import org.cpsolver.studentsct.reservation.Reservation; 040import org.cpsolver.studentsct.reservation.ReservationOverride; 041import org.dom4j.Document; 042import org.dom4j.DocumentException; 043import org.dom4j.Element; 044import org.dom4j.io.SAXReader; 045 046/** 047 * Load student sectioning model from an XML file. 048 * 049 * <br> 050 * <br> 051 * Parameters: 052 * <table border='1' summary='Related Solver Parameters'> 053 * <tr> 054 * <th>Parameter</th> 055 * <th>Type</th> 056 * <th>Comment</th> 057 * </tr> 058 * <tr> 059 * <td>General.Input</td> 060 * <td>{@link String}</td> 061 * <td>Path of an XML file to be loaded</td> 062 * </tr> 063 * <tr> 064 * <td>Xml.LoadBest</td> 065 * <td>{@link Boolean}</td> 066 * <td>If true, load best assignments</td> 067 * </tr> 068 * <tr> 069 * <td>Xml.LoadInitial</td> 070 * <td>{@link Boolean}</td> 071 * <td>If false, load initial assignments</td> 072 * </tr> 073 * <tr> 074 * <td>Xml.LoadCurrent</td> 075 * <td>{@link Boolean}</td> 076 * <td>If true, load current assignments</td> 077 * </tr> 078 * <tr> 079 * <td>Xml.LoadOfferings</td> 080 * <td>{@link Boolean}</td> 081 * <td>If true, load offerings (and their stucture, i.e., courses, 082 * configurations, subparts and sections)</td> 083 * </tr> 084 * <tr> 085 * <td>Xml.LoadStudents</td> 086 * <td>{@link Boolean}</td> 087 * <td>If true, load students (and their requests)</td> 088 * </tr> 089 * <tr> 090 * <td>Xml.StudentFilter</td> 091 * <td>{@link StudentFilter}</td> 092 * <td>If provided, students are filtered by the given student filter</td> 093 * </tr> 094 * </table> 095 * 096 * <br> 097 * <br> 098 * Usage: 099 * <pre><code> 100 * StudentSectioningModel model = new StudentSectioningModel(cfg);<br> 101 * new StudentSectioningXMLLoader(model).load();<br> 102 * </code></pre> 103 * 104 * @version StudentSct 1.3 (Student Sectioning)<br> 105 * Copyright (C) 2007 - 2014 Tomas Muller<br> 106 * <a href="mailto:muller@unitime.org">muller@unitime.org</a><br> 107 * <a href="http://muller.unitime.org">http://muller.unitime.org</a><br> 108 * <br> 109 * This library is free software; you can redistribute it and/or modify 110 * it under the terms of the GNU Lesser General Public License as 111 * published by the Free Software Foundation; either version 3 of the 112 * License, or (at your option) any later version. <br> 113 * <br> 114 * This library is distributed in the hope that it will be useful, but 115 * WITHOUT ANY WARRANTY; without even the implied warranty of 116 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 117 * Lesser General Public License for more details. <br> 118 * <br> 119 * You should have received a copy of the GNU Lesser General Public 120 * License along with this library; if not see 121 * <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>. 122 */ 123 124public class StudentSectioningXMLLoader extends StudentSectioningLoader { 125 private static org.apache.log4j.Logger sLogger = org.apache.log4j.Logger 126 .getLogger(StudentSectioningXMLLoader.class); 127 128 private File iInputFile; 129 private File iTimetableFile = null; 130 private boolean iLoadBest = false; 131 private boolean iLoadInitial = false; 132 private boolean iLoadCurrent = false; 133 private boolean iLoadOfferings = true; 134 private boolean iLoadStudents = true; 135 private StudentFilter iStudentFilter = null; 136 137 /** 138 * Constructor 139 * 140 * @param model 141 * student sectioning model 142 * @param assignment current assignment 143 */ 144 public StudentSectioningXMLLoader(StudentSectioningModel model, Assignment<Request, Enrollment> assignment) { 145 super(model, assignment); 146 iInputFile = new File(getModel().getProperties().getProperty("General.Input", 147 "." + File.separator + "solution.xml")); 148 if (getModel().getProperties().getProperty("General.InputTimetable") != null) 149 iTimetableFile = new File(getModel().getProperties().getProperty("General.InputTimetable")); 150 iLoadBest = getModel().getProperties().getPropertyBoolean("Xml.LoadBest", true); 151 iLoadInitial = getModel().getProperties().getPropertyBoolean("Xml.LoadInitial", true); 152 iLoadCurrent = getModel().getProperties().getPropertyBoolean("Xml.LoadCurrent", true); 153 iLoadOfferings = getModel().getProperties().getPropertyBoolean("Xml.LoadOfferings", true); 154 iLoadStudents = getModel().getProperties().getPropertyBoolean("Xml.LoadStudents", true); 155 if (getModel().getProperties().getProperty("Xml.StudentFilter") != null) { 156 try { 157 iStudentFilter = (StudentFilter) Class.forName( 158 getModel().getProperties().getProperty("Xml.StudentFilter")).getConstructor(new Class[] {}) 159 .newInstance(new Object[] {}); 160 } catch (Exception e) { 161 sLogger.error("Unable to create student filter, reason: " + e.getMessage(), e); 162 } 163 } 164 } 165 166 /** Set input file (e.g., if it is not set by General.Input property) 167 * @param inputFile input file 168 **/ 169 public void setInputFile(File inputFile) { 170 iInputFile = inputFile; 171 } 172 173 /** Set student filter 174 * @param filter student filter 175 **/ 176 public void setStudentFilter(StudentFilter filter) { 177 iStudentFilter = filter; 178 } 179 180 /** Set whether to load students 181 * @param loadStudents true if students are to be loaded 182 **/ 183 public void setLoadStudents(boolean loadStudents) { 184 iLoadStudents = loadStudents; 185 } 186 187 /** Set whether to load offerings 188 * @param loadOfferings true if instructional offerings are to be loaded 189 **/ 190 public void setLoadOfferings(boolean loadOfferings) { 191 iLoadOfferings = loadOfferings; 192 } 193 194 /** Create BitSet from a bit string */ 195 private static BitSet createBitSet(String bitString) { 196 BitSet ret = new BitSet(bitString.length()); 197 for (int i = 0; i < bitString.length(); i++) 198 if (bitString.charAt(i) == '1') 199 ret.set(i); 200 return ret; 201 } 202 203 /** Load the file */ 204 @Override 205 public void load() throws Exception { 206 sLogger.debug("Reading XML data from " + iInputFile); 207 208 Document document = (new SAXReader()).read(iInputFile); 209 Element root = document.getRootElement(); 210 211 load(root); 212 } 213 214 /** 215 * Load data from the given XML root 216 * @param root document root 217 * @throws DocumentException 218 */ 219 protected void load(Element root) throws DocumentException { 220 sLogger.debug("Root element: " + root.getName()); 221 if (!"sectioning".equals(root.getName())) { 222 sLogger.error("Given XML file is not student sectioning problem."); 223 return; 224 } 225 226 if (iLoadOfferings && getModel().getDistanceConflict() != null && root.element("travel-times") != null) 227 loadTravelTimes(root.element("travel-times"), getModel().getDistanceConflict().getDistanceMetric()); 228 229 Map<Long, Placement> timetable = null; 230 if (iTimetableFile != null) { 231 sLogger.info("Reading timetable from " + iTimetableFile + " ..."); 232 Document timetableDocument = (new SAXReader()).read(iTimetableFile); 233 Element timetableRoot = timetableDocument.getRootElement(); 234 if (!"timetable".equals(timetableRoot.getName())) { 235 sLogger.error("Given XML file is not course timetabling problem."); 236 return; 237 } 238 timetable = loadTimetable(timetableRoot); 239 } 240 241 Progress.getInstance(getModel()).load(root, true); 242 Progress.getInstance(getModel()).message(Progress.MSGLEVEL_STAGE, "Restoring from backup ..."); 243 244 if (root.attributeValue("term") != null) 245 getModel().getProperties().setProperty("Data.Term", root.attributeValue("term")); 246 if (root.attributeValue("year") != null) 247 getModel().getProperties().setProperty("Data.Year", root.attributeValue("year")); 248 if (root.attributeValue("initiative") != null) 249 getModel().getProperties().setProperty("Data.Initiative", root.attributeValue("initiative")); 250 251 Map<Long, Offering> offeringTable = new HashMap<Long, Offering>(); 252 Map<Long, Course> courseTable = new HashMap<Long, Course>(); 253 254 if (iLoadOfferings && root.element("offerings") != null) { 255 loadOfferings(root.element("offerings"), offeringTable, courseTable, timetable); 256 } else { 257 for (Offering offering : getModel().getOfferings()) { 258 offeringTable.put(new Long(offering.getId()), offering); 259 for (Course course : offering.getCourses()) { 260 courseTable.put(new Long(course.getId()), course); 261 } 262 } 263 } 264 265 if (iLoadStudents && root.element("students") != null) { 266 loadStudents(root.element("students"), offeringTable, courseTable); 267 } 268 269 if (iLoadOfferings && root.element("constraints") != null) 270 loadLinkedSectiond(root.element("constraints"), offeringTable); 271 272 sLogger.debug("Model successfully loaded."); 273 } 274 275 /** 276 * Load offerings 277 * @param offeringsEl offerings element 278 * @param offeringTable offering table 279 * @param courseTable course table 280 * @param timetable provided timetable (null if to be loaded from the given document) 281 */ 282 protected void loadOfferings(Element offeringsEl, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable, Map<Long, Placement> timetable) { 283 HashMap<Long, Config> configTable = new HashMap<Long, Config>(); 284 HashMap<Long, Subpart> subpartTable = new HashMap<Long, Subpart>(); 285 HashMap<Long, Section> sectionTable = new HashMap<Long, Section>(); 286 for (Iterator<?> i = offeringsEl.elementIterator("offering"); i.hasNext();) { 287 Element offeringEl = (Element) i.next(); 288 Offering offering = new Offering( 289 Long.parseLong(offeringEl.attributeValue("id")), 290 offeringEl.attributeValue("name", "O" + offeringEl.attributeValue("id"))); 291 offeringTable.put(new Long(offering.getId()), offering); 292 getModel().addOffering(offering); 293 294 for (Iterator<?> j = offeringEl.elementIterator("course"); j.hasNext();) { 295 Element courseEl = (Element) j.next(); 296 Course course = loadCourse(courseEl, offering); 297 courseTable.put(new Long(course.getId()), course); 298 } 299 300 for (Iterator<?> j = offeringEl.elementIterator("config"); j.hasNext();) { 301 Element configEl = (Element) j.next(); 302 Config config = loadConfig(configEl, offering, subpartTable, sectionTable, timetable); 303 configTable.put(config.getId(), config); 304 } 305 306 for (Iterator<?> j = offeringEl.elementIterator("reservation"); j.hasNext(); ) { 307 Element reservationEl = (Element)j.next(); 308 loadReservation(reservationEl, offering, configTable, sectionTable); 309 } 310 } 311 } 312 313 /** 314 * Load course 315 * @param courseEl course element 316 * @param offering parent offering 317 * @return loaded course 318 */ 319 protected Course loadCourse(Element courseEl, Offering offering) { 320 Course course = new Course( 321 Long.parseLong(courseEl.attributeValue("id")), 322 courseEl.attributeValue("subjectArea", ""), 323 courseEl.attributeValue("courseNbr", "C" + courseEl.attributeValue("id")), 324 offering, Integer.parseInt(courseEl.attributeValue("limit", "-1")), 325 Integer.parseInt(courseEl.attributeValue("projected", "0"))); 326 return course; 327 } 328 329 /** 330 * Load config 331 * @param configEl config element 332 * @param offering parent offering 333 * @param subpartTable subpart table (of the offering) 334 * @param sectionTable section table (of the offering) 335 * @param timetable provided timetable 336 * @return loaded config 337 */ 338 protected Config loadConfig(Element configEl, Offering offering, Map<Long, Subpart> subpartTable, Map<Long, Section> sectionTable, Map<Long, Placement> timetable) { 339 Config config = new Config 340 (Long.parseLong(configEl.attributeValue("id")), 341 Integer.parseInt(configEl.attributeValue("limit", "-1")), 342 configEl.attributeValue("name", "G" + configEl.attributeValue("id")), 343 offering); 344 for (Iterator<?> k = configEl.elementIterator("subpart"); k.hasNext();) { 345 Element subpartEl = (Element) k.next(); 346 Subpart subpart = loadSubpart(subpartEl, config, subpartTable, sectionTable, timetable); 347 subpartTable.put(new Long(subpart.getId()), subpart); 348 } 349 return config; 350 } 351 352 /** 353 * Load subpart 354 * @param subpartEl supart element 355 * @param config parent config 356 * @param subpartTable subpart table (of the offering) 357 * @param sectionTable section table (of the offering) 358 * @param timetable provided timetable 359 * @return loaded subpart 360 */ 361 protected Subpart loadSubpart(Element subpartEl, Config config, Map<Long, Subpart> subpartTable, Map<Long, Section> sectionTable, Map<Long, Placement> timetable) { 362 Subpart parentSubpart = null; 363 if (subpartEl.attributeValue("parent") != null) 364 parentSubpart = subpartTable.get(Long.valueOf(subpartEl.attributeValue("parent"))); 365 Subpart subpart = new Subpart( 366 Long.parseLong(subpartEl.attributeValue("id")), 367 subpartEl.attributeValue("itype"), 368 subpartEl.attributeValue("name", "P" + subpartEl.attributeValue("id")), 369 config, 370 parentSubpart); 371 subpart.setAllowOverlap("true".equals(subpartEl.attributeValue("allowOverlap", "false"))); 372 373 374 for (Iterator<?> l = subpartEl.elementIterator("section"); l.hasNext();) { 375 Element sectionEl = (Element) l.next(); 376 Section section = loadSection(sectionEl, subpart, sectionTable, timetable); 377 sectionTable.put(new Long(section.getId()), section); 378 } 379 380 return subpart; 381 } 382 383 /** 384 * Load section 385 * @param sectionEl section element 386 * @param subpart parent subpart 387 * @param sectionTable section table (of the offering) 388 * @param timetable provided timetable 389 * @return loaded section 390 */ 391 protected Section loadSection(Element sectionEl, Subpart subpart, Map<Long, Section> sectionTable, Map<Long, Placement> timetable) { 392 Section parentSection = null; 393 if (sectionEl.attributeValue("parent") != null) 394 parentSection = sectionTable.get(Long.valueOf(sectionEl.attributeValue("parent"))); 395 Placement placement = null; 396 if (timetable != null) { 397 placement = timetable.get(Long.parseLong(sectionEl.attributeValue("id"))); 398 } else { 399 TimeLocation time = null; 400 Element timeEl = sectionEl.element("time"); 401 if (timeEl != null) { 402 time = new TimeLocation( 403 Integer.parseInt(timeEl.attributeValue("days"), 2), 404 Integer.parseInt(timeEl.attributeValue("start")), 405 Integer.parseInt(timeEl.attributeValue("length")), 0, 0, 406 timeEl.attributeValue("datePattern") == null ? null : Long.valueOf(timeEl.attributeValue("datePattern")), 407 timeEl.attributeValue("datePatternName", ""), 408 createBitSet(timeEl.attributeValue("dates")), 409 Integer.parseInt(timeEl.attributeValue("breakTime", "0"))); 410 if (timeEl.attributeValue("pattern") != null) 411 time.setTimePatternId(Long.valueOf(timeEl.attributeValue("pattern"))); 412 } 413 List<RoomLocation> rooms = new ArrayList<RoomLocation>(); 414 for (Iterator<?> m = sectionEl.elementIterator("room"); m.hasNext();) { 415 Element roomEl = (Element) m.next(); 416 Double posX = null, posY = null; 417 if (roomEl.attributeValue("location") != null) { 418 String loc = roomEl.attributeValue("location"); 419 posX = Double.valueOf(loc.substring(0, loc.indexOf(','))); 420 posY = Double.valueOf(loc.substring(loc.indexOf(',') + 1)); 421 } 422 RoomLocation room = new RoomLocation( 423 Long.valueOf(roomEl.attributeValue("id")), 424 roomEl.attributeValue("name", "R" + roomEl.attributeValue("id")), 425 roomEl.attributeValue("building") == null ? null : Long.valueOf(roomEl.attributeValue("building")), 426 0, Integer.parseInt(roomEl.attributeValue("capacity")), 427 posX, posY, "true".equals(roomEl.attributeValue("ignoreTooFar")), null); 428 rooms.add(room); 429 } 430 placement = (time == null ? null : new Placement(null, time, rooms)); 431 } 432 433 Section section = new Section( 434 Long.parseLong(sectionEl.attributeValue("id")), 435 Integer.parseInt(sectionEl.attributeValue("limit")), 436 sectionEl.attributeValue("name", "S" + sectionEl.attributeValue("id")), 437 subpart, placement, sectionEl.attributeValue("instructorIds"), 438 sectionEl.attributeValue("instructorNames"), parentSection); 439 440 section.setSpaceHeld(Double.parseDouble(sectionEl.attributeValue("hold", "0.0"))); 441 section.setSpaceExpected(Double.parseDouble(sectionEl.attributeValue("expect", "0.0"))); 442 for (Iterator<?> m = sectionEl.elementIterator("cname"); m.hasNext(); ) { 443 Element cNameEl = (Element)m.next(); 444 section.setName(Long.parseLong(cNameEl.attributeValue("id")), cNameEl.getText()); 445 } 446 Element ignoreEl = sectionEl.element("no-conflicts"); 447 if (ignoreEl != null) { 448 for (Iterator<?> m = ignoreEl.elementIterator("section"); m.hasNext(); ) 449 section.addIgnoreConflictWith(Long.parseLong(((Element)m.next()).attributeValue("id"))); 450 } 451 452 return section; 453 } 454 455 /** 456 * Load reservation 457 * @param reservationEl reservation element 458 * @param offering parent offering 459 * @param configTable config table (of the offering) 460 * @param sectionTable section table (of the offering) 461 * @return loaded reservation 462 */ 463 protected Reservation loadReservation(Element reservationEl, Offering offering, HashMap<Long, Config> configTable, HashMap<Long, Section> sectionTable) { 464 Reservation r = null; 465 if ("individual".equals(reservationEl.attributeValue("type"))) { 466 Set<Long> studentIds = new HashSet<Long>(); 467 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 468 Element studentEl = (Element)k.next(); 469 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 470 } 471 r = new IndividualReservation(Long.valueOf(reservationEl.attributeValue("id")), offering, studentIds); 472 } else if ("group".equals(reservationEl.attributeValue("type"))) { 473 Set<Long> studentIds = new HashSet<Long>(); 474 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 475 Element studentEl = (Element)k.next(); 476 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 477 } 478 r = new GroupReservation(Long.valueOf(reservationEl.attributeValue("id")), 479 Double.parseDouble(reservationEl.attributeValue("limit", "-1")), 480 offering, studentIds); 481 } else if ("curriculum".equals(reservationEl.attributeValue("type"))) { 482 List<String> classifications = new ArrayList<String>(); 483 for (Iterator<?> k = reservationEl.elementIterator("classification"); k.hasNext(); ) { 484 Element clasfEl = (Element)k.next(); 485 classifications.add(clasfEl.attributeValue("code")); 486 } 487 List<String> majors = new ArrayList<String>(); 488 for (Iterator<?> k = reservationEl.elementIterator("major"); k.hasNext(); ) { 489 Element majorEl = (Element)k.next(); 490 majors.add(majorEl.attributeValue("code")); 491 } 492 r = new CurriculumReservation(Long.valueOf(reservationEl.attributeValue("id")), 493 Double.parseDouble(reservationEl.attributeValue("limit", "-1")), 494 offering, 495 reservationEl.attributeValue("area"), 496 classifications, majors); 497 } else if ("course".equals(reservationEl.attributeValue("type"))) { 498 long courseId = Long.parseLong(reservationEl.attributeValue("course")); 499 for (Course course: offering.getCourses()) { 500 if (course.getId() == courseId) 501 r = new CourseReservation(Long.valueOf(reservationEl.attributeValue("id")), course); 502 } 503 } else if ("dummy".equals(reservationEl.attributeValue("type"))) { 504 r = new DummyReservation(offering); 505 } else if ("override".equals(reservationEl.attributeValue("type"))) { 506 Set<Long> studentIds = new HashSet<Long>(); 507 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 508 Element studentEl = (Element)k.next(); 509 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 510 } 511 r = new ReservationOverride(Long.valueOf(reservationEl.attributeValue("id")), offering, studentIds); 512 } 513 if (r == null) { 514 sLogger.error("Unknown reservation type "+ reservationEl.attributeValue("type")); 515 return null; 516 } 517 r.setExpired("true".equals(reservationEl.attributeValue("expired", "false"))); 518 for (Iterator<?> k = reservationEl.elementIterator("config"); k.hasNext(); ) { 519 Element configEl = (Element)k.next(); 520 r.addConfig(configTable.get(Long.parseLong(configEl.attributeValue("id")))); 521 } 522 for (Iterator<?> k = reservationEl.elementIterator("section"); k.hasNext(); ) { 523 Element sectionEl = (Element)k.next(); 524 r.addSection(sectionTable.get(Long.parseLong(sectionEl.attributeValue("id")))); 525 } 526 r.setPriority(Integer.parseInt(reservationEl.attributeValue("priority", String.valueOf(r.getPriority())))); 527 r.setMustBeUsed("true".equals(reservationEl.attributeValue("mustBeUsed", r.mustBeUsed() ? "true" : "false"))); 528 r.setAllowOverlap("true".equals(reservationEl.attributeValue("allowOverlap", r.isAllowOverlap() ? "true" : "false"))); 529 r.setCanAssignOverLimit("true".equals(reservationEl.attributeValue("canAssignOverLimit", r.canAssignOverLimit() ? "true" : "false"))); 530 return r; 531 } 532 533 /** 534 * Load given timetable 535 * @param timetableRoot document root in the course timetabling XML format 536 * @return loaded timetable (map class id: assigned placement) 537 */ 538 protected Map<Long, Placement> loadTimetable(Element timetableRoot) { 539 Map<Long, Placement> timetable = new HashMap<Long, Placement>(); 540 HashMap<Long, RoomLocation> rooms = new HashMap<Long, RoomLocation>(); 541 for (Iterator<?> i = timetableRoot.element("rooms").elementIterator("room"); i.hasNext();) { 542 Element roomEl = (Element)i.next(); 543 Long roomId = Long.valueOf(roomEl.attributeValue("id")); 544 Double posX = null, posY = null; 545 if (roomEl.attributeValue("location") != null) { 546 String loc = roomEl.attributeValue("location"); 547 posX = Double.valueOf(loc.substring(0, loc.indexOf(','))); 548 posY = Double.valueOf(loc.substring(loc.indexOf(',') + 1)); 549 } 550 RoomLocation room = new RoomLocation( 551 Long.valueOf(roomEl.attributeValue("id")), 552 roomEl.attributeValue("name", "R" + roomEl.attributeValue("id")), 553 roomEl.attributeValue("building") == null ? null : Long.valueOf(roomEl.attributeValue("building")), 554 0, Integer.parseInt(roomEl.attributeValue("capacity")), 555 posX, posY, "true".equals(roomEl.attributeValue("ignoreTooFar")), null); 556 rooms.put(roomId, room); 557 } 558 for (Iterator<?> i = timetableRoot.element("classes").elementIterator("class"); i.hasNext();) { 559 Element classEl = (Element)i.next(); 560 Long classId = Long.valueOf(classEl.attributeValue("id")); 561 TimeLocation time = null; 562 Element timeEl = null; 563 for (Iterator<?> j = classEl.elementIterator("time"); j.hasNext(); ) { 564 Element e = (Element)j.next(); 565 if ("true".equals(e.attributeValue("solution", "false"))) { timeEl = e; break; } 566 } 567 if (timeEl != null) { 568 time = new TimeLocation( 569 Integer.parseInt(timeEl.attributeValue("days"), 2), 570 Integer.parseInt(timeEl.attributeValue("start")), 571 Integer.parseInt(timeEl.attributeValue("length")), 0, 0, 572 classEl.attributeValue("datePattern") == null ? null : Long.valueOf(classEl.attributeValue("datePattern")), 573 classEl.attributeValue("datePatternName", ""), createBitSet(classEl.attributeValue("dates")), 574 Integer.parseInt(timeEl.attributeValue("breakTime", "0"))); 575 if (timeEl.attributeValue("pattern") != null) 576 time.setTimePatternId(Long.valueOf(timeEl.attributeValue("pattern"))); 577 } 578 List<RoomLocation> room = new ArrayList<RoomLocation>(); 579 for (Iterator<?> j = classEl.elementIterator("room"); j.hasNext();) { 580 Element roomEl = (Element) j.next(); 581 if (!"true".equals(roomEl.attributeValue("solution", "false"))) continue; 582 room.add(rooms.get(Long.valueOf(roomEl.attributeValue("id")))); 583 } 584 Placement placement = (time == null ? null : new Placement(null, time, room)); 585 if (placement != null) 586 timetable.put(classId, placement); 587 } 588 return timetable; 589 } 590 591 /** 592 * Load travel times 593 * @param travelTimesEl travel-time element 594 * @param metric distance metric to be populated 595 */ 596 protected void loadTravelTimes(Element travelTimesEl, DistanceMetric metric) { 597 for (Iterator<?> i = travelTimesEl.elementIterator("travel-time"); i.hasNext();) { 598 Element travelTimeEl = (Element)i.next(); 599 metric.addTravelTime( 600 Long.valueOf(travelTimeEl.attributeValue("id1")), 601 Long.valueOf(travelTimeEl.attributeValue("id2")), 602 Integer.valueOf(travelTimeEl.attributeValue("minutes"))); 603 } 604 } 605 606 /** 607 * Load linked sections 608 * @param constraintsEl constraints element 609 * @param offeringTable offering table 610 */ 611 protected void loadLinkedSectiond(Element constraintsEl, Map<Long, Offering> offeringTable) { 612 for (Iterator<?> i = constraintsEl.elementIterator("linked-sections"); i.hasNext();) { 613 Element linkedEl = (Element) i.next(); 614 List<Section> sections = new ArrayList<Section>(); 615 for (Iterator<?> j = linkedEl.elementIterator("section"); j.hasNext();) { 616 Element sectionEl = (Element) j.next(); 617 Offering offering = offeringTable.get(Long.valueOf(sectionEl.attributeValue("offering"))); 618 sections.add(offering.getSection(Long.valueOf(sectionEl.attributeValue("id")))); 619 } 620 getModel().addLinkedSections(sections); 621 } 622 } 623 624 /** 625 * Load students 626 * @param studentsEl students element 627 * @param offeringTable offering table 628 * @param courseTable course table 629 */ 630 protected void loadStudents(Element studentsEl, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable) { 631 List<Enrollment> bestEnrollments = new ArrayList<Enrollment>(); 632 List<Enrollment> currentEnrollments = new ArrayList<Enrollment>(); 633 for (Iterator<?> i = studentsEl.elementIterator("student"); i.hasNext();) { 634 Element studentEl = (Element) i.next(); 635 Student student = loadStudent(studentEl); 636 if (iStudentFilter != null && !iStudentFilter.accept(student)) 637 continue; 638 for (Iterator<?> j = studentEl.elementIterator(); j.hasNext();) { 639 Element requestEl = (Element) j.next(); 640 Request request = loadRequest(requestEl, student, offeringTable, courseTable); 641 if (request == null) continue; 642 643 Element initialEl = requestEl.element("initial"); 644 if (iLoadInitial && initialEl != null) { 645 Enrollment enrollment = loadEnrollment(initialEl, request); 646 if (enrollment != null) 647 request.setInitialAssignment(enrollment); 648 } 649 Element currentEl = requestEl.element("current"); 650 if (iLoadCurrent && currentEl != null) { 651 Enrollment enrollment = loadEnrollment(currentEl, request); 652 if (enrollment != null) 653 currentEnrollments.add(enrollment); 654 } 655 Element bestEl = requestEl.element("best"); 656 if (iLoadBest && bestEl != null) { 657 Enrollment enrollment = loadEnrollment(bestEl, request); 658 if (enrollment != null) 659 bestEnrollments.add(enrollment); 660 } 661 } 662 getModel().addStudent(student); 663 } 664 665 if (!bestEnrollments.isEmpty()) { 666 // Enrollments with a reservation must go first 667 for (Enrollment enrollment : bestEnrollments) { 668 if (enrollment.getReservation() == null) continue; 669 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 670 if (conflicts.isEmpty()) 671 getAssignment().assign(0, enrollment); 672 else 673 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 674 } 675 for (Enrollment enrollment : bestEnrollments) { 676 if (enrollment.getReservation() != null) continue; 677 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 678 if (conflicts.isEmpty()) 679 getAssignment().assign(0, enrollment); 680 else 681 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 682 } 683 getModel().saveBest(getAssignment()); 684 } 685 686 if (!currentEnrollments.isEmpty()) { 687 for (Request request : getModel().variables()) 688 getAssignment().unassign(0, request); 689 // Enrollments with a reservation must go first 690 for (Enrollment enrollment : currentEnrollments) { 691 if (enrollment.getReservation() == null) continue; 692 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 693 if (conflicts.isEmpty()) 694 getAssignment().assign(0, enrollment); 695 else 696 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 697 } 698 for (Enrollment enrollment : currentEnrollments) { 699 if (enrollment.getReservation() != null) continue; 700 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 701 if (conflicts.isEmpty()) 702 getAssignment().assign(0, enrollment); 703 else 704 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 705 } 706 } 707 } 708 709 /** 710 * Load student 711 * @param studentEl student element 712 * @return loaded student 713 */ 714 protected Student loadStudent(Element studentEl) { 715 Student student = new Student(Long.parseLong(studentEl.attributeValue("id")), "true".equals(studentEl.attributeValue("dummy"))); 716 student.setExternalId(studentEl.attributeValue("externalId")); 717 student.setName(studentEl.attributeValue("name")); 718 student.setStatus(studentEl.attributeValue("status")); 719 for (Iterator<?> j = studentEl.elementIterator(); j.hasNext();) { 720 Element requestEl = (Element) j.next(); 721 if ("classification".equals(requestEl.getName())) { 722 student.getAcademicAreaClasiffications().add( 723 new AcademicAreaCode(requestEl.attributeValue("area"), requestEl.attributeValue("code"))); 724 } else if ("major".equals(requestEl.getName())) { 725 student.getMajors().add( 726 new AcademicAreaCode(requestEl.attributeValue("area"), requestEl.attributeValue("code"))); 727 } else if ("minor".equals(requestEl.getName())) { 728 student.getMinors().add( 729 new AcademicAreaCode(requestEl.attributeValue("area"), requestEl.attributeValue("code"))); 730 } 731 } 732 return student; 733 } 734 735 /** 736 * Load request 737 * @param requestEl request element 738 * @param student parent student 739 * @param offeringTable offering table 740 * @param courseTable course table 741 * @return loaded request 742 */ 743 protected Request loadRequest(Element requestEl, Student student, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable) { 744 if ("freeTime".equals(requestEl.getName())) { 745 return loadFreeTime(requestEl, student); 746 } else if ("course".equals(requestEl.getName())) { 747 return loadCourseRequest(requestEl, student, offeringTable, courseTable); 748 } else { 749 return null; 750 } 751 } 752 753 /** 754 * Load free time request 755 * @param requestEl request element 756 * @param student parent student 757 * @return loaded free time request 758 */ 759 public FreeTimeRequest loadFreeTime(Element requestEl, Student student) { 760 TimeLocation time = new TimeLocation(Integer.parseInt(requestEl.attributeValue("days"), 2), 761 Integer.parseInt(requestEl.attributeValue("start")), Integer.parseInt(requestEl 762 .attributeValue("length")), 0, 0, 763 requestEl.attributeValue("datePattern") == null ? null : Long.valueOf(requestEl 764 .attributeValue("datePattern")), "", createBitSet(requestEl 765 .attributeValue("dates")), 0); 766 FreeTimeRequest request = new FreeTimeRequest(Long.parseLong(requestEl.attributeValue("id")), 767 Integer.parseInt(requestEl.attributeValue("priority")), "true".equals(requestEl 768 .attributeValue("alternative")), student, time); 769 if (requestEl.attributeValue("weight") != null) 770 request.setWeight(Double.parseDouble(requestEl.attributeValue("weight"))); 771 return request; 772 } 773 774 /** 775 * Load course request 776 * @param requestEl request element 777 * @param student parent student 778 * @param offeringTable offering table 779 * @param courseTable course table 780 * @return loaded course request 781 */ 782 public CourseRequest loadCourseRequest(Element requestEl, Student student, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable) { 783 List<Course> courses = new ArrayList<Course>(); 784 courses.add(courseTable.get(Long.valueOf(requestEl.attributeValue("course")))); 785 for (Iterator<?> k = requestEl.elementIterator("alternative"); k.hasNext();) 786 courses.add(courseTable.get(Long.valueOf(((Element) k.next()).attributeValue("course")))); 787 Long timeStamp = null; 788 if (requestEl.attributeValue("timeStamp") != null) 789 timeStamp = Long.valueOf(requestEl.attributeValue("timeStamp")); 790 CourseRequest courseRequest = new CourseRequest( 791 Long.parseLong(requestEl.attributeValue("id")), 792 Integer.parseInt(requestEl.attributeValue("priority")), 793 "true".equals(requestEl.attributeValue("alternative")), 794 student, courses, 795 "true".equals(requestEl.attributeValue("waitlist", "false")), timeStamp); 796 if (requestEl.attributeValue("weight") != null) 797 courseRequest.setWeight(Double.parseDouble(requestEl.attributeValue("weight"))); 798 for (Iterator<?> k = requestEl.elementIterator("waitlisted"); k.hasNext();) { 799 Element choiceEl = (Element) k.next(); 800 courseRequest.getWaitlistedChoices().add( 801 new Choice(offeringTable.get(Long.valueOf(choiceEl.attributeValue("offering"))), choiceEl.getText())); 802 } 803 for (Iterator<?> k = requestEl.elementIterator("selected"); k.hasNext();) { 804 Element choiceEl = (Element) k.next(); 805 courseRequest.getSelectedChoices().add( 806 new Choice(offeringTable.get(Long.valueOf(choiceEl.attributeValue("offering"))), choiceEl.getText())); 807 } 808 groups: for (Iterator<?> k = requestEl.elementIterator("group"); k.hasNext();) { 809 Element groupEl = (Element) k.next(); 810 long gid = Long.parseLong(groupEl.attributeValue("id")); 811 String gname = groupEl.attributeValue("name", "g" + gid); 812 Course course = courseTable.get(Long.valueOf(groupEl.attributeValue("course"))); 813 for (RequestGroup g: course.getRequestGroups()) { 814 if (g.getId() == gid) { 815 courseRequest.addRequestGroup(g); 816 continue groups; 817 } 818 } 819 courseRequest.addRequestGroup(new RequestGroup(gid, gname, course)); 820 } 821 return courseRequest; 822 } 823 824 /** 825 * Load enrollment 826 * @param enrollmentEl enrollment element (current, best, or initial) 827 * @param request parent request 828 * @return loaded enrollment 829 */ 830 protected Enrollment loadEnrollment(Element enrollmentEl, Request request) { 831 if (request instanceof CourseRequest) { 832 CourseRequest courseRequest = (CourseRequest) request; 833 HashSet<Section> sections = new HashSet<Section>(); 834 for (Iterator<?> k = enrollmentEl.elementIterator("section"); k.hasNext();) { 835 Element sectionEl = (Element) k.next(); 836 Section section = courseRequest.getSection(Long.parseLong(sectionEl 837 .attributeValue("id"))); 838 sections.add(section); 839 } 840 Reservation reservation = null; 841 if (enrollmentEl.attributeValue("reservation", null) != null) { 842 long reservationId = Long.valueOf(enrollmentEl.attributeValue("reservation")); 843 for (Course course: courseRequest.getCourses()) 844 for (Reservation r: course.getOffering().getReservations()) 845 if (r.getId() == reservationId) { reservation = r; break; } 846 } 847 if (!sections.isEmpty()) 848 return courseRequest.createEnrollment(sections, reservation); 849 } else if (request instanceof FreeTimeRequest) { 850 return ((FreeTimeRequest)request).createEnrollment(); 851 } 852 return null; 853 } 854 855 856}