me.vertretungsplan.parser

Class SVPlanParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.SVPlanParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class SVPlanParser
extends BaseParser

Parser for substitution schedules in HTML format created by the svPlan software.

Example: Ratsschule Melle

This parser can be accessed using "svplan" for SubstitutionScheduleData.setApi(String).

Configuration parameters

These parameters can be supplied in SubstitutionScheduleData.setData(JSONObject) to configure the parser:

urls (Array of Strings, required)

The URLs of the HTML files of the schedule. There is one file for each day.

encoding (String, required)

The charset of the HTML files. It's probably either UTF-8 or ISO-8859-1.

classes (Array of Strings, required)

The list of all classes, as they can appear in the schedule

classSeparator (String, optional, Default: ", ")

The string with which multiple classes are separated.

excludeTeachers (Boolean, optional, Default: false)

Don't show teachers on the schedule.

repeatClass (Boolean, optional, Default: true)

Whether an empty class column means that there is no class associated with this substitution (false) or that the class from the previous row should be used (true).

Additionally, this parser supports the parameters specified in LoginHandler for login-protected schedules.

Field Summary

Fields inherited from class me.vertretungsplan.parser.BaseParser

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

Constructor Summary

Constructors

Constructor and Description
SVPlanParser(SubstitutionScheduleData scheduleData, CookieProvider cookieProvider)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAllClasses() Get a list of all available classes.
java.util.List<java.lang.String>	getAllTeachers() Get a list of all available teachers.
SubstitutionSchedule	getSubstitutionSchedule() Downloads and parses the substitution schedule

Methods inherited from class me.vertretungsplan.parser.BaseParser

contains, getClassesFromJson, getCredential, getInstance, getLastChange, httpGet, httpGet, httpPost, httpPost, httpPost, httpPost, isPersonal, recognizeType, setCredential, setDebuggingDataHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

SVPlanParser

public SVPlanParser(SubstitutionScheduleData scheduleData,
                    CookieProvider cookieProvider)

Method Detail

getSubstitutionSchedule

public SubstitutionSchedule getSubstitutionSchedule()
                                             throws java.io.IOException,
                                                    org.json.JSONException,
                                                    CredentialInvalidException

Description copied from interface: SubstitutionScheduleParser

Downloads and parses the substitution schedule

Specified by:

getSubstitutionSchedule in interface SubstitutionScheduleParser

Specified by:

getSubstitutionSchedule in class BaseParser

Returns:

the parsed SubstitutionSchedule

Throws:

java.io.IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException - the supplied credential (BaseParser.setCredential(Credential) is not correct

getAllClasses

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

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:

org.json.JSONException - Error with the JSON configuration

getAllTeachers

public java.util.List<java.lang.String> getAllTeachers()

Description copied from class: BaseParser

Get a list of all available teachers. Can also be null.

Specified by:

getAllTeachers in class BaseParser

Returns:

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