me.vertretungsplan.parser

Class UntisCommonParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.UntisCommonParser

All Implemented Interfaces:

SubstitutionScheduleParser

Direct Known Subclasses:

UntisInfoHeadlessParser, UntisInfoParser, UntisMonitorParser, UntisSubstitutionParser

public abstract class UntisCommonParser
extends BaseParser

Contains common code used by UntisInfoParser, UntisInfoHeadlessParser, UntisMonitorParser and UntisSubstitutionParser.

Configuration parameters

These parameters can be supplied in SubstitutionScheduleData.setData(JSONObject) in addition to the parameters specified in the documentation of the parser itself.

columns (Array of Strings, required)

The order of columns used in the substitutions table. Entries can be: "lesson", "subject", "previousSubject", "type", "type-entfall", "room", "previousRoom", "teacher", "previousTeacher", desc", "desc-type", "substitutionFrom", "teacherTo", "class", "ignore" ("class" only works when classInExtraLine is false.

lastChangeLeft (Boolean, optional)

Whether the date of last change is in the top left corner instead of in the .mon_head table. Default: false

classInExtraLine (Boolean, optional)

Whether the changes in the table are grouped using headers containing the class name(s). Default: false

teacherInExtraLine (Boolean, optional)

Whether the changes in the table are grouped using headers containing the teacher name. Default: false

classesSeparated (Boolean, optional)

Whether the class names are separated by commas. If this is set to false, combinations like "5abcde" are attempted to be accounted for using an ugly algorithm based on RegExes generated from getAllClasses(). Default: true

excludeClasses (Array of Strings, optional)

Substitutions for classes from this Array are ignored when reading the schedule. By default, only the class "-----" is ignored.

classRegex (String, optional)

RegEx to modify the classes set on the schedule (in BaseParser.getSubstitutionSchedule(), not getAllClasses(). The RegEx is matched against the class using Matcher.find(). If the RegEx contains a group, the content of the first group Matcher.group(int) is used as the resulting class. Otherwise, Matcher.group() is used. If the RegEx cannot be matched (Matcher.find() returns false), the class is set to an empty string.

typeAutoDetection (Boolean, optional)

If there is no type column and the detection using desc-type did not work, this sets whether the type may be automatically set to "Entfall" (cancellation) depending on the values of other columns. Default: true

allClassesCourses (Array of Strings, optional)

If a class included in this array is given on the schedule, this will be replaced by a list of all classes. This is useful for courses that all or multiple classes can attend, but that are saved as a separate class in Untis. Default: empty

Field Summary

Fields inherited from class me.vertretungsplan.parser.BaseParser

colorProvider, cookieProvider, cookieStore, credential, debuggingDataHandler, encodingDetector, executor, PARAM_CLASS_REGEX, sardine, scheduleData

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAllClasses() Get a list of all available classes.
protected void	parseSubstitutionTable(SubstitutionSchedule v, java.lang.String lastChange, org.jsoup.nodes.Document doc)
protected void	parseSubstitutionTable(SubstitutionSchedule v, java.lang.String lastChange, org.jsoup.nodes.Document doc, java.lang.String className) Parses an Untis substitution table (UntisSubstitutionParser).

Methods inherited from class me.vertretungsplan.parser.BaseParser

contains, getAllTeachers, getClassesFromJson, getCredential, getInstance, getLastChange, getSubstitutionSchedule, getWebdavClient, httpGet, httpGet, httpGet, httpPost, httpPost, httpPost, httpPost, isPersonal, recognizeType, setCredential, setDebuggingDataHandler, setLocalSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAllClasses

public java.util.List<java.lang.String> getAllClasses()
                                               throws java.io.IOException,
                                                      org.json.JSONException,
                                                      CredentialInvalidException

Description copied from class: BaseParser

Get a list of all available classes.

Specified by:

getAllClasses in class BaseParser

Returns:

a list of all available classes (also those not currently affected by the substitution schedule)

Throws:

java.io.IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException

parseSubstitutionTable

protected void parseSubstitutionTable(SubstitutionSchedule v,
                                      java.lang.String lastChange,
                                      org.jsoup.nodes.Document doc)
                               throws CredentialInvalidException,
                                      java.io.IOException,
                                      org.json.JSONException

Throws:

CredentialInvalidException

java.io.IOException

org.json.JSONException

parseSubstitutionTable

protected void parseSubstitutionTable(SubstitutionSchedule v,
                                      java.lang.String lastChange,
                                      org.jsoup.nodes.Document doc,
                                      java.lang.String className)
                               throws org.json.JSONException,
                                      CredentialInvalidException,
                                      java.io.IOException

Parses an Untis substitution table (UntisSubstitutionParser).

Parameters:

v -

lastChange -

doc -

Throws:

org.json.JSONException

CredentialInvalidException

java.io.IOException