me.vertretungsplan.objects

Class Substitution

java.lang.Object

me.vertretungsplan.objects.Substitution

All Implemented Interfaces:

java.lang.Cloneable

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

Represents one substitution on a SubstitutionSchedule

Constructor Summary

Constructors

Constructor and Description
Substitution()
Substitution(Substitution substitution, java.util.Set<java.lang.String> classes) Creates a copy of a substitution with a different set of classes

Method Summary

Modifier and Type	Method and Description
Substitution	clone()
boolean	equals(java.lang.Object o)
boolean	equalsExcludingClasses(java.lang.Object o) Check if this substitution equals another one, but excluding the classes.
boolean	equalsExcludingPreviousTeachers(java.lang.Object o) Check if this substitution equals another one, but excluding the previous teachers.
boolean	equalsExcludingTeachers(java.lang.Object o) Check if this substitution equals another one, but excluding the teachers.
boolean	equalsExcludingType(java.lang.Object o) Check if this substitution equals another one, but excluding the type.
java.util.Set<java.lang.String>	getClasses() Get the classes this substitution applies for
java.lang.String	getColor() Get the color in which this substitution should be shown on the schedule as hexadecimal representation (such as #FF0000 for red).
java.lang.String	getDesc() Get an additional description of this substitution, such as "tasks on page 42" or "moved to 6th lesson."
java.lang.String	getLesson() Get the lesson which this substitution is for.
java.lang.String	getPreviousAndCurrentTeacherText()
java.lang.String	getPreviousRoom() Get the room in which this lesson would have been taught according to the regular schedule.
java.lang.String	getPreviousSubject() Get the subject that would have been taught in this lesson according to the regular schedule.
java.lang.String	getPreviousTeacher() Get the teacher who would have given this lesson according to the regular schedule.
java.util.Set<java.lang.String>	getPreviousTeachers() Get the teachers who would have given this lesson according to the regular schedule.
java.lang.String	getRoom() Get the room in which this lesson will be taught.
java.lang.String	getSubject() Get the subject that will be taught in this lesson.
java.lang.String	getSubstitutionFrom() Get the "substitution from" ("Vertr. von") value.
java.lang.String	getTeacher() Get the teacher giving this lesson.
java.util.Set<java.lang.String>	getTeachers() Get the teachers giving this lesson.
java.lang.String	getTeacherText()
java.lang.String	getTeacherTo() Get the "teacher to" ("(Le.) nach") value.
java.lang.String	getText()
java.lang.String	getType() Get the type of this substitution.
int	hashCode()
void	setClasses(java.util.Set<java.lang.String> classes) Set the classes this substitution applies for.
void	setColor(java.lang.String color) Set the color in which this substitution should be shown on the schedule as hexadecimal representation (such as #FF0000 for red).
void	setDesc(java.lang.String desc) Set an additional description of this substitution, such as "tasks on page 42" or "moved to 6th lesson."
void	setLesson(java.lang.String lesson) Set the lesson which this substitution is for.
void	setPreviousRoom(java.lang.String previousRoom) Set the room in which this lesson would have been taught according to the regular schedule.
void	setPreviousSubject(java.lang.String previousSubject) Set the subject that would have been taught in this lesson according to the regular schedule.
void	setPreviousTeacher(java.lang.String previousTeacher) Set the teacher who would have given this lesson according to the regular schedule.
void	setPreviousTeachers(java.util.Set<java.lang.String> previousTeachers) Set the teachers who would have given this lesson according to the regular schedule.
void	setRoom(java.lang.String room) Set the room in which this lesson will be taught.
void	setSubject(java.lang.String subject) Set the subject that will be taught in this lesson.
void	setSubstitutionFrom(java.lang.String substitutionFrom) Set the "substitution from" ("Vertr. von") value.
void	setTeacher(java.lang.String teacher) Set the teacher giving this lesson.
void	setTeachers(java.util.Set<java.lang.String> teachers) Set the teachers giving this lesson.
void	setTeacherTo(java.lang.String teacherTo) Set the "teacher to" ("(Le.) nach") value.
void	setType(java.lang.String type) Set the type of this substitution.
java.lang.String	toString()
java.lang.String	toString(SubstitutionSchedule.Type type) Get a string representation of the substitution, using different wording depending on the type.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Substitution

public Substitution()

Substitution

public Substitution(Substitution substitution,
                    java.util.Set<java.lang.String> classes)

Creates a copy of a substitution with a different set of classes

Parameters:

substitution - the substitution to copy

classes - the set of classes to use

Method Detail

getText

public java.lang.String getText()

Returns:

A text describing the substitution (designed to be shown together with class, type and lesson)

getTeacherText

public java.lang.String getTeacherText()

Returns:

A text describing the substitution (designed to be shown together with getPreviousAndCurrentTeacherText(), type and lesson)

getPreviousAndCurrentTeacherText

public java.lang.String getPreviousAndCurrentTeacherText()

Returns:

A text describing the current and previous teacher

getClasses

public java.util.Set<java.lang.String> getClasses()

Get the classes this substitution applies for

Returns:

the classes

setClasses

public void setClasses(java.util.Set<java.lang.String> classes)

Set the classes this substitution applies for. Required.

Parameters:

classes - the classes to set

getLesson

public java.lang.String getLesson()

Get the lesson which this substitution is for. Keep it short, the recommended format is e.g. "1" for single lessons and "5-6" for multiple lessons. But some schools use different ways to name their lessons.

Returns:

the lesson

setLesson

public void setLesson(java.lang.String lesson)

Set the lesson which this substitution is for. Keep it short, the recommended format is e.g. "1" for single lessons and "5-6" for multiple lessons. But some schools use different ways to name their lessons. Required.

Parameters:

lesson - the lesson

getType

public java.lang.String getType()

Get the type of this substitution. Something like "substitution", "cancellation", "different room" ("Vertretung", "Entfall", "anderer Raum") etc.

Returns:

the type

setType

public void setType(java.lang.String type)

Set the type of this substitution. Something like "substitution", "cancellation", "different room" ("Vertretung", "Entfall", "anderer Raum") etc. Required.

Parameters:

type - the type to set

getSubject

public java.lang.String getSubject()

Get the subject that will be taught in this lesson.

Returns:

the subject

setSubject

public void setSubject(java.lang.String subject)

Set the subject that will be taught in this lesson.

Parameters:

subject - the subject to set

getPreviousSubject

public java.lang.String getPreviousSubject()

Get the subject that would have been taught in this lesson according to the regular schedule.

Returns:

the previous subject

setPreviousSubject

public void setPreviousSubject(java.lang.String previousSubject)

Set the subject that would have been taught in this lesson according to the regular schedule.

Parameters:

previousSubject - the previous subject to set

getTeacher

public java.lang.String getTeacher()

Get the teacher giving this lesson. Abbreviations are used in most cases. If there are multiple teachers, they are returned as a comma-separated list. See also getTeachers().

Returns:

the teacher

getTeachers

public java.util.Set<java.lang.String> getTeachers()

Get the teachers giving this lesson. Abbreviations are used in most cases.

Returns:

the teachers

setTeacher

public void setTeacher(java.lang.String teacher)

Set the teacher giving this lesson. Abbreviations are used in most cases. If there are multiple teachers, use setTeachers(Set) instead.

Parameters:

teacher - the teacher to set

setTeachers

public void setTeachers(java.util.Set<java.lang.String> teachers)

Set the teachers giving this lesson. Abbreviations are used in most cases.

Parameters:

teachers - the teachers to set

getPreviousTeacher

public java.lang.String getPreviousTeacher()

Get the teacher who would have given this lesson according to the regular schedule. Abbreviations are used in most cases. If there are multiple teachers, they are returned as a comma-separated list. See also getPreviousTeachers().

Returns:

the previous teacher

getPreviousTeachers

public java.util.Set<java.lang.String> getPreviousTeachers()

Get the teachers who would have given this lesson according to the regular schedule. Abbreviations are used in most cases.

Returns:

the previous teachers

setPreviousTeacher

public void setPreviousTeacher(java.lang.String previousTeacher)

Set the teacher who would have given this lesson according to the regular schedule. Abbreviations are used in most cases. If there are multiple teachers, use setPreviousTeachers(Set) instead.

Parameters:

previousTeacher - the previous teacher to set

setPreviousTeachers

public void setPreviousTeachers(java.util.Set<java.lang.String> previousTeachers)

Set the teachers who would have given this lesson according to the regular schedule. Abbreviations are used in most cases.

Parameters:

previousTeachers - the previous teachers to set

getRoom

public java.lang.String getRoom()

Get the room in which this lesson will be taught.

Returns:

the room

setRoom

public void setRoom(java.lang.String room)

Set the room in which this lesson will be taught.

Parameters:

room - the room to set

getPreviousRoom

public java.lang.String getPreviousRoom()

Get the room in which this lesson would have been taught according to the regular schedule.

Returns:

the previous room

setPreviousRoom

public void setPreviousRoom(java.lang.String previousRoom)

Set the room in which this lesson would have been taught according to the regular schedule.

Parameters:

previousRoom - the previous room to set

getDesc

public java.lang.String getDesc()

Get an additional description of this substitution, such as "tasks on page 42" or "moved to 6th lesson."

Returns:

the description

setDesc

public void setDesc(java.lang.String desc)

Set an additional description of this substitution, such as "tasks on page 42" or "moved to 6th lesson."

Parameters:

desc - the description to set

getColor

public java.lang.String getColor()

Get the color in which this substitution should be shown on the schedule as hexadecimal representation (such as #FF0000 for red).

Returns:

the color to set

setColor

public void setColor(java.lang.String color)

Set the color in which this substitution should be shown on the schedule as hexadecimal representation (such as #FF0000 for red). Normally, this should only be done by ColorProvider. Required.

Parameters:

color - the color to set

getSubstitutionFrom

public java.lang.String getSubstitutionFrom()

Get the "substitution from" ("Vertr. von") value. This can be found on some Untis schedules when a lesson was moved to another lesson or day and determines the date and lesson where this lesson would have been taught according to the normal schedule.

Returns:

the substitution from

setSubstitutionFrom

public void setSubstitutionFrom(java.lang.String substitutionFrom)

Set the "substitution from" ("Vertr. von") value. This can be found on some Untis schedules when a lesson was moved to another lesson or day and determines the date and lesson where this lesson would have been taught according to the normal schedule.

Parameters:

substitutionFrom - the substitution from to set

getTeacherTo

public java.lang.String getTeacherTo()

Get the "teacher to" ("(Le.) nach") value. This can be found on some Untis schedules when a lesson was moved to another lesson or day and determines the date and lesson where this lesson will be taught instead.

Returns:

the teacher to

setTeacherTo

public void setTeacherTo(java.lang.String teacherTo)

Set the "teacher to" ("(Le.) nach") value. This can be found on some Untis schedules when a lesson was moved to another lesson or day and determines the date and lesson where this lesson will be taught instead.

Parameters:

teacherTo - the teacher to to set

equalsExcludingType

public boolean equalsExcludingType(java.lang.Object o)

Check if this substitution equals another one, but excluding the type.

Parameters:

o - the substitution (or other object) to compare

Returns:

boolean indicating whether all fields of the two substitutions, excluding the classes, are equal

equalsExcludingClasses

public boolean equalsExcludingClasses(java.lang.Object o)

Check if this substitution equals another one, but excluding the classes. This is used to merge two substitutions with the same data and different classes automatically.

Parameters:

o - the substitution (or other object) to compare

Returns:

boolean indicating whether all fields of the two substitutions, excluding the classes, are equal

equalsExcludingTeachers

public boolean equalsExcludingTeachers(java.lang.Object o)

Check if this substitution equals another one, but excluding the teachers. This is used to merge two substitutions with the same data and different teachers automatically.

Parameters:

o - the substitution (or other object) to compare

Returns:

boolean indicating whether all fields of the two substitutions, excluding the teachers, are equal

equalsExcludingPreviousTeachers

public boolean equalsExcludingPreviousTeachers(java.lang.Object o)

Check if this substitution equals another one, but excluding the previous teachers. This is used to merge two substitutions with the same data and different previous teachers automatically.

Parameters:

o - the substitution (or other object) to compare

Returns:

boolean indicating whether all fields of the two substitutions, excluding the previous teachers, are equal

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

toString

public java.lang.String toString(SubstitutionSchedule.Type type)

Get a string representation of the substitution, using different wording depending on the type. Useful for debugging (console output).

Parameters:

type - the type of the SubstitutionSchedule. Affects the format in which the fields are output

Returns:

a string representation of this substitution

clone

public Substitution clone()
                   throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException