Software Design: Class Diagram - Annotation

[xltvy]

Issue Description

As the next part of the software design process, we will provide a class diagram for our project moving from the use case diagram phase. Class diagram will be completed with a collective effort and I will be preparing the annotation sub-section of the diagram.

• This issue is a sub-issue of Software Design: Class Diagram #86 .
• Annotation class will be formed, using this section of the use case diagram as basis.

• The class diagram will be generated using the Lucichart app, and the diagram can be viewed here .

Step Details

Steps that will be performed:

• ID system
• Upvote system
• Ownership
• Content

This is a list of features that the Annotation class has. This structure may be enhanced/enlarged and new base titles can be added in the future, as Annotation class may have more features.

Final Actions

• After each part of the Annotation class is determined and combined into a diagram, it will be merged into the main class diagram provided in this link.
• After completion, this issue will be reviewed and evaluated by the team members upon closing the issue.

Deadline of the Issue

04.04.2022 - Monday - 23.59

Reviewer

Muhammed Enes Sürmeli

Deadline for the Review

05.04.2022 - Tuesday - 10.00

[xltvy]

Info:

I have created the initial form of the Annotation class as part of the class diagram of our project.

Here is a screenshot taken directly from our class diagram, which can be viewed from this link:

This issue will be reviewed and if necessary edited/updated further.

[xltvy]

Attributes

I defined the class attributes as follows:

Attribute Name	Type	Description
annotation_id	int	ID of the annotation
owner_id	UID	ID of the user that created this annotation
course_id	int	ID of the course that this annotation belongs to
category_id	int	ID of the category that this annotation belongs to
chapter_number	int	number of the chapter that this annotation belongs to
page_number	int	number of the page that this annotation belongs to
pos_x	float	X coordinate of location of the annotation on a page
pos_y	float	Y coordinate of location of the annotation on a page
created_at	Date	The date this annotation is created
updated_at	Date	The date this annotation is updated latest
deleted_at	Date	The date this annotation is deleted
upvote	int	Number of upvotes this annotation received
content	string	Content of the annotation as a text

[xltvy]

Methods

I defined the class methods as follows:

Method Name	Parameters	Return Type
createAnnotation	annotation_id: int, owner_id: UID, course_id: int, category_id: int, chapter_number: int, page_number: int, pos_x: float, pos_y: float, created_at: Date, content: string	void
editAnnotation	new_content: string, edit_date: Date	void
deleteAnnotation	-	void
getUserId	-	UID
getCategory	-	int
getCourse	-	int
getDate	-	Date
getUpvote	-	int
upvote	-	void
downvote	-	void

[surmelienes1]

It looks very good and complete for now, great job! Thank you Altay for your valuable contributions. After we hold our meeting to review the class diagram as a whole, we can make an additional integrity check according to the rest of the work from other team members.

I will now close this issue since I don't see any changes to be further made. If you have additional questions, suggestions, or ideas, you can reopen this issue and add your thoughts as a comment.