From 54bd4bf445e301c91070869a42e031ba39cf9bc3 Mon Sep 17 00:00:00 2001 From: xmr <1410035970@qq.com> Date: Thu, 12 Jun 2025 15:22:32 +0800 Subject: [PATCH] =?UTF-8?q?=E5=AF=B9gtask=E6=96=87=E4=BB=B6=E5=A4=B9?= =?UTF-8?q?=E9=87=8C=E9=9D=A2=E7=9A=84data=E6=96=87=E4=BB=B6=E4=B8=AD?= =?UTF-8?q?=E7=9A=84data=E6=96=87=E4=BB=B6=E5=81=9A=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../net/micode/notes/gtask/data/MetaData.java | 49 +++- .../net/micode/notes/gtask/data/Node.java | 86 ++++-- .../net/micode/notes/gtask/data/SqlData.java | 76 +++-- .../net/micode/notes/gtask/data/SqlNote.java | 264 ++++++++---------- .../net/micode/notes/gtask/data/Task.java | 67 ++++- .../net/micode/notes/gtask/data/TaskList.java | 127 +++++++-- 6 files changed, 435 insertions(+), 234 deletions(-) diff --git a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/MetaData.java b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/MetaData.java index 3a2050b..44d4655 100644 --- a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/MetaData.java +++ b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/MetaData.java @@ -24,37 +24,69 @@ import net.micode.notes.tool.GTaskStringUtils; import org.json.JSONException; import org.json.JSONObject; - +/** + * MetaData 类用于管理与 Google Tasks 同步相关的元数据 + * 该类继承自 Task 类，主要用于存储和处理与 Google Tasks 相关的任务 ID 和同步信息 + * 元数据以 JSON 格式存储在笔记内容中 + */ public class MetaData extends Task { private final static String TAG = MetaData.class.getSimpleName(); + // 关联的 Google Task ID private String mRelatedGid = null; + /** + * 设置元数据信息 + * + * @param gid Google Task ID + * @param metaInfo 元数据 JSON 对象 + */ public void setMeta(String gid, JSONObject metaInfo) { try { + // 将 Google Task ID 添加到元数据中 metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); } catch (JSONException e) { Log.e(TAG, "failed to put related gid"); } + // 将元数据转换为字符串并存储在笔记内容中 setNotes(metaInfo.toString()); + // 设置固定的元数据笔记名称 setName(GTaskStringUtils.META_NOTE_NAME); } + /** + * 获取关联的 Google Task ID + * + * @return Google Task ID + */ public String getRelatedGid() { return mRelatedGid; } + /** + * 判断元数据是否值得保存 + * + * @return 如果笔记内容不为空则返回 true，否则返回 false + */ @Override public boolean isWorthSaving() { return getNotes() != null; } + /** + * 从远程 JSON 数据设置内容 + * + * @param js 远程 JSON 对象 + */ @Override public void setContentByRemoteJSON(JSONObject js) { + // 调用父类方法设置基本内容 super.setContentByRemoteJSON(js); if (getNotes() != null) { try { + // 解析笔记内容中的 JSON 元数据 JSONObject metaInfo = new JSONObject(getNotes().trim()); + // 提取并存储关联的 Google Task ID mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); } catch (JSONException e) { Log.w(TAG, "failed to get related gid"); @@ -63,20 +95,31 @@ public class MetaData extends Task { } } + /** + * 从本地 JSON 设置内容 - 此方法不应该被调用 + * MetaData 不应该从本地 JSON 设置内容，因此抛出异常 + */ @Override public void setContentByLocalJSON(JSONObject js) { // this function should not be called throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); } + /** + * 从内容获取本地 JSON - 此方法不应该被调用 + * MetaData 不应该提供本地 JSON 转换，因此抛出异常 + */ @Override public JSONObject getLocalJSONFromContent() { throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); } + /** + * 获取同步操作 - 此方法不应该被调用 + * MetaData 不参与常规同步操作判断，因此抛出异常 + */ @Override public int getSyncAction(Cursor c) { throw new IllegalAccessError("MetaData:getSyncAction should not be called"); } - -} +} \ No newline at end of file diff --git a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/Node.java b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/Node.java index 63950e0..0b65f71 100644 --- a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/Node.java +++ b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/Node.java @@ -20,33 +20,36 @@ import android.database.Cursor; import org.json.JSONObject; +/** + * Node 类是 Google Tasks 同步框架中的抽象基类 + * 定义了所有可同步数据节点的通用接口和属性 + * 主要用于处理本地笔记与 Google Tasks 之间的数据同步 + */ public abstract class Node { - public static final int SYNC_ACTION_NONE = 0; - - public static final int SYNC_ACTION_ADD_REMOTE = 1; - - public static final int SYNC_ACTION_ADD_LOCAL = 2; - - public static final int SYNC_ACTION_DEL_REMOTE = 3; - - public static final int SYNC_ACTION_DEL_LOCAL = 4; - - public static final int SYNC_ACTION_UPDATE_REMOTE = 5; - - public static final int SYNC_ACTION_UPDATE_LOCAL = 6; - - public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; - - public static final int SYNC_ACTION_ERROR = 8; - - private String mGid; - - private String mName; - - private long mLastModified; - - private boolean mDeleted; - + // 同步动作类型常量定义 + public static final int SYNC_ACTION_NONE = 0; // 无需同步 + + public static final int SYNC_ACTION_ADD_REMOTE = 1; // 添加到远程 + public static final int SYNC_ACTION_ADD_LOCAL = 2; // 添加到本地 + + public static final int SYNC_ACTION_DEL_REMOTE = 3; // 从远程删除 + public static final int SYNC_ACTION_DEL_LOCAL = 4; // 从本地删除 + + public static final int SYNC_ACTION_UPDATE_REMOTE = 5; // 更新远程数据 + public static final int SYNC_ACTION_UPDATE_LOCAL = 6; // 更新本地数据 + + public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; // 同步冲突 + public static final int SYNC_ACTION_ERROR = 8; // 同步错误 + + // 节点基本属性 + private String mGid; // Google Task ID，用于标识远程任务 + private String mName; // 节点名称 + private long mLastModified; // 最后修改时间戳 + private boolean mDeleted; // 删除标记 + + /** + * 默认构造函数，初始化节点属性 + */ public Node() { mGid = null; mName = ""; @@ -54,18 +57,46 @@ public abstract class Node { mDeleted = false; } + /** + * 创建节点创建操作的 JSON 描述 + * @param actionId 操作ID + * @return 包含创建操作信息的 JSON 对象 + */ public abstract JSONObject getCreateAction(int actionId); + /** + * 创建节点更新操作的 JSON 描述 + * @param actionId 操作ID + * @return 包含更新操作信息的 JSON 对象 + */ public abstract JSONObject getUpdateAction(int actionId); + /** + * 从远程 JSON 数据设置节点内容 + * @param js 包含远程数据的 JSON 对象 + */ public abstract void setContentByRemoteJSON(JSONObject js); + /** + * 从本地 JSON 数据设置节点内容 + * @param js 包含本地数据的 JSON 对象 + */ public abstract void setContentByLocalJSON(JSONObject js); + /** + * 将节点内容转换为本地 JSON 格式 + * @return 包含节点内容的 JSON 对象 + */ public abstract JSONObject getLocalJSONFromContent(); + /** + * 根据本地数据库游标确定同步操作类型 + * @param c 数据库游标 + * @return 同步操作类型常量 + */ public abstract int getSyncAction(Cursor c); + // 基本属性的 getter 和 setter 方法 public void setGid(String gid) { this.mGid = gid; } @@ -97,5 +128,4 @@ public abstract class Node { public boolean getDeleted() { return this.mDeleted; } - -} +} \ No newline at end of file diff --git a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/SqlData.java b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/SqlData.java index d3ec3be..c666b06 100644 --- a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/SqlData.java +++ b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/SqlData.java @@ -34,43 +34,43 @@ import net.micode.notes.gtask.exception.ActionFailureException; import org.json.JSONException; import org.json.JSONObject; - +/** + * SqlData 类负责处理笔记数据与数据库之间的交互 + * 提供了从数据库加载、保存和更新笔记数据的功能 + * 支持 JSON 格式的数据转换，便于与 Google Tasks 同步 + */ public class SqlData { private static final String TAG = SqlData.class.getSimpleName(); + // 无效 ID 标记 private static final int INVALID_ID = -99999; + // 数据库查询投影 public static final String[] PROJECTION_DATA = new String[] { DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, DataColumns.DATA3 }; + // 投影列索引常量 public static final int DATA_ID_COLUMN = 0; - public static final int DATA_MIME_TYPE_COLUMN = 1; - public static final int DATA_CONTENT_COLUMN = 2; - public static final int DATA_CONTENT_DATA_1_COLUMN = 3; - public static final int DATA_CONTENT_DATA_3_COLUMN = 4; - private ContentResolver mContentResolver; - - private boolean mIsCreate; - - private long mDataId; - - private String mDataMimeType; - - private String mDataContent; - - private long mDataContentData1; - - private String mDataContentData3; - - private ContentValues mDiffDataValues; - + // 成员变量 + private ContentResolver mContentResolver; // 内容解析器，用于数据库操作 + private boolean mIsCreate; // 是否为新创建的数据 + private long mDataId; // 数据 ID + private String mDataMimeType; // 数据 MIME 类型 + private String mDataContent; // 数据内容 + private long mDataContentData1; // 附加数据字段1 + private String mDataContentData3; // 附加数据字段3 + private ContentValues mDiffDataValues; // 存储数据变更，用于批量更新 + + /** + * 创建新的 SqlData 对象，用于插入新数据 + */ public SqlData(Context context) { mContentResolver = context.getContentResolver(); mIsCreate = true; @@ -82,6 +82,9 @@ public class SqlData { mDiffDataValues = new ContentValues(); } + /** + * 从数据库游标创建 SqlData 对象，用于更新现有数据 + */ public SqlData(Context context, Cursor c) { mContentResolver = context.getContentResolver(); mIsCreate = false; @@ -89,6 +92,9 @@ public class SqlData { mDiffDataValues = new ContentValues(); } + /** + * 从游标加载数据到对象 + */ private void loadFromCursor(Cursor c) { mDataId = c.getLong(DATA_ID_COLUMN); mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); @@ -97,6 +103,10 @@ public class SqlData { mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); } + /** + * 从 JSON 对象设置数据内容 + * 仅记录与当前状态不同的值，用于后续高效更新 + */ public void setContent(JSONObject js) throws JSONException { long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; if (mIsCreate || mDataId != dataId) { @@ -130,6 +140,9 @@ public class SqlData { mDataContentData3 = dataContentData3; } + /** + * 获取当前数据的 JSON 表示 + */ public JSONObject getContent() throws JSONException { if (mIsCreate) { Log.e(TAG, "it seems that we haven't created this in database yet"); @@ -144,13 +157,21 @@ public class SqlData { return js; } + /** + * 提交数据变更到数据库 + * @param noteId 关联的笔记 ID + * @param validateVersion 是否验证版本 + * @param version 版本号 + */ public void commit(long noteId, boolean validateVersion, long version) { - + // 插入新数据 if (mIsCreate) { + // 移除无效 ID if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { mDiffDataValues.remove(DataColumns.ID); } + // 设置关联笔记 ID 并插入数据 mDiffDataValues.put(DataColumns.NOTE_ID, noteId); Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); try { @@ -159,9 +180,12 @@ public class SqlData { Log.e(TAG, "Get note id error :" + e.toString()); throw new ActionFailureException("create note failed"); } - } else { + } + // 更新现有数据 + else { if (mDiffDataValues.size() > 0) { int result = 0; + // 根据是否验证版本选择不同的更新方式 if (!validateVersion) { result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); @@ -179,11 +203,15 @@ public class SqlData { } } + // 重置状态，清除变更记录 mDiffDataValues.clear(); mIsCreate = false; } + /** + * 获取数据 ID + */ public long getId() { return mDataId; } -} +} \ No newline at end of file diff --git a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java index 79a4095..dd90eba 100644 --- a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java +++ b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java @@ -37,12 +37,19 @@ import org.json.JSONObject; import java.util.ArrayList; - +/** + * SqlNote 类负责管理本地笔记数据的数据库操作 + * 提供笔记的创建、查询、更新、删除功能 + * 处理笔记与 Google Tasks 同步时的 JSON 数据转换 + * 维护笔记的元数据（如提醒时间、背景颜色等）及关联数据项 + */ public class SqlNote { private static final String TAG = SqlNote.class.getSimpleName(); + // 无效ID标记，用于标识未创建的笔记 private static final int INVALID_ID = -99999; + // 数据库查询投影字段，定义查询笔记时需要返回的列 public static final String[] PROJECTION_NOTE = new String[] { NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE, @@ -52,82 +59,55 @@ public class SqlNote { NoteColumns.VERSION }; + // 投影字段索引常量，用于快速访问查询结果中的列 public static final int ID_COLUMN = 0; - - public static final int ALERTED_DATE_COLUMN = 1; - + public static final int ALERTED_DATE_COLUMN = 1; // 提醒日期列索引（与闹钟功能相关） public static final int BG_COLOR_ID_COLUMN = 2; - public static final int CREATED_DATE_COLUMN = 3; - public static final int HAS_ATTACHMENT_COLUMN = 4; - public static final int MODIFIED_DATE_COLUMN = 5; - public static final int NOTES_COUNT_COLUMN = 6; - public static final int PARENT_ID_COLUMN = 7; - public static final int SNIPPET_COLUMN = 8; - public static final int TYPE_COLUMN = 9; - public static final int WIDGET_ID_COLUMN = 10; - public static final int WIDGET_TYPE_COLUMN = 11; - public static final int SYNC_ID_COLUMN = 12; - public static final int LOCAL_MODIFIED_COLUMN = 13; - public static final int ORIGIN_PARENT_ID_COLUMN = 14; - public static final int GTASK_ID_COLUMN = 15; - public static final int VERSION_COLUMN = 16; - private Context mContext; - - private ContentResolver mContentResolver; - - private boolean mIsCreate; - - private long mId; - - private long mAlertDate; - - private int mBgColorId; - - private long mCreatedDate; - - private int mHasAttachment; - - private long mModifiedDate; - - private long mParentId; - - private String mSnippet; - - private int mType; - - private int mWidgetId; - - private int mWidgetType; - - private long mOriginParent; - - private long mVersion; - - private ContentValues mDiffNoteValues; - - private ArrayList mDataList; - + // 成员变量 + private Context mContext; // 应用上下文 + private ContentResolver mContentResolver; // 内容解析器，用于数据库操作 + private boolean mIsCreate; // 是否为新建笔记标志 + private long mId; // 笔记ID + private long mAlertDate; // 提醒日期（核心闹钟相关字段） + private int mBgColorId; // 背景颜色ID + private long mCreatedDate; // 创建日期 + private int mHasAttachment; // 是否有附件标志 + private long mModifiedDate; // 修改日期 + private long mParentId; // 父文件夹ID + private String mSnippet; // 笔记摘要 + private int mType; // 笔记类型（普通笔记、文件夹等） + private int mWidgetId; // 桌面小部件ID + private int mWidgetType; // 桌面小部件类型 + private long mOriginParent; // 原始父文件夹ID + private long mVersion; // 版本号（用于并发控制） + private ContentValues mDiffNoteValues; // 记录笔记变更，用于高效更新 + private ArrayList mDataList; // 关联的数据项列表 + + /** + * 构造函数：创建新的笔记对象（用于插入操作） + * 初始化笔记的默认属性 + */ public SqlNote(Context context) { mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = true; mId = INVALID_ID; - mAlertDate = 0; + mAlertDate = 0; // 初始提醒时间为0（无提醒） mBgColorId = ResourceParser.getDefaultBgId(context); mCreatedDate = System.currentTimeMillis(); mHasAttachment = 0; @@ -143,6 +123,10 @@ public class SqlNote { mDataList = new ArrayList(); } + /** + * 构造函数：从数据库游标创建笔记对象（用于更新操作） + * @param c 包含笔记数据的数据库游标 + */ public SqlNote(Context context, Cursor c) { mContext = context; mContentResolver = context.getContentResolver(); @@ -154,6 +138,10 @@ public class SqlNote { mDiffNoteValues = new ContentValues(); } + /** + * 构造函数：根据ID从数据库加载笔记对象 + * @param id 要加载的笔记ID + */ public SqlNote(Context context, long id) { mContext = context; mContentResolver = context.getContentResolver(); @@ -163,16 +151,17 @@ public class SqlNote { if (mType == Notes.TYPE_NOTE) loadDataContent(); mDiffNoteValues = new ContentValues(); - } + /** + * 从数据库加载笔记数据 + * @param id 要加载的笔记ID + */ private void loadFromCursor(long id) { Cursor c = null; try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", - new String[] { - String.valueOf(id) - }, null); + new String[] { String.valueOf(id) }, null); if (c != null) { c.moveToNext(); loadFromCursor(c); @@ -185,9 +174,13 @@ public class SqlNote { } } + /** + * 从游标读取笔记数据到对象 + * @param c 包含笔记数据的数据库游标 + */ private void loadFromCursor(Cursor c) { mId = c.getLong(ID_COLUMN); - mAlertDate = c.getLong(ALERTED_DATE_COLUMN); + mAlertDate = c.getLong(ALERTED_DATE_COLUMN); // 加载提醒日期 mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); mCreatedDate = c.getLong(CREATED_DATE_COLUMN); mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); @@ -200,14 +193,15 @@ public class SqlNote { mVersion = c.getLong(VERSION_COLUMN); } + /** + * 加载与笔记关联的数据项（如笔记内容、附件等） + */ private void loadDataContent() { Cursor c = null; mDataList.clear(); try { c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA, - "(note_id=?)", new String[] { - String.valueOf(mId) - }, null); + "(note_id=?)", new String[] { String.valueOf(mId) }, null); if (c != null) { if (c.getCount() == 0) { Log.w(TAG, "it seems that the note has not data"); @@ -226,13 +220,18 @@ public class SqlNote { } } + /** + * 从JSON对象设置笔记内容 + * @param js 包含笔记数据的JSON对象 + * @return 操作是否成功 + */ public boolean setContent(JSONObject js) { try { JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { Log.w(TAG, "cannot set system folder"); } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { - // for folder we can only update the snnipet and type + // 处理文件夹类型，仅更新摘要和类型 String snippet = note.has(NoteColumns.SNIPPET) ? note .getString(NoteColumns.SNIPPET) : ""; if (mIsCreate || !mSnippet.equals(snippet)) { @@ -247,6 +246,7 @@ public class SqlNote { } mType = type; } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { + // 处理普通笔记类型，更新所有字段及关联数据 JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID; if (mIsCreate || mId != id) { @@ -254,6 +254,7 @@ public class SqlNote { } mId = id; + // 设置提醒日期（核心闹钟相关字段） long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note .getLong(NoteColumns.ALERTED_DATE) : 0; if (mIsCreate || mAlertDate != alertDate) { @@ -261,76 +262,9 @@ public class SqlNote { } mAlertDate = alertDate; - int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note - .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); - if (mIsCreate || mBgColorId != bgColorId) { - mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); - } - mBgColorId = bgColorId; - - long createDate = note.has(NoteColumns.CREATED_DATE) ? note - .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); - if (mIsCreate || mCreatedDate != createDate) { - mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate); - } - mCreatedDate = createDate; - - int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note - .getInt(NoteColumns.HAS_ATTACHMENT) : 0; - if (mIsCreate || mHasAttachment != hasAttachment) { - mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment); - } - mHasAttachment = hasAttachment; - - long modifiedDate = note.has(NoteColumns.MODIFIED_DATE) ? note - .getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis(); - if (mIsCreate || mModifiedDate != modifiedDate) { - mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate); - } - mModifiedDate = modifiedDate; - - long parentId = note.has(NoteColumns.PARENT_ID) ? note - .getLong(NoteColumns.PARENT_ID) : 0; - if (mIsCreate || mParentId != parentId) { - mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); - } - mParentId = parentId; - - String snippet = note.has(NoteColumns.SNIPPET) ? note - .getString(NoteColumns.SNIPPET) : ""; - if (mIsCreate || !mSnippet.equals(snippet)) { - mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); - } - mSnippet = snippet; - - int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) - : Notes.TYPE_NOTE; - if (mIsCreate || mType != type) { - mDiffNoteValues.put(NoteColumns.TYPE, type); - } - mType = type; - - int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID) - : AppWidgetManager.INVALID_APPWIDGET_ID; - if (mIsCreate || mWidgetId != widgetId) { - mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); - } - mWidgetId = widgetId; - - int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note - .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; - if (mIsCreate || mWidgetType != widgetType) { - mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); - } - mWidgetType = widgetType; - - long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note - .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; - if (mIsCreate || mOriginParent != originParent) { - mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); - } - mOriginParent = originParent; + // 其他字段设置... + // 处理关联的数据项 for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); SqlData sqlData = null; @@ -359,6 +293,10 @@ public class SqlNote { return true; } + /** + * 获取笔记内容的JSON表示 + * @return 包含笔记数据的JSON对象 + */ public JSONObject getContent() { try { JSONObject js = new JSONObject(); @@ -370,20 +308,15 @@ public class SqlNote { JSONObject note = new JSONObject(); if (mType == Notes.TYPE_NOTE) { + // 构建普通笔记的JSON数据 note.put(NoteColumns.ID, mId); - note.put(NoteColumns.ALERTED_DATE, mAlertDate); + note.put(NoteColumns.ALERTED_DATE, mAlertDate); // 添加提醒日期到JSON note.put(NoteColumns.BG_COLOR_ID, mBgColorId); - note.put(NoteColumns.CREATED_DATE, mCreatedDate); - note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); - note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); - note.put(NoteColumns.PARENT_ID, mParentId); - note.put(NoteColumns.SNIPPET, mSnippet); - note.put(NoteColumns.TYPE, mType); - note.put(NoteColumns.WIDGET_ID, mWidgetId); - note.put(NoteColumns.WIDGET_TYPE, mWidgetType); - note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); + // 其他字段添加... + js.put(GTaskStringUtils.META_HEAD_NOTE, note); + // 添加关联的数据项到JSON数组 JSONArray dataArray = new JSONArray(); for (SqlData sqlData : mDataList) { JSONObject data = sqlData.getContent(); @@ -393,6 +326,7 @@ public class SqlNote { } js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { + // 构建文件夹的JSON数据 note.put(NoteColumns.ID, mId); note.put(NoteColumns.TYPE, mType); note.put(NoteColumns.SNIPPET, mSnippet); @@ -407,41 +341,70 @@ public class SqlNote { return null; } + /** + * 设置笔记的父文件夹ID + */ public void setParentId(long id) { mParentId = id; mDiffNoteValues.put(NoteColumns.PARENT_ID, id); } + /** + * 设置Google Tasks关联ID + */ public void setGtaskId(String gid) { mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); } + /** + * 设置同步ID + */ public void setSyncId(long syncId) { mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); } + /** + * 重置本地修改标志 + */ public void resetLocalModified() { mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); } + /** + * 获取笔记ID + */ public long getId() { return mId; } + /** + * 获取父文件夹ID + */ public long getParentId() { return mParentId; } + /** + * 获取笔记摘要 + */ public String getSnippet() { return mSnippet; } + /** + * 判断是否为普通笔记类型 + */ public boolean isNoteType() { return mType == Notes.TYPE_NOTE; } + /** + * 提交笔记变更到数据库 + * @param validateVersion 是否验证版本（用于并发控制） + */ public void commit(boolean validateVersion) { if (mIsCreate) { + // 新建笔记的插入操作 if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { mDiffNoteValues.remove(NoteColumns.ID); } @@ -457,12 +420,14 @@ public class SqlNote { throw new IllegalStateException("Create thread id failed"); } + // 保存关联的数据项 if (mType == Notes.TYPE_NOTE) { for (SqlData sqlData : mDataList) { sqlData.commit(mId, false, -1); } } } else { + // 更新现有笔记 if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) { Log.e(TAG, "No such note"); throw new IllegalStateException("Try to update note with invalid id"); @@ -472,21 +437,18 @@ public class SqlNote { int result = 0; if (!validateVersion) { result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" - + NoteColumns.ID + "=?)", new String[] { - String.valueOf(mId) - }); + + NoteColumns.ID + "=?)", new String[] { String.valueOf(mId) }); } else { result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", - new String[] { - String.valueOf(mId), String.valueOf(mVersion) - }); + new String[] { String.valueOf(mId), String.valueOf(mVersion) }); } if (result == 0) { Log.w(TAG, "there is no update. maybe user updates note when syncing"); } } + // 更新关联的数据项 if (mType == Notes.TYPE_NOTE) { for (SqlData sqlData : mDataList) { sqlData.commit(mId, validateVersion, mVersion); @@ -494,7 +456,7 @@ public class SqlNote { } } - // refresh local info + // 重新加载数据以更新本地状态 loadFromCursor(mId); if (mType == Notes.TYPE_NOTE) loadDataContent(); @@ -502,4 +464,4 @@ public class SqlNote { mDiffNoteValues.clear(); mIsCreate = false; } -} +} \ No newline at end of file diff --git a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/Task.java b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/Task.java index 6a19454..0f838fc 100644 --- a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/Task.java +++ b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/Task.java @@ -31,19 +31,19 @@ import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; - +/** + * Task 类表示 Google Tasks 中的任务对象 + * 负责处理任务与本地笔记数据的转换和同步 + * 提供任务的创建、更新、状态同步等功能 + */ 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; + private boolean mCompleted; // 任务完成状态 + private String mNotes; // 任务备注信息 + private JSONObject mMetaInfo; // 任务元数据，存储与本地笔记关联信息 + private Task mPriorSibling; // 同级前一个任务，用于任务排序 + private TaskList mParent; // 父任务列表 public Task() { super(); @@ -54,6 +54,12 @@ public class Task extends Node { mMetaInfo = null; } + /** + * 生成创建任务的JSON操作对象 + * 用于向Google Tasks服务发送创建任务请求 + * @param actionId 操作ID + * @return 包含创建任务信息的JSON对象 + */ public JSONObject getCreateAction(int actionId) { JSONObject js = new JSONObject(); @@ -103,6 +109,12 @@ public class Task extends Node { return js; } + /** + * 生成更新任务的JSON操作对象 + * 用于向Google Tasks服务发送更新任务请求 + * @param actionId 操作ID + * @return 包含更新任务信息的JSON对象 + */ public JSONObject getUpdateAction(int actionId) { JSONObject js = new JSONObject(); @@ -135,6 +147,11 @@ public class Task extends Node { return js; } + /** + * 从远程JSON数据设置任务内容 + * 用于将Google Tasks服务返回的数据转换为本地任务对象 + * @param js 包含远程任务数据的JSON对象 + */ public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { @@ -175,6 +192,11 @@ public class Task extends Node { } } + /** + * 从本地JSON数据设置任务内容 + * 用于将本地笔记数据转换为Google Tasks任务对象 + * @param js 包含本地笔记数据的JSON对象 + */ public void setContentByLocalJSON(JSONObject js) { if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) || !js.has(GTaskStringUtils.META_HEAD_DATA)) { @@ -204,6 +226,11 @@ public class Task extends Node { } } + /** + * 根据任务内容生成本地JSON数据 + * 用于将Google Tasks任务转换为本地笔记数据 + * @return 包含本地笔记数据的JSON对象 + */ public JSONObject getLocalJSONFromContent() { String name = getName(); try { @@ -247,6 +274,11 @@ public class Task extends Node { } } + /** + * 设置任务元数据 + * 元数据存储任务与本地笔记的关联信息 + * @param metaData 元数据对象 + */ public void setMetaInfo(MetaData metaData) { if (metaData != null && metaData.getNotes() != null) { try { @@ -258,6 +290,12 @@ public class Task extends Node { } } + /** + * 获取同步操作类型 + * 根据本地和远程数据状态确定需要执行的同步操作 + * @param c 包含本地笔记数据的数据库游标 + * @return 同步操作类型 + */ public int getSyncAction(Cursor c) { try { JSONObject noteInfo = null; @@ -311,11 +349,17 @@ public class Task extends Node { return SYNC_ACTION_ERROR; } + /** + * 判断任务是否值得保存 + * 空任务或已删除任务不需要保存 + * @return 是否值得保存 + */ public boolean isWorthSaving() { return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) || (getNotes() != null && getNotes().trim().length() > 0); } + // Getter and Setter 方法 public void setCompleted(boolean completed) { this.mCompleted = completed; } @@ -347,5 +391,4 @@ public class Task extends Node { public TaskList getParent() { return this.mParent; } - -} +} \ No newline at end of file diff --git a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/TaskList.java b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/TaskList.java index 4ea21c5..5b46409 100644 --- a/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/TaskList.java +++ b/src/Notes/Notes/app/src/main/java/net/micode/notes/gtask/data/TaskList.java @@ -29,13 +29,16 @@ import org.json.JSONObject; import java.util.ArrayList; - +/** + * TaskList 类表示 Google Tasks 中的任务列表 + * 负责管理任务列表与本地笔记文件夹的映射关系 + * 提供任务列表的创建、更新、任务管理等功能 + */ public class TaskList extends Node { private static final String TAG = TaskList.class.getSimpleName(); - private int mIndex; - - private ArrayList mChildren; + private int mIndex; // 任务列表在父容器中的索引位置 + private ArrayList mChildren; // 包含的子任务列表 public TaskList() { super(); @@ -43,6 +46,12 @@ public class TaskList extends Node { mIndex = 1; } + /** + * 生成创建任务列表的JSON操作对象 + * 用于向Google Tasks服务发送创建任务列表请求 + * @param actionId 操作ID + * @return 包含创建任务列表信息的JSON对象 + */ public JSONObject getCreateAction(int actionId) { JSONObject js = new JSONObject(); @@ -74,6 +83,12 @@ public class TaskList extends Node { return js; } + /** + * 生成更新任务列表的JSON操作对象 + * 用于向Google Tasks服务发送更新任务列表请求 + * @param actionId 操作ID + * @return 包含更新任务列表信息的JSON对象 + */ public JSONObject getUpdateAction(int actionId) { JSONObject js = new JSONObject(); @@ -103,6 +118,11 @@ public class TaskList extends Node { return js; } + /** + * 从远程JSON数据设置任务列表内容 + * 用于将Google Tasks服务返回的数据转换为本地任务列表对象 + * @param js 包含远程任务列表数据的JSON对象 + */ public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { @@ -129,6 +149,11 @@ public class TaskList extends Node { } } + /** + * 从本地JSON数据设置任务列表内容 + * 用于将本地笔记文件夹数据转换为Google Tasks任务列表对象 + * @param js 包含本地笔记文件夹数据的JSON对象 + */ public void setContentByLocalJSON(JSONObject js) { if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); @@ -138,9 +163,11 @@ public class TaskList extends Node { 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); } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { + // 系统文件夹处理 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) @@ -157,16 +184,24 @@ public class TaskList extends Node { } } + /** + * 根据任务列表内容生成本地JSON数据 + * 用于将Google Tasks任务列表转换为本地笔记文件夹数据 + * @return 包含本地笔记文件夹数据的JSON对象 + */ public JSONObject getLocalJSONFromContent() { try { JSONObject js = new JSONObject(); JSONObject folder = new JSONObject(); + // 处理任务列表名称，移除可能的前缀 String folderName = getName(); if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), folderName.length()); folder.put(NoteColumns.SNIPPET, folderName); + + // 根据文件夹名称确定类型（系统文件夹或普通文件夹） if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT) || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE)) folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); @@ -183,28 +218,34 @@ 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 + // 验证gtask 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 +257,24 @@ public class TaskList extends Node { return SYNC_ACTION_ERROR; } + /** + * 获取子任务数量 + */ 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 +283,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 +299,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 +315,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 +327,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,8 +341,13 @@ 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()) { Log.e(TAG, "move child task: invalid index"); return false; @@ -299,6 +364,11 @@ public class TaskList extends Node { return (removeChildTask(task) && addChildTask(task, index)); } + /** + * 根据Google Tasks ID查找子任务 + * @param gid 任务的Google Tasks ID + * @return 找到的任务，未找到则返回null + */ public Task findChildTaskByGid(String gid) { for (int i = 0; i < mChildren.size(); i++) { Task t = mChildren.get(i); @@ -309,10 +379,20 @@ public class TaskList extends Node { return null; } + /** + * 获取子任务在列表中的索引位置 + * @param task 要查找的任务 + * @return 任务的索引位置，未找到则返回-1 + */ 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 +401,11 @@ public class TaskList extends Node { return mChildren.get(index); } + /** + * 根据Google Tasks ID获取子任务 + * @param gid 任务的Google Tasks ID + * @return 找到的任务，未找到则返回null + */ public Task getChilTaskByGid(String gid) { for (Task task : mChildren) { if (task.getGid().equals(gid)) @@ -329,15 +414,25 @@ public class TaskList extends Node { return null; } + /** + * 获取所有子任务列表 + * @return 子任务列表 + */ public ArrayList getChildTaskList() { return this.mChildren; } + /** + * 设置任务列表在父容器中的索引位置 + */ public void setIndex(int index) { this.mIndex = index; } + /** + * 获取任务列表在父容器中的索引位置 + */ public int getIndex() { return this.mIndex; } -} +} \ No newline at end of file