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 course.setCredit(courseEl.attributeValue("credit")); 327 return course; 328 } 329 330 /** 331 * Load config 332 * @param configEl config element 333 * @param offering parent offering 334 * @param subpartTable subpart table (of the offering) 335 * @param sectionTable section table (of the offering) 336 * @param timetable provided timetable 337 * @return loaded config 338 */ 339 protected Config loadConfig(Element configEl, Offering offering, Map<Long, Subpart> subpartTable, Map<Long, Section> sectionTable, Map<Long, Placement> timetable) { 340 Config config = new Config 341 (Long.parseLong(configEl.attributeValue("id")), 342 Integer.parseInt(configEl.attributeValue("limit", "-1")), 343 configEl.attributeValue("name", "G" + configEl.attributeValue("id")), 344 offering); 345 for (Iterator<?> k = configEl.elementIterator("subpart"); k.hasNext();) { 346 Element subpartEl = (Element) k.next(); 347 Subpart subpart = loadSubpart(subpartEl, config, subpartTable, sectionTable, timetable); 348 subpartTable.put(new Long(subpart.getId()), subpart); 349 } 350 return config; 351 } 352 353 /** 354 * Load subpart 355 * @param subpartEl supart element 356 * @param config parent config 357 * @param subpartTable subpart table (of the offering) 358 * @param sectionTable section table (of the offering) 359 * @param timetable provided timetable 360 * @return loaded subpart 361 */ 362 protected Subpart loadSubpart(Element subpartEl, Config config, Map<Long, Subpart> subpartTable, Map<Long, Section> sectionTable, Map<Long, Placement> timetable) { 363 Subpart parentSubpart = null; 364 if (subpartEl.attributeValue("parent") != null) 365 parentSubpart = subpartTable.get(Long.valueOf(subpartEl.attributeValue("parent"))); 366 Subpart subpart = new Subpart( 367 Long.parseLong(subpartEl.attributeValue("id")), 368 subpartEl.attributeValue("itype"), 369 subpartEl.attributeValue("name", "P" + subpartEl.attributeValue("id")), 370 config, 371 parentSubpart); 372 subpart.setAllowOverlap("true".equals(subpartEl.attributeValue("allowOverlap", "false"))); 373 subpart.setCredit(subpartEl.attributeValue("credit")); 374 375 for (Iterator<?> l = subpartEl.elementIterator("section"); l.hasNext();) { 376 Element sectionEl = (Element) l.next(); 377 Section section = loadSection(sectionEl, subpart, sectionTable, timetable); 378 sectionTable.put(new Long(section.getId()), section); 379 } 380 381 return subpart; 382 } 383 384 /** 385 * Load section 386 * @param sectionEl section element 387 * @param subpart parent subpart 388 * @param sectionTable section table (of the offering) 389 * @param timetable provided timetable 390 * @return loaded section 391 */ 392 protected Section loadSection(Element sectionEl, Subpart subpart, Map<Long, Section> sectionTable, Map<Long, Placement> timetable) { 393 Section parentSection = null; 394 if (sectionEl.attributeValue("parent") != null) 395 parentSection = sectionTable.get(Long.valueOf(sectionEl.attributeValue("parent"))); 396 Placement placement = null; 397 if (timetable != null) { 398 placement = timetable.get(Long.parseLong(sectionEl.attributeValue("id"))); 399 } else { 400 TimeLocation time = null; 401 Element timeEl = sectionEl.element("time"); 402 if (timeEl != null) { 403 time = new TimeLocation( 404 Integer.parseInt(timeEl.attributeValue("days"), 2), 405 Integer.parseInt(timeEl.attributeValue("start")), 406 Integer.parseInt(timeEl.attributeValue("length")), 0, 0, 407 timeEl.attributeValue("datePattern") == null ? null : Long.valueOf(timeEl.attributeValue("datePattern")), 408 timeEl.attributeValue("datePatternName", ""), 409 createBitSet(timeEl.attributeValue("dates")), 410 Integer.parseInt(timeEl.attributeValue("breakTime", "0"))); 411 if (timeEl.attributeValue("pattern") != null) 412 time.setTimePatternId(Long.valueOf(timeEl.attributeValue("pattern"))); 413 } 414 List<RoomLocation> rooms = new ArrayList<RoomLocation>(); 415 for (Iterator<?> m = sectionEl.elementIterator("room"); m.hasNext();) { 416 Element roomEl = (Element) m.next(); 417 Double posX = null, posY = null; 418 if (roomEl.attributeValue("location") != null) { 419 String loc = roomEl.attributeValue("location"); 420 posX = Double.valueOf(loc.substring(0, loc.indexOf(','))); 421 posY = Double.valueOf(loc.substring(loc.indexOf(',') + 1)); 422 } 423 RoomLocation room = new RoomLocation( 424 Long.valueOf(roomEl.attributeValue("id")), 425 roomEl.attributeValue("name", "R" + roomEl.attributeValue("id")), 426 roomEl.attributeValue("building") == null ? null : Long.valueOf(roomEl.attributeValue("building")), 427 0, Integer.parseInt(roomEl.attributeValue("capacity")), 428 posX, posY, "true".equals(roomEl.attributeValue("ignoreTooFar")), null); 429 rooms.add(room); 430 } 431 placement = (time == null ? null : new Placement(null, time, rooms)); 432 } 433 434 Section section = new Section( 435 Long.parseLong(sectionEl.attributeValue("id")), 436 Integer.parseInt(sectionEl.attributeValue("limit")), 437 sectionEl.attributeValue("name", "S" + sectionEl.attributeValue("id")), 438 subpart, placement, sectionEl.attributeValue("instructorIds"), 439 sectionEl.attributeValue("instructorNames"), parentSection); 440 441 section.setSpaceHeld(Double.parseDouble(sectionEl.attributeValue("hold", "0.0"))); 442 section.setSpaceExpected(Double.parseDouble(sectionEl.attributeValue("expect", "0.0"))); 443 section.setCancelled("true".equalsIgnoreCase(sectionEl.attributeValue("cancelled", "false"))); 444 for (Iterator<?> m = sectionEl.elementIterator("cname"); m.hasNext(); ) { 445 Element cNameEl = (Element)m.next(); 446 section.setName(Long.parseLong(cNameEl.attributeValue("id")), cNameEl.getText()); 447 } 448 Element ignoreEl = sectionEl.element("no-conflicts"); 449 if (ignoreEl != null) { 450 for (Iterator<?> m = ignoreEl.elementIterator("section"); m.hasNext(); ) 451 section.addIgnoreConflictWith(Long.parseLong(((Element)m.next()).attributeValue("id"))); 452 } 453 454 return section; 455 } 456 457 /** 458 * Load reservation 459 * @param reservationEl reservation element 460 * @param offering parent offering 461 * @param configTable config table (of the offering) 462 * @param sectionTable section table (of the offering) 463 * @return loaded reservation 464 */ 465 protected Reservation loadReservation(Element reservationEl, Offering offering, HashMap<Long, Config> configTable, HashMap<Long, Section> sectionTable) { 466 Reservation r = null; 467 if ("individual".equals(reservationEl.attributeValue("type"))) { 468 Set<Long> studentIds = new HashSet<Long>(); 469 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 470 Element studentEl = (Element)k.next(); 471 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 472 } 473 r = new IndividualReservation(Long.valueOf(reservationEl.attributeValue("id")), offering, studentIds); 474 } else if ("group".equals(reservationEl.attributeValue("type"))) { 475 Set<Long> studentIds = new HashSet<Long>(); 476 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 477 Element studentEl = (Element)k.next(); 478 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 479 } 480 r = new GroupReservation(Long.valueOf(reservationEl.attributeValue("id")), 481 Double.parseDouble(reservationEl.attributeValue("limit", "-1")), 482 offering, studentIds); 483 } else if ("curriculum".equals(reservationEl.attributeValue("type"))) { 484 List<String> classifications = new ArrayList<String>(); 485 for (Iterator<?> k = reservationEl.elementIterator("classification"); k.hasNext(); ) { 486 Element clasfEl = (Element)k.next(); 487 classifications.add(clasfEl.attributeValue("code")); 488 } 489 List<String> majors = new ArrayList<String>(); 490 for (Iterator<?> k = reservationEl.elementIterator("major"); k.hasNext(); ) { 491 Element majorEl = (Element)k.next(); 492 majors.add(majorEl.attributeValue("code")); 493 } 494 r = new CurriculumReservation(Long.valueOf(reservationEl.attributeValue("id")), 495 Double.parseDouble(reservationEl.attributeValue("limit", "-1")), 496 offering, 497 reservationEl.attributeValue("area"), 498 classifications, majors); 499 } else if ("course".equals(reservationEl.attributeValue("type"))) { 500 long courseId = Long.parseLong(reservationEl.attributeValue("course")); 501 for (Course course: offering.getCourses()) { 502 if (course.getId() == courseId) 503 r = new CourseReservation(Long.valueOf(reservationEl.attributeValue("id")), course); 504 } 505 } else if ("dummy".equals(reservationEl.attributeValue("type"))) { 506 r = new DummyReservation(offering); 507 } else if ("override".equals(reservationEl.attributeValue("type"))) { 508 Set<Long> studentIds = new HashSet<Long>(); 509 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 510 Element studentEl = (Element)k.next(); 511 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 512 } 513 r = new ReservationOverride(Long.valueOf(reservationEl.attributeValue("id")), offering, studentIds); 514 } 515 if (r == null) { 516 sLogger.error("Unknown reservation type "+ reservationEl.attributeValue("type")); 517 return null; 518 } 519 r.setExpired("true".equals(reservationEl.attributeValue("expired", "false"))); 520 for (Iterator<?> k = reservationEl.elementIterator("config"); k.hasNext(); ) { 521 Element configEl = (Element)k.next(); 522 r.addConfig(configTable.get(Long.parseLong(configEl.attributeValue("id")))); 523 } 524 for (Iterator<?> k = reservationEl.elementIterator("section"); k.hasNext(); ) { 525 Element sectionEl = (Element)k.next(); 526 r.addSection(sectionTable.get(Long.parseLong(sectionEl.attributeValue("id")))); 527 } 528 r.setPriority(Integer.parseInt(reservationEl.attributeValue("priority", String.valueOf(r.getPriority())))); 529 r.setMustBeUsed("true".equals(reservationEl.attributeValue("mustBeUsed", r.mustBeUsed() ? "true" : "false"))); 530 r.setAllowOverlap("true".equals(reservationEl.attributeValue("allowOverlap", r.isAllowOverlap() ? "true" : "false"))); 531 r.setCanAssignOverLimit("true".equals(reservationEl.attributeValue("canAssignOverLimit", r.canAssignOverLimit() ? "true" : "false"))); 532 return r; 533 } 534 535 /** 536 * Load given timetable 537 * @param timetableRoot document root in the course timetabling XML format 538 * @return loaded timetable (map class id: assigned placement) 539 */ 540 protected Map<Long, Placement> loadTimetable(Element timetableRoot) { 541 Map<Long, Placement> timetable = new HashMap<Long, Placement>(); 542 HashMap<Long, RoomLocation> rooms = new HashMap<Long, RoomLocation>(); 543 for (Iterator<?> i = timetableRoot.element("rooms").elementIterator("room"); i.hasNext();) { 544 Element roomEl = (Element)i.next(); 545 Long roomId = Long.valueOf(roomEl.attributeValue("id")); 546 Double posX = null, posY = null; 547 if (roomEl.attributeValue("location") != null) { 548 String loc = roomEl.attributeValue("location"); 549 posX = Double.valueOf(loc.substring(0, loc.indexOf(','))); 550 posY = Double.valueOf(loc.substring(loc.indexOf(',') + 1)); 551 } 552 RoomLocation room = new RoomLocation( 553 Long.valueOf(roomEl.attributeValue("id")), 554 roomEl.attributeValue("name", "R" + roomEl.attributeValue("id")), 555 roomEl.attributeValue("building") == null ? null : Long.valueOf(roomEl.attributeValue("building")), 556 0, Integer.parseInt(roomEl.attributeValue("capacity")), 557 posX, posY, "true".equals(roomEl.attributeValue("ignoreTooFar")), null); 558 rooms.put(roomId, room); 559 } 560 for (Iterator<?> i = timetableRoot.element("classes").elementIterator("class"); i.hasNext();) { 561 Element classEl = (Element)i.next(); 562 Long classId = Long.valueOf(classEl.attributeValue("id")); 563 TimeLocation time = null; 564 Element timeEl = null; 565 for (Iterator<?> j = classEl.elementIterator("time"); j.hasNext(); ) { 566 Element e = (Element)j.next(); 567 if ("true".equals(e.attributeValue("solution", "false"))) { timeEl = e; break; } 568 } 569 if (timeEl != null) { 570 time = new TimeLocation( 571 Integer.parseInt(timeEl.attributeValue("days"), 2), 572 Integer.parseInt(timeEl.attributeValue("start")), 573 Integer.parseInt(timeEl.attributeValue("length")), 0, 0, 574 classEl.attributeValue("datePattern") == null ? null : Long.valueOf(classEl.attributeValue("datePattern")), 575 classEl.attributeValue("datePatternName", ""), createBitSet(classEl.attributeValue("dates")), 576 Integer.parseInt(timeEl.attributeValue("breakTime", "0"))); 577 if (timeEl.attributeValue("pattern") != null) 578 time.setTimePatternId(Long.valueOf(timeEl.attributeValue("pattern"))); 579 } 580 List<RoomLocation> room = new ArrayList<RoomLocation>(); 581 for (Iterator<?> j = classEl.elementIterator("room"); j.hasNext();) { 582 Element roomEl = (Element) j.next(); 583 if (!"true".equals(roomEl.attributeValue("solution", "false"))) continue; 584 room.add(rooms.get(Long.valueOf(roomEl.attributeValue("id")))); 585 } 586 Placement placement = (time == null ? null : new Placement(null, time, room)); 587 if (placement != null) 588 timetable.put(classId, placement); 589 } 590 return timetable; 591 } 592 593 /** 594 * Load travel times 595 * @param travelTimesEl travel-time element 596 * @param metric distance metric to be populated 597 */ 598 protected void loadTravelTimes(Element travelTimesEl, DistanceMetric metric) { 599 for (Iterator<?> i = travelTimesEl.elementIterator("travel-time"); i.hasNext();) { 600 Element travelTimeEl = (Element)i.next(); 601 metric.addTravelTime( 602 Long.valueOf(travelTimeEl.attributeValue("id1")), 603 Long.valueOf(travelTimeEl.attributeValue("id2")), 604 Integer.valueOf(travelTimeEl.attributeValue("minutes"))); 605 } 606 } 607 608 /** 609 * Load linked sections 610 * @param constraintsEl constraints element 611 * @param offeringTable offering table 612 */ 613 protected void loadLinkedSectiond(Element constraintsEl, Map<Long, Offering> offeringTable) { 614 for (Iterator<?> i = constraintsEl.elementIterator("linked-sections"); i.hasNext();) { 615 Element linkedEl = (Element) i.next(); 616 List<Section> sections = new ArrayList<Section>(); 617 for (Iterator<?> j = linkedEl.elementIterator("section"); j.hasNext();) { 618 Element sectionEl = (Element) j.next(); 619 Offering offering = offeringTable.get(Long.valueOf(sectionEl.attributeValue("offering"))); 620 sections.add(offering.getSection(Long.valueOf(sectionEl.attributeValue("id")))); 621 } 622 getModel().addLinkedSections(sections); 623 } 624 } 625 626 /** 627 * Load students 628 * @param studentsEl students element 629 * @param offeringTable offering table 630 * @param courseTable course table 631 */ 632 protected void loadStudents(Element studentsEl, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable) { 633 List<Enrollment> bestEnrollments = new ArrayList<Enrollment>(); 634 List<Enrollment> currentEnrollments = new ArrayList<Enrollment>(); 635 for (Iterator<?> i = studentsEl.elementIterator("student"); i.hasNext();) { 636 Element studentEl = (Element) i.next(); 637 Student student = loadStudent(studentEl); 638 if (iStudentFilter != null && !iStudentFilter.accept(student)) 639 continue; 640 for (Iterator<?> j = studentEl.elementIterator(); j.hasNext();) { 641 Element requestEl = (Element) j.next(); 642 Request request = loadRequest(requestEl, student, offeringTable, courseTable); 643 if (request == null) continue; 644 645 Element initialEl = requestEl.element("initial"); 646 if (iLoadInitial && initialEl != null) { 647 Enrollment enrollment = loadEnrollment(initialEl, request); 648 if (enrollment != null) 649 request.setInitialAssignment(enrollment); 650 } 651 Element currentEl = requestEl.element("current"); 652 if (iLoadCurrent && currentEl != null) { 653 Enrollment enrollment = loadEnrollment(currentEl, request); 654 if (enrollment != null) 655 currentEnrollments.add(enrollment); 656 } 657 Element bestEl = requestEl.element("best"); 658 if (iLoadBest && bestEl != null) { 659 Enrollment enrollment = loadEnrollment(bestEl, request); 660 if (enrollment != null) 661 bestEnrollments.add(enrollment); 662 } 663 } 664 getModel().addStudent(student); 665 } 666 667 if (!bestEnrollments.isEmpty()) { 668 // Enrollments with a reservation must go first 669 for (Enrollment enrollment : bestEnrollments) { 670 if (enrollment.getReservation() == null) continue; 671 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 672 if (conflicts.isEmpty()) 673 getAssignment().assign(0, enrollment); 674 else 675 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 676 } 677 for (Enrollment enrollment : bestEnrollments) { 678 if (enrollment.getReservation() != null) continue; 679 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 680 if (conflicts.isEmpty()) 681 getAssignment().assign(0, enrollment); 682 else 683 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 684 } 685 getModel().saveBest(getAssignment()); 686 } 687 688 if (!currentEnrollments.isEmpty()) { 689 for (Request request : getModel().variables()) 690 getAssignment().unassign(0, request); 691 // Enrollments with a reservation must go first 692 for (Enrollment enrollment : currentEnrollments) { 693 if (enrollment.getReservation() == null) continue; 694 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 695 if (conflicts.isEmpty()) 696 getAssignment().assign(0, enrollment); 697 else 698 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 699 } 700 for (Enrollment enrollment : currentEnrollments) { 701 if (enrollment.getReservation() != null) continue; 702 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 703 if (conflicts.isEmpty()) 704 getAssignment().assign(0, enrollment); 705 else 706 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 707 } 708 } 709 } 710 711 /** 712 * Load student 713 * @param studentEl student element 714 * @return loaded student 715 */ 716 protected Student loadStudent(Element studentEl) { 717 Student student = new Student(Long.parseLong(studentEl.attributeValue("id")), "true".equals(studentEl.attributeValue("dummy"))); 718 student.setExternalId(studentEl.attributeValue("externalId")); 719 student.setName(studentEl.attributeValue("name")); 720 student.setStatus(studentEl.attributeValue("status")); 721 for (Iterator<?> j = studentEl.elementIterator(); j.hasNext();) { 722 Element requestEl = (Element) j.next(); 723 if ("classification".equals(requestEl.getName())) { 724 student.getAcademicAreaClasiffications().add( 725 new AcademicAreaCode(requestEl.attributeValue("area"), requestEl.attributeValue("code"))); 726 } else if ("major".equals(requestEl.getName())) { 727 student.getMajors().add( 728 new AcademicAreaCode(requestEl.attributeValue("area"), requestEl.attributeValue("code"))); 729 } else if ("minor".equals(requestEl.getName())) { 730 student.getMinors().add( 731 new AcademicAreaCode(requestEl.attributeValue("area"), requestEl.attributeValue("code"))); 732 } 733 } 734 return student; 735 } 736 737 /** 738 * Load request 739 * @param requestEl request element 740 * @param student parent student 741 * @param offeringTable offering table 742 * @param courseTable course table 743 * @return loaded request 744 */ 745 protected Request loadRequest(Element requestEl, Student student, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable) { 746 if ("freeTime".equals(requestEl.getName())) { 747 return loadFreeTime(requestEl, student); 748 } else if ("course".equals(requestEl.getName())) { 749 return loadCourseRequest(requestEl, student, offeringTable, courseTable); 750 } else { 751 return null; 752 } 753 } 754 755 /** 756 * Load free time request 757 * @param requestEl request element 758 * @param student parent student 759 * @return loaded free time request 760 */ 761 public FreeTimeRequest loadFreeTime(Element requestEl, Student student) { 762 TimeLocation time = new TimeLocation(Integer.parseInt(requestEl.attributeValue("days"), 2), 763 Integer.parseInt(requestEl.attributeValue("start")), Integer.parseInt(requestEl 764 .attributeValue("length")), 0, 0, 765 requestEl.attributeValue("datePattern") == null ? null : Long.valueOf(requestEl 766 .attributeValue("datePattern")), "", createBitSet(requestEl 767 .attributeValue("dates")), 0); 768 FreeTimeRequest request = new FreeTimeRequest(Long.parseLong(requestEl.attributeValue("id")), 769 Integer.parseInt(requestEl.attributeValue("priority")), "true".equals(requestEl 770 .attributeValue("alternative")), student, time); 771 if (requestEl.attributeValue("weight") != null) 772 request.setWeight(Double.parseDouble(requestEl.attributeValue("weight"))); 773 return request; 774 } 775 776 /** 777 * Load course request 778 * @param requestEl request element 779 * @param student parent student 780 * @param offeringTable offering table 781 * @param courseTable course table 782 * @return loaded course request 783 */ 784 public CourseRequest loadCourseRequest(Element requestEl, Student student, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable) { 785 List<Course> courses = new ArrayList<Course>(); 786 courses.add(courseTable.get(Long.valueOf(requestEl.attributeValue("course")))); 787 for (Iterator<?> k = requestEl.elementIterator("alternative"); k.hasNext();) 788 courses.add(courseTable.get(Long.valueOf(((Element) k.next()).attributeValue("course")))); 789 Long timeStamp = null; 790 if (requestEl.attributeValue("timeStamp") != null) 791 timeStamp = Long.valueOf(requestEl.attributeValue("timeStamp")); 792 CourseRequest courseRequest = new CourseRequest( 793 Long.parseLong(requestEl.attributeValue("id")), 794 Integer.parseInt(requestEl.attributeValue("priority")), 795 "true".equals(requestEl.attributeValue("alternative")), 796 student, courses, 797 "true".equals(requestEl.attributeValue("waitlist", "false")), timeStamp); 798 if (requestEl.attributeValue("weight") != null) 799 courseRequest.setWeight(Double.parseDouble(requestEl.attributeValue("weight"))); 800 for (Iterator<?> k = requestEl.elementIterator("waitlisted"); k.hasNext();) { 801 Element choiceEl = (Element) k.next(); 802 courseRequest.getWaitlistedChoices().add( 803 new Choice(offeringTable.get(Long.valueOf(choiceEl.attributeValue("offering"))), choiceEl.getText())); 804 } 805 for (Iterator<?> k = requestEl.elementIterator("selected"); k.hasNext();) { 806 Element choiceEl = (Element) k.next(); 807 courseRequest.getSelectedChoices().add( 808 new Choice(offeringTable.get(Long.valueOf(choiceEl.attributeValue("offering"))), choiceEl.getText())); 809 } 810 groups: for (Iterator<?> k = requestEl.elementIterator("group"); k.hasNext();) { 811 Element groupEl = (Element) k.next(); 812 long gid = Long.parseLong(groupEl.attributeValue("id")); 813 String gname = groupEl.attributeValue("name", "g" + gid); 814 Course course = courseTable.get(Long.valueOf(groupEl.attributeValue("course"))); 815 for (RequestGroup g: course.getRequestGroups()) { 816 if (g.getId() == gid) { 817 courseRequest.addRequestGroup(g); 818 continue groups; 819 } 820 } 821 courseRequest.addRequestGroup(new RequestGroup(gid, gname, course)); 822 } 823 return courseRequest; 824 } 825 826 /** 827 * Load enrollment 828 * @param enrollmentEl enrollment element (current, best, or initial) 829 * @param request parent request 830 * @return loaded enrollment 831 */ 832 protected Enrollment loadEnrollment(Element enrollmentEl, Request request) { 833 if (request instanceof CourseRequest) { 834 CourseRequest courseRequest = (CourseRequest) request; 835 HashSet<Section> sections = new HashSet<Section>(); 836 for (Iterator<?> k = enrollmentEl.elementIterator("section"); k.hasNext();) { 837 Element sectionEl = (Element) k.next(); 838 Section section = courseRequest.getSection(Long.parseLong(sectionEl 839 .attributeValue("id"))); 840 sections.add(section); 841 } 842 Reservation reservation = null; 843 if (enrollmentEl.attributeValue("reservation", null) != null) { 844 long reservationId = Long.valueOf(enrollmentEl.attributeValue("reservation")); 845 for (Course course: courseRequest.getCourses()) 846 for (Reservation r: course.getOffering().getReservations()) 847 if (r.getId() == reservationId) { reservation = r; break; } 848 } 849 if (!sections.isEmpty()) 850 return courseRequest.createEnrollment(sections, reservation); 851 } else if (request instanceof FreeTimeRequest) { 852 return ((FreeTimeRequest)request).createEnrollment(); 853 } 854 return null; 855 } 856 857 858}