Add some JavaDoc for modified methods (d036e1d5) · Commits · e / os / Notes

app/src/main/java/it/niedermann/owncloud/notes/persistence/AbstractNotesDatabase.java

+5 −19

Original line number	Diff line number	Diff line
		@@ -91,7 +91,6 @@ abstract class AbstractNotesDatabase extends SQLiteOpenHelper {
		}

		private void createNotesTable(@NonNull SQLiteDatabase db) {
		// TODO: category ID foreign key
		db.execSQL("CREATE TABLE " + table_notes + " ( " +
		key_id + " INTEGER PRIMARY KEY AUTOINCREMENT, " +
		key_remote_id + " INTEGER, " +
		@@ -124,7 +123,6 @@ abstract class AbstractNotesDatabase extends SQLiteOpenHelper {
		}

		private void createCategoryTable(@NonNull SQLiteDatabase db) {
		// TODO: category ID account id
		db.execSQL("CREATE TABLE " + table_category + "(" +
		key_id + " INTEGER PRIMARY KEY AUTOINCREMENT, " +
		key_account_id + " INTEGER, " +
		@@ -302,10 +300,13 @@ abstract class AbstractNotesDatabase extends SQLiteOpenHelper {
		CapabilitiesWorker.update(context);
		}
		if (oldVersion < 13) {
		// Rename a tmp_NOTES table.
		String tmpTableNotes = String.format("tmp_%s", table_notes);
		db.execSQL("ALTER TABLE " + table_notes + " RENAME TO " + tmpTableNotes);
		createNotesTable(db);
		createCategoryTable(db);
		// A hashtable storing categoryTitle - categoryId Mapping
		// This is used to prevent too many searches in database
		Hashtable<String, Integer> categoryTitleIdMap = new Hashtable<>();
		int id = 1;
		Cursor tmpNotesCursor = db.rawQuery("SELECT * FROM " + tmpTableNotes, null);
		@@ -316,19 +317,16 @@ abstract class AbstractNotesDatabase extends SQLiteOpenHelper {
		if (categoryTitleIdMap.containsKey(categoryTitle) && categoryTitleIdMap.get(categoryTitle) != null) {
		categoryId = categoryTitleIdMap.get(categoryTitle);
		} else {
		// The category does not exists in the database, create it.
		categoryId = id++;
		ContentValues values = new ContentValues();
		values.put(key_id, categoryId);
		values.put(key_account_id, accountId);
		values.put(key_title, categoryTitle);
		db.insert(table_category, null, values);
		// if (categoryTitle.trim().equals("")) {
		// db.execSQL("INSERT INTO " + table_category + " VALUES ( " + categoryId + " , " + accountId + ", EMPTY) ");
		// } else {
		// db.execSQL("INSERT INTO " + table_category + " VALUES ( " + categoryId + " , " + accountId + " , '" + categoryTitle + "' ) ");
		// }
		categoryTitleIdMap.put(categoryTitle, categoryId);
		}
		// Move the data in tmp_NOTES to NOTES
		ContentValues values = new ContentValues();
		values.put(key_id, tmpNotesCursor.getInt(0));
		values.put(key_remote_id, tmpNotesCursor.getInt(1));
		@@ -342,18 +340,6 @@ abstract class AbstractNotesDatabase extends SQLiteOpenHelper {
		values.put(key_etag, tmpNotesCursor.getString(9));
		values.put(key_etag, tmpNotesCursor.getString(10));
		db.insert(table_notes, null, values);
		// String values = String.format("%d, %d, %d, '%s', '%s', %d, '%s', %d, %d, ",// %s, %s",
		// tmpNotesCursor.getInt(0), tmpNotesCursor.getInt(1), tmpNotesCursor.getInt(2),
		// tmpNotesCursor.getString(3), tmpNotesCursor.getString(4), tmpNotesCursor.getInt(5),
		// tmpNotesCursor.getString(6), tmpNotesCursor.getInt(7), categoryId);
		// if (tmpNotesCursor.getString(9) == null) {
		// values = values + "null, ";
		// }
		// if (tmpNotesCursor.getString(10).trim().equals("")) {
		// values = values + "''";
		// }
		// Log.e("###", values + " " + categoryTitle);
		// db.execSQL("INSERT INTO " + table_notes + " VALUES ( " + values + " ) ");
		}
		tmpNotesCursor.close();
		db.execSQL("DROP TABLE IF EXISTS " + tmpTableNotes);

app/src/main/java/it/niedermann/owncloud/notes/persistence/NotesDatabase.java

+62 −20

Original line number	Diff line number	Diff line
		@@ -377,9 +377,16 @@ public class NotesDatabase extends AbstractNotesDatabase {
		}

		// TODO: test

		/**
		* This method return all of the categories with given accountId
		* The join operation is used because it is needed that the number of notes in each category
		*
		* @param accountId The user account Id
		* @return All of the categories with given accountId
		*/
		@NonNull
		@WorkerThread
		// the categories without note will not be returned
		public List<NavigationAdapter.NavigationItem> getCategories(long accountId) {
		validateAccountId(accountId);
		String category_title = String.format("%s.%s", table_category, key_title);
		@@ -409,6 +416,15 @@ public class NotesDatabase extends AbstractNotesDatabase {
		return categories;
		}

		/**
		* This method return the category list containing all of the categories containing the
		* search pattern and matched with the given accountId
		* The join operation is used because it is needed that the number of notes in each category
		*
		* @param accountId The user account ID
		* @param search The search pattern
		* @return The category list containing all of the categories matched
		*/
		// TODO merge with getCategories(long accountId)
		// TODO: test
		@NonNull
		@@ -461,17 +477,27 @@ public class NotesDatabase extends AbstractNotesDatabase {
		}

		// TODO: test

		/**
		* Set the category for a given note.
		* This method will search in the database to find out the category id in the db.
		* If there is no such category existing, this method will create it and search again.
		*
		* @param ssoAccount The single sign on account
		* @param note The note which will be updated
		* @param category The category title which should be used to find the category id.
		* @param callback When the synchronization is finished, this callback will be invoked (optional).
		*/
		public void setCategory(SingleSignOnAccount ssoAccount, @NonNull DBNote note, @NonNull String category, @Nullable ISyncCallback callback) {
		note.setCategory(category);
		note.setStatus(DBStatus.LOCAL_EDITED);
		SQLiteDatabase db = this.getWritableDatabase();
		ContentValues values = new ContentValues();
		values.put(key_status, note.getStatus().getTitle());
		if (getCategoryIdByTitle(note.getAccountId(), category, false) == -1) {
		if (addCategory(note.getCategory(), note.getAccountId()) == -1) {
		if (getCategoryIdByTitle(note.getAccountId(), category, false) == -1 &&
		addCategory(note.getCategory(), note.getAccountId()) == -1) {
		Log.e(TAG, String.format("Error occurs when creating category: %s", note.getCategory()));
		}
		}
		int id = getCategoryIdByTitle(note.getAccountId(), note.getCategory(), true);
		values.put(key_category, id);
		// values.put(key_category, note.getCategory());
		@@ -828,24 +854,26 @@ public class NotesDatabase extends AbstractNotesDatabase {
		// TODO: Not sure: Add more methods for category table.


		// TODO: Test
		/**
		* get the category id.
		* Get the category if with the given category title
		*
		* @param accountId: Account ID
		* @param categoryTitle: The category title
		* @return the corresponding category id.
		* @param accountId The user account Id
		* @param categoryTitle The category title which will be search in the db
		* @param create True if there is no such category, the db will add one.
		* False the db will not create one and return -1
		* @return -1 if there is no such category else the corresponding id
		*/
		// TODO: Test
		@NonNull
		@WorkerThread
		private Integer getCategoryIdByTitle(long accountId, @NonNull String categoryTitle, boolean create) {
		if (create) {
		if (getCategoryIdByTitle(accountId, categoryTitle, false) == -1) {
		if (addCategory(categoryTitle, accountId) == -1) {
		// If the category does not exist in the current db, create it.
		if (getCategoryIdByTitle(accountId, categoryTitle, false) == -1 &&
		addCategory(categoryTitle, accountId) == -1) {
		Log.e(TAG, String.format("Error occurs when creating category: %s", categoryTitle));
		}
		}
		}
		validateAccountId(accountId);
		SQLiteDatabase db = getReadableDatabase();
		Cursor cursor = db.query(
		@@ -865,16 +893,21 @@ public class NotesDatabase extends AbstractNotesDatabase {
		}

		// TODO: test
		/**
		* Find the category title with the category id
		* @param accountId The user account Id
		* @param categoryId The category Id which will be searched.
		* @return empty if there is no such result, else return the corresponding title.
		*/
		@NonNull
		@WorkerThread
		private String getTitleByCategoryId(long accountId, int id) {
		if (accountId != -1)
		private String getTitleByCategoryId(long accountId, int categoryId) {
		validateAccountId(accountId);
		Cursor cursor = getReadableDatabase().query(
		table_category,
		new String[]{key_title},
		key_id + " = ? AND " + key_account_id + " = ? ",
		new String[]{String.valueOf(id), String.valueOf(accountId)},
		new String[]{String.valueOf(categoryId), String.valueOf(accountId)},
		key_title,
		null,
		key_title);
		@@ -912,13 +945,22 @@ public class NotesDatabase extends AbstractNotesDatabase {

		// TODO: test
		// TODO: not fuzzy search by testing bug?
		private List<Integer> getCategoryIdsByTitle(long accountId, @NonNull String title) {
		/**
		* Find out all of the matched Category id with the given accountId and category title
		* Note that this method supports the fuzzy search. But only prefix match is supported.
		* "abcd" will be returned when categoryTitle is "ab" while it will not be returned when the categoryTitle is "bc"
		*
		* @param accountId The user account Id
		* @param categoryTitle The category title which will be searched.
		* @return All matched category ids.
		*/
		private List<Integer> getCategoryIdsByTitle(long accountId, @NonNull String categoryTitle) {
		validateAccountId(accountId);
		Cursor cursor = getReadableDatabase().query(
		table_category,
		new String[]{key_id},
		key_title + " = ? OR " + key_title + " LIKE ? AND " + key_account_id + " = ? ",
		new String[]{title, title + "%", String.valueOf(accountId)},
		new String[]{categoryTitle, categoryTitle + "%", String.valueOf(accountId)},
		key_id,
		null,
		key_id