me.vertretungsplan.parser

Class CSVParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.CSVParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class CSVParser
extends BaseParser

Generic parser for substitution schedules in CSV format.

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

Configuration parameters

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

url (String, required)

The url of the CSV file to be fetched

separator (String, required)

The separator used in the CSV file (such as ",", ";" or "\t")

columns (Array of Strings, required)

The order of columns used in the CSV file. Entries can be: "lesson", "subject", "previousSubject", "type", "type-entfall", "room", "previousRoom", "teacher", "previousTeacher", desc", "desc-type", "class", "day", "stand", "ignore"

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

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

website (String, recommended)

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

skipLines (Integer, optional)

The number of lines to skip at the beginning of the CSV file. Default: 0

classesUrl (String, optional)

The URL of an additional CSV file containing the classes, one per line

classRegex (String, optional)

RegEx to modify the classes set on the schedule (in 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.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVParser

public CSVParser(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()

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)