me.vertretungsplan.parser

Class NotCompatibleParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.NotCompatibleParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class NotCompatibleParser
extends BaseParser

Field Summary

Fields inherited from class me.vertretungsplan.parser.BaseParser

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

Constructor Summary

Constructors

Constructor and Description
NotCompatibleParser(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.
Credential	getCredential()
org.joda.time.LocalDateTime	getLastChange() Returns the time when the substitution schedule was last changed.
SubstitutionSchedule	getSubstitutionSchedule() Downloads and parses the substitution schedule
boolean	isPersonal() Some substitution schedule systems allow the user to only see his "own" substitution schedule depending on the credentials he enters.
void	setCredential(Credential credential)

Methods inherited from class me.vertretungsplan.parser.BaseParser

contains, getClassesFromJson, getInstance, getWebdavClient, httpGet, httpGet, httpGet, httpPost, httpPost, httpPost, httpPost, recognizeType, setDebuggingDataHandler, setLocalSource

Methods inherited from class java.lang.Object

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

Constructor Detail

NotCompatibleParser

public NotCompatibleParser(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()
                                                throws java.io.IOException,
                                                       org.json.JSONException,
                                                       CredentialInvalidException

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

CredentialInvalidException

getLastChange

public org.joda.time.LocalDateTime getLastChange()
                                          throws java.io.IOException,
                                                 org.json.JSONException,
                                                 CredentialInvalidException

Description copied from interface: SubstitutionScheduleParser

Returns the time when the substitution schedule was last changed. This can be used to use a previously cached schedule if nothing was changed. Should return null if this information is not available or should not be relied upon. The default implementation in BaseParser returns null.

Specified by:

getLastChange in interface SubstitutionScheduleParser

Overrides:

getLastChange in class BaseParser

Returns:

the time when the substitution schedule was last changed

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

setCredential

public void setCredential(Credential credential)

Specified by:

setCredential in interface SubstitutionScheduleParser

Overrides:

setCredential in class BaseParser

getCredential

public Credential getCredential()

Specified by:

getCredential in interface SubstitutionScheduleParser

Overrides:

getCredential in class BaseParser

isPersonal

public boolean isPersonal()

Description copied from interface: SubstitutionScheduleParser

Some substitution schedule systems allow the user to only see his "own" substitution schedule depending on the credentials he enters. If this is the case - i.e. the parser can return different schedules depending on the credentials - this function should be overridden to return true.

Specified by:

isPersonal in interface SubstitutionScheduleParser

Overrides:

isPersonal in class BaseParser

Returns:

whether this parser returns personal schedules