add skeleton for CourseCategory

Courses will be able to describe any special categories of courses they belong to, such as being in the category of language courses.

Author: david-fong

.idea/gradle.xml

@@ -5,6 +5,7 @@
 import com.dvf.ucst.core.Student.CompletedCourse;
 import com.dvf.ucst.core.StudentCoreQualities;
 import com.dvf.ucst.core.UbcLocalFiles;
+import com.dvf.ucst.core.courseutils.categorymatchers.CourseCategory;
 import com.dvf.ucst.core.faculties.CampusNotFoundException;
 import com.dvf.ucst.core.faculties.FacultyTreeNode;
 import com.dvf.ucst.core.faculties.UbcCampuses;
@@ -36,6 +37,8 @@ public final class Course implements CreditValued, HyperlinkBookIf, SectionIdStr
  private final String courseIdToken;
  private final int creditValue;
  private final String descriptionString;
+ private final Set<CourseCategory> categories =
+ Collections.unmodifiableSet(EnumSet.noneOf(CourseCategory.class)); // unmodifiable. // TODO
 
  // reqs are non-null:
  private final Requirement<StudentCoreQualities> studentReqs;
@@ -111,6 +114,10 @@ public final String getCourseDescription() {
  return descriptionString;
  }
 
+ public Set<CourseCategory> getCategories() {
+ return categories;
+ }
+
  @Override
  public final String getSystemFullSectionIdString() {
  return facultyTreeNode.getRootCampus().getAbbreviation()

ucst-core/src/main/java/com/dvf/ucst/core/courseutils/Course.java

@@ -0,0 +1,33 @@
+package com.dvf.ucst.core.courseutils.categorymatchers;
+
+/**
+ *
+ */
+class CategoryLanguage {
+
+ /*
+ @ naomi. delete this when you don't need it anymore.
+ A [Predicate] is a function that takes an object and returns a boolean value.
+ in java, the "::" operator is used to refer to a function/method as an object.
+ so I could have written this as:
+
+ static Predicate<String> CHECK_OBJECT = new Predicate<String>() {
+ return false;
+ }
+
+ or also in lambda-style shorthand as:
+
+ static Predicate<String> CHECK_OBJECT = (courseCode) -> {
+ return false;
+ }
+
+ and in either of these cases, in CourseCategory.java, it would instead say
+
+ LANGUAGE (CategoryLanguage.CHECK_OBJECT)
+
+ */
+ static boolean CHECK(final String courseCode) {
+ return false; // TODO:
+ }
+
+}

ucst-core/src/main/java/com/dvf/ucst/core/courseutils/categorymatchers/CategoryLanguage.java

@@ -0,0 +1,59 @@
+package com.dvf.ucst.core.courseutils.categorymatchers;
+
+import com.dvf.ucst.utils.xml.MalformedXmlDataException;
+import com.dvf.ucst.utils.xml.XmlUtils;
+import org.w3c.dom.Attr;
+
+import java.util.function.Predicate;
+
+/**
+ * the [isCourseInCategoryCheckerFunction] will be defined in its own file in the
+ * [categorymatchers] package.
+ */
+public enum CourseCategory implements XmlUtils.XmlConstant {
+ LANGUAGE (CategoryLanguage::CHECK),
+ // more things will go here as we find them.
+ ;
+ private final Predicate<String> isCourseInCategoryCheckerFunction;
+
+ CourseCategory(final Predicate<String> isCourseInCategoryCheckerFunction) {
+ this.isCourseInCategoryCheckerFunction = isCourseInCategoryCheckerFunction;
+ }
+
+ public boolean isCourseInThisCategory(final String courseCode) {
+ return isCourseInCategoryCheckerFunction.test(courseCode);
+ }
+
+ @Override
+ public String getXmlConstantValue() {
+ /*
+ @ naomi, delete this comment after reading.
+ this is the enum's name in the source code.
+ for example, the above enum "LANGUAGE" will return "LANGUAGE".
+ we could define names for each one but there's not much point:
+ this string will only be seen in xml files and this works well
+ because we'll be sure that no names are the same (would mess up
+ decoding the xml) (enums of the same type must have different
+ names in the source code).
+ */
+ return name();
+ }
+
+ /**
+ *
+ * @param attr Must not be [null].
+ * @return The [CourseCategory] whose [::getXmlConstantValue] equals [xmlAttrValue.getValue()].
+ * @throws MalformedXmlDataException If no matching [CourseCategory] could be found.
+ */
+ public static CourseCategory decodeXmlAttr(final Attr attr) throws MalformedXmlDataException {
+ // there may be ways to make this perform better (using a static map from
+ // enum names to themselves). for now this is ok!
+ for (final CourseCategory category : CourseCategory.values()) {
+ if (category.getXmlConstantValue().equals(attr.getValue())) {
+ return category;
+ }
+ }
+ throw MalformedXmlDataException.invalidAttrVal(attr);
+ }
+
+}