From 8f13dbf271f50c3961b1a01c54e022dc0e6cb4d4 Mon Sep 17 00:00:00 2001 From: Jyk <1758766792@qq.com> Date: Thu, 8 May 2025 14:24:38 +0800 Subject: [PATCH] gtask/data/Task.java gtask/data/TaskList.java --- src/net/micode/notes/gtask/data/Task.java | 142 +++++++++++++---- src/net/micode/notes/gtask/data/TaskList.java | 146 +++++++++++++++--- 2 files changed, 234 insertions(+), 54 deletions(-) diff --git a/src/net/micode/notes/gtask/data/Task.java b/src/net/micode/notes/gtask/data/Task.java index 6a19454..8b9a091 100644 --- a/src/net/micode/notes/gtask/data/Task.java +++ b/src/net/micode/notes/gtask/data/Task.java @@ -31,20 +31,32 @@ import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; - +/* + * Task类用于表示和处理任务相关的数据和操作。 + * 它提供了创建、更新任务操作的JSON对象的方法， + * 以及从本地和远程JSON对象中设置任务内容的功能。 + */ public class Task extends Node { private static final String TAG = Task.class.getSimpleName(); + // 任务是否完成 private boolean mCompleted; + // 任务的笔记内容 private String mNotes; + // 任务的元信息 private JSONObject mMetaInfo; + // 任务的前一个兄弟任务 private Task mPriorSibling; + // 任务所属的任务列表 private TaskList mParent; + /* + * 构造函数，初始化任务的基本属性。 + */ public Task() { super(); mCompleted = false; @@ -54,21 +66,26 @@ public class Task extends Node { mMetaInfo = null; } + /* + * 生成任务创建操作的JSON对象。 + * @param actionId 操作的ID + * @return 生成的JSON对象 + */ public JSONObject getCreateAction(int actionId) { JSONObject js = new JSONObject(); try { - // action_type + // 设置操作类型为创建 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); - // action_id + // 设置操作的ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // index + // 设置任务的索引 js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); - // entity_delta + // 设置任务的详细信息 JSONObject entity = new JSONObject(); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); @@ -79,17 +96,17 @@ public class Task extends Node { } js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); - // parent_id + // 设置任务的父任务列表ID js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); - // dest_parent_type + // 设置目标父类型 js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, GTaskStringUtils.GTASK_JSON_TYPE_GROUP); - // list_id + // 设置列表ID js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); - // prior_sibling_id + // 如果存在前一个兄弟任务，设置其ID if (mPriorSibling != null) { js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); } @@ -103,21 +120,26 @@ public class Task extends Node { return js; } + /* + * 生成任务更新操作的JSON对象。 + * @param actionId 操作的ID + * @return 生成的JSON对象 + */ public JSONObject getUpdateAction(int actionId) { JSONObject js = new JSONObject(); try { - // action_type + // 设置操作类型为更新 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); - // action_id + // 设置操作的ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // id + // 设置任务的ID js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); - // entity_delta + // 设置任务的详细信息 JSONObject entity = new JSONObject(); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); if (getNotes() != null) { @@ -135,35 +157,39 @@ public class Task extends Node { return js; } + /* + * 从远程JSON对象中设置任务内容。 + * @param js 远程JSON对象 + */ public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { - // id + // 设置任务ID if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); } - // last_modified + // 设置最后修改时间 if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); } - // name + // 设置任务名称 if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); } - // notes + // 设置任务笔记 if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) { setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); } - // deleted + // 设置任务是否已删除 if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) { setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); } - // completed + // 设置任务是否已完成 if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) { setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); } @@ -175,6 +201,10 @@ public class Task extends Node { } } + /* + * 从本地JSON对象中设置任务内容。 + * @param js 本地JSON对象 + */ public void setContentByLocalJSON(JSONObject js) { if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) || !js.has(GTaskStringUtils.META_HEAD_DATA)) { @@ -182,14 +212,17 @@ public class Task extends Node { } try { + // 获取本地JSON对象中的笔记信息和数据数组 JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + // 检查笔记类型是否正确 if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) { Log.e(TAG, "invalid type"); return; } + // 遍历数据数组，找到任务名称 for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { @@ -204,16 +237,21 @@ public class Task extends Node { } } + /* + * 从任务内容中生成本地JSON对象。 + * @return 生成的本地JSON对象 + */ public JSONObject getLocalJSONFromContent() { String name = getName(); try { if (mMetaInfo == null) { - // new task created from web + // 如果是新创建的任务 if (name == null) { Log.w(TAG, "the note seems to be an empty one"); return null; } + // 创建新的JSON对象 JSONObject js = new JSONObject(); JSONObject note = new JSONObject(); JSONArray dataArray = new JSONArray(); @@ -225,10 +263,11 @@ public class Task extends Node { js.put(GTaskStringUtils.META_HEAD_NOTE, note); return js; } else { - // synced task + // 如果是已同步的任务 JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + // 更新任务名称 for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { @@ -247,6 +286,10 @@ public class Task extends Node { } } + /* + * 设置任务的元信息。 + * @param metaData 元数据 + */ public void setMetaInfo(MetaData metaData) { if (metaData != null && metaData.getNotes() != null) { try { @@ -258,6 +301,11 @@ public class Task extends Node { } } + /* + * 获取任务的同步操作类型。 + * @param c 数据库游标 + * @return 同步操作类型 + */ public int getSyncAction(Cursor c) { try { JSONObject noteInfo = null; @@ -275,31 +323,32 @@ public class Task extends Node { return SYNC_ACTION_UPDATE_LOCAL; } - // validate the note id now + // 验证笔记ID是否匹配 if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.ID)) { Log.w(TAG, "note id doesn't match"); return SYNC_ACTION_UPDATE_LOCAL; } if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { - // there is no local update + // 如果本地没有更新 if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // no update both side + // 如果远程也没有更新 return SYNC_ACTION_NONE; } else { - // apply remote to local + // 应用远程更新到本地 return SYNC_ACTION_UPDATE_LOCAL; } } else { - // validate gtask id + // 验证任务ID是否匹配 if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { Log.e(TAG, "gtask id doesn't match"); return SYNC_ACTION_ERROR; } if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // local modification only + // 只有本地有更新 return SYNC_ACTION_UPDATE_REMOTE; } else { + // 发生冲突 return SYNC_ACTION_UPDATE_CONFLICT; } } @@ -311,41 +360,76 @@ public class Task extends Node { return SYNC_ACTION_ERROR; } + /* + * 判断任务是否值得保存。 + * @return 如果任务有内容或元信息，则返回true + */ public boolean isWorthSaving() { return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) || (getNotes() != null && getNotes().trim().length() > 0); } + /* + * 设置任务的完成状态。 + * @param completed 是否完成 + */ public void setCompleted(boolean completed) { this.mCompleted = completed; } + /* + * 设置任务的笔记内容。 + * @param notes 笔记内容 + */ public void setNotes(String notes) { this.mNotes = notes; } + /* + * 设置任务的前一个兄弟任务。 + * @param priorSibling 前一个兄弟任务 + */ public void setPriorSibling(Task priorSibling) { this.mPriorSibling = priorSibling; } + /* + * 设置任务的任务列表。 + * @param parent 任务列表 + */ public void setParent(TaskList parent) { this.mParent = parent; } + /* + * 获取任务的完成状态。 + * @return 是否完成 + */ public boolean getCompleted() { return this.mCompleted; } + /* + * 获取任务的笔记内容。 + * @return 笔记内容 + */ public String getNotes() { return this.mNotes; } + /* + * 获取任务的前一个兄弟任务。 + * @return 前一个兄弟任务 + */ public Task getPriorSibling() { return this.mPriorSibling; } + /* + * 获取任务的任务列表。 + * @return 任务列表 + */ public TaskList getParent() { return this.mParent; } - -} +} \ No newline at end of file diff --git a/src/net/micode/notes/gtask/data/TaskList.java b/src/net/micode/notes/gtask/data/TaskList.java index 4ea21c5..2e882da 100644 --- a/src/net/micode/notes/gtask/data/TaskList.java +++ b/src/net/micode/notes/gtask/data/TaskList.java @@ -29,35 +29,49 @@ import org.json.JSONObject; import java.util.ArrayList; - +/* + * TaskList类用于表示和处理任务列表相关的数据和操作。 + * 它提供了创建、更新任务列表操作的JSON对象的方法， + * 以及从本地和远程JSON对象中设置任务列表内容的功能。 + */ public class TaskList extends Node { private static final String TAG = TaskList.class.getSimpleName(); + // 任务列表的索引 private int mIndex; + // 任务列表中的任务集合 private ArrayList mChildren; + /* + * 构造函数，初始化任务列表的基本属性。 + */ public TaskList() { super(); mChildren = new ArrayList(); mIndex = 1; } + /* + * 生成任务列表创建操作的JSON对象。 + * @param actionId 操作的ID + * @return 生成的JSON对象 + */ public JSONObject getCreateAction(int actionId) { JSONObject js = new JSONObject(); try { - // action_type + // 设置操作类型为创建 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); - // action_id + // 设置操作的ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // index + // 设置任务列表的索引 js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex); - // entity_delta + // 设置任务列表的详细信息 JSONObject entity = new JSONObject(); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); @@ -74,21 +88,26 @@ public class TaskList extends Node { return js; } + /* + * 生成任务列表更新操作的JSON对象。 + * @param actionId 操作的ID + * @return 生成的JSON对象 + */ public JSONObject getUpdateAction(int actionId) { JSONObject js = new JSONObject(); try { - // action_type + // 设置操作类型为更新 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); - // action_id + // 设置操作的ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // id + // 设置任务列表的ID js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); - // entity_delta + // 设置任务列表的详细信息 JSONObject entity = new JSONObject(); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); @@ -103,20 +122,24 @@ public class TaskList extends Node { return js; } + /* + * 从远程JSON对象中设置任务列表内容。 + * @param js 远程JSON对象 + */ public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { - // id + // 设置任务列表ID if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); } - // last_modified + // 设置最后修改时间 if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); } - // name + // 设置任务列表名称 if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); } @@ -129,14 +152,20 @@ public class TaskList extends Node { } } + /* + * 从本地JSON对象中设置任务列表内容。 + * @param js 本地JSON对象 + */ public void setContentByLocalJSON(JSONObject js) { if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); } try { + // 获取本地JSON对象中的文件夹信息 JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + // 根据文件夹类型设置任务列表名称 if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { String name = folder.getString(NoteColumns.SNIPPET); setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name); @@ -144,8 +173,7 @@ public class TaskList extends Node { if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER) setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT); else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER) - setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX - + GTaskStringUtils.FOLDER_CALL_NOTE); + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE); else Log.e(TAG, "invalid system folder"); } else { @@ -157,8 +185,13 @@ public class TaskList extends Node { } } + /* + * 从任务列表内容中生成本地JSON对象。 + * @return 生成的本地JSON对象 + */ public JSONObject getLocalJSONFromContent() { try { + // 创建新的JSON对象 JSONObject js = new JSONObject(); JSONObject folder = new JSONObject(); @@ -183,28 +216,33 @@ public class TaskList extends Node { } } + /* + * 获取任务列表的同步操作类型。 + * @param c 数据库游标 + * @return 同步操作类型 + */ public int getSyncAction(Cursor c) { try { if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { - // there is no local update + // 如果本地没有更新 if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // no update both side + // 如果远程也没有更新 return SYNC_ACTION_NONE; } else { - // apply remote to local + // 应用远程更新到本地 return SYNC_ACTION_UPDATE_LOCAL; } } else { - // validate gtask id + // 验证任务列表ID是否匹配 if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { Log.e(TAG, "gtask id doesn't match"); return SYNC_ACTION_ERROR; } if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // local modification only + // 只有本地有更新 return SYNC_ACTION_UPDATE_REMOTE; } else { - // for folder conflicts, just apply local modification + // 对于文件夹冲突，只应用本地更新 return SYNC_ACTION_UPDATE_REMOTE; } } @@ -216,16 +254,25 @@ public class TaskList extends Node { return SYNC_ACTION_ERROR; } + /* + * 获取任务列表中的任务数量。 + * @return 任务数量 + */ public int getChildTaskCount() { return mChildren.size(); } + /* + * 向任务列表中添加任务。 + * @param task 要添加的任务 + * @return 添加是否成功 + */ public boolean addChildTask(Task task) { boolean ret = false; if (task != null && !mChildren.contains(task)) { ret = mChildren.add(task); if (ret) { - // need to set prior sibling and parent + // 设置任务的前一个兄弟任务和父任务列表 task.setPriorSibling(mChildren.isEmpty() ? null : mChildren .get(mChildren.size() - 1)); task.setParent(this); @@ -234,6 +281,12 @@ public class TaskList extends Node { return ret; } + /* + * 向任务列表中指定位置添加任务。 + * @param task 要添加的任务 + * @param index 指定位置 + * @return 添加是否成功 + */ public boolean addChildTask(Task task, int index) { if (index < 0 || index > mChildren.size()) { Log.e(TAG, "add child task: invalid index"); @@ -244,7 +297,7 @@ public class TaskList extends Node { if (task != null && pos == -1) { mChildren.add(index, task); - // update the task list + // 更新任务列表 Task preTask = null; Task afterTask = null; if (index != 0) @@ -260,6 +313,11 @@ public class TaskList extends Node { return true; } + /* + * 从任务列表中移除任务。 + * @param task 要移除的任务 + * @return 移除是否成功 + */ public boolean removeChildTask(Task task) { boolean ret = false; int index = mChildren.indexOf(task); @@ -267,11 +325,11 @@ public class TaskList extends Node { ret = mChildren.remove(task); if (ret) { - // reset prior sibling and parent + // 重置任务的前一个兄弟任务和父任务列表 task.setPriorSibling(null); task.setParent(null); - // update the task list + // 更新任务列表 if (index != mChildren.size()) { mChildren.get(index).setPriorSibling( index == 0 ? null : mChildren.get(index - 1)); @@ -281,6 +339,12 @@ public class TaskList extends Node { return ret; } + /* + * 在任务列表中移动任务的位置。 + * @param task 要移动的任务 + * @param index 目标位置 + * @return 移动是否成功 + */ public boolean moveChildTask(Task task, int index) { if (index < 0 || index >= mChildren.size()) { @@ -299,6 +363,11 @@ public class TaskList extends Node { return (removeChildTask(task) && addChildTask(task, index)); } + /* + * 根据任务ID查找任务。 + * @param gid 任务ID + * @return 找到的任务，如果找不到则返回null + */ public Task findChildTaskByGid(String gid) { for (int i = 0; i < mChildren.size(); i++) { Task t = mChildren.get(i); @@ -309,10 +378,20 @@ public class TaskList extends Node { return null; } + /* + * 获取任务在任务列表中的索引。 + * @param task 任务 + * @return 索引 + */ public int getChildTaskIndex(Task task) { return mChildren.indexOf(task); } + /* + * 根据索引获取任务。 + * @param index 索引 + * @return 任务，如果索引无效则返回null + */ public Task getChildTaskByIndex(int index) { if (index < 0 || index >= mChildren.size()) { Log.e(TAG, "getTaskByIndex: invalid index"); @@ -321,6 +400,11 @@ public class TaskList extends Node { return mChildren.get(index); } + /* + * 根据任务ID获取任务。 + * @param gid 任务ID + * @return 任务，如果找不到则返回null + */ public Task getChilTaskByGid(String gid) { for (Task task : mChildren) { if (task.getGid().equals(gid)) @@ -329,15 +413,27 @@ public class TaskList extends Node { return null; } + /* + * 获取任务列表中的所有任务。 + * @return 任务集合 + */ public ArrayList getChildTaskList() { return this.mChildren; } + /* + * 设置任务列表的索引。 + * @param index 索引 + */ public void setIndex(int index) { this.mIndex = index; } + /* + * 获取任务列表的索引。 + * @return 索引 + */ public int getIndex() { return this.mIndex; } -} +} \ No newline at end of file -- 2.34.1