add todos on persistent data spec

Author: david-fong

ucst-core/src/main/java/com/dvf/ucst/core/faculties/FacultyTreeNode.java

@@ -157,6 +157,11 @@ enum SubDirectories {
  // also, reqs will need to be able to refer to common reqs like the engineering "impact of tech
  // on society" candidates, and the arts elective candidates. How to decide where to put and how
  // to refer to them in a way that specifies that?
+ /*
+ TODO [spec]: make specialization information on course requirements go under a different file
+ hierarchy to follow their object representation:
+ campus >> programs >> specializations >> subject >> files named after specialization UID.
+ */
  ;
  private final Path subDirectory;
 

ucst-core/src/main/java/com/dvf/ucst/core/faculties/vancouver/AppliedScienceFaculties.java renamed to ucst-core/src/main/java/com/dvf/ucst/core/faculties/vancouver/BascFaculties.java

@@ -6,28 +6,29 @@
 import java.util.HashMap;
 import java.util.Map;
 
-public enum AppliedScienceFaculties implements FacultyTreeNode {
- BMEG("Biomedical"),
- CHML("Chemical and Biological"),
- CIVL("Civil"),
- CPEN("Computer"),
- ELEC("Electrical"),
- ENPH("Engineering Physics", ""),
- ENVE("Environmental"),
- GEOE("Geological"),
- IGEN("Integrated"),
- MECH("Mechanical"),
- MINE("Mining"),
- MTRL("Materials"),
+public enum BascFaculties implements FacultyTreeNode {
+ BMEG ("Biomedical"),
+ CHML ("Chemical and Biological"),
+ CIVL ("Civil"),
+ CPEN ("Computer"),
+ ELEC ("Electrical"),
+ ENPH ("Engineering Physics", ""),
+ ENVE ("Environmental"),
+ GEOE ("Geological"),
+ IGEN ("Integrated"),
+ MANU ("Manufacturing"),
+ MECH ("Mechanical"),
+ MINE ("Mining"),
+ MTRL ("Materials"),
  ;
  private final String name;
  private final Map<String, Course> courseCodeMap;
 
- AppliedScienceFaculties(String name) {
+ BascFaculties(String name) {
  this.name = name + " Engineering";
  this.courseCodeMap = new HashMap<>();
  }
- AppliedScienceFaculties(String name, String s) {
+ BascFaculties(String name, String s) {
  this.name = name;
  this.courseCodeMap = new HashMap<>();
  }

ucst-core/src/main/java/com/dvf/ucst/core/faculties/vancouver/ScienceFaculties.java renamed to ucst-core/src/main/java/com/dvf/ucst/core/faculties/vancouver/ScieFaculties.java

@@ -3,13 +3,12 @@
 import com.dvf.ucst.core.courseutils.Course;
 import com.dvf.ucst.core.faculties.FacultyTreeNode;
 
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
 import static com.dvf.ucst.core.faculties.FacultyTreeNode.FacultyTreeNodeType.DEPARTMENT;
 
-public enum ScienceFaculties implements FacultyTreeNode {
+public enum ScieFaculties implements FacultyTreeNode {
  // TODO [data]: add entries as needed. prefer alphabetical order.
  // ...
  CPSC (DEPARTMENT, "Computer Science"),
@@ -24,7 +23,7 @@ public enum ScienceFaculties implements FacultyTreeNode {
  private final Class<? extends FacultyTreeNode> childrenClass;
  private final Map<String, Course> courseCodeMap;
 
- <T extends Enum<?> & FacultyTreeNode> ScienceFaculties(
+ <T extends Enum<?> & FacultyTreeNode> ScieFaculties(
  final FacultyTreeNodeType facultyType,
  final String nonAbbreviatedName,
  final Class<T> childrenClass
@@ -36,7 +35,7 @@ <T extends Enum<?> & FacultyTreeNode> ScienceFaculties(
  }
 
  // constructor for faculties without children faculties.
- ScienceFaculties(final FacultyTreeNodeType facultyType, final String nonAbbreviatedName) {
+ ScieFaculties(final FacultyTreeNodeType facultyType, final String nonAbbreviatedName) {
  this(facultyType, nonAbbreviatedName, null);
  }
 

ucst-core/src/main/java/com/dvf/ucst/core/faculties/vancouver/VancouverFaculties.java

@@ -14,9 +14,9 @@
  */
 public enum VancouverFaculties implements FacultyTreeNode {
  // TODO [data]: add entries as needed. prefer alphabetical order.
- APSC (FACULTY, "Applied Science", AppliedScienceFaculties.class),
+ APSC (FACULTY, "Applied Science", BascFaculties.class),
  // ...
- SCIE (FACULTY, "Science", ScienceFaculties.class),
+ SCIE (FACULTY, "Science", ScieFaculties.class),
  // ...
  ;
  private final FacultyTreeNodeType facultyType;

ucst-core/src/main/java/com/dvf/ucst/core/programs/ProgramOfStudy.java

@@ -21,6 +21,14 @@ public interface ProgramOfStudy {
 
  FacultyTreeRootCampus getCampusContext();
 
+ /*
+ TODO [investigate]: It seems like StudentCoreQualityReqs don't care about the
+ actual specialization- and instead just about the subject (faculty/dept) of
+ the specialization under a program of study. If so, it may not be necessary
+ to implement the methods for specializations like their UID, name, and notes.
+ actually, we probably do- assuming each specialization under the same subject
+ can have its own mappings of years of study to course requirements.
+ */
  Map<FacultyTreeNode, Set<ProgramSpecialization>> getSpecializations(); // must be unmodifiable map.
 
 

ucst-core/src/main/java/com/dvf/ucst/core/programs/ProgramSpecialization.java

@@ -1,7 +1,8 @@
 package com.dvf.ucst.core.programs;
 
 import com.dvf.ucst.core.faculties.FacultyTreeNode;
-import com.dvf.ucst.core.programs.ProgramOfStudy;
+
+import java.nio.file.Path;
 
 /**
  *
@@ -12,4 +13,10 @@ public interface ProgramSpecialization {
 
  FacultyTreeNode getSubject();
 
+ /**
+ * TODO: uncomment and implement. make corresponding method for ProgramOfStudy.
+ * Path to xml file mapping YearOfStudy to course requirements
+ */
+ //Path getCourseRequirementsPath();
+
 }

ucst-core/src/main/java/com/dvf/ucst/core/programs/vancouver/BascSpecializations.java

@@ -1,7 +1,7 @@
 package com.dvf.ucst.core.programs.vancouver;
 
 import com.dvf.ucst.core.faculties.FacultyTreeNode;
-import com.dvf.ucst.core.faculties.vancouver.AppliedScienceFaculties;
+import com.dvf.ucst.core.faculties.vancouver.BascFaculties;
 import com.dvf.ucst.core.programs.ProgramOfStudy;
 import com.dvf.ucst.core.programs.ProgramSpecialization;
 
@@ -34,7 +34,7 @@ default ProgramOfStudy getParentProgram() {
 
  private enum CpenSpecializations implements BascProgramSpecialization {
  ;
- private static final FacultyTreeNode SUBJECT = AppliedScienceFaculties.CPEN;
+ private static final FacultyTreeNode SUBJECT = BascFaculties.CPEN;
 
  @Override
  public FacultyTreeNode getSubject() {
@@ -44,7 +44,7 @@ public FacultyTreeNode getSubject() {
 
  private enum ElecSpecializations implements BascProgramSpecialization {
  ;
- private static final FacultyTreeNode SUBJECT = AppliedScienceFaculties.ELEC;
+ private static final FacultyTreeNode SUBJECT = BascFaculties.ELEC;
 
  @Override
  public FacultyTreeNode getSubject() {