me.vertretungsplan.parser

Class BaseParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

All Implemented Interfaces:

SubstitutionScheduleParser

Direct Known Subclasses:

CSVParser, DaVinciParser, ESchoolParser, SVPlanParser, TurboVertretungParser, UntisCommonParser

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 org.apache.http.client.fluent.Executor	executor
protected SubstitutionScheduleData	scheduleData

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	contains(org.json.JSONArray array, java.lang.String string)
abstract java.util.List<java.lang.String>	getAllClasses() Gibt eine Liste aller verfügbaren Klassen zurück.
abstract java.util.List<java.lang.String>	getAllTeachers()
protected java.util.List<java.lang.String>	getClassesFromJson()
protected java.lang.String	getClassName(java.lang.String text, org.json.JSONObject data)
Credential	getCredential()
static BaseParser	getInstance(SubstitutionScheduleData data, CookieProvider cookieProvider) Create an appropriate parser for a given school.
abstract SubstitutionSchedule	getSubstitutionSchedule() Ruft den Vertretungsplan ab und parst ihn.
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)
protected static java.lang.String	recognizeType(java.lang.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

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

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 java.lang.String recognizeType(java.lang.String text)

getSubstitutionSchedule

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

Ruft den Vertretungsplan ab und parst ihn. Wird immer asynchron ausgeführt.

Specified by:

getSubstitutionSchedule in interface SubstitutionScheduleParser

Returns:

Der geparste SubstitutionSchedule

Throws:

java.io.IOException

org.json.JSONException

CredentialInvalidException

getAllClasses

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

Gibt eine Liste aller verfügbaren Klassen zurück. Wird immer asynchron ausgeführt.

Returns:

Eine Liste aller verfügbaren Klassen für diese Schule (auch die, die nicht aktuell vom Vertretungsplan betroffen sind)

Throws:

java.io.IOException

org.json.JSONException

getAllTeachers

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

Throws:

java.io.IOException

org.json.JSONException

getCredential

public Credential getCredential()

Specified by:

getCredential in interface SubstitutionScheduleParser

setCredential

public void setCredential(Credential credential)

Specified by:

setCredential in interface SubstitutionScheduleParser

httpGet

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

Throws:

java.io.IOException

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

Throws:

java.io.IOException

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

Throws:

java.io.IOException

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

Throws:

java.io.IOException

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

Throws:

java.io.IOException

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

Throws:

java.io.IOException

getClassName

protected java.lang.String getClassName(java.lang.String text,
                            org.json.JSONObject data)
                                 throws org.json.JSONException

Throws:

org.json.JSONException

contains

protected 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