001package org.cpsolver.studentsct; 002 003import java.io.File; 004import java.util.ArrayList; 005import java.util.BitSet; 006import java.util.Collections; 007import java.util.Comparator; 008import java.util.HashSet; 009import java.util.HashMap; 010import java.util.Iterator; 011import java.util.List; 012import java.util.Map; 013import java.util.Set; 014 015import org.cpsolver.coursett.model.Placement; 016import org.cpsolver.coursett.model.RoomLocation; 017import org.cpsolver.coursett.model.TimeLocation; 018import org.cpsolver.ifs.assignment.Assignment; 019import org.cpsolver.ifs.model.Constraint; 020import org.cpsolver.ifs.util.DistanceMetric; 021import org.cpsolver.ifs.util.Progress; 022import org.cpsolver.studentsct.constraint.FixedAssignments; 023import org.cpsolver.studentsct.filter.StudentFilter; 024import org.cpsolver.studentsct.model.AreaClassificationMajor; 025import org.cpsolver.studentsct.model.Choice; 026import org.cpsolver.studentsct.model.Config; 027import org.cpsolver.studentsct.model.Course; 028import org.cpsolver.studentsct.model.CourseRequest; 029import org.cpsolver.studentsct.model.Enrollment; 030import org.cpsolver.studentsct.model.FreeTimeRequest; 031import org.cpsolver.studentsct.model.Instructor; 032import org.cpsolver.studentsct.model.Offering; 033import org.cpsolver.studentsct.model.Request; 034import org.cpsolver.studentsct.model.Request.RequestPriority; 035import org.cpsolver.studentsct.model.Student.BackToBackPreference; 036import org.cpsolver.studentsct.model.Student.ModalityPreference; 037import org.cpsolver.studentsct.model.Student.StudentPriority; 038import org.cpsolver.studentsct.model.RequestGroup; 039import org.cpsolver.studentsct.model.Section; 040import org.cpsolver.studentsct.model.Student; 041import org.cpsolver.studentsct.model.StudentGroup; 042import org.cpsolver.studentsct.model.Subpart; 043import org.cpsolver.studentsct.model.Unavailability; 044import org.cpsolver.studentsct.reservation.CourseReservation; 045import org.cpsolver.studentsct.reservation.CourseRestriction; 046import org.cpsolver.studentsct.reservation.CurriculumOverride; 047import org.cpsolver.studentsct.reservation.CurriculumReservation; 048import org.cpsolver.studentsct.reservation.CurriculumRestriction; 049import org.cpsolver.studentsct.reservation.DummyReservation; 050import org.cpsolver.studentsct.reservation.GroupReservation; 051import org.cpsolver.studentsct.reservation.IndividualReservation; 052import org.cpsolver.studentsct.reservation.IndividualRestriction; 053import org.cpsolver.studentsct.reservation.LearningCommunityReservation; 054import org.cpsolver.studentsct.reservation.Reservation; 055import org.cpsolver.studentsct.reservation.ReservationOverride; 056import org.cpsolver.studentsct.reservation.Restriction; 057import org.dom4j.Document; 058import org.dom4j.DocumentException; 059import org.dom4j.Element; 060import org.dom4j.io.SAXReader; 061 062/** 063 * Load student sectioning model from an XML file. 064 * 065 * <br> 066 * <br> 067 * Parameters: 068 * <table border='1' summary='Related Solver Parameters'> 069 * <tr> 070 * <th>Parameter</th> 071 * <th>Type</th> 072 * <th>Comment</th> 073 * </tr> 074 * <tr> 075 * <td>General.Input</td> 076 * <td>{@link String}</td> 077 * <td>Path of an XML file to be loaded</td> 078 * </tr> 079 * <tr> 080 * <td>Xml.LoadBest</td> 081 * <td>{@link Boolean}</td> 082 * <td>If true, load best assignments</td> 083 * </tr> 084 * <tr> 085 * <td>Xml.LoadInitial</td> 086 * <td>{@link Boolean}</td> 087 * <td>If false, load initial assignments</td> 088 * </tr> 089 * <tr> 090 * <td>Xml.LoadCurrent</td> 091 * <td>{@link Boolean}</td> 092 * <td>If true, load current assignments</td> 093 * </tr> 094 * <tr> 095 * <td>Xml.LoadOfferings</td> 096 * <td>{@link Boolean}</td> 097 * <td>If true, load offerings (and their stucture, i.e., courses, 098 * configurations, subparts and sections)</td> 099 * </tr> 100 * <tr> 101 * <td>Xml.LoadStudents</td> 102 * <td>{@link Boolean}</td> 103 * <td>If true, load students (and their requests)</td> 104 * </tr> 105 * <tr> 106 * <td>Xml.StudentFilter</td> 107 * <td>{@link StudentFilter}</td> 108 * <td>If provided, students are filtered by the given student filter</td> 109 * </tr> 110 * </table> 111 * 112 * <br> 113 * <br> 114 * Usage: 115 * <pre><code> 116 * StudentSectioningModel model = new StudentSectioningModel(cfg);<br> 117 * new StudentSectioningXMLLoader(model).load();<br> 118 * </code></pre> 119 * 120 * @version StudentSct 1.3 (Student Sectioning)<br> 121 * Copyright (C) 2007 - 2014 Tomáš Müller<br> 122 * <a href="mailto:muller@unitime.org">muller@unitime.org</a><br> 123 * <a href="http://muller.unitime.org">http://muller.unitime.org</a><br> 124 * <br> 125 * This library is free software; you can redistribute it and/or modify 126 * it under the terms of the GNU Lesser General Public License as 127 * published by the Free Software Foundation; either version 3 of the 128 * License, or (at your option) any later version. <br> 129 * <br> 130 * This library is distributed in the hope that it will be useful, but 131 * WITHOUT ANY WARRANTY; without even the implied warranty of 132 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 133 * Lesser General Public License for more details. <br> 134 * <br> 135 * You should have received a copy of the GNU Lesser General Public 136 * License along with this library; if not see 137 * <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>. 138 */ 139 140public class StudentSectioningXMLLoader extends StudentSectioningLoader { 141 private static org.apache.logging.log4j.Logger sLogger = org.apache.logging.log4j.LogManager.getLogger(StudentSectioningXMLLoader.class); 142 143 private File iInputFile; 144 private File iTimetableFile = null; 145 private boolean iLoadBest = false; 146 private boolean iLoadInitial = false; 147 private boolean iLoadCurrent = false; 148 private boolean iLoadOfferings = true; 149 private boolean iLoadStudents = true; 150 private StudentFilter iStudentFilter = null; 151 private boolean iWaitlistCritical = false; 152 private boolean iMoveCriticalUp = false; 153 154 /** 155 * Constructor 156 * 157 * @param model 158 * student sectioning model 159 * @param assignment current assignment 160 */ 161 public StudentSectioningXMLLoader(StudentSectioningModel model, Assignment<Request, Enrollment> assignment) { 162 super(model, assignment); 163 iInputFile = new File(getModel().getProperties().getProperty("General.Input", 164 "." + File.separator + "solution.xml")); 165 if (getModel().getProperties().getProperty("General.InputTimetable") != null) 166 iTimetableFile = new File(getModel().getProperties().getProperty("General.InputTimetable")); 167 iLoadBest = getModel().getProperties().getPropertyBoolean("Xml.LoadBest", true); 168 iLoadInitial = getModel().getProperties().getPropertyBoolean("Xml.LoadInitial", true); 169 iLoadCurrent = getModel().getProperties().getPropertyBoolean("Xml.LoadCurrent", true); 170 iLoadOfferings = getModel().getProperties().getPropertyBoolean("Xml.LoadOfferings", true); 171 iLoadStudents = getModel().getProperties().getPropertyBoolean("Xml.LoadStudents", true); 172 iWaitlistCritical = getModel().getProperties().getPropertyBoolean("Xml.WaitlistCritical", false); 173 iMoveCriticalUp = getModel().getProperties().getPropertyBoolean("Xml.MoveCriticalUp", false); 174 if (getModel().getProperties().getProperty("Xml.StudentFilter") != null) { 175 try { 176 iStudentFilter = (StudentFilter) Class.forName( 177 getModel().getProperties().getProperty("Xml.StudentFilter")).getConstructor(new Class[] {}) 178 .newInstance(new Object[] {}); 179 } catch (Exception e) { 180 sLogger.error("Unable to create student filter, reason: " + e.getMessage(), e); 181 } 182 } 183 } 184 185 /** Set input file (e.g., if it is not set by General.Input property) 186 * @param inputFile input file 187 **/ 188 public void setInputFile(File inputFile) { 189 iInputFile = inputFile; 190 } 191 192 /** Set student filter 193 * @param filter student filter 194 **/ 195 public void setStudentFilter(StudentFilter filter) { 196 iStudentFilter = filter; 197 } 198 199 /** Set whether to load students 200 * @param loadStudents true if students are to be loaded 201 **/ 202 public void setLoadStudents(boolean loadStudents) { 203 iLoadStudents = loadStudents; 204 } 205 206 /** Set whether to load offerings 207 * @param loadOfferings true if instructional offerings are to be loaded 208 **/ 209 public void setLoadOfferings(boolean loadOfferings) { 210 iLoadOfferings = loadOfferings; 211 } 212 213 /** Create BitSet from a bit string */ 214 private static BitSet createBitSet(String bitString) { 215 BitSet ret = new BitSet(bitString.length()); 216 for (int i = 0; i < bitString.length(); i++) 217 if (bitString.charAt(i) == '1') 218 ret.set(i); 219 return ret; 220 } 221 222 /** Load the file */ 223 @Override 224 public void load() throws Exception { 225 sLogger.debug("Reading XML data from " + iInputFile); 226 227 Document document = (new SAXReader()).read(iInputFile); 228 Element root = document.getRootElement(); 229 230 load(root); 231 } 232 233 public void load(Document document) { 234 Element root = document.getRootElement(); 235 236 if (getModel() != null && root.element("travel-times") != null) 237 loadTravelTimes(root.element("travel-times"), getModel().getDistanceMetric()); 238 239 Progress.getInstance(getModel()).load(root, true); 240 Progress.getInstance(getModel()).message(Progress.MSGLEVEL_STAGE, "Restoring from backup ..."); 241 242 Map<Long, Offering> offeringTable = new HashMap<Long, Offering>(); 243 Map<Long, Course> courseTable = new HashMap<Long, Course>(); 244 245 if (root.element("offerings") != null) { 246 loadOfferings(root.element("offerings"), offeringTable, courseTable, null); 247 } 248 249 List<Enrollment> bestEnrollments = new ArrayList<Enrollment>(); 250 List<Enrollment> currentEnrollments = new ArrayList<Enrollment>(); 251 if (root.element("students") != null) { 252 loadStudents(root.element("students"), offeringTable, courseTable, bestEnrollments, currentEnrollments); 253 } 254 255 if (root.element("constraints") != null) 256 loadLinkedSections(root.element("constraints"), offeringTable); 257 258 if (!bestEnrollments.isEmpty()) assignBest(bestEnrollments); 259 if (!currentEnrollments.isEmpty()) assignCurrent(currentEnrollments); 260 261 if (iMoveCriticalUp) moveCriticalRequestsUp(); 262 263 boolean hasFixed = false; 264 for (Request r: getModel().variables()) { 265 if (r instanceof CourseRequest && ((CourseRequest)r).isFixed()) { 266 hasFixed = true; break; 267 } 268 } 269 if (hasFixed) 270 getModel().addGlobalConstraint(new FixedAssignments()); 271 } 272 273 /** 274 * Load data from the given XML root 275 * @param root document root 276 * @throws DocumentException 277 */ 278 protected void load(Element root) throws DocumentException { 279 sLogger.debug("Root element: " + root.getName()); 280 if (!"sectioning".equals(root.getName())) { 281 sLogger.error("Given XML file is not student sectioning problem."); 282 return; 283 } 284 285 if (iLoadOfferings && getModel().getDistanceConflict() != null && root.element("travel-times") != null) 286 loadTravelTimes(root.element("travel-times"), getModel().getDistanceConflict().getDistanceMetric()); 287 288 Map<Long, Placement> timetable = null; 289 if (iTimetableFile != null) { 290 sLogger.info("Reading timetable from " + iTimetableFile + " ..."); 291 Document timetableDocument = (new SAXReader()).read(iTimetableFile); 292 Element timetableRoot = timetableDocument.getRootElement(); 293 if (!"timetable".equals(timetableRoot.getName())) { 294 sLogger.error("Given XML file is not course timetabling problem."); 295 return; 296 } 297 timetable = loadTimetable(timetableRoot); 298 } 299 300 Progress.getInstance(getModel()).load(root, true); 301 Progress.getInstance(getModel()).message(Progress.MSGLEVEL_STAGE, "Restoring from backup ..."); 302 303 if (root.attributeValue("term") != null) 304 getModel().getProperties().setProperty("Data.Term", root.attributeValue("term")); 305 if (root.attributeValue("year") != null) 306 getModel().getProperties().setProperty("Data.Year", root.attributeValue("year")); 307 if (root.attributeValue("initiative") != null) 308 getModel().getProperties().setProperty("Data.Initiative", root.attributeValue("initiative")); 309 310 Map<Long, Offering> offeringTable = new HashMap<Long, Offering>(); 311 Map<Long, Course> courseTable = new HashMap<Long, Course>(); 312 313 if (iLoadOfferings && root.element("offerings") != null) { 314 loadOfferings(root.element("offerings"), offeringTable, courseTable, timetable); 315 } else { 316 for (Offering offering : getModel().getOfferings()) { 317 offeringTable.put(Long.valueOf(offering.getId()), offering); 318 for (Course course : offering.getCourses()) { 319 courseTable.put(Long.valueOf(course.getId()), course); 320 } 321 } 322 } 323 324 List<Enrollment> bestEnrollments = new ArrayList<Enrollment>(); 325 List<Enrollment> currentEnrollments = new ArrayList<Enrollment>(); 326 if (iLoadStudents && root.element("students") != null) { 327 loadStudents(root.element("students"), offeringTable, courseTable, bestEnrollments, currentEnrollments); 328 } 329 330 if (iLoadOfferings && root.element("constraints") != null) 331 loadLinkedSections(root.element("constraints"), offeringTable); 332 333 if (!bestEnrollments.isEmpty()) assignBest(bestEnrollments); 334 if (!currentEnrollments.isEmpty()) assignCurrent(currentEnrollments); 335 336 if (iMoveCriticalUp) moveCriticalRequestsUp(); 337 338 sLogger.debug("Model successfully loaded."); 339 } 340 341 /** 342 * Load offerings 343 * @param offeringsEl offerings element 344 * @param offeringTable offering table 345 * @param courseTable course table 346 * @param timetable provided timetable (null if to be loaded from the given document) 347 */ 348 protected void loadOfferings(Element offeringsEl, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable, Map<Long, Placement> timetable) { 349 HashMap<Long, Config> configTable = new HashMap<Long, Config>(); 350 HashMap<Long, Subpart> subpartTable = new HashMap<Long, Subpart>(); 351 HashMap<Long, Section> sectionTable = new HashMap<Long, Section>(); 352 for (Iterator<?> i = offeringsEl.elementIterator("offering"); i.hasNext();) { 353 Element offeringEl = (Element) i.next(); 354 Offering offering = new Offering( 355 Long.parseLong(offeringEl.attributeValue("id")), 356 offeringEl.attributeValue("name", "O" + offeringEl.attributeValue("id"))); 357 offeringTable.put(Long.valueOf(offering.getId()), offering); 358 getModel().addOffering(offering); 359 360 for (Iterator<?> j = offeringEl.elementIterator("course"); j.hasNext();) { 361 Element courseEl = (Element) j.next(); 362 Course course = loadCourse(courseEl, offering); 363 courseTable.put(Long.valueOf(course.getId()), course); 364 } 365 366 for (Iterator<?> j = offeringEl.elementIterator("config"); j.hasNext();) { 367 Element configEl = (Element) j.next(); 368 Config config = loadConfig(configEl, offering, subpartTable, sectionTable, timetable); 369 configTable.put(config.getId(), config); 370 } 371 372 for (Iterator<?> j = offeringEl.elementIterator("reservation"); j.hasNext(); ) { 373 Element reservationEl = (Element)j.next(); 374 loadReservation(reservationEl, offering, configTable, sectionTable); 375 } 376 377 for (Iterator<?> j = offeringEl.elementIterator("restriction"); j.hasNext(); ) { 378 Element restrictionEl = (Element)j.next(); 379 loadRestriction(restrictionEl, offering, configTable, sectionTable); 380 } 381 } 382 } 383 384 /** 385 * Load course 386 * @param courseEl course element 387 * @param offering parent offering 388 * @return loaded course 389 */ 390 protected Course loadCourse(Element courseEl, Offering offering) { 391 Course course = new Course( 392 Long.parseLong(courseEl.attributeValue("id")), 393 courseEl.attributeValue("subjectArea", ""), 394 courseEl.attributeValue("courseNbr", "C" + courseEl.attributeValue("id")), 395 offering, Integer.parseInt(courseEl.attributeValue("limit", "-1")), 396 Integer.parseInt(courseEl.attributeValue("projected", "0"))); 397 course.setCredit(courseEl.attributeValue("credit")); 398 String credits = courseEl.attributeValue("credits"); 399 if (credits != null) 400 course.setCreditValue(Float.valueOf(credits)); 401 return course; 402 } 403 404 /** 405 * Load config 406 * @param configEl config element 407 * @param offering parent offering 408 * @param subpartTable subpart table (of the offering) 409 * @param sectionTable section table (of the offering) 410 * @param timetable provided timetable 411 * @return loaded config 412 */ 413 protected Config loadConfig(Element configEl, Offering offering, Map<Long, Subpart> subpartTable, Map<Long, Section> sectionTable, Map<Long, Placement> timetable) { 414 Config config = new Config 415 (Long.parseLong(configEl.attributeValue("id")), 416 Integer.parseInt(configEl.attributeValue("limit", "-1")), 417 configEl.attributeValue("name", "G" + configEl.attributeValue("id")), 418 offering); 419 Element imEl = configEl.element("instructional-method"); 420 if (imEl != null) { 421 config.setInstructionalMethodId(Long.parseLong(imEl.attributeValue("id"))); 422 config.setInstructionalMethodName(imEl.attributeValue("name", "M" + imEl.attributeValue("id"))); 423 config.setInstructionalMethodReference(imEl.attributeValue("reference", config.getInstructionalMethodName())); 424 } 425 for (Iterator<?> k = configEl.elementIterator("subpart"); k.hasNext();) { 426 Element subpartEl = (Element) k.next(); 427 Subpart subpart = loadSubpart(subpartEl, config, subpartTable, sectionTable, timetable); 428 subpartTable.put(Long.valueOf(subpart.getId()), subpart); 429 } 430 return config; 431 } 432 433 /** 434 * Load subpart 435 * @param subpartEl supart element 436 * @param config parent config 437 * @param subpartTable subpart table (of the offering) 438 * @param sectionTable section table (of the offering) 439 * @param timetable provided timetable 440 * @return loaded subpart 441 */ 442 protected Subpart loadSubpart(Element subpartEl, Config config, Map<Long, Subpart> subpartTable, Map<Long, Section> sectionTable, Map<Long, Placement> timetable) { 443 Subpart parentSubpart = null; 444 if (subpartEl.attributeValue("parent") != null) 445 parentSubpart = subpartTable.get(Long.valueOf(subpartEl.attributeValue("parent"))); 446 Subpart subpart = new Subpart( 447 Long.parseLong(subpartEl.attributeValue("id")), 448 subpartEl.attributeValue("itype"), 449 subpartEl.attributeValue("name", "P" + subpartEl.attributeValue("id")), 450 config, 451 parentSubpart); 452 subpart.setAllowOverlap("true".equals(subpartEl.attributeValue("allowOverlap", "false"))); 453 subpart.setCredit(subpartEl.attributeValue("credit")); 454 String credits = subpartEl.attributeValue("credits"); 455 if (credits != null) 456 subpart.setCreditValue(Float.valueOf(credits)); 457 458 for (Iterator<?> l = subpartEl.elementIterator("section"); l.hasNext();) { 459 Element sectionEl = (Element) l.next(); 460 Section section = loadSection(sectionEl, subpart, sectionTable, timetable); 461 sectionTable.put(Long.valueOf(section.getId()), section); 462 } 463 464 return subpart; 465 } 466 467 /** 468 * Load section 469 * @param sectionEl section element 470 * @param subpart parent subpart 471 * @param sectionTable section table (of the offering) 472 * @param timetable provided timetable 473 * @return loaded section 474 */ 475 @SuppressWarnings("deprecation") 476 protected Section loadSection(Element sectionEl, Subpart subpart, Map<Long, Section> sectionTable, Map<Long, Placement> timetable) { 477 Section parentSection = null; 478 if (sectionEl.attributeValue("parent") != null) 479 parentSection = sectionTable.get(Long.valueOf(sectionEl.attributeValue("parent"))); 480 Placement placement = null; 481 if (timetable != null) { 482 placement = timetable.get(Long.parseLong(sectionEl.attributeValue("id"))); 483 } else { 484 TimeLocation time = null; 485 Element timeEl = sectionEl.element("time"); 486 if (timeEl != null) { 487 time = new TimeLocation( 488 Integer.parseInt(timeEl.attributeValue("days"), 2), 489 Integer.parseInt(timeEl.attributeValue("start")), 490 Integer.parseInt(timeEl.attributeValue("length")), 0, 0, 491 timeEl.attributeValue("datePattern") == null ? null : Long.valueOf(timeEl.attributeValue("datePattern")), 492 timeEl.attributeValue("datePatternName", ""), 493 createBitSet(timeEl.attributeValue("dates")), 494 Integer.parseInt(timeEl.attributeValue("breakTime", "0"))); 495 if (timeEl.attributeValue("pattern") != null) 496 time.setTimePatternId(Long.valueOf(timeEl.attributeValue("pattern"))); 497 } 498 List<RoomLocation> rooms = new ArrayList<RoomLocation>(); 499 for (Iterator<?> m = sectionEl.elementIterator("room"); m.hasNext();) { 500 Element roomEl = (Element) m.next(); 501 Double posX = null, posY = null; 502 if (roomEl.attributeValue("location") != null) { 503 String loc = roomEl.attributeValue("location"); 504 posX = Double.valueOf(loc.substring(0, loc.indexOf(','))); 505 posY = Double.valueOf(loc.substring(loc.indexOf(',') + 1)); 506 } 507 RoomLocation room = new RoomLocation( 508 Long.valueOf(roomEl.attributeValue("id")), 509 roomEl.attributeValue("name", "R" + roomEl.attributeValue("id")), 510 roomEl.attributeValue("building") == null ? null : Long.valueOf(roomEl.attributeValue("building")), 511 0, Integer.parseInt(roomEl.attributeValue("capacity")), 512 posX, posY, "true".equals(roomEl.attributeValue("ignoreTooFar")), null); 513 rooms.add(room); 514 } 515 placement = (time == null ? null : new Placement(null, time, rooms)); 516 } 517 518 List<Instructor> instructors = new ArrayList<Instructor>(); 519 for (Iterator<?> m = sectionEl.elementIterator("instructor"); m.hasNext(); ) { 520 Element instructorEl = (Element)m.next(); 521 instructors.add(new Instructor(Long.parseLong(instructorEl.attributeValue("id")), instructorEl.attributeValue("externalId"), instructorEl.attributeValue("name"), instructorEl.attributeValue("email"))); 522 } 523 if (instructors.isEmpty() && sectionEl.attributeValue("instructorIds") != null) 524 instructors = Instructor.toInstructors(sectionEl.attributeValue("instructorIds"), sectionEl.attributeValue("instructorNames")); 525 Section section = new Section( 526 Long.parseLong(sectionEl.attributeValue("id")), 527 Integer.parseInt(sectionEl.attributeValue("limit")), 528 sectionEl.attributeValue("name", "S" + sectionEl.attributeValue("id")), 529 subpart, placement, instructors, parentSection); 530 531 section.setSpaceHeld(Double.parseDouble(sectionEl.attributeValue("hold", "0.0"))); 532 section.setSpaceExpected(Double.parseDouble(sectionEl.attributeValue("expect", "0.0"))); 533 section.setCancelled("true".equalsIgnoreCase(sectionEl.attributeValue("cancelled", "false"))); 534 section.setEnabled("true".equalsIgnoreCase(sectionEl.attributeValue("enabled", "true"))); 535 section.setOnline("true".equalsIgnoreCase(sectionEl.attributeValue("online", "false"))); 536 section.setPast("true".equalsIgnoreCase(sectionEl.attributeValue("past", "false"))); 537 for (Iterator<?> m = sectionEl.elementIterator("cname"); m.hasNext(); ) { 538 Element cNameEl = (Element)m.next(); 539 section.setName(Long.parseLong(cNameEl.attributeValue("id")), cNameEl.getText()); 540 } 541 Element ignoreEl = sectionEl.element("no-conflicts"); 542 if (ignoreEl != null) { 543 for (Iterator<?> m = ignoreEl.elementIterator("section"); m.hasNext(); ) 544 section.addIgnoreConflictWith(Long.parseLong(((Element)m.next()).attributeValue("id"))); 545 } 546 547 return section; 548 } 549 550 /** 551 * Load reservation 552 * @param reservationEl reservation element 553 * @param offering parent offering 554 * @param configTable config table (of the offering) 555 * @param sectionTable section table (of the offering) 556 * @return loaded reservation 557 */ 558 protected Reservation loadReservation(Element reservationEl, Offering offering, HashMap<Long, Config> configTable, HashMap<Long, Section> sectionTable) { 559 Reservation r = null; 560 if ("individual".equals(reservationEl.attributeValue("type"))) { 561 Set<Long> studentIds = new HashSet<Long>(); 562 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 563 Element studentEl = (Element)k.next(); 564 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 565 } 566 r = new IndividualReservation(Long.valueOf(reservationEl.attributeValue("id")), offering, studentIds); 567 } else if ("group".equals(reservationEl.attributeValue("type"))) { 568 Set<Long> studentIds = new HashSet<Long>(); 569 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 570 Element studentEl = (Element)k.next(); 571 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 572 } 573 r = new GroupReservation(Long.valueOf(reservationEl.attributeValue("id")), 574 Double.parseDouble(reservationEl.attributeValue("limit", "-1")), 575 offering, studentIds); 576 } else if ("lc".equals(reservationEl.attributeValue("type"))) { 577 Set<Long> studentIds = new HashSet<Long>(); 578 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 579 Element studentEl = (Element)k.next(); 580 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 581 } 582 long courseId = Long.parseLong(reservationEl.attributeValue("course")); 583 for (Course course: offering.getCourses()) { 584 if (course.getId() == courseId) 585 r = new LearningCommunityReservation(Long.valueOf(reservationEl.attributeValue("id")), 586 Double.parseDouble(reservationEl.attributeValue("limit", "-1")), 587 course, studentIds); 588 } 589 } else if ("curriculum".equals(reservationEl.attributeValue("type")) || "curriculum-override".equals(reservationEl.attributeValue("type"))) { 590 List<String> acadAreas = new ArrayList<String>(); 591 for (Iterator<?> k = reservationEl.elementIterator("area"); k.hasNext(); ) { 592 Element areaEl = (Element)k.next(); 593 acadAreas.add(areaEl.attributeValue("code")); 594 } 595 if (acadAreas.isEmpty() && reservationEl.attributeValue("area") != null) 596 acadAreas.add(reservationEl.attributeValue("area")); 597 List<String> classifications = new ArrayList<String>(); 598 for (Iterator<?> k = reservationEl.elementIterator("classification"); k.hasNext(); ) { 599 Element clasfEl = (Element)k.next(); 600 classifications.add(clasfEl.attributeValue("code")); 601 } 602 List<String> majors = new ArrayList<String>(); 603 for (Iterator<?> k = reservationEl.elementIterator("major"); k.hasNext(); ) { 604 Element majorEl = (Element)k.next(); 605 majors.add(majorEl.attributeValue("code")); 606 } 607 List<String> minors = new ArrayList<String>(); 608 for (Iterator<?> k = reservationEl.elementIterator("minor"); k.hasNext(); ) { 609 Element minorEl = (Element)k.next(); 610 minors.add(minorEl.attributeValue("code")); 611 } 612 if ("curriculum".equals(reservationEl.attributeValue("type"))) 613 r = new CurriculumReservation(Long.valueOf(reservationEl.attributeValue("id")), 614 Double.parseDouble(reservationEl.attributeValue("limit", "-1")), 615 offering, 616 acadAreas, classifications, majors, minors); 617 else 618 r = new CurriculumOverride(Long.valueOf(reservationEl.attributeValue("id")), 619 Double.parseDouble(reservationEl.attributeValue("limit", "-1")), 620 offering, 621 acadAreas, classifications, majors, minors); 622 for (Iterator<?> k = reservationEl.elementIterator("major"); k.hasNext(); ) { 623 Element majorEl = (Element)k.next(); 624 for (Iterator<?> l = majorEl.elementIterator("concentration"); l.hasNext(); ) { 625 Element concentrationEl = (Element)l.next(); 626 ((CurriculumReservation)r).addConcentration(majorEl.attributeValue("code"), concentrationEl.attributeValue("code")); 627 } 628 } 629 } else if ("course".equals(reservationEl.attributeValue("type"))) { 630 long courseId = Long.parseLong(reservationEl.attributeValue("course")); 631 for (Course course: offering.getCourses()) { 632 if (course.getId() == courseId) 633 r = new CourseReservation(Long.valueOf(reservationEl.attributeValue("id")), course); 634 } 635 } else if ("dummy".equals(reservationEl.attributeValue("type"))) { 636 r = new DummyReservation(offering); 637 } else if ("override".equals(reservationEl.attributeValue("type"))) { 638 Set<Long> studentIds = new HashSet<Long>(); 639 for (Iterator<?> k = reservationEl.elementIterator("student"); k.hasNext(); ) { 640 Element studentEl = (Element)k.next(); 641 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 642 } 643 r = new ReservationOverride(Long.valueOf(reservationEl.attributeValue("id")), offering, studentIds); 644 } 645 if (r == null) { 646 sLogger.error("Unknown reservation type "+ reservationEl.attributeValue("type")); 647 return null; 648 } 649 r.setExpired("true".equals(reservationEl.attributeValue("expired", "false"))); 650 for (Iterator<?> k = reservationEl.elementIterator("config"); k.hasNext(); ) { 651 Element configEl = (Element)k.next(); 652 r.addConfig(configTable.get(Long.parseLong(configEl.attributeValue("id")))); 653 } 654 for (Iterator<?> k = reservationEl.elementIterator("section"); k.hasNext(); ) { 655 Element sectionEl = (Element)k.next(); 656 r.addSection(sectionTable.get(Long.parseLong(sectionEl.attributeValue("id"))), false); 657 } 658 r.setPriority(Integer.parseInt(reservationEl.attributeValue("priority", String.valueOf(r.getPriority())))); 659 r.setMustBeUsed("true".equals(reservationEl.attributeValue("mustBeUsed", r.mustBeUsed() ? "true" : "false"))); 660 r.setAllowOverlap("true".equals(reservationEl.attributeValue("allowOverlap", r.isAllowOverlap() ? "true" : "false"))); 661 r.setCanAssignOverLimit("true".equals(reservationEl.attributeValue("canAssignOverLimit", r.canAssignOverLimit() ? "true" : "false"))); 662 r.setAllowDisabled("true".equals(reservationEl.attributeValue("allowDisabled", r.isAllowDisabled() ? "true" : "false"))); 663 r.setNeverIncluded("true".equals(reservationEl.attributeValue("neverIncluded", "false"))); 664 r.setBreakLinkedSections("true".equals(reservationEl.attributeValue("breakLinkedSections", "false"))); 665 return r; 666 } 667 668 /** 669 * Load restriction 670 * @param restrictionEl restriction element 671 * @param offering parent offering 672 * @param configTable config table (of the offering) 673 * @param sectionTable section table (of the offering) 674 * @return loaded restriction 675 */ 676 protected Restriction loadRestriction(Element restrictionEl, Offering offering, HashMap<Long, Config> configTable, HashMap<Long, Section> sectionTable) { 677 Restriction r = null; 678 if ("individual".equals(restrictionEl.attributeValue("type"))) { 679 Set<Long> studentIds = new HashSet<Long>(); 680 for (Iterator<?> k = restrictionEl.elementIterator("student"); k.hasNext(); ) { 681 Element studentEl = (Element)k.next(); 682 studentIds.add(Long.parseLong(studentEl.attributeValue("id"))); 683 } 684 r = new IndividualRestriction(Long.valueOf(restrictionEl.attributeValue("id")), offering, studentIds); 685 } else if ("curriculum".equals(restrictionEl.attributeValue("type"))) { 686 List<String> acadAreas = new ArrayList<String>(); 687 for (Iterator<?> k = restrictionEl.elementIterator("area"); k.hasNext(); ) { 688 Element areaEl = (Element)k.next(); 689 acadAreas.add(areaEl.attributeValue("code")); 690 } 691 if (acadAreas.isEmpty() && restrictionEl.attributeValue("area") != null) 692 acadAreas.add(restrictionEl.attributeValue("area")); 693 List<String> classifications = new ArrayList<String>(); 694 for (Iterator<?> k = restrictionEl.elementIterator("classification"); k.hasNext(); ) { 695 Element clasfEl = (Element)k.next(); 696 classifications.add(clasfEl.attributeValue("code")); 697 } 698 List<String> majors = new ArrayList<String>(); 699 for (Iterator<?> k = restrictionEl.elementIterator("major"); k.hasNext(); ) { 700 Element majorEl = (Element)k.next(); 701 majors.add(majorEl.attributeValue("code")); 702 } 703 List<String> minors = new ArrayList<String>(); 704 for (Iterator<?> k = restrictionEl.elementIterator("minor"); k.hasNext(); ) { 705 Element minorEl = (Element)k.next(); 706 minors.add(minorEl.attributeValue("code")); 707 } 708 r = new CurriculumRestriction(Long.valueOf(restrictionEl.attributeValue("id")), 709 offering, 710 acadAreas, classifications, majors, minors); 711 for (Iterator<?> k = restrictionEl.elementIterator("major"); k.hasNext(); ) { 712 Element majorEl = (Element)k.next(); 713 for (Iterator<?> l = majorEl.elementIterator("concentration"); l.hasNext(); ) { 714 Element concentrationEl = (Element)l.next(); 715 ((CurriculumRestriction)r).addConcentration(majorEl.attributeValue("code"), concentrationEl.attributeValue("code")); 716 } 717 } 718 } else if ("course".equals(restrictionEl.attributeValue("type"))) { 719 long courseId = Long.parseLong(restrictionEl.attributeValue("course")); 720 for (Course course: offering.getCourses()) { 721 if (course.getId() == courseId) 722 r = new CourseRestriction(Long.valueOf(restrictionEl.attributeValue("id")), course); 723 } 724 } 725 if (r == null) { 726 sLogger.error("Unknown reservation type "+ restrictionEl.attributeValue("type")); 727 return null; 728 } 729 for (Iterator<?> k = restrictionEl.elementIterator("config"); k.hasNext(); ) { 730 Element configEl = (Element)k.next(); 731 r.addConfig(configTable.get(Long.parseLong(configEl.attributeValue("id")))); 732 } 733 for (Iterator<?> k = restrictionEl.elementIterator("section"); k.hasNext(); ) { 734 Element sectionEl = (Element)k.next(); 735 r.addSection(sectionTable.get(Long.parseLong(sectionEl.attributeValue("id")))); 736 } 737 return r; 738 } 739 740 /** 741 * Load given timetable 742 * @param timetableRoot document root in the course timetabling XML format 743 * @return loaded timetable (map class id: assigned placement) 744 */ 745 protected Map<Long, Placement> loadTimetable(Element timetableRoot) { 746 Map<Long, Placement> timetable = new HashMap<Long, Placement>(); 747 HashMap<Long, RoomLocation> rooms = new HashMap<Long, RoomLocation>(); 748 for (Iterator<?> i = timetableRoot.element("rooms").elementIterator("room"); i.hasNext();) { 749 Element roomEl = (Element)i.next(); 750 Long roomId = Long.valueOf(roomEl.attributeValue("id")); 751 Double posX = null, posY = null; 752 if (roomEl.attributeValue("location") != null) { 753 String loc = roomEl.attributeValue("location"); 754 posX = Double.valueOf(loc.substring(0, loc.indexOf(','))); 755 posY = Double.valueOf(loc.substring(loc.indexOf(',') + 1)); 756 } 757 RoomLocation room = new RoomLocation( 758 Long.valueOf(roomEl.attributeValue("id")), 759 roomEl.attributeValue("name", "R" + roomEl.attributeValue("id")), 760 roomEl.attributeValue("building") == null ? null : Long.valueOf(roomEl.attributeValue("building")), 761 0, Integer.parseInt(roomEl.attributeValue("capacity")), 762 posX, posY, "true".equals(roomEl.attributeValue("ignoreTooFar")), null); 763 rooms.put(roomId, room); 764 } 765 for (Iterator<?> i = timetableRoot.element("classes").elementIterator("class"); i.hasNext();) { 766 Element classEl = (Element)i.next(); 767 Long classId = Long.valueOf(classEl.attributeValue("id")); 768 TimeLocation time = null; 769 Element timeEl = null; 770 for (Iterator<?> j = classEl.elementIterator("time"); j.hasNext(); ) { 771 Element e = (Element)j.next(); 772 if ("true".equals(e.attributeValue("solution", "false"))) { timeEl = e; break; } 773 } 774 if (timeEl != null) { 775 time = new TimeLocation( 776 Integer.parseInt(timeEl.attributeValue("days"), 2), 777 Integer.parseInt(timeEl.attributeValue("start")), 778 Integer.parseInt(timeEl.attributeValue("length")), 0, 0, 779 classEl.attributeValue("datePattern") == null ? null : Long.valueOf(classEl.attributeValue("datePattern")), 780 classEl.attributeValue("datePatternName", ""), createBitSet(classEl.attributeValue("dates")), 781 Integer.parseInt(timeEl.attributeValue("breakTime", "0"))); 782 if (timeEl.attributeValue("pattern") != null) 783 time.setTimePatternId(Long.valueOf(timeEl.attributeValue("pattern"))); 784 } 785 List<RoomLocation> room = new ArrayList<RoomLocation>(); 786 for (Iterator<?> j = classEl.elementIterator("room"); j.hasNext();) { 787 Element roomEl = (Element) j.next(); 788 if (!"true".equals(roomEl.attributeValue("solution", "false"))) continue; 789 room.add(rooms.get(Long.valueOf(roomEl.attributeValue("id")))); 790 } 791 Placement placement = (time == null ? null : new Placement(null, time, room)); 792 if (placement != null) 793 timetable.put(classId, placement); 794 } 795 return timetable; 796 } 797 798 /** 799 * Load travel times 800 * @param travelTimesEl travel-time element 801 * @param metric distance metric to be populated 802 */ 803 protected void loadTravelTimes(Element travelTimesEl, DistanceMetric metric) { 804 for (Iterator<?> i = travelTimesEl.elementIterator("travel-time"); i.hasNext();) { 805 Element travelTimeEl = (Element)i.next(); 806 metric.addTravelTime( 807 Long.valueOf(travelTimeEl.attributeValue("id1")), 808 Long.valueOf(travelTimeEl.attributeValue("id2")), 809 Integer.valueOf(travelTimeEl.attributeValue("minutes"))); 810 } 811 } 812 813 /** 814 * Load linked sections 815 * @param constraintsEl constraints element 816 * @param offeringTable offering table 817 */ 818 protected void loadLinkedSections(Element constraintsEl, Map<Long, Offering> offeringTable) { 819 for (Iterator<?> i = constraintsEl.elementIterator("linked-sections"); i.hasNext();) { 820 Element linkedEl = (Element) i.next(); 821 List<Section> sections = new ArrayList<Section>(); 822 for (Iterator<?> j = linkedEl.elementIterator("section"); j.hasNext();) { 823 Element sectionEl = (Element) j.next(); 824 Offering offering = offeringTable.get(Long.valueOf(sectionEl.attributeValue("offering"))); 825 sections.add(offering.getSection(Long.valueOf(sectionEl.attributeValue("id")))); 826 } 827 getModel().addLinkedSections("true".equals(linkedEl.attributeValue("mustBeUsed", "false")), sections); 828 } 829 } 830 831 /** 832 * Load students 833 * @param studentsEl students element 834 * @param offeringTable offering table 835 * @param courseTable course table 836 */ 837 protected void loadStudents(Element studentsEl, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable, List<Enrollment> bestEnrollments, List<Enrollment> currentEnrollments) { 838 for (Iterator<?> i = studentsEl.elementIterator("student"); i.hasNext();) { 839 Element studentEl = (Element) i.next(); 840 Student student = loadStudent(studentEl, offeringTable); 841 if (iStudentFilter != null && !iStudentFilter.accept(student)) 842 continue; 843 for (Iterator<?> j = studentEl.elementIterator(); j.hasNext();) { 844 Element requestEl = (Element) j.next(); 845 Request request = loadRequest(requestEl, student, offeringTable, courseTable); 846 if (request == null) continue; 847 848 Element initialEl = requestEl.element("initial"); 849 if (iLoadInitial && initialEl != null) { 850 Enrollment enrollment = loadEnrollment(initialEl, request); 851 if (enrollment != null) 852 request.setInitialAssignment(enrollment); 853 } 854 Element currentEl = requestEl.element("current"); 855 if (iLoadCurrent && currentEl != null) { 856 Enrollment enrollment = loadEnrollment(currentEl, request); 857 if (enrollment != null) 858 currentEnrollments.add(enrollment); 859 } 860 Element bestEl = requestEl.element("best"); 861 if (iLoadBest && bestEl != null) { 862 Enrollment enrollment = loadEnrollment(bestEl, request); 863 if (enrollment != null) 864 bestEnrollments.add(enrollment); 865 } 866 Element fixedEl = requestEl.element("fixed"); 867 if (fixedEl != null && request instanceof CourseRequest) 868 ((CourseRequest)request).setFixedValue(loadEnrollment(fixedEl, request)); 869 } 870 getModel().addStudent(student); 871 } 872 } 873 874 /** 875 * Save best enrollments 876 * @param bestEnrollments best enrollments 877 */ 878 protected void assignBest(List<Enrollment> bestEnrollments) { 879 // Enrollments with a reservation must go first, enrollments with an override go last 880 for (Enrollment enrollment : bestEnrollments) { 881 if (enrollment.getReservation() == null || enrollment.getReservation().isExpired()) continue; 882 if (!enrollment.getStudent().isAvailable(enrollment)) { 883 sLogger.warn("Enrollment " + enrollment + " is conflicting: student not available."); 884 continue; 885 } 886 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 887 if (conflicts.isEmpty()) 888 getAssignment().assign(0, enrollment); 889 else 890 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 891 } 892 for (Enrollment enrollment : bestEnrollments) { 893 if (enrollment.getReservation() != null) continue; 894 if (!enrollment.getStudent().isAvailable(enrollment)) { 895 sLogger.warn("Enrollment " + enrollment + " is conflicting: student not available."); 896 continue; 897 } 898 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 899 if (conflicts.isEmpty()) 900 getAssignment().assign(0, enrollment); 901 else 902 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 903 } 904 for (Enrollment enrollment : bestEnrollments) { 905 if (enrollment.getReservation() == null || !enrollment.getReservation().isExpired()) continue; 906 if (!enrollment.getStudent().isAvailable(enrollment)) { 907 sLogger.warn("Enrollment " + enrollment + " is conflicting: student not available."); 908 continue; 909 } 910 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 911 if (conflicts.isEmpty()) 912 getAssignment().assign(0, enrollment); 913 else 914 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 915 } 916 getModel().saveBest(getAssignment()); 917 } 918 919 /** 920 * Assign current enrollments 921 * @param currentEnrollments current enrollments 922 */ 923 protected void assignCurrent(List<Enrollment> currentEnrollments) { 924 for (Request request : getModel().variables()) 925 getAssignment().unassign(0, request); 926 // Enrollments with a reservation must go first, enrollments with an override go last 927 for (Enrollment enrollment : currentEnrollments) { 928 if (enrollment.getReservation() == null || enrollment.getReservation().isExpired()) continue; 929 if (!enrollment.getStudent().isAvailable(enrollment)) { 930 sLogger.warn("Enrollment " + enrollment + " is conflicting: student not available."); 931 continue; 932 } 933 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 934 if (conflicts.isEmpty()) 935 getAssignment().assign(0, enrollment); 936 else 937 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 938 } 939 for (Enrollment enrollment : currentEnrollments) { 940 if (enrollment.getReservation() != null) continue; 941 if (!enrollment.getStudent().isAvailable(enrollment)) { 942 sLogger.warn("Enrollment " + enrollment + " is conflicting: student not available."); 943 continue; 944 } 945 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 946 if (conflicts.isEmpty()) 947 getAssignment().assign(0, enrollment); 948 else 949 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 950 } 951 for (Enrollment enrollment : currentEnrollments) { 952 if (enrollment.getReservation() == null || !enrollment.getReservation().isExpired()) continue; 953 if (!enrollment.getStudent().isAvailable(enrollment)) { 954 sLogger.warn("Enrollment " + enrollment + " is conflicting: student not available."); 955 continue; 956 } 957 Map<Constraint<Request, Enrollment>, Set<Enrollment>> conflicts = getModel().conflictConstraints(getAssignment(), enrollment); 958 if (conflicts.isEmpty()) 959 getAssignment().assign(0, enrollment); 960 else 961 sLogger.warn("Enrollment " + enrollment + " conflicts with " + conflicts); 962 } 963 } 964 965 /** 966 * Load student 967 * @param studentEl student element 968 * @param offeringTable offering table 969 * @return loaded student 970 */ 971 protected Student loadStudent(Element studentEl, Map<Long, Offering> offeringTable) { 972 Student student = new Student(Long.parseLong(studentEl.attributeValue("id")), "true".equals(studentEl.attributeValue("dummy"))); 973 if (studentEl.attributeValue("priority") != null) 974 student.setPriority(StudentPriority.getPriority(studentEl.attributeValue("priority"))); 975 if ("true".equals(studentEl.attributeValue("shortDistances"))) 976 student.setNeedShortDistances(true); 977 if ("true".equals(studentEl.attributeValue("allowDisabled"))) 978 student.setAllowDisabled(true); 979 student.setExternalId(studentEl.attributeValue("externalId")); 980 student.setName(studentEl.attributeValue("name")); 981 student.setStatus(studentEl.attributeValue("status")); 982 String minCredit = studentEl.attributeValue("minCredit"); 983 if (minCredit != null) 984 student.setMinCredit(Float.parseFloat(minCredit)); 985 String maxCredit = studentEl.attributeValue("maxCredit"); 986 if (maxCredit != null) 987 student.setMaxCredit(Float.parseFloat(maxCredit)); 988 String classFirstDate = studentEl.attributeValue("classFirstDate"); 989 if (classFirstDate != null) 990 student.setClassFirstDate(Integer.parseInt(classFirstDate)); 991 String classLastDate = studentEl.attributeValue("classLastDate"); 992 if (classLastDate != null) 993 student.setClassLastDate(Integer.parseInt(classLastDate)); 994 String modality = studentEl.attributeValue("modality"); 995 if (modality != null) 996 student.setModalityPreference(ModalityPreference.valueOf(modality)); 997 String btb = studentEl.attributeValue("btb"); 998 if (btb != null) 999 student.setBackToBackPreference(BackToBackPreference.valueOf(btb)); 1000 1001 List<String[]> clasf = new ArrayList<String[]>(); 1002 List<String[]> major = new ArrayList<String[]>(); 1003 for (Iterator<?> j = studentEl.elementIterator(); j.hasNext();) { 1004 Element requestEl = (Element) j.next(); 1005 if ("classification".equals(requestEl.getName())) { 1006 clasf.add(new String[] {requestEl.attributeValue("area"), requestEl.attributeValue("code"), requestEl.attributeValue("label")}); 1007 } else if ("major".equals(requestEl.getName())) { 1008 major.add(new String[] {requestEl.attributeValue("area"), requestEl.attributeValue("code"), requestEl.attributeValue("label")}); 1009 } else if ("minor".equals(requestEl.getName())) { 1010 if ("A".equals(requestEl.attributeValue("area"))) 1011 student.getAccommodations().add(requestEl.attributeValue("code")); 1012 else 1013 student.getGroups().add(new StudentGroup(requestEl.attributeValue("area"), requestEl.attributeValue("code"), requestEl.attributeValue("label"))); 1014 } else if ("unavailability".equals(requestEl.getName())) { 1015 Offering offering = offeringTable.get(Long.parseLong(requestEl.attributeValue("offering"))); 1016 Section section = (offering == null ? null : offering.getSection(Long.parseLong(requestEl.attributeValue("section")))); 1017 if (section != null) 1018 new Unavailability(student, section, "true".equals(requestEl.attributeValue("allowOverlap"))); 1019 } else if ("acm".equals(requestEl.getName())) { 1020 if (requestEl.attributeValue("minor") != null) 1021 student.getAreaClassificationMinors().add(new AreaClassificationMajor( 1022 requestEl.attributeValue("area"), requestEl.attributeValue("areaName"), 1023 requestEl.attributeValue("classification"), requestEl.attributeValue("classificationName"), 1024 requestEl.attributeValue("minor"), requestEl.attributeValue("minorName"), 1025 requestEl.attributeValue("concentration"), requestEl.attributeValue("concentrationName"), 1026 requestEl.attributeValue("degree"), requestEl.attributeValue("degreeName"), 1027 requestEl.attributeValue("program"), requestEl.attributeValue("programName"), 1028 requestEl.attributeValue("weight") == null ? null : Double.valueOf(requestEl.attributeValue("weight")))); 1029 else 1030 student.getAreaClassificationMajors().add(new AreaClassificationMajor( 1031 requestEl.attributeValue("area"), requestEl.attributeValue("areaName"), 1032 requestEl.attributeValue("classification"), requestEl.attributeValue("classificationName"), 1033 requestEl.attributeValue("major"), requestEl.attributeValue("majorName"), 1034 requestEl.attributeValue("concentration"), requestEl.attributeValue("concentrationName"), 1035 requestEl.attributeValue("degree"), requestEl.attributeValue("degreeName"), 1036 requestEl.attributeValue("program"), requestEl.attributeValue("programName"), 1037 requestEl.attributeValue("weight") == null ? null : Double.valueOf(requestEl.attributeValue("weight")))); 1038 } else if ("group".equals(requestEl.getName())) { 1039 student.getGroups().add(new StudentGroup(requestEl.attributeValue("type"), requestEl.attributeValue("reference"), requestEl.attributeValue("name"))); 1040 } else if ("accommodation".equals(requestEl.getName())) { 1041 student.getAccommodations().add(requestEl.attributeValue("reference")); 1042 } else if ("advisor".equals(requestEl.getName())) { 1043 student.getAdvisors().add(new Instructor(0l, requestEl.attributeValue("externalId"), requestEl.attributeValue("name"), requestEl.attributeValue("email"))); 1044 } 1045 } 1046 for (int i = 0; i < Math.min(clasf.size(), major.size()); i++) { 1047 student.getAreaClassificationMajors().add(new AreaClassificationMajor(clasf.get(i)[0],clasf.get(i)[1],major.get(i)[1])); 1048 } 1049 return student; 1050 } 1051 1052 /** 1053 * Load request 1054 * @param requestEl request element 1055 * @param student parent student 1056 * @param offeringTable offering table 1057 * @param courseTable course table 1058 * @return loaded request 1059 */ 1060 protected Request loadRequest(Element requestEl, Student student, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable) { 1061 if ("freeTime".equals(requestEl.getName())) { 1062 return loadFreeTime(requestEl, student); 1063 } else if ("course".equals(requestEl.getName())) { 1064 return loadCourseRequest(requestEl, student, offeringTable, courseTable); 1065 } else { 1066 return null; 1067 } 1068 } 1069 1070 /** 1071 * Load free time request 1072 * @param requestEl request element 1073 * @param student parent student 1074 * @return loaded free time request 1075 */ 1076 public FreeTimeRequest loadFreeTime(Element requestEl, Student student) { 1077 TimeLocation time = new TimeLocation(Integer.parseInt(requestEl.attributeValue("days"), 2), 1078 Integer.parseInt(requestEl.attributeValue("start")), Integer.parseInt(requestEl 1079 .attributeValue("length")), 0, 0, 1080 requestEl.attributeValue("datePattern") == null ? null : Long.valueOf(requestEl 1081 .attributeValue("datePattern")), "", createBitSet(requestEl 1082 .attributeValue("dates")), 0); 1083 FreeTimeRequest request = new FreeTimeRequest(Long.parseLong(requestEl.attributeValue("id")), 1084 Integer.parseInt(requestEl.attributeValue("priority")), "true".equals(requestEl 1085 .attributeValue("alternative")), student, time); 1086 if (requestEl.attributeValue("weight") != null) 1087 request.setWeight(Double.parseDouble(requestEl.attributeValue("weight"))); 1088 return request; 1089 } 1090 1091 /** 1092 * Load course request 1093 * @param requestEl request element 1094 * @param student parent student 1095 * @param offeringTable offering table 1096 * @param courseTable course table 1097 * @return loaded course request 1098 */ 1099 public CourseRequest loadCourseRequest(Element requestEl, Student student, Map<Long, Offering> offeringTable, Map<Long, Course> courseTable) { 1100 List<Course> courses = new ArrayList<Course>(); 1101 courses.add(courseTable.get(Long.valueOf(requestEl.attributeValue("course")))); 1102 for (Iterator<?> k = requestEl.elementIterator("alternative"); k.hasNext();) 1103 courses.add(courseTable.get(Long.valueOf(((Element) k.next()).attributeValue("course")))); 1104 Long timeStamp = null; 1105 if (requestEl.attributeValue("timeStamp") != null) 1106 timeStamp = Long.valueOf(requestEl.attributeValue("timeStamp")); 1107 CourseRequest courseRequest = new CourseRequest( 1108 Long.parseLong(requestEl.attributeValue("id")), 1109 Integer.parseInt(requestEl.attributeValue("priority")), 1110 "true".equals(requestEl.attributeValue("alternative")), 1111 student, courses, 1112 "true".equals(requestEl.attributeValue("waitlist", "false")), 1113 RequestPriority.valueOf(requestEl.attributeValue("importance", 1114 "true".equals(requestEl.attributeValue("critical", "false")) ? RequestPriority.Critical.name() : RequestPriority.Normal.name())), 1115 timeStamp); 1116 if (iWaitlistCritical && RequestPriority.Critical.isCritical(courseRequest) && !courseRequest.isAlternative()) courseRequest.setWaitlist(true); 1117 if (requestEl.attributeValue("weight") != null) 1118 courseRequest.setWeight(Double.parseDouble(requestEl.attributeValue("weight"))); 1119 for (Iterator<?> k = requestEl.elementIterator("waitlisted"); k.hasNext();) { 1120 Element choiceEl = (Element) k.next(); 1121 courseRequest.getWaitlistedChoices().add( 1122 new Choice(offeringTable.get(Long.valueOf(choiceEl.attributeValue("offering"))), choiceEl.getText())); 1123 } 1124 for (Iterator<?> k = requestEl.elementIterator("selected"); k.hasNext();) { 1125 Element choiceEl = (Element) k.next(); 1126 courseRequest.getSelectedChoices().add( 1127 new Choice(offeringTable.get(Long.valueOf(choiceEl.attributeValue("offering"))), choiceEl.getText())); 1128 } 1129 for (Iterator<?> k = requestEl.elementIterator("required"); k.hasNext();) { 1130 Element choiceEl = (Element) k.next(); 1131 courseRequest.getRequiredChoices().add( 1132 new Choice(offeringTable.get(Long.valueOf(choiceEl.attributeValue("offering"))), choiceEl.getText())); 1133 } 1134 groups: for (Iterator<?> k = requestEl.elementIterator("group"); k.hasNext();) { 1135 Element groupEl = (Element) k.next(); 1136 long gid = Long.parseLong(groupEl.attributeValue("id")); 1137 String gname = groupEl.attributeValue("name", "g" + gid); 1138 Course course = courseTable.get(Long.valueOf(groupEl.attributeValue("course"))); 1139 for (RequestGroup g: course.getRequestGroups()) { 1140 if (g.getId() == gid) { 1141 courseRequest.addRequestGroup(g); 1142 continue groups; 1143 } 1144 } 1145 courseRequest.addRequestGroup(new RequestGroup(gid, gname, course)); 1146 } 1147 return courseRequest; 1148 } 1149 1150 /** 1151 * Load enrollment 1152 * @param enrollmentEl enrollment element (current, best, or initial) 1153 * @param request parent request 1154 * @return loaded enrollment 1155 */ 1156 protected Enrollment loadEnrollment(Element enrollmentEl, Request request) { 1157 if (request instanceof CourseRequest) { 1158 CourseRequest courseRequest = (CourseRequest) request; 1159 HashSet<Section> sections = new HashSet<Section>(); 1160 for (Iterator<?> k = enrollmentEl.elementIterator("section"); k.hasNext();) { 1161 Element sectionEl = (Element) k.next(); 1162 Section section = courseRequest.getSection(Long.parseLong(sectionEl 1163 .attributeValue("id"))); 1164 sections.add(section); 1165 } 1166 Reservation reservation = null; 1167 if (enrollmentEl.attributeValue("reservation", null) != null) { 1168 long reservationId = Long.valueOf(enrollmentEl.attributeValue("reservation")); 1169 for (Course course: courseRequest.getCourses()) 1170 for (Reservation r: course.getOffering().getReservations()) 1171 if (r.getId() == reservationId) { reservation = r; break; } 1172 } 1173 if (!sections.isEmpty()) { 1174 if (enrollmentEl.attributeValue("course") != null) { 1175 Course course = courseRequest.getCourse(Long.valueOf(enrollmentEl.attributeValue("course"))); 1176 if (course != null) 1177 return courseRequest.createEnrollment(course, sections, reservation); 1178 } 1179 return courseRequest.createEnrollment(sections, reservation); 1180 } 1181 } else if (request instanceof FreeTimeRequest) { 1182 return ((FreeTimeRequest)request).createEnrollment(); 1183 } 1184 return null; 1185 } 1186 1187 protected void moveCriticalRequestsUp() { 1188 for (Student student: getModel().getStudents()) { 1189 int assigned = 0, critical = 0; 1190 for (Request r: student.getRequests()) { 1191 if (r instanceof CourseRequest) { 1192 if (r.getInitialAssignment() != null) assigned ++; 1193 if (r.getRequestPriority() != RequestPriority.Normal) critical ++; 1194 } 1195 } 1196 if ((getModel().getKeepInitialAssignments() && assigned > 0) || critical > 0) { 1197 Collections.sort(student.getRequests(), new Comparator<Request>() { 1198 @Override 1199 public int compare(Request r1, Request r2) { 1200 if (r1.isAlternative() != r2.isAlternative()) return r1.isAlternative() ? 1 : -1; 1201 if (getModel().getKeepInitialAssignments()) { 1202 boolean a1 = (r1 instanceof CourseRequest && r1.getInitialAssignment() != null); 1203 boolean a2 = (r2 instanceof CourseRequest && r2.getInitialAssignment() != null); 1204 if (a1 != a2) return a1 ? -1 : 1; 1205 } 1206 int c1 = r1.getRequestPriority().ordinal(); 1207 int c2 = r2.getRequestPriority().ordinal(); 1208 if (c1 != c2) return c1 < c2 ? -1 : 1; 1209 return r1.getPriority() < r2.getPriority() ? -1 : 1; 1210 } 1211 }); 1212 int p = 0; 1213 for (Request r: student.getRequests()) 1214 r.setPriority(p++); 1215 } 1216 } 1217 } 1218 1219}