Added docs into branch

Signed-off-by: Marcin Woźniak <y0rune@aol.com>
This commit is contained in:
Marcin Woźniak 2020-11-18 09:01:45 +01:00
parent 17e5625315
commit bc6c55165e
Signed by: y0rune
GPG Key ID: F204C385F57EB348
11 changed files with 39 additions and 3 deletions

View File

@ -12,9 +12,8 @@ import org.apache.poi.ss.usermodel.Row;
import com.plannaplan.models.FileData; import com.plannaplan.models.FileData;
/** /**
* Dupa dupa dupd * FileReader is the class using for reading xls file from input stream.
*/ */
public class FileReader { public class FileReader {
private InputStream fileInputStream; private InputStream fileInputStream;

View File

@ -14,6 +14,9 @@ import org.apache.poi.ss.usermodel.Row;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/**
* FileToDatabaseMigrator is used for migrate data from file (it reads line by line) and push it into database
*/
@Component @Component
public class FileToDatabaseMigrator { public class FileToDatabaseMigrator {

View File

@ -7,6 +7,10 @@ import javax.persistence.Id;
import javax.persistence.JoinColumn; import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne; import javax.persistence.ManyToOne;
/**
* Entity of Assignment grouping of state associated about group_id and commision_id
*/
@Entity @Entity
public class Assignment { public class Assignment {
@Id @Id

View File

@ -11,6 +11,10 @@ import javax.persistence.JoinColumn;
import javax.persistence.OneToMany; import javax.persistence.OneToMany;
import javax.persistence.OneToOne; import javax.persistence.OneToOne;
/**
* Entity of Commision grouping of state associated about commison and owner_id
*/
@Entity @Entity
public class Commision { public class Commision {
@Id @Id

View File

@ -10,6 +10,10 @@ import javax.persistence.GenerationType;
import javax.persistence.Id; import javax.persistence.Id;
import javax.persistence.OneToMany; import javax.persistence.OneToMany;
/**
* Entity of Course grouping of state of course
*/
@Entity @Entity
public class Course { public class Course {
@Id @Id

View File

@ -10,7 +10,9 @@ import javax.persistence.ManyToOne;
import com.plannaplan.types.GroupType; import com.plannaplan.types.GroupType;
import com.plannaplan.types.WeekDay; import com.plannaplan.types.WeekDay;
/**
* Entity of Groups grouping of state ssociated about course,time,room,capacity,type,day
*/
@Entity @Entity
public class Groups { public class Groups {

View File

@ -5,6 +5,10 @@ import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType; import javax.persistence.GenerationType;
import javax.persistence.Id; import javax.persistence.Id;
/**
* Entity of Lecturer grouping of state ssociated about id,title,name,surname
*/
@Entity @Entity
public class Lecturer { public class Lecturer {
@Id @Id

View File

@ -9,6 +9,10 @@ import javax.persistence.Id;
import com.plannaplan.types.UserRoles; import com.plannaplan.types.UserRoles;
/**
* Entity of User grouping of state ssociated about id,name,surname,email,role,token,tokenCreatedDate
*/
@Entity @Entity
public class User { public class User {
@Id @Id

View File

@ -1,5 +1,9 @@
package com.plannaplan.types; package com.plannaplan.types;
/**
* GroupType contains types: LECTURE, CLASS
*/
public enum GroupType { public enum GroupType {
LECTURE, CLASS LECTURE, CLASS
} }

View File

@ -1,5 +1,9 @@
package com.plannaplan.types; package com.plannaplan.types;
/**
* UserRoles contains types: STUDENT, DEANERY, ADMIN, TEST_USER
*/
public enum UserRoles { public enum UserRoles {
STUDENT, DEANERY, ADMIN, TEST_USER STUDENT, DEANERY, ADMIN, TEST_USER
} }

View File

@ -1,5 +1,9 @@
package com.plannaplan.types; package com.plannaplan.types;
/**
* WeekDay contains types: MONDAY(0), TUESDAY(1), WEDNESDAY(2), THURSDAY(3), FRIDAY(4), SATURDAY(5), SUNDAY(6).
*/
public enum WeekDay { public enum WeekDay {
MONDAY(0), TUESDAY(1), WEDNESDAY(2), THURSDAY(3), FRIDAY(4), SATURDAY(5), SUNDAY(6); MONDAY(0), TUESDAY(1), WEDNESDAY(2), THURSDAY(3), FRIDAY(4), SATURDAY(5), SUNDAY(6);