From e129743823842721ed3d08716375d98fec8e9b4a Mon Sep 17 00:00:00 2001 From: abandon <2758180753@qq,com> Date: Sun, 15 Jun 2025 21:15:14 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=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/SqlData.java | 105 +++++-- .../net/micode/notes/gtask/data/SqlNote.java | 280 ++++++++++------- .../src/net/micode/notes/gtask/data/Task.java | 281 +++++++++++------- .../net/micode/notes/gtask/data/TaskList.java | 191 +++++++++--- 4 files changed, 557 insertions(+), 300 deletions(-) diff --git a/Notes-master/src/net/micode/notes/gtask/data/SqlData.java b/Notes-master/src/net/micode/notes/gtask/data/SqlData.java index d3ec3be..4c72a93 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/SqlData.java +++ b/Notes-master/src/net/micode/notes/gtask/data/SqlData.java @@ -2,16 +2,11 @@ * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 您可以在遵守License的前提下使用本文件 + * 具体License内容可查阅：http://www.apache.org/licenses/LICENSE-2.0 * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 软件按"原样"分发，不提供任何形式的明示或暗示的保证 + * 详见License中关于权限和限制的具体条款 */ package net.micode.notes.gtask.data; @@ -34,43 +29,42 @@ import net.micode.notes.gtask.exception.ActionFailureException; import org.json.JSONException; import org.json.JSONObject; - +/** + * SQL数据操作类 + * 用于处理笔记附属数据的数据库操作，支持增量更新和版本验证 + * 通过ContentResolver与Android ContentProvider进行交互 + */ public class SqlData { private static final String TAG = SqlData.class.getSimpleName(); + private static final int INVALID_ID = -99999; // 无效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实例，用于创建新数据 + * + * @param context 应用上下文 + */ public SqlData(Context context) { mContentResolver = context.getContentResolver(); mIsCreate = true; @@ -82,6 +76,13 @@ public class SqlData { mDiffDataValues = new ContentValues(); } + /** + * 构造函数（从数据库加载模式） + * 从数据库游标初始化SQLData实例，用于更新已有数据 + * + * @param context 应用上下文 + * @param c 数据库游标 + */ public SqlData(Context context, Cursor c) { mContentResolver = context.getContentResolver(); mIsCreate = false; @@ -89,6 +90,12 @@ public class SqlData { mDiffDataValues = new ContentValues(); } + /** + * 从游标加载数据 + * 从数据库游标中读取数据并设置到当前实例 + * + * @param c 数据库游标 + */ private void loadFromCursor(Cursor c) { mDataId = c.getLong(DATA_ID_COLUMN); mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); @@ -97,6 +104,13 @@ public class SqlData { mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); } + /** + * 从JSON对象设置内容 + * 比较新旧值，仅记录有变化的字段，实现增量更新 + * + * @param js 包含新内容的JSON对象 + * @throws JSONException 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 +144,13 @@ public class SqlData { mDataContentData3 = dataContentData3; } + /** + * 获取内容的JSON表示 + * 将当前数据转换为JSON对象 + * + * @return 包含当前数据的JSON对象 + * @throws JSONException JSON构建异常 + */ public JSONObject getContent() throws JSONException { if (mIsCreate) { Log.e(TAG, "it seems that we haven't created this in database yet"); @@ -144,9 +165,19 @@ public class SqlData { return js; } + /** + * 提交数据变更 + * 将记录的变更提交到数据库，支持新建和更新操作 + * 可选的版本验证功能，确保数据一致性 + * + * @param noteId 关联的笔记ID + * @param validateVersion 是否验证版本 + * @param version 期望的版本号 + */ public void commit(long noteId, boolean validateVersion, long version) { if (mIsCreate) { + // 新建操作 if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { mDiffDataValues.remove(DataColumns.ID); } @@ -160,12 +191,15 @@ public class SqlData { throw new ActionFailureException("create note failed"); } } else { + // 更新操作 if (mDiffDataValues.size() > 0) { int result = 0; if (!validateVersion) { + // 不验证版本直接更新 result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); } else { + // 验证版本后更新，确保数据未被其他进程修改 result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE @@ -183,7 +217,12 @@ public class SqlData { mIsCreate = false; } + /** + * 获取数据ID + * + * @return 数据ID + */ public long getId() { return mDataId; } -} +} \ No newline at end of file diff --git a/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java b/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java index 79a4095..26b65b5 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java +++ b/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java @@ -2,16 +2,11 @@ * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 您可以在遵守License的前提下使用本文件 + * 具体License内容可查阅：http://www.apache.org/licenses/LICENSE-2.0 * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 软件按"原样"分发，不提供任何形式的明示或暗示的保证 + * 详见License中关于权限和限制的具体条款 */ package net.micode.notes.gtask.data; @@ -37,12 +32,17 @@ import org.json.JSONObject; import java.util.ArrayList; - +/** + * 笔记数据操作类 + * 处理笔记数据的数据库操作，包括增删改查 + * 支持与Google Tasks同步的笔记数据处理 + * 实现增量更新和版本验证机制 + */ public class SqlNote { private static final String TAG = SqlNote.class.getSimpleName(); + private static final int INVALID_ID = -99999; // 无效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, @@ -53,96 +53,76 @@ public class SqlNote { }; public static final int ID_COLUMN = 0; - 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; // 附属数据列表 + + /** + * 构造函数（新建笔记模式） + * 初始化一个新的SqlNote实例，用于创建新笔记 + * + * @param context 应用上下文 + */ public SqlNote(Context context) { mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = true; mId = INVALID_ID; mAlertDate = 0; - mBgColorId = ResourceParser.getDefaultBgId(context); - mCreatedDate = System.currentTimeMillis(); + mBgColorId = ResourceParser.getDefaultBgId(context); // 设置默认背景色 + mCreatedDate = System.currentTimeMillis(); // 当前时间作为创建时间 mHasAttachment = 0; - mModifiedDate = System.currentTimeMillis(); - mParentId = 0; + mModifiedDate = System.currentTimeMillis(); // 当前时间作为修改时间 + mParentId = 0; // 默认父文件夹为根文件夹 mSnippet = ""; - mType = Notes.TYPE_NOTE; - mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; - mWidgetType = Notes.TYPE_WIDGET_INVALIDE; + mType = Notes.TYPE_NOTE; // 默认类型为普通笔记 + mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; // 无效的小部件ID + mWidgetType = Notes.TYPE_WIDGET_INVALIDE; // 无效的小部件类型 mOriginParent = 0; mVersion = 0; mDiffNoteValues = new ContentValues(); mDataList = new ArrayList(); } + /** + * 构造函数（从数据库加载模式） + * 从数据库游标初始化SqlNote实例，用于更新已有笔记 + * + * @param context 应用上下文 + * @param c 数据库游标 + */ public SqlNote(Context context, Cursor c) { mContext = context; mContentResolver = context.getContentResolver(); @@ -150,10 +130,17 @@ public class SqlNote { loadFromCursor(c); mDataList = new ArrayList(); if (mType == Notes.TYPE_NOTE) - loadDataContent(); + loadDataContent(); // 仅当为笔记类型时加载附属数据 mDiffNoteValues = new ContentValues(); } + /** + * 构造函数（按ID加载模式） + * 根据笔记ID从数据库加载笔记数据 + * + * @param context 应用上下文 + * @param id 笔记ID + */ public SqlNote(Context context, long id) { mContext = context; mContentResolver = context.getContentResolver(); @@ -161,18 +148,20 @@ public class SqlNote { loadFromCursor(id); mDataList = new ArrayList(); if (mType == Notes.TYPE_NOTE) - loadDataContent(); + loadDataContent(); // 仅当为笔记类型时加载附属数据 mDiffNoteValues = new ContentValues(); - } + /** + * 从ID加载笔记数据 + * + * @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,6 +174,11 @@ public class SqlNote { } } + /** + * 从游标加载笔记数据 + * + * @param c 数据库游标 + */ private void loadFromCursor(Cursor c) { mId = c.getLong(ID_COLUMN); mAlertDate = c.getLong(ALERTED_DATE_COLUMN); @@ -200,14 +194,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,22 +221,27 @@ 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) : ""; + // 文件夹只能更新名称和类型 + 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; + int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) : Notes.TYPE_NOTE; if (mIsCreate || mType != type) { mDiffNoteValues.put(NoteColumns.TYPE, type); } @@ -254,83 +254,79 @@ public class SqlNote { } mId = id; - long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note - .getLong(NoteColumns.ALERTED_DATE) : 0; + // 以下为设置笔记各属性，仅当值变化时记录到mDiffNoteValues + long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note.getLong(NoteColumns.ALERTED_DATE) : 0; if (mIsCreate || mAlertDate != alertDate) { mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); } mAlertDate = alertDate; - int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note - .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); + 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(); + 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; + 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(); + 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; + 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) : ""; + 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; + 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) + 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; + 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; + 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 +355,11 @@ public class SqlNote { return true; } + /** + * 获取笔记内容的JSON表示 + * + * @return 包含笔记内容的JSON对象 + */ public JSONObject getContent() { try { JSONObject js = new JSONObject(); @@ -370,6 +371,7 @@ 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.BG_COLOR_ID, mBgColorId); @@ -384,6 +386,7 @@ public class SqlNote { note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); js.put(GTaskStringUtils.META_HEAD_NOTE, note); + // 添加附属数据 JSONArray dataArray = new JSONArray(); for (SqlData sqlData : mDataList) { JSONObject data = sqlData.getContent(); @@ -393,6 +396,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 +411,86 @@ public class SqlNote { return null; } + /** + * 设置父文件夹ID + * + * @param id 父文件夹ID + */ public void setParentId(long id) { mParentId = id; mDiffNoteValues.put(NoteColumns.PARENT_ID, id); } + /** + * 设置Google Tasks ID + * + * @param gid Google Tasks ID + */ public void setGtaskId(String gid) { mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); } + /** + * 设置同步ID + * + * @param syncId 同步ID + */ public void setSyncId(long syncId) { mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); } + /** + * 重置本地修改标识 + */ public void resetLocalModified() { mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); } + /** + * 获取笔记ID + * + * @return 笔记ID + */ public long getId() { return mId; } + /** + * 获取父文件夹ID + * + * @return 父文件夹ID + */ public long getParentId() { return mParentId; } + /** + * 获取笔记摘要/文件夹名称 + * + * @return 笔记摘要/文件夹名称 + */ public String getSnippet() { return mSnippet; } + /** + * 判断是否为笔记类型 + * + * @return true如果是笔记类型，false如果是文件夹或系统文件夹 + */ 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,36 +506,37 @@ 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"); } if (mDiffNoteValues.size() > 0) { - mVersion ++; + mVersion++; 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 +544,7 @@ public class SqlNote { } } - // refresh local info + // 刷新本地数据 loadFromCursor(mId); if (mType == Notes.TYPE_NOTE) loadDataContent(); @@ -502,4 +552,4 @@ public class SqlNote { mDiffNoteValues.clear(); mIsCreate = false; } -} +} \ No newline at end of file diff --git a/Notes-master/src/net/micode/notes/gtask/data/Task.java b/Notes-master/src/net/micode/notes/gtask/data/Task.java index 6a19454..ef8c5b4 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/Task.java +++ b/Notes-master/src/net/micode/notes/gtask/data/Task.java @@ -2,16 +2,11 @@ * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 您可以在遵守License的前提下使用本文件 + * 具体License内容可查阅：http://www.apache.org/licenses/LICENSE-2.0 * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 软件按"原样"分发，不提供任何形式的明示或暗示的保证 + * 详见License中关于权限和限制的具体条款 */ package net.micode.notes.gtask.data; @@ -31,20 +26,25 @@ import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; - +/** + * Google Tasks任务类 + * 实现Node接口，代表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; // 所属的任务列表 + + /** + * 构造函数 + * 初始化任务基础属性，继承自Node的ID、名称等字段 + */ public Task() { super(); mCompleted = false; @@ -54,70 +54,75 @@ public class Task extends Node { mMetaInfo = null; } + /** + * 生成创建任务的JSON请求体 + * 用于向Google Tasks服务器发送创建任务的API请求 + * + * @param actionId 操作唯一标识 + * @return 符合Google Tasks API格式的JSON对象 + * @throws ActionFailureException 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 + // 设置操作类型为创建 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); + // 设置操作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"); - entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, - GTaskStringUtils.GTASK_JSON_TYPE_TASK); + entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_TASK); if (getNotes() != null) { entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); } js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); - // parent_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 + js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); - // prior_sibling_id + // 设置任务排序关联（前一个兄弟任务） if (mPriorSibling != null) { js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); } } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + Log.e(TAG, "创建任务JSON构造失败", e); throw new ActionFailureException("fail to generate task-create jsonobject"); } return js; } + /** + * 生成更新任务的JSON请求体 + * 用于向Google Tasks服务器发送更新任务的API请求 + * + * @param actionId 操作唯一标识 + * @return 符合Google Tasks API格式的JSON对象 + * @throws ActionFailureException 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 + // 设置操作类型为更新 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); // 设置任务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) { @@ -127,69 +132,61 @@ public class Task extends Node { js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + Log.e(TAG, "更新任务JSON构造失败", e); throw new ActionFailureException("fail to generate task-update jsonobject"); } return js; } + /** + * 从远程JSON数据解析任务内容 + * 处理Google Tasks服务器返回的任务数据 + * + * @param js 服务器返回的JSON数据 + * @throws ActionFailureException 解析失败时抛出 + */ public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { - // 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)) { + // 解析基础属性 + if (js.has(GTaskStringUtils.GTASK_JSON_ID)) setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); + 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)); - } + if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); + if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); + if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); + if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + Log.e(TAG, "远程任务数据解析失败", e); throw new ActionFailureException("fail to get task content from jsonobject"); } } } + /** + * 从本地JSON数据解析任务内容 + * 处理本地数据库存储的任务数据 + * + * @param js 本地存储的JSON数据 + */ public void setContentByLocalJSON(JSONObject js) { - if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) - || !js.has(GTaskStringUtils.META_HEAD_DATA)) { - Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); + if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) || !js.has(GTaskStringUtils.META_HEAD_DATA)) { + Log.w(TAG, "本地任务数据格式无效"); + return; } try { 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"); + Log.e(TAG, "无效的任务类型"); return; } + // 从附属数据中提取任务名称 for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { @@ -199,21 +196,27 @@ public class Task extends Node { } } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + Log.e(TAG, "本地任务数据解析失败", e); } } + /** + * 生成本地存储的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"); + Log.w(TAG, "空任务无法存储"); return null; } + // 构建基础JSON结构 JSONObject js = new JSONObject(); JSONObject note = new JSONObject(); JSONArray dataArray = new JSONArray(); @@ -225,14 +228,15 @@ 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)) { - data.put(DataColumns.CONTENT, getName()); + data.put(DataColumns.CONTENT, name); break; } } @@ -241,23 +245,34 @@ public class Task extends Node { return mMetaInfo; } } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + Log.e(TAG, "本地任务数据生成失败", e); return null; } } + /** + * 从MetaData对象加载元数据 + * + * @param metaData 包含元数据的对象 + */ public void setMetaInfo(MetaData metaData) { if (metaData != null && metaData.getNotes() != null) { try { mMetaInfo = new JSONObject(metaData.getNotes()); } catch (JSONException e) { - Log.w(TAG, e.toString()); + Log.w(TAG, "元数据解析失败", e); mMetaInfo = null; } } } + /** + * 确定任务同步操作类型 + * 根据本地数据库与远程数据的差异判断同步策略 + * + * @param c 本地数据库游标（包含任务记录） + * @return 同步操作类型常量（如新增、更新、冲突等） + */ public int getSyncAction(Cursor c) { try { JSONObject noteInfo = null; @@ -265,87 +280,123 @@ public class Task extends Node { noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); } + // 元数据异常处理 if (noteInfo == null) { - Log.w(TAG, "it seems that note meta has been deleted"); + Log.w(TAG, "任务元数据已删除，执行远程更新"); return SYNC_ACTION_UPDATE_REMOTE; } - if (!noteInfo.has(NoteColumns.ID)) { - Log.w(TAG, "remote note id seems to be deleted"); + Log.w(TAG, "远程任务ID缺失，执行本地更新"); 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"); + Log.w(TAG, "本地与远程笔记ID不匹配，执行本地更新"); 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; + return SYNC_ACTION_NONE; // 无变更 } else { - // apply remote to local - return SYNC_ACTION_UPDATE_LOCAL; + return SYNC_ACTION_UPDATE_LOCAL; // 应用远程更新 } } else { - // validate gtask id + // 本地有修改时的同步策略 if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { - Log.e(TAG, "gtask id doesn't match"); + Log.e(TAG, "Google Tasks ID不匹配，同步错误"); return SYNC_ACTION_ERROR; } if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // local modification only - return SYNC_ACTION_UPDATE_REMOTE; + return SYNC_ACTION_UPDATE_REMOTE; // 提交本地修改 } else { - return SYNC_ACTION_UPDATE_CONFLICT; + return SYNC_ACTION_UPDATE_CONFLICT; // 同步冲突 } } } catch (Exception e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + Log.e(TAG, "同步操作类型判断失败", e); } return SYNC_ACTION_ERROR; } + /** + * 判断任务是否需要保存 + * 当任务包含有效数据时返回true + * + * @return 保存必要性标记 + */ public boolean isWorthSaving() { - return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) - || (getNotes() != null && getNotes().trim().length() > 0); + return mMetaInfo != null + || (getName() != null && getName().trim().length() > 0) + || (getNotes() != null && getNotes().trim().length() > 0); } + // 以下为属性访问器和修改器（带注释说明） + /** + * 设置任务完成状态 + * @param completed 完成状态（true为已完成） + */ 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 完成状态（true为已完成） + */ 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/Notes-master/src/net/micode/notes/gtask/data/TaskList.java b/Notes-master/src/net/micode/notes/gtask/data/TaskList.java index 4ea21c5..da3f3aa 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/TaskList.java +++ b/Notes-master/src/net/micode/notes/gtask/data/TaskList.java @@ -2,16 +2,11 @@ * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 您可以在遵守License的前提下使用本文件 + * 具体License内容可查阅：http://www.apache.org/licenses/LICENSE-2.0 * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 软件按"原样"分发，不提供任何形式的明示或暗示的保证 + * 详见License中关于权限和限制的具体条款 */ package net.micode.notes.gtask.data; @@ -29,35 +24,49 @@ import org.json.JSONObject; import java.util.ArrayList; - +/** + * Google Tasks任务列表类 + * 表示一个任务列表，包含多个子任务 + * 负责处理任务列表与Google Tasks服务之间的数据交互和同步 + */ public class TaskList extends Node { private static final String TAG = TaskList.class.getSimpleName(); - private int mIndex; - - private ArrayList mChildren; + private int mIndex; // 任务列表在Google Tasks中的排序索引 + private ArrayList mChildren; // 子任务列表 + /** + * 构造函数 + * 初始化任务列表的基本属性 + */ public TaskList() { super(); mChildren = new ArrayList(); - mIndex = 1; + mIndex = 1; // 默认索引为1 } + /** + * 生成创建任务列表的JSON操作对象 + * 用于向Google Tasks服务器发送创建任务列表请求 + * + * @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 +83,28 @@ public class TaskList extends Node { return js; } + /** + * 生成更新任务列表的JSON操作对象 + * 用于向Google Tasks服务器发送更新任务列表请求 + * + * @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 +119,26 @@ public class TaskList extends Node { return js; } + /** + * 从远程JSON数据设置任务列表内容 + * 解析从Google Tasks服务器获取的JSON数据，设置任务列表属性 + * + * @param js 包含远程任务列表数据的JSON对象 + */ public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { - // id + // 从JSON中提取并设置任务列表ID if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); } - // last_modified + // 从JSON中提取并设置最后修改时间 if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); } - // name + // 从JSON中提取并设置任务列表名称 if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); } @@ -129,6 +151,12 @@ public class TaskList extends Node { } } + /** + * 从本地JSON数据设置任务列表内容 + * 解析本地存储的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"); @@ -137,10 +165,12 @@ public class TaskList extends Node { try { 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,15 +187,24 @@ public class TaskList extends Node { } } + /** + * 从任务列表内容生成本地JSON数据 + * 将任务列表属性转换为本地存储的JSON格式 + * + * @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)) @@ -183,28 +222,35 @@ 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 + // 验证Google Tasks 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 +262,27 @@ public class TaskList extends Node { return SYNC_ACTION_ERROR; } + /** + * 获取子任务数量 + * + * @return 子任务数量 + */ public int getChildTaskCount() { return mChildren.size(); } + /** + * 添加子任务到任务列表末尾 + * + * @param task 要添加的任务 + * @return 添加成功返回true，否则返回false + */ 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 +291,13 @@ public class TaskList extends Node { return ret; } + /** + * 添加子任务到指定位置 + * + * @param task 要添加的任务 + * @param index 指定位置索引 + * @return 添加成功返回true，否则返回false + */ public boolean addChildTask(Task task, int index) { if (index < 0 || index > mChildren.size()) { Log.e(TAG, "add child task: invalid index"); @@ -244,7 +308,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 +324,12 @@ public class TaskList extends Node { return true; } + /** + * 从任务列表中移除子任务 + * + * @param task 要移除的任务 + * @return 移除成功返回true，否则返回false + */ public boolean removeChildTask(Task task) { boolean ret = false; int index = mChildren.indexOf(task); @@ -267,11 +337,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 +351,14 @@ public class TaskList extends Node { return ret; } + /** + * 移动子任务到指定位置 + * + * @param task 要移动的任务 + * @param index 指定位置索引 + * @return 移动成功返回true，否则返回false + */ public boolean moveChildTask(Task task, int index) { - if (index < 0 || index >= mChildren.size()) { Log.e(TAG, "move child task: invalid index"); return false; @@ -296,9 +372,17 @@ public class TaskList extends Node { if (pos == index) return true; + + // 先移除再添加，更新任务顺序 return (removeChildTask(task) && addChildTask(task, index)); } + /** + * 根据GID查找子任务 + * + * @param gid 任务的GID + * @return 找到的任务，未找到返回null + */ public Task findChildTaskByGid(String gid) { for (int i = 0; i < mChildren.size(); i++) { Task t = mChildren.get(i); @@ -309,10 +393,22 @@ 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 +417,12 @@ public class TaskList extends Node { return mChildren.get(index); } + /** + * 根据GID获取子任务 + * + * @param gid 任务的GID + * @return 找到的任务，未找到返回null + */ public Task getChilTaskByGid(String gid) { for (Task task : mChildren) { if (task.getGid().equals(gid)) @@ -329,15 +431,30 @@ 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