me.vertretungsplan.parser

Class BaseParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

All Implemented Interfaces:

SubstitutionScheduleParser

Direct Known Subclasses:

CSVParser, DaVinciParser, ESchoolParser, IndiwareMobileParser, IndiwareParser, IphisParser, LegionBoardParser, NotCompatibleParser, SchoolJoomlaParser, SVPlanParser, TurboVertretungParser, UntisCommonParser, WebUntisParser

public abstract class BaseParser
extends java.lang.Object
implements SubstitutionScheduleParser

Base class for SubstitutionScheduleParser implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected ColorProvider	colorProvider
protected CookieProvider	cookieProvider
protected org.apache.http.client.CookieStore	cookieStore
protected Credential	credential
protected DebuggingDataHandler	debuggingDataHandler
protected org.mozilla.universalchardet.UniversalDetector	encodingDetector
protected org.apache.http.client.fluent.Executor	executor
static java.lang.String	PARAM_CLASS_REGEX
protected SubstitutionScheduleData	scheduleData

Method Summary

Modifier and Type	Method and Description
protected static boolean	contains(org.json.JSONArray array, java.lang.String string)
abstract java.util.List<java.lang.String>	getAllClasses() Get a list of all available classes.
abstract java.util.List<java.lang.String>	getAllTeachers() Get a list of all available teachers.
protected java.util.List<java.lang.String>	getClassesFromJson()
Credential	getCredential()
static BaseParser	getInstance(SubstitutionScheduleData data, CookieProvider cookieProvider) Create an appropriate parser for a given school.
org.joda.time.LocalDateTime	getLastChange() Returns the time when the substitution schedule was last changed.
abstract SubstitutionSchedule	getSubstitutionSchedule() Downloads and parses the substitution schedule
protected java.lang.String	httpGet(java.lang.String url, java.lang.String encoding)
protected java.lang.String	httpGet(java.lang.String url, java.lang.String encoding, java.util.Map<java.lang.String,java.lang.String> headers)
protected java.lang.String	httpPost(java.lang.String url, java.lang.String encoding, java.util.List<org.apache.http.NameValuePair> formParams)
protected java.lang.String	httpPost(java.lang.String url, java.lang.String encoding, java.util.List<org.apache.http.NameValuePair> formParams, java.util.Map<java.lang.String,java.lang.String> headers)
protected java.lang.String	httpPost(java.lang.String url, java.lang.String encoding, java.lang.String body, org.apache.http.entity.ContentType contentType)
protected java.lang.String	httpPost(java.lang.String url, java.lang.String encoding, java.lang.String body, org.apache.http.entity.ContentType contentType, java.util.Map<java.lang.String,java.lang.String> headers)
boolean	isPersonal() Some substitution schedule systems allow the user to only see his "own" substitution schedule depending on the credentials he enters.
protected static java.lang.String	recognizeType(java.lang.String text)
void	setCredential(Credential credential)
void	setDebuggingDataHandler(DebuggingDataHandler handler)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_CLASS_REGEX

public static final java.lang.String PARAM_CLASS_REGEX

See Also:

Constant Field Values

scheduleData

protected SubstitutionScheduleData scheduleData

executor

protected org.apache.http.client.fluent.Executor executor

credential

protected Credential credential

cookieStore

protected org.apache.http.client.CookieStore cookieStore

colorProvider

protected ColorProvider colorProvider

cookieProvider

protected CookieProvider cookieProvider

encodingDetector

protected org.mozilla.universalchardet.UniversalDetector encodingDetector

debuggingDataHandler

protected DebuggingDataHandler debuggingDataHandler

Method Detail

getInstance

public static BaseParser getInstance(SubstitutionScheduleData data,
                                     @Nullable
                                     CookieProvider cookieProvider)

Create an appropriate parser for a given school. Automatically uses the appropriate subclass depending on SubstitutionScheduleData.getApi().

Parameters:

data - a SubstitutionScheduleData object containing information about the substitution schedule

Returns:

a BaseParser subclass able to parse the given schedule.

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

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 (setCredential(Credential) is not correct

recognizeType

protected static java.lang.String recognizeType(java.lang.String text)

getSubstitutionSchedule

public abstract 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

Returns:

the parsed SubstitutionSchedule

Throws:

java.io.IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

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

getAllClasses

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

Get a list of all available classes.

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 abstract java.util.List<java.lang.String> getAllTeachers()
                                                         throws java.io.IOException,
                                                                org.json.JSONException,
                                                                CredentialInvalidException

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

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

getCredential

public Credential getCredential()

Specified by:

getCredential in interface SubstitutionScheduleParser

setCredential

public void setCredential(Credential credential)

Specified by:

setCredential in interface SubstitutionScheduleParser

setDebuggingDataHandler

public void setDebuggingDataHandler(DebuggingDataHandler handler)

httpGet

protected java.lang.String httpGet(java.lang.String url,
                                   java.lang.String encoding)
                            throws java.io.IOException,
                                   CredentialInvalidException

Throws:

java.io.IOException

CredentialInvalidException

httpGet

protected java.lang.String httpGet(java.lang.String url,
                                   java.lang.String encoding,
                                   java.util.Map<java.lang.String,java.lang.String> headers)
                            throws java.io.IOException,
                                   CredentialInvalidException

Throws:

java.io.IOException

CredentialInvalidException

httpPost

protected java.lang.String httpPost(java.lang.String url,
                                    java.lang.String encoding,
                                    java.util.List<org.apache.http.NameValuePair> formParams)
                             throws java.io.IOException,
                                    CredentialInvalidException

Throws:

java.io.IOException

CredentialInvalidException

httpPost

protected java.lang.String httpPost(java.lang.String url,
                                    java.lang.String encoding,
                                    java.util.List<org.apache.http.NameValuePair> formParams,
                                    java.util.Map<java.lang.String,java.lang.String> headers)
                             throws java.io.IOException,
                                    CredentialInvalidException

Throws:

java.io.IOException

CredentialInvalidException

httpPost

protected java.lang.String httpPost(java.lang.String url,
                                    java.lang.String encoding,
                                    java.lang.String body,
                                    org.apache.http.entity.ContentType contentType)
                             throws java.io.IOException,
                                    CredentialInvalidException

Throws:

java.io.IOException

CredentialInvalidException

httpPost

protected java.lang.String httpPost(java.lang.String url,
                                    java.lang.String encoding,
                                    java.lang.String body,
                                    org.apache.http.entity.ContentType contentType,
                                    java.util.Map<java.lang.String,java.lang.String> headers)
                             throws java.io.IOException,
                                    CredentialInvalidException

Throws:

java.io.IOException

CredentialInvalidException

contains

protected static boolean contains(org.json.JSONArray array,
                                  java.lang.String string)
                           throws org.json.JSONException

Throws:

org.json.JSONException

getClassesFromJson

@Nullable
protected java.util.List<java.lang.String> getClassesFromJson()
                                                                  throws org.json.JSONException

Throws:

org.json.JSONException

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

Returns:

whether this parser returns personal schedules