SubstitutionSchedule (parser 1.0.0-beta326 API)

java.lang.Object
- me.vertretungsplan.objects.SubstitutionSchedule

All Implemented Interfaces:: java.lang.Cloneable

public class SubstitutionSchedule
extends java.lang.Object
implements java.lang.Cloneable

Represents a school's substitution schedule

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SubstitutionSchedule.Type
Represents the type of a substitution schedule

Nested Classes
Modifier and Type	Class and Description
`static class`	`SubstitutionSchedule.Type` Represents the type of a substitution schedule

Constructor Summary

Constructors
Constructor and Description
`SubstitutionSchedule()`
`SubstitutionSchedule(SubstitutionSchedule other)` Creates a new SubstitutionSchedule containing the same data as the given one

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdditionalInfo(AdditionalInfo info)` Add an additional info to this schedule
`void`	`addDay(SubstitutionScheduleDay newDay)` Add a day to this substitution schedule
`SubstitutionSchedule`	`clone()`
`boolean`	`equals(java.lang.Object o)`
`static java.util.Set<Substitution>`	`filterByClass(java.lang.String theClass, java.util.Set<Substitution> substitutions)` Filter a set of substitutions by class
`protected void`	`filterByClassAndExcludedSubject(SubstitutionSchedule filteredSchedule, java.lang.String theClass, java.util.Set<java.lang.String> excludedSubjects)`
`static java.util.Set<Substitution>`	`filterBySubject(java.util.Set<java.lang.String> excludedSubjects, java.util.Set<Substitution> substitutions)` Filter a set of substitutions by excluding a set of subjects
`static java.util.Set<Substitution>`	`filterByTeacher(java.lang.String teacher, java.util.Set<Substitution> substitutions)` Filter a set of substitutions by teacher
`protected void`	`filterByTeacherAndExcludedSubject(SubstitutionSchedule filteredSchedule, java.lang.String teacher, java.util.Set<java.lang.String> excludedSubjects)`
`SubstitutionSchedule`	`filteredByClassAndExcludedSubject(java.lang.String theClass, java.util.Set<java.lang.String> excludedSubjects)` Get a new schedule that only contains the data that applies to the specified class, excluding substitutions for the specified subjects.
`SubstitutionSchedule`	`filteredByTeacherAndExcludedSubject(java.lang.String teacher, java.util.Set<java.lang.String> excludedSubjects)` Get a new schedule that only contains the data that applies to the specified teacher, excluding substitutions for the specified subjects.
`static SubstitutionSchedule`	`fromData(SubstitutionScheduleData scheduleData)` Initialize a SubstitutionSchedule with the correct type taken from a `SubstitutionScheduleData`
`java.util.List<AdditionalInfo>`	`getAdditionalInfos()` Get the list of additional infos on this schedule
`java.util.List<java.lang.String>`	`getClasses()` Get the list of classes that can appear on this schedule.
`java.util.List<SubstitutionScheduleDay>`	`getDays()` Get the list of days included in this schedule
`org.joda.time.LocalDateTime`	`getLastChange()` Get the date and time where this schedule was last updated.
`java.lang.String`	`getLastChangeString()` Get the date and time where this schedule was last updated as a string representation
`java.util.List<java.lang.String>`	`getTeachers()` Get the list of teachers that can appear on this schedule.
`SubstitutionSchedule.Type`	`getType()` Get the type of this schedule
`java.lang.String`	`getWebsite()` Get the website where this schedule can be found online
`int`	`hashCode()`
`void`	`setClasses(java.util.List<java.lang.String> classes)` Set the list of classes.
`void`	`setLastChange(org.joda.time.LocalDateTime lastChange)` Set the date and time where this schedule was last updated.
`void`	`setLastChangeString(java.lang.String lastChangeString)` Set the date and time where this schedule was last updated as a string representation.
`void`	`setTeachers(java.util.List<java.lang.String> teachers)` Set the list of teachers.
`void`	`setType(SubstitutionSchedule.Type type)` Set the type of this schedule
`void`	`setWebsite(java.lang.String website)` Set the website where this schedule can be found online
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SubstitutionSchedule
```
public SubstitutionSchedule()
```
  - SubstitutionSchedule
```
public SubstitutionSchedule(SubstitutionSchedule other)
```
    Creates a new SubstitutionSchedule containing the same data as the given one
    
    Parameters:
    
    other - the SubstitutionSchedule whose data to use
- Method Detail
  - fromData
```
public static SubstitutionSchedule fromData(SubstitutionScheduleData scheduleData)
```
    Initialize a SubstitutionSchedule with the correct type taken from a SubstitutionScheduleData
    
    Parameters:
    
    scheduleData - a SubstitutionScheduleData to create a schedule for
    
    Returns:
    
    a schedule initialized with the correct type
  - filterByClass
```
public static java.util.Set<Substitution> filterByClass(java.lang.String theClass,
                                                        java.util.Set<Substitution> substitutions)
```
    Filter a set of substitutions by class
    
    Parameters:
    
    theClass - the name of a class
    
    substitutions - a set of Substitutions
    
    Returns:
    
    the substitutions from the set that apply to the specified class
  - filterBySubject
```
public static java.util.Set<Substitution> filterBySubject(java.util.Set<java.lang.String> excludedSubjects,
                                                          java.util.Set<Substitution> substitutions)
```
    Filter a set of substitutions by excluding a set of subjects
    
    Parameters:
    
    excludedSubjects - a set of subjects to exclude
    
    substitutions - a set of Substitutions
    
    Returns:
    
    the substitutions from the set that are not for one of the specified subjects
  - filterByTeacher
```
public static java.util.Set<Substitution> filterByTeacher(java.lang.String teacher,
                                                          java.util.Set<Substitution> substitutions)
```
    Filter a set of substitutions by teacher
    
    Parameters:
    
    teacher - a teacher's name/abbreviation
    
    substitutions - a set of Substitutions
    
    Returns:
    
    the substitutions from the set that apply to the specified teacher
  - getType
```
public SubstitutionSchedule.Type getType()
```
    Get the type of this schedule
    
    Returns:
    
    the type of this schedule
  - setType
```
public void setType(SubstitutionSchedule.Type type)
```
    Set the type of this schedule
    
    Parameters:
    
    type - the type of this schedule
  - getLastChange
```
public org.joda.time.LocalDateTime getLastChange()
```
    Get the date and time where this schedule was last updated. If the date could not be parsed, there is only a string representation available using getLastChangeString().
    
    Returns:
    
    the date and time where this schedule was last updated
  - setLastChange
```
public void setLastChange(org.joda.time.LocalDateTime lastChange)
```
    Set the date and time where this schedule was last updated. If the date could not be parsed, use setLastChangeString(String) to specify a string representation. If you used SubstitutionScheduleDay.setLastChange(LocalDateTime), this will automatically be set to the newest date of all the days.
    
    Parameters:
    
    lastChange - the date and time where this schedule was last updated.
  - getLastChangeString
```
public java.lang.String getLastChangeString()
```
    Get the date and time where this schedule was last updated as a string representation
    
    Returns:
    
    the date and time where this schedule was last updated, as a string representation
  - setLastChangeString
```
public void setLastChangeString(java.lang.String lastChangeString)
```
    Set the date and time where this schedule was last updated as a string representation. If you can parse the date, you should use setLastChange(LocalDateTime) instead.
    
    Parameters:
    
    lastChangeString - the date and time where this schedule was last updated, as a string representation
  - getWebsite
```
public java.lang.String getWebsite()
```
    Get the website where this schedule can be found online
    
    Returns:
    
    the website URL
  - setWebsite
```
public void setWebsite(java.lang.String website)
```
    Set the website where this schedule can be found online
    
    Parameters:
    
    website - the website URl
  - getDays
```
public java.util.List<SubstitutionScheduleDay> getDays()
```
    Get the list of days included in this schedule
    
    Returns:
    
    the list of days
  - addDay
```
public void addDay(SubstitutionScheduleDay newDay)
```
    Add a day to this substitution schedule
    
    Parameters:
    
    newDay - the day to add
  - getAdditionalInfos
```
public java.util.List<AdditionalInfo> getAdditionalInfos()
```
    Get the list of additional infos on this schedule
    
    Returns:
    
    the list of additional infos on this schedule
  - addAdditionalInfo
```
public void addAdditionalInfo(AdditionalInfo info)
```
    Add an additional info to this schedule
    
    Parameters:
    
    info - the additional info to add
  - getClasses
```
public java.util.List<java.lang.String> getClasses()
```
    Get the list of classes that can appear on this schedule. May only be empty if this is a SubstitutionSchedule.Type.TEACHER schedule
    
    Returns:
    
    the list of classes
  - setClasses
```
public void setClasses(java.util.List<java.lang.String> classes)
```
    Set the list of classes. Not required if this is a SubstitutionSchedule.Type.TEACHER schedule.
    
    Parameters:
    
    classes - the list of classes to set.
  - getTeachers
```
public java.util.List<java.lang.String> getTeachers()
```
    Get the list of teachers that can appear on this schedule. May be empty even if this is a SubstitutionSchedule.Type.TEACHER schedule.
    
    Returns:
    
    the list of teachers
  - setTeachers
```
public void setTeachers(java.util.List<java.lang.String> teachers)
```
    Set the list of teachers. Not required even if this is a SubstitutionSchedule.Type.TEACHER schedule.
    
    Parameters:
    
    teachers - the list of teachers to set.
  - clone
```
public SubstitutionSchedule clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - filteredByClassAndExcludedSubject
```
public SubstitutionSchedule filteredByClassAndExcludedSubject(java.lang.String theClass,
                                                              java.util.Set<java.lang.String> excludedSubjects)
```
    Get a new schedule that only contains the data that applies to the specified class, excluding substitutions for the specified subjects.
    
    Parameters:
    
    theClass - the class whose substitutions should be included
    
    excludedSubjects - the subjects that should be excluded
    
    Returns:
    
    a new SubstitutionSchedule containing the filtered data
  - filterByClassAndExcludedSubject
```
protected void filterByClassAndExcludedSubject(SubstitutionSchedule filteredSchedule,
                                               java.lang.String theClass,
                                               java.util.Set<java.lang.String> excludedSubjects)
```
  - filteredByTeacherAndExcludedSubject
```
public SubstitutionSchedule filteredByTeacherAndExcludedSubject(java.lang.String teacher,
                                                                java.util.Set<java.lang.String> excludedSubjects)
```
    Get a new schedule that only contains the data that applies to the specified teacher, excluding substitutions for the specified subjects.
    
    Parameters:
    
    teacher - the teacher whose substitutions should be included
    
    excludedSubjects - the subjects that should be excluded
    
    Returns:
    
    a new SubstitutionSchedule containing the filtered data
  - filterByTeacherAndExcludedSubject
```
protected void filterByTeacherAndExcludedSubject(SubstitutionSchedule filteredSchedule,
                                                 java.lang.String teacher,
                                                 java.util.Set<java.lang.String> excludedSubjects)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SubstitutionSchedule

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubstitutionSchedule

SubstitutionSchedule

Method Detail

fromData

filterByClass

filterBySubject

filterByTeacher

getType

setType

getLastChange

setLastChange

getLastChangeString

setLastChangeString

getWebsite

setWebsite

getDays

addDay

getAdditionalInfos

addAdditionalInfo

getClasses

setClasses

getTeachers

setTeachers

clone

filteredByClassAndExcludedSubject

filterByClassAndExcludedSubject

filteredByTeacherAndExcludedSubject

filterByTeacherAndExcludedSubject

equals

hashCode

toString