me.vertretungsplan.parser

Class IndiwareParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.IndiwareParser

All Implemented Interfaces:

SubstitutionScheduleParser

Direct Known Subclasses:

IndiwareStundenplan24Parser

public class IndiwareParser
extends BaseParser

Parser for substitution schedules in XML or HTML format created by the Indiware software.

This parser can be accessed using "indiware" 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 XML files of the schedule. There is one file for each day. If the filenames themselves contain the date, you can use something like {date(yyyy-MM-dd)} in the URL. This placeholder will then be replaced with the dates of the next 7 days.

encoding (String, required)

The charset of the XML 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

embeddedContentSelector (String, optional)

When the Untis 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 Indiware HTML 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

Modifier and Type	Field and Description
protected org.json.JSONObject	data

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
IndiwareParser(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

Field Detail

data

protected org.json.JSONObject data

Constructor Detail

IndiwareParser

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

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

getAllTeachers

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

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)

Throws:

java.io.IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration