me.vertretungsplan.parser

Class BaseParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

All Implemented Interfaces:

SubstitutionScheduleParser

Direct Known Subclasses:

CSVParser, DaVinciParser, ESchoolParser, IndiwareParser, LegionBoardParser, SVPlanParser, TurboVertretungParser, UntisCommonParser, WebUntisParser

public abstract class BaseParser
extends 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 org.mozilla.universalchardet.UniversalDetector	encodingDetector
protected org.apache.http.client.fluent.Executor	executor
static String	PARAM_CLASS_REGEX
protected SubstitutionScheduleData	scheduleData

Method Summary

Modifier and Type	Method and Description
protected boolean	contains(org.json.JSONArray array, String string)
abstract List<String>	getAllClasses() Get a list of all available classes.
abstract List<String>	getAllTeachers() Get a list of all available teachers.
protected List<String>	getClassesFromJson()
Credential	getCredential()
static BaseParser	getInstance(SubstitutionScheduleData data, CookieProvider cookieProvider) Create an appropriate parser for a given school.
abstract SubstitutionSchedule	getSubstitutionSchedule() Downloads and parses the substitution schedule
protected String	httpGet(String url, String encoding)
protected String	httpGet(String url, String encoding, Map<String,String> headers)
protected String	httpPost(String url, String encoding, List<org.apache.http.NameValuePair> formParams)
protected String	httpPost(String url, String encoding, List<org.apache.http.NameValuePair> formParams, Map<String,String> headers)
protected String	httpPost(String url, String encoding, String body, org.apache.http.entity.ContentType contentType)
protected String	httpPost(String url, String encoding, String body, org.apache.http.entity.ContentType contentType, Map<String,String> headers)
protected static String	recognizeType(String text)
void	setCredential(Credential credential)

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

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.

recognizeType

protected static String recognizeType(String text)

getSubstitutionSchedule

public abstract SubstitutionSchedule getSubstitutionSchedule()
                                                      throws IOException,
                                                             org.json.JSONException,
                                                             CredentialInvalidException

Downloads and parses the substitution schedule

Specified by:

getSubstitutionSchedule in interface SubstitutionScheduleParser

Returns:

the parsed SubstitutionSchedule

Throws:

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 List<String> getAllClasses()
                                    throws 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:

IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException

getAllTeachers

public abstract List<String> getAllTeachers()
                                     throws 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:

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

httpGet

protected String httpGet(String url,
                         String encoding)
                  throws IOException,
                         CredentialInvalidException

Throws:

IOException

CredentialInvalidException

httpGet

protected String httpGet(String url,
                         String encoding,
                         Map<String,String> headers)
                  throws IOException,
                         CredentialInvalidException

Throws:

IOException

CredentialInvalidException

httpPost

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

Throws:

IOException

CredentialInvalidException

httpPost

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

Throws:

IOException

CredentialInvalidException

httpPost

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

Throws:

IOException

CredentialInvalidException

httpPost

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

Throws:

IOException

CredentialInvalidException

contains

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

Throws:

org.json.JSONException

getClassesFromJson

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

Throws:

org.json.JSONException