me.vertretungsplan.parser

Class DaVinciParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.DaVinciParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class DaVinciParser
extends BaseParser

Parser for substitution schedules in HTML format created by the DaVinci software. Supports DaVinci 6 and 5 (the latter was not tested in depth yet).

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

Configuration parameters

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

url (String, required if urls not specified)

The URL of the home page of the DaVinci HTML export can be found. This can either be a schedule for a single day or an overview page with a selection of classes or days (in both calendar and list views)

urls (Array of strings, required if url not specified)

The URLs of the home page of the DaVinci HTML export can be found. This can either be a schedule for a single day or an overview page with a selection of classes or days (in both calendar and list views)

classes (Array of Strings, required if classesSource not specified)

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

classesSource (String, optional)

The URL of the homepage of a DaVinci timetable, showing the list of all available classes

website (String, recommended)

The URL of a website where the substitution schedule can be seen online

embeddedContentSelector (String, optional)

When the DaVinci schedule is embedded in another HTML file using server-side code, you can use this to specify which HTML elements should be considered as the containers for the DaVinci schedule. The CSS selector syntax is supported as specified by JSoup.

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, sardine, scheduleData

Constructor Summary

Constructors

Constructor and Description
DaVinciParser(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, 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

Constructor Detail

DaVinciParser

public DaVinciParser(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 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

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)