Massive Update for storage model #54

ToonDragon · 2019-03-02T16:04:56Z

Added 3 files to handle source storage function.

Source object will be the primary type for storing source information. Contains the following fields. More can be added as necessary.

Source Title (compulsory field)
Source Type (compulsory field)
Source Details (compulsory field)
Source Tags (can contain 0 or more tags)

Functions should be able to accomplish the following:

Add a new source to the database of sources
Delete sources from the database by index
Mass delete all sources from the database
Load existing database from an external txt file
Write current database to external txt file
Edit the each of the parameters in each source individually and by index

#51

Merge from Main 25/2/2019

Merge from Main 25/2/2019 4.57pm

Merge from Main 26/2/2019

Added 3 files to handle source storage function. Source object will be the primary type for storing source information. Contains the following fields. More can be added as necessary. 1) Source Title (compulsory field) 2) Source Type (compulsory field) 3) Source Details (compulsory field) 4) Source Tags (can contain 0 or more tags) Functions should be able to accomplish the following: 1) Add a new source to the database of sources 2) Delete sources from the database by index 3) Mass delete all sources from the database 4) Load existing database from an external txt file 5) Write current database to external txt file 6) Edit the each of the parameters in each source individually and by index

ToonDragon · 2019-03-02T16:05:36Z

Pending review

src/main/java/seedu/address/sourcemodel/Source.java

src/main/java/seedu/address/sourcemodel/SourceDatabase.java

src/main/java/seedu/address/sourcemodel/SourceStorageOperations.java

case141

I think we should create it similar to how the persons model is created and not just one whole sourcemodel. Because this may cause problems in the future code. You should add the individual title/tag/type/detail classes. Should be done as soon as possible in future versions.

src/main/java/seedu/address/sourcemodel/SourceDatabase.java

src/main/java/seedu/address/sourcemodel/SourceStorageOperations.java

ToonDragon · 2019-03-02T18:23:16Z

Modified the Java Docs accordingly and a few minor changes

fterh · 2019-03-03T01:35:42Z

src/main/java/seedu/address/sourcemodel/Source.java

@@ -6,16 +6,16 @@
 * Represents the model of a source.
 */
 public class Source {
-    /** Title of the source as detailed by the user, can be anything **/
+    // Title of the source as detailed by the user, can be anything


You don't need to comment if your variable name is descriptive, e.g. sourceTitle is obvious enough

fterh · 2019-03-03T01:35:55Z

src/main/java/seedu/address/sourcemodel/Source.java

    private String sourceTitle;

-    /** Type of the source, defined by the user but should follow some convention like "Book" or "Website" **/
+    // Type of the source, defined by the user but should follow some convention like "Book" or "Website" 
    private String sourceType;


This should be an enumeration

fterh · 2019-03-03T01:37:06Z

src/main/java/seedu/address/sourcemodel/Source.java

    private String sourceDetails;

-    /** List of tags for this source, while user defined, should follow some conventions to avoid duplicates **/
+    // List of tags for this source, while user defined, should follow some conventions to avoid duplicates 


Why not use a HashSet to avoid duplicates?

Also you might wanna consider canonicalizing them, e.g. strip whitespaces and lowercase them, so you won't end up with e.g. "Biology" and "biology".

fterh · 2019-03-03T01:38:07Z

src/main/java/seedu/address/sourcemodel/Source.java

@@ -25,7 +25,9 @@ public Source (String sourceTitle, String sourceType, String sourceDetails, Arra
        this.sourceTags = sourceTags;
    }

-    /** Public get functions for all the details of the source, to be used for retrieving information **/
+    /**


Not 100% sure about this, but I'm pretty sure (99%) this gets interpreted as javadoc comment for getSourceTitle(), so if you try to use getSourceTitle() IntelliJ will pop up with the description "Public get functions for all the details of the source, to be used for retrieving information".

Have you tried this?

fterh · 2019-03-03T01:38:13Z

src/main/java/seedu/address/sourcemodel/Source.java

@@ -39,7 +41,9 @@ public String getSourceDetails() {
        return this.sourceTags;
    }

-    /** Public set functions for all the details of the source, to be used for editing information **/
+    /**


fterh · 2019-03-03T01:38:40Z

src/main/java/seedu/address/sourcemodel/SourceDatabase.java

    public SourceDatabase() {
        this.database = SourceStorageOperations.loadExistingDatabase();
    }

-    // Functions to manipulate source objects in the database
+    /**


Same as prev

fterh · 2019-03-03T01:39:53Z

src/main/java/seedu/address/sourcemodel/SourceDatabase.java

+    /**
+     * Constructor for the main database object, will automatically load any existing entries in the database file
+     * The database will be empty if there is nothing in the existing file to load
+     */
    public SourceDatabase() {
        this.database = SourceStorageOperations.loadExistingDatabase();


You forgot to remove this this. :P

fterh · 2019-03-03T01:42:52Z

src/main/java/seedu/address/sourcemodel/SourceDatabase.java

    }
    public void editSourceTitleAtIndex (int index, String newTitle) {
-        this.database.get(index).setSourceTitle(newTitle);
+        database.get(index).setSourceTitle(newTitle);


Eh, database.get(index) potentially throws IndexOutOfBoundsException. I think you should wrap it in a try catch clause to fail gracefully (maybe log it and feedback to user), otherwise the whole program will just crash :P

Merge pull request CS2103-AY1819S2-W13-3#54 from DarrenDragonLee/master

ToonDragon and others added 4 commits February 25, 2019 16:43

Merge pull request #2 from CS2103-AY1819S2-W13-3/master

9b8303b

Merge from Main 25/2/2019

Merge pull request #3 from CS2103-AY1819S2-W13-3/master

64a67cf

Merge from Main 25/2/2019 4.57pm

Merge pull request #4 from CS2103-AY1819S2-W13-3/master

f416ccb

Merge from Main 26/2/2019

ToonDragon added this to the v1.1 milestone Mar 2, 2019

ToonDragon added 3 commits March 3, 2019 00:17

Removed "whitespaces"

88c59e3

Removed "whitespaces" again

66cfd5e

Added javadocs

9f07b33

fterh reviewed Mar 2, 2019

View reviewed changes

case141 requested changes Mar 2, 2019

View reviewed changes

fterh reviewed Mar 2, 2019

View reviewed changes

src/main/java/seedu/address/sourcemodel/SourceDatabase.java Outdated Show resolved Hide resolved

fterh reviewed Mar 2, 2019

View reviewed changes

src/main/java/seedu/address/sourcemodel/SourceStorageOperations.java Show resolved Hide resolved

Modified Java Docs and made minor changes

cb8de10

ToonDragon added 2 commits March 3, 2019 02:27

Removed "whitespaces"

2035830

Modified import order

f058444

fterh requested changes Mar 3, 2019

View reviewed changes

fterh approved these changes Mar 3, 2019

View reviewed changes

case141 approved these changes Mar 3, 2019

View reviewed changes

ToonDragon merged commit 33390d6 into CS2103-AY1819S2-W13-3:master Mar 3, 2019

ToonDragon added a commit to ToonDragon/main that referenced this pull request Mar 5, 2019

Merge pull request #5 from CS2103-AY1819S2-W13-3/master

9a69087

Merge pull request CS2103-AY1819S2-W13-3#54 from DarrenDragonLee/master

case141 removed this from the v1.1 milestone Mar 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Massive Update for storage model #54

Massive Update for storage model #54

ToonDragon commented Mar 2, 2019

ToonDragon commented Mar 2, 2019

case141 left a comment •

edited

ToonDragon commented Mar 2, 2019

fterh Mar 3, 2019

fterh Mar 3, 2019

fterh Mar 3, 2019

fterh Mar 3, 2019

fterh Mar 3, 2019

fterh Mar 3, 2019

fterh Mar 3, 2019

fterh Mar 3, 2019

Massive Update for storage model #54

Massive Update for storage model #54

Conversation

ToonDragon commented Mar 2, 2019

ToonDragon commented Mar 2, 2019

case141 left a comment • edited

Choose a reason for hiding this comment

ToonDragon commented Mar 2, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

case141 left a comment •

edited