From 0244641af056482e33a75a7f616f23dcb0ffd2bf Mon Sep 17 00:00:00 2001 From: jacky-qiao <1102127448@qq.com> Date: Tue, 31 Dec 2024 10:00:20 +0800 Subject: [PATCH] =?UTF-8?q?gtask/data=E4=B8=AD6=E4=B8=AA=E4=BB=A3=E7=A0=81?= =?UTF-8?q?=E4=BF=AE=E6=94=B9=E5=AE=8C=E6=AF=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../net/micode/notes/gtask/data/MetaData.java | 66 ++- .../src/net/micode/notes/gtask/data/Node.java | 71 ++- .../net/micode/notes/gtask/data/SqlData.java | 217 ++++--- .../net/micode/notes/gtask/data/SqlNote.java | 551 +++++++++--------- .../src/net/micode/notes/gtask/data/Task.java | 315 +++++----- .../net/micode/notes/gtask/data/TaskList.java | 219 ++++--- 6 files changed, 744 insertions(+), 695 deletions(-) diff --git a/Notes-master/src/net/micode/notes/gtask/data/MetaData.java b/Notes-master/src/net/micode/notes/gtask/data/MetaData.java index 3a2050b..6225cb0 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/MetaData.java +++ b/Notes-master/src/net/micode/notes/gtask/data/MetaData.java @@ -1,82 +1,94 @@ /* * 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 + * 该文件属于Apache License, Version 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. + * 除非适用法律要求或书面同意，软件 + * 根据许可证分发是在“原样”基础上进行的， + * 不提供任何形式的保证或条件，无论是明示或暗示的。 + * 查看许可证以获取有关权限和 + * 限制的具体信息。 */ -package net.micode.notes.gtask.data; +package net.micode.notes.gtask.data; // 定义该类的位置 -import android.database.Cursor; -import android.util.Log; +import android.database.Cursor; // 导入Android的Cursor类，用于数据库操作 +import android.util.Log; // 导入Android的Log类，用于日志输出 -import net.micode.notes.tool.GTaskStringUtils; - -import org.json.JSONException; -import org.json.JSONObject; +import net.micode.notes.tool.GTaskStringUtils; // 导入自定义工具类，用于字符串处理 +import org.json.JSONException; // 导入JSON异常处理类 +import org.json.JSONObject; // 导入JSON对象类 +// MetaData类继承自Task类，表示元数据的管理类 public class MetaData extends Task { - private final static String TAG = MetaData.class.getSimpleName(); + private final static String TAG = MetaData.class.getSimpleName(); // 获取当前类名作为日志标签 - private String mRelatedGid = null; + private String mRelatedGid = null; // 声明一个私有属性，用于存储相关的GID + // 设置元数据的方法，接收GID和JSON对象作为参数 public void setMeta(String gid, JSONObject metaInfo) { try { + // 将GID放入metadata信息中 metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); } catch (JSONException e) { + // 捕获JSON异常并记录错误 Log.e(TAG, "failed to put related gid"); } + // 设置笔记内容为JSON对象的字符串表示 setNotes(metaInfo.toString()); + // 设置名称为常量名称 setName(GTaskStringUtils.META_NOTE_NAME); } + // 获取相关GID的方法 public String getRelatedGid() { - return mRelatedGid; + return mRelatedGid; // 返回相关GID } + // 重写isWorthSaving方法，判断是否值得保存 @Override public boolean isWorthSaving() { - return getNotes() != null; + return getNotes() != null; // 如果笔记内容不为空，则值得保存 } + // 重写通过远程JSON设置内容的方法 @Override public void setContentByRemoteJSON(JSONObject js) { - super.setContentByRemoteJSON(js); - if (getNotes() != null) { + super.setContentByRemoteJSON(js); // 调用父类的方法 + if (getNotes() != null) { // 如果笔记内容不为空 try { + // 将笔记内容转换为JSON对象 JSONObject metaInfo = new JSONObject(getNotes().trim()); + // 获取相关GID并保存 mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); } catch (JSONException e) { + // 捕获JSON异常并记录警告 Log.w(TAG, "failed to get related gid"); - mRelatedGid = null; + mRelatedGid = null; // 将相关GID设置为null } } } + // 重写通过本地JSON设置内容的方法，该方法不应被调用 @Override public void setContentByLocalJSON(JSONObject js) { - // this function should not be called - throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); // 抛出异常，指明不应调用 } + // 重写从内容获取本地JSON的方法，该方法不应被调用 @Override public JSONObject getLocalJSONFromContent() { - throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); // 抛出异常，指明不应调用 } + // 重写获取同步操作的方法，该方法不应被调用 @Override public int getSyncAction(Cursor c) { - throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + throw new IllegalAccessError("MetaData:getSyncAction should not be called"); // 抛出异常，指明不应调用 } - } diff --git a/Notes-master/src/net/micode/notes/gtask/data/Node.java b/Notes-master/src/net/micode/notes/gtask/data/Node.java index 63950e0..a520edc 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/Node.java +++ b/Notes-master/src/net/micode/notes/gtask/data/Node.java @@ -14,88 +14,95 @@ * limitations under the License. */ +// 定义包名 package net.micode.notes.gtask.data; +// 导入必要的类 import android.database.Cursor; - import org.json.JSONObject; +// 抽象类 Node，表示一个数据节点的基本结构 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; // 唯一标识符 + private String mName; // 节点名称 + private long mLastModified; // 最后修改时间 + private boolean mDeleted; // 是否删除标记 + + // 构造函数，初始化节点属性 public Node() { - mGid = null; - mName = ""; - mLastModified = 0; - mDeleted = false; + mGid = null; // 初始化 Gid 为 null + mName = ""; // 初始化名称为空字符串 + mLastModified = 0; // 初始化最后修改时间为 0 + mDeleted = false; // 初始化删除状态为 false } + // 抽象方法，获取创建操作的 JSON 对象 public abstract JSONObject getCreateAction(int actionId); + // 抽象方法，获取更新操作的 JSON 对象 public abstract JSONObject getUpdateAction(int actionId); + // 抽象方法，通过远程 JSON 设置内容 public abstract void setContentByRemoteJSON(JSONObject js); + // 抽象方法，通过本地 JSON 设置内容 public abstract void setContentByLocalJSON(JSONObject js); + // 抽象方法，从内容获取本地 JSON public abstract JSONObject getLocalJSONFromContent(); + // 抽象方法，从 Cursor 获取同步操作类型 public abstract int getSyncAction(Cursor c); + // 设置 Gid public void setGid(String gid) { this.mGid = gid; } + // 设置名称 public void setName(String name) { this.mName = name; } + // 设置最后修改时间 public void setLastModified(long lastModified) { this.mLastModified = lastModified; } + // 设置删除状态 public void setDeleted(boolean deleted) { this.mDeleted = deleted; } + // 获取 Gid public String getGid() { return this.mGid; } + // 获取名称 public String getName() { return this.mName; } + // 获取最后修改时间 public long getLastModified() { return this.mLastModified; } + // 获取删除状态 public boolean getDeleted() { return this.mDeleted; } - } 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..88e1fe8 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/SqlData.java +++ b/Notes-master/src/net/micode/notes/gtask/data/SqlData.java @@ -1,189 +1,186 @@ /* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * 版权所有 (c) 2010-2011 MiCode 开源社区 (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 + * 根据 Apache 许可证第 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. + * 除非适用法律要求或书面同意，否则根据许可证分发的软件 + * 是在“按原样”基础上分发的，不附带任何明示或暗示的担保或条件。 + * 有关许可证下权限和限制的具体语言，请参阅许可证。 */ -package net.micode.notes.gtask.data; +package net.micode.notes.gtask.data; // 定义包名 -import android.content.ContentResolver; -import android.content.ContentUris; -import android.content.ContentValues; -import android.content.Context; -import android.database.Cursor; -import android.net.Uri; -import android.util.Log; +import android.content.ContentResolver; // 导入ContentResolver类，用于管理内容提供者的操作 +import android.content.ContentUris; // 导入ContentUris类，用于构造内容URI +import android.content.ContentValues; // 导入ContentValues类，用于存储行的列值 +import android.content.Context; // 导入Context类，表示应用环境 +import android.database.Cursor; // 导入Cursor类，用于访问数据库查询结果 +import android.net.Uri; // 导入Uri类，用于表示内容的URI +import android.util.Log; // 导入Log类，用于记录调试信息 -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.DataColumns; -import net.micode.notes.data.Notes.DataConstants; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.data.NotesDatabaseHelper.TABLE; -import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.data.Notes; // 导入Notes类，表示笔记相关的数据结构 +import net.micode.notes.data.Notes.DataColumns; // 导入数据列常量 +import net.micode.notes.data.Notes.DataConstants; // 导入数据常量 +import net.micode.notes.data.Notes.NoteColumns; // 导入笔记列常量 +import net.micode.notes.data.NotesDatabaseHelper.TABLE; // 导入数据库表名常量 +import net.micode.notes.gtask.exception.ActionFailureException; // 导入自定义异常类 -import org.json.JSONException; -import org.json.JSONObject; +import org.json.JSONException; // 导入JSONException类，用于处理JSON异常 +import org.json.JSONObject; // 导入JSONObject类，表示一个JSON对象 -public class SqlData { - private static final String TAG = SqlData.class.getSimpleName(); +public class SqlData { // 定义SqlData类 + private static final String TAG = SqlData.class.getSimpleName(); // 定义日志标签 - private static final int INVALID_ID = -99999; + private static final int INVALID_ID = -99999; // 定义无效ID常量 + // 定义数据投影数组，包含要查询的列 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; // 数据内容的第一个额外字段 + private String mDataContentData3; // 数据内容的第三个额外字段 + private ContentValues mDiffDataValues; // 存储变化的数据值 + // 构造函数，用于创建新的SqlData实例 public SqlData(Context context) { - mContentResolver = context.getContentResolver(); - mIsCreate = true; - mDataId = INVALID_ID; - mDataMimeType = DataConstants.NOTE; - mDataContent = ""; - mDataContentData1 = 0; - mDataContentData3 = ""; - mDiffDataValues = new ContentValues(); + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = true; // 设置为创建状态 + mDataId = INVALID_ID; // 初始化ID为无效值 + mDataMimeType = DataConstants.NOTE; // 默认MIME类型为笔记 + mDataContent = ""; // 初始化内容为空 + mDataContentData1 = 0; // 第一个数据字段初始化为0 + mDataContentData3 = ""; // 第三个数据字段初始化为空 + mDiffDataValues = new ContentValues(); // 创建内容值实例 } + // 构造函数，用于从游标中加载SqlData实例 public SqlData(Context context, Cursor c) { - mContentResolver = context.getContentResolver(); - mIsCreate = false; - loadFromCursor(c); - mDiffDataValues = new ContentValues(); + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非创建状态 + loadFromCursor(c); // 从游标加载数据 + mDiffDataValues = new ContentValues(); // 创建内容值实例 } + // 从游标中加载数据到SqlData实例 private void loadFromCursor(Cursor c) { - mDataId = c.getLong(DATA_ID_COLUMN); - mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); - mDataContent = c.getString(DATA_CONTENT_COLUMN); - mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); - mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); + mDataId = c.getLong(DATA_ID_COLUMN); // 获取数据ID + mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); // 获取MIME类型 + mDataContent = c.getString(DATA_CONTENT_COLUMN); // 获取内容 + mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); // 获取第一个数据字段 + mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); // 获取第三个数据字段 } + // 设置内容，从JSONObject填充数据 public void setContent(JSONObject js) throws JSONException { - long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; - if (mIsCreate || mDataId != dataId) { - mDiffDataValues.put(DataColumns.ID, dataId); + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; // 获取ID + if (mIsCreate || mDataId != dataId) { // 如果是创建状态或ID不相等 + mDiffDataValues.put(DataColumns.ID, dataId); // 更新变化的ID值 } - mDataId = dataId; + mDataId = dataId; // 更新数据ID String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) - : DataConstants.NOTE; - if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { - mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); + : DataConstants.NOTE; // 获取MIME类型 + if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { // 如果是创建状态或MIME类型不同 + mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); // 更新变化的MIME类型 } - mDataMimeType = dataMimeType; + mDataMimeType = dataMimeType; // 更新MIME类型 - String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; - if (mIsCreate || !mDataContent.equals(dataContent)) { - mDiffDataValues.put(DataColumns.CONTENT, dataContent); + String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; // 获取内容 + if (mIsCreate || !mDataContent.equals(dataContent)) { // 如果是创建状态或内容不同 + mDiffDataValues.put(DataColumns.CONTENT, dataContent); // 更新变化的内容 } - mDataContent = dataContent; + mDataContent = dataContent; // 更新内容 - long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; - if (mIsCreate || mDataContentData1 != dataContentData1) { - mDiffDataValues.put(DataColumns.DATA1, dataContentData1); + long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; // 获取第一个数据字段 + if (mIsCreate || mDataContentData1 != dataContentData1) { // 如果是创建状态或字段不同 + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); // 更新变化的第一个数据字段 } - mDataContentData1 = dataContentData1; + mDataContentData1 = dataContentData1; // 更新第一个数据字段 - String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; - if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { - mDiffDataValues.put(DataColumns.DATA3, dataContentData3); + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; // 获取第三个数据字段 + if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { // 如果是创建状态或字段不同 + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); // 更新变化的第三个数据字段 } - mDataContentData3 = dataContentData3; + mDataContentData3 = dataContentData3; // 更新第三个数据字段 } + // 获取内容，返回为JSONObject public JSONObject getContent() throws JSONException { - if (mIsCreate) { - Log.e(TAG, "it seems that we haven't created this in database yet"); - return null; + if (mIsCreate) { // 如果是创建状态 + Log.e(TAG, "it seems that we haven't created this in database yet"); // 记录错误日志 + return null; // 返回null } - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建新的JSON对象 + // 将数据添加到JSON对象中 js.put(DataColumns.ID, mDataId); js.put(DataColumns.MIME_TYPE, mDataMimeType); js.put(DataColumns.CONTENT, mDataContent); js.put(DataColumns.DATA1, mDataContentData1); js.put(DataColumns.DATA3, mDataContentData3); - return js; + return js; // 返回填充的JSON对象 } + // 提交更改到数据库 public void commit(long noteId, boolean validateVersion, long version) { - if (mIsCreate) { - if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { - mDiffDataValues.remove(DataColumns.ID); + if (mIsCreate) { // 如果是创建状态 + if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { // 如果ID无效且变化值中包含ID + mDiffDataValues.remove(DataColumns.ID); // 移除变化值中的ID } - mDiffDataValues.put(DataColumns.NOTE_ID, noteId); - Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); + mDiffDataValues.put(DataColumns.NOTE_ID, noteId); // 添加笔记ID到变化值 + Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); // 插入数据 try { - mDataId = Long.valueOf(uri.getPathSegments().get(1)); - } catch (NumberFormatException e) { - Log.e(TAG, "Get note id error :" + e.toString()); - throw new ActionFailureException("create note failed"); + mDataId = Long.valueOf(uri.getPathSegments().get(1)); // 获取新创建的ID + } catch (NumberFormatException e) { // 捕获数字格式异常 + Log.e(TAG, "Get note id error :" + e.toString()); // 记录错误日志 + throw new ActionFailureException("create note failed"); // 抛出创建失败异常 } - } else { - if (mDiffDataValues.size() > 0) { - int result = 0; - if (!validateVersion) { + } else { // 如果不是创建状态 + if (mDiffDataValues.size() > 0) { // 如果有变化值 + int result = 0; // 定义返回结果 + if (!validateVersion) { // 如果不验证版本 result = mContentResolver.update(ContentUris.withAppendedId( - Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); - } else { + 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 + " WHERE " + NoteColumns.VERSION + "=?)", new String[] { String.valueOf(noteId), String.valueOf(version) - }); + }); // 根据版本更新数据 } - if (result == 0) { - Log.w(TAG, "there is no update. maybe user updates note when syncing"); + if (result == 0) { // 如果没有更新行 + Log.w(TAG, "there is no update. maybe user updates note when syncing"); // 记录警告日志 } } } - mDiffDataValues.clear(); - mIsCreate = false; + mDiffDataValues.clear(); // 清空变化的数据值 + mIsCreate = false; // 设置为非创建状态 } + // 获取数据ID public long getId() { - return mDataId; + return mDataId; // 返回数据ID } } 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..cb58657 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java +++ b/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java @@ -16,33 +16,35 @@ package net.micode.notes.gtask.data; -import android.appwidget.AppWidgetManager; -import android.content.ContentResolver; -import android.content.ContentValues; -import android.content.Context; -import android.database.Cursor; -import android.net.Uri; -import android.util.Log; - -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.DataColumns; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.gtask.exception.ActionFailureException; -import net.micode.notes.tool.GTaskStringUtils; -import net.micode.notes.tool.ResourceParser; - -import org.json.JSONArray; -import org.json.JSONException; -import org.json.JSONObject; - -import java.util.ArrayList; - - +// 导入相关的类 +import android.appwidget.AppWidgetManager; // 用于访问小部件管理器 +import android.content.ContentResolver; // 用于访问内容提供者 +import android.content.ContentValues; // 表示一组键值对 +import android.content.Context; // Android的上下文类 +import android.database.Cursor; // 用于访问查询结果 +import android.net.Uri; // 表示统一资源标识符 +import android.util.Log; // 日志记录工具 + +import net.micode.notes.data.Notes; // 引入笔记数据类 +import net.micode.notes.data.Notes.DataColumns; // 数据列常量 +import net.micode.notes.data.Notes.NoteColumns; // 笔记列常量 +import net.micode.notes.gtask.exception.ActionFailureException; // 异常类 +import net.micode.notes.tool.GTaskStringUtils; // 工具类，用于处理GTask字符串 +import net.micode.notes.tool.ResourceParser; // 资源解析工具类 + +import org.json.JSONArray; // 用于处理JSON数组 +import org.json.JSONException; // JSON异常处理 +import org.json.JSONObject; // 用于处理JSON对象 + +import java.util.ArrayList; // 动态数组 + +// SqlNote 类表示笔记的数据库操作 public class SqlNote { - private static final String TAG = SqlNote.class.getSimpleName(); + private static final String TAG = SqlNote.class.getSimpleName(); // 日志标签 - private static final int INVALID_ID = -99999; + private static final int INVALID_ID = -99999; // 无效ID常量 + // 定义查询笔记所需的列 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,454 +54,443 @@ public class SqlNote { NoteColumns.VERSION }; + // 定义各个列的索引常量 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实例 public SqlNote(Context context) { - mContext = context; - mContentResolver = context.getContentResolver(); - mIsCreate = true; - mId = INVALID_ID; - mAlertDate = 0; - mBgColorId = ResourceParser.getDefaultBgId(context); - mCreatedDate = System.currentTimeMillis(); - mHasAttachment = 0; - mModifiedDate = System.currentTimeMillis(); - mParentId = 0; - mSnippet = ""; - mType = Notes.TYPE_NOTE; - mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; - mWidgetType = Notes.TYPE_WIDGET_INVALIDE; - mOriginParent = 0; - mVersion = 0; - mDiffNoteValues = new ContentValues(); - mDataList = new ArrayList(); + mContext = context; // 设置上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = true; // 设置为新建状态 + mId = INVALID_ID; // 设置ID为无效值 + mAlertDate = 0; // 初始化提醒日期 + mBgColorId = ResourceParser.getDefaultBgId(context); // 获取默认背景ID + mCreatedDate = System.currentTimeMillis(); // 获取当前时间作为创建日期 + mHasAttachment = 0; // 初始化无附件 + mModifiedDate = System.currentTimeMillis(); // 获取当前时间作为修改日期 + mParentId = 0; // 初始化父级ID + mSnippet = ""; // 初始化笔记摘录 + mType = Notes.TYPE_NOTE; // 默认类型为笔记 + mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; // 设置小部件ID为无效值 + mWidgetType = Notes.TYPE_WIDGET_INVALIDE; // 设置小部件类型为无效值 + mOriginParent = 0; // 初始化原始父级ID + mVersion = 0; // 初始化版本号 + mDiffNoteValues = new ContentValues(); // 初始化变化的笔记值 + mDataList = new ArrayList(); // 初始化笔记数据列表 } + // 构造函数：根据Cursor创建SqlNote实例 public SqlNote(Context context, Cursor c) { - mContext = context; - mContentResolver = context.getContentResolver(); - mIsCreate = false; - loadFromCursor(c); - mDataList = new ArrayList(); - if (mType == Notes.TYPE_NOTE) - loadDataContent(); - mDiffNoteValues = new ContentValues(); + mContext = context; // 设置上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非新建状态 + loadFromCursor(c); // 从Cursor加载数据 + mDataList = new ArrayList(); // 初始化笔记数据列表 + if (mType == Notes.TYPE_NOTE) // 如果类型为笔记 + loadDataContent(); // 加载数据内容 + mDiffNoteValues = new ContentValues(); // 初始化变化的笔记值 } + // 构造函数：根据ID创建SqlNote实例 public SqlNote(Context context, long id) { - mContext = context; - mContentResolver = context.getContentResolver(); - mIsCreate = false; - loadFromCursor(id); - mDataList = new ArrayList(); - if (mType == Notes.TYPE_NOTE) - loadDataContent(); - mDiffNoteValues = new ContentValues(); - + mContext = context; // 设置上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非新建状态 + loadFromCursor(id); // 根据ID加载数据 + mDataList = new ArrayList(); // 初始化笔记数据列表 + if (mType == Notes.TYPE_NOTE) // 如果类型为笔记 + loadDataContent(); // 加载数据内容 + mDiffNoteValues = new ContentValues(); // 初始化变化的笔记值 } + // 从Cursor中加载笔记数据 private void loadFromCursor(long id) { - Cursor c = null; + Cursor c = null; // 初始化Cursor try { + // 查询笔记数据 c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", new String[] { - String.valueOf(id) + String.valueOf(id) // 根据ID查询 }, null); - if (c != null) { - c.moveToNext(); - loadFromCursor(c); + if (c != null) { // 如果Cursor不为空 + c.moveToNext(); // 移动到下一行 + loadFromCursor(c); // 从Cursor加载数据 } else { - Log.w(TAG, "loadFromCursor: cursor = null"); + Log.w(TAG, "loadFromCursor: cursor = null"); // 如果Cursor为空，记录警告日志 } } finally { - if (c != null) + if (c != null) // 关闭Cursor c.close(); } } + // 从Cursor中加载笔记数据 private void loadFromCursor(Cursor c) { - mId = c.getLong(ID_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); - mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); - mParentId = c.getLong(PARENT_ID_COLUMN); - mSnippet = c.getString(SNIPPET_COLUMN); - mType = c.getInt(TYPE_COLUMN); - mWidgetId = c.getInt(WIDGET_ID_COLUMN); - mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); - mVersion = c.getLong(VERSION_COLUMN); + mId = c.getLong(ID_COLUMN); // 获取ID + mAlertDate = c.getLong(ALERTED_DATE_COLUMN); // 获取提醒日期 + mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); // 获取背景颜色ID + mCreatedDate = c.getLong(CREATED_DATE_COLUMN); // 获取创建日期 + mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); // 获取附件标志 + mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); // 获取修改日期 + mParentId = c.getLong(PARENT_ID_COLUMN); // 获取父级ID + mSnippet = c.getString(SNIPPET_COLUMN); // 获取笔记摘录 + mType = c.getInt(TYPE_COLUMN); // 获取笔记类型 + mWidgetId = c.getInt(WIDGET_ID_COLUMN); // 获取小部件ID + mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); // 获取小部件类型 + mVersion = c.getLong(VERSION_COLUMN); // 获取版本号 } + // 加载笔记数据内容 private void loadDataContent() { - Cursor c = null; - mDataList.clear(); + Cursor c = null; // 初始化Cursor + mDataList.clear(); // 清空数据列表 try { + // 查询笔记数据内容 c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA, "(note_id=?)", new String[] { - String.valueOf(mId) + String.valueOf(mId) // 根据笔记ID查询 }, null); - if (c != null) { - if (c.getCount() == 0) { - Log.w(TAG, "it seems that the note has not data"); - return; + if (c != null) { // 如果Cursor不为空 + if (c.getCount() == 0) { // 如果没有数据 + Log.w(TAG, "it seems that the note has not data"); // 记录警告日志 + return; // 返回 } + // 遍历Cursor中的数据 while (c.moveToNext()) { - SqlData data = new SqlData(mContext, c); - mDataList.add(data); + SqlData data = new SqlData(mContext, c); // 创建SqlData实例 + mDataList.add(data); // 添加到数据列表 } } else { - Log.w(TAG, "loadDataContent: cursor = null"); + Log.w(TAG, "loadDataContent: cursor = null"); // 如果Cursor为空，记录警告日志 } } finally { - if (c != null) + if (c != null) // 关闭Cursor c.close(); } } + // 设置笔记内容 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 + 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) { // 如果是文件夹 + // 只更新摘录和类型 String snippet = note.has(NoteColumns.SNIPPET) ? note - .getString(NoteColumns.SNIPPET) : ""; + .getString(NoteColumns.SNIPPET) : ""; // 获取摘录 if (mIsCreate || !mSnippet.equals(snippet)) { - mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); + mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); // 更新摘录 } - mSnippet = snippet; + mSnippet = snippet; // 设置摘录 int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) - : Notes.TYPE_NOTE; + : Notes.TYPE_NOTE; // 获取类型 if (mIsCreate || mType != type) { - mDiffNoteValues.put(NoteColumns.TYPE, type); + mDiffNoteValues.put(NoteColumns.TYPE, type); // 更新类型 } - 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; + 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; // 获取ID if (mIsCreate || mId != id) { - mDiffNoteValues.put(NoteColumns.ID, id); + mDiffNoteValues.put(NoteColumns.ID, id); // 更新ID } - mId = id; + mId = id; // 设置ID long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note - .getLong(NoteColumns.ALERTED_DATE) : 0; + .getLong(NoteColumns.ALERTED_DATE) : 0; // 获取提醒日期 if (mIsCreate || mAlertDate != alertDate) { - mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); + mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); // 更新提醒日期 } - mAlertDate = alertDate; + mAlertDate = alertDate; // 设置提醒日期 int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note - .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); + .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); // 获取背景颜色ID if (mIsCreate || mBgColorId != bgColorId) { - mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); + mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); // 更新背景颜色ID } - mBgColorId = bgColorId; + mBgColorId = bgColorId; // 设置背景颜色ID long createDate = note.has(NoteColumns.CREATED_DATE) ? note - .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); + .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); // 获取创建日期 if (mIsCreate || mCreatedDate != createDate) { - mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate); + mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate); // 更新创建日期 } - mCreatedDate = createDate; + mCreatedDate = createDate; // 设置创建日期 int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note - .getInt(NoteColumns.HAS_ATTACHMENT) : 0; + .getInt(NoteColumns.HAS_ATTACHMENT) : 0; // 获取附件标志 if (mIsCreate || mHasAttachment != hasAttachment) { - mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment); + mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment); // 更新附件标志 } - mHasAttachment = hasAttachment; + mHasAttachment = hasAttachment; // 设置附件标志 long modifiedDate = note.has(NoteColumns.MODIFIED_DATE) ? note - .getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis(); + .getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis(); // 获取修改日期 if (mIsCreate || mModifiedDate != modifiedDate) { - mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate); + mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate); // 更新修改日期 } - mModifiedDate = modifiedDate; + mModifiedDate = modifiedDate; // 设置修改日期 long parentId = note.has(NoteColumns.PARENT_ID) ? note - .getLong(NoteColumns.PARENT_ID) : 0; + .getLong(NoteColumns.PARENT_ID) : 0; // 获取父级ID if (mIsCreate || mParentId != parentId) { - mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); + mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); // 更新父级ID } - mParentId = parentId; + mParentId = parentId; // 设置父级ID String snippet = note.has(NoteColumns.SNIPPET) ? note - .getString(NoteColumns.SNIPPET) : ""; + .getString(NoteColumns.SNIPPET) : ""; // 获取摘录 if (mIsCreate || !mSnippet.equals(snippet)) { - mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); + mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); // 更新摘录 } - mSnippet = snippet; + mSnippet = snippet; // 设置摘录 int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) - : Notes.TYPE_NOTE; + : Notes.TYPE_NOTE; // 获取类型 if (mIsCreate || mType != type) { - mDiffNoteValues.put(NoteColumns.TYPE, type); + mDiffNoteValues.put(NoteColumns.TYPE, type); // 更新类型 } - mType = type; + mType = type; // 设置类型 int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID) - : AppWidgetManager.INVALID_APPWIDGET_ID; + : AppWidgetManager.INVALID_APPWIDGET_ID; // 获取小部件ID if (mIsCreate || mWidgetId != widgetId) { - mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); + mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); // 更新小部件ID } - mWidgetId = widgetId; + mWidgetId = widgetId; // 设置小部件ID int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note - .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; + .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; // 获取小部件类型 if (mIsCreate || mWidgetType != widgetType) { - mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); + mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); // 更新小部件类型 } - mWidgetType = widgetType; + mWidgetType = widgetType; // 设置小部件类型 long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note - .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; + .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; // 获取原始父级ID if (mIsCreate || mOriginParent != originParent) { - mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); + mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); // 更新原始父级ID } - mOriginParent = originParent; + mOriginParent = originParent; // 设置原始父级ID + // 加载数据数组中的每一项 for (int i = 0; i < dataArray.length(); i++) { - JSONObject data = dataArray.getJSONObject(i); - SqlData sqlData = null; - if (data.has(DataColumns.ID)) { - long dataId = data.getLong(DataColumns.ID); - for (SqlData temp : mDataList) { + JSONObject data = dataArray.getJSONObject(i); // 获取JSON数据对象 + SqlData sqlData = null; // 初始化SqlData对象 + if (data.has(DataColumns.ID)) { // 如果数据中有ID + long dataId = data.getLong(DataColumns.ID); // 获取数据ID + for (SqlData temp : mDataList) { // 查找对应的SqlData实例 if (dataId == temp.getId()) { - sqlData = temp; + sqlData = temp; // 找到对应的SqlData } } } - if (sqlData == null) { - sqlData = new SqlData(mContext); - mDataList.add(sqlData); + if (sqlData == null) { // 如果没有找到对应的SqlData + sqlData = new SqlData(mContext); // 创建新的SqlData实例 + mDataList.add(sqlData); // 添加到数据列表 } - sqlData.setContent(data); + sqlData.setContent(data); // 设置SqlData内容 } } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - return false; + } catch (JSONException e) { // 捕获JSON异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈信息 + return false; // 返回false表示失败 } - return true; + return true; // 返回true表示成功 } + // 获取笔记内容 public JSONObject getContent() { try { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建新的JSON对象 - if (mIsCreate) { - Log.e(TAG, "it seems that we haven't created this in database yet"); - return null; + if (mIsCreate) { // 如果是新建状态 + Log.e(TAG, "it seems that we haven't created this in database yet"); // 记录错误日志 + return null; // 返回null } - JSONObject note = new JSONObject(); - if (mType == Notes.TYPE_NOTE) { - note.put(NoteColumns.ID, mId); - note.put(NoteColumns.ALERTED_DATE, mAlertDate); - 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); - - JSONArray dataArray = new JSONArray(); - for (SqlData sqlData : mDataList) { - JSONObject data = sqlData.getContent(); - if (data != null) { - dataArray.put(data); + JSONObject note = new JSONObject(); // 创建笔记对象 + if (mType == Notes.TYPE_NOTE) { // 如果类型为笔记 + note.put(NoteColumns.ID, mId); // 添加ID + note.put(NoteColumns.ALERTED_DATE, mAlertDate); // 添加提醒日期 + note.put(NoteColumns.BG_COLOR_ID, mBgColorId); // 添加背景颜色ID + note.put(NoteColumns.CREATED_DATE, mCreatedDate); // 添加创建日期 + note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); // 添加附件标志 + note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); // 添加修改日期 + note.put(NoteColumns.PARENT_ID, mParentId); // 添加父级ID + note.put(NoteColumns.SNIPPET, mSnippet); // 添加摘录 + note.put(NoteColumns.TYPE, mType); // 添加笔记类型 + note.put(NoteColumns.WIDGET_ID, mWidgetId); // 添加小部件ID + note.put(NoteColumns.WIDGET_TYPE, mWidgetType); // 添加小部件类型 + note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); // 添加原始父级ID + js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 将笔记对象放入结果JSON + + JSONArray dataArray = new JSONArray(); // 创建数据数组 + for (SqlData sqlData : mDataList) { // 遍历数据列表 + JSONObject data = sqlData.getContent(); // 获取数据的JSON对象 + if (data != null) { // 如果数据不为空 + dataArray.put(data); // 添加到数组 } } - js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); - } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { - note.put(NoteColumns.ID, mId); - note.put(NoteColumns.TYPE, mType); - note.put(NoteColumns.SNIPPET, mSnippet); - js.put(GTaskStringUtils.META_HEAD_NOTE, note); + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); // 将数据数组放入结果JSON + } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { // 如果是文件夹或系统类型 + note.put(NoteColumns.ID, mId); // 添加ID + note.put(NoteColumns.TYPE, mType); // 添加类型 + note.put(NoteColumns.SNIPPET, mSnippet); // 添加摘录 + js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 将笔记对象放入结果JSON } - return js; - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + return js; // 返回结果JSON对象 + } catch (JSONException e) { // 捕获JSON异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈信息 } - return null; + return null; // 返回null } + // 设置父级ID public void setParentId(long id) { - mParentId = id; - mDiffNoteValues.put(NoteColumns.PARENT_ID, id); + mParentId = id; // 设置父级ID + mDiffNoteValues.put(NoteColumns.PARENT_ID, id); // 更新变化的值 } + // 设置GTask Id public void setGtaskId(String gid) { - mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); + mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); // 更新变化的值 } + // 设置同步ID public void setSyncId(long syncId) { - mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); + mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); // 更新变化的值 } + // 重置本地修改标志 public void resetLocalModified() { - mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); + mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); // 更新变化的值 } + // 获取笔记ID public long getId() { - return mId; + return mId; // 返回ID } + // 获取父级ID public long getParentId() { - return mParentId; + return mParentId; // 返回父级ID } + // 获取笔记摘录 public String getSnippet() { - return mSnippet; + return mSnippet; // 返回摘录 } + // 判断是否为笔记类型 public boolean isNoteType() { - return mType == Notes.TYPE_NOTE; + return mType == Notes.TYPE_NOTE; // 返回类型是否为笔记 } + // 提交笔记到数据库 public void commit(boolean validateVersion) { - if (mIsCreate) { + if (mIsCreate) { // 如果是新建状态 if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { - mDiffNoteValues.remove(NoteColumns.ID); + mDiffNoteValues.remove(NoteColumns.ID); // 移除ID } - Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); + Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); // 插入笔记 try { - mId = Long.valueOf(uri.getPathSegments().get(1)); - } catch (NumberFormatException e) { - Log.e(TAG, "Get note id error :" + e.toString()); - throw new ActionFailureException("create note failed"); + mId = Long.valueOf(uri.getPathSegments().get(1)); // 获取笔记ID + } catch (NumberFormatException e) { // 捕获数字格式异常 + Log.e(TAG, "Get note id error :" + e.toString()); // 记录错误日志 + throw new ActionFailureException("create note failed"); // 抛出创建失败异常 } - if (mId == 0) { - throw new IllegalStateException("Create thread id failed"); + if (mId == 0) { // 如果ID为0，表示创建失败 + throw new IllegalStateException("Create thread id failed"); // 抛出异常 } - if (mType == Notes.TYPE_NOTE) { + if (mType == Notes.TYPE_NOTE) { // 如果类型为笔记 for (SqlData sqlData : mDataList) { - sqlData.commit(mId, false, -1); + sqlData.commit(mId, false, -1); // 提交每个SqlData } } - } else { + } 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"); + Log.e(TAG, "No such note"); // 记录错误日志 + throw new IllegalStateException("Try to update note with invalid id"); // 抛出异常 } - if (mDiffNoteValues.size() > 0) { - mVersion ++; - int result = 0; - if (!validateVersion) { + if (mDiffNoteValues.size() > 0) { // 如果有变化的值 + mVersion++; // 增加版本号 + int result = 0; // 结果初始化 + if (!validateVersion) { // 如果不需要验证版本 result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?)", new String[] { - String.valueOf(mId) + String.valueOf(mId) // 根据ID更新 }); - } else { + } else { // 需要验证版本 result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", new String[] { - String.valueOf(mId), String.valueOf(mVersion) + String.valueOf(mId), String.valueOf(mVersion) // 根据ID和版本更新 }); } - if (result == 0) { - Log.w(TAG, "there is no update. maybe user updates note when syncing"); + 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) { + if (mType == Notes.TYPE_NOTE) { // 如果类型为笔记 + for (SqlData sqlData : mDataList) { // 提交每个SqlData sqlData.commit(mId, validateVersion, mVersion); } } } - // refresh local info - loadFromCursor(mId); + // 刷新本地信息 + loadFromCursor(mId); // 重新加载笔记数据 if (mType == Notes.TYPE_NOTE) - loadDataContent(); + loadDataContent(); // 重新加载数据内容 - mDiffNoteValues.clear(); - mIsCreate = false; + mDiffNoteValues.clear(); // 清空变化的值 + mIsCreate = false; // 设置为非新建状态 } } 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..b36e2bd 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/Task.java +++ b/Notes-master/src/net/micode/notes/gtask/data/Task.java @@ -14,338 +14,355 @@ * limitations under the License. */ -package net.micode.notes.gtask.data; +package net.micode.notes.gtask.data; // 声明该类属于 net.micode.notes.gtask.data 包 -import android.database.Cursor; -import android.text.TextUtils; -import android.util.Log; +import android.database.Cursor; // 导入 Cursor 类，用于操作数据库结果集 +import android.text.TextUtils; // 导入 TextUtils 类，用于处理文本操作 +import android.util.Log; // 导入 Log 类，用于日志记录 -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.DataColumns; -import net.micode.notes.data.Notes.DataConstants; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.gtask.exception.ActionFailureException; -import net.micode.notes.tool.GTaskStringUtils; +import net.micode.notes.data.Notes; // 导入 Notes 类，用于引用笔记相关的常量和方法 +import net.micode.notes.data.Notes.DataColumns; // 导入数据列常量 +import net.micode.notes.data.Notes.DataConstants; // 导入数据常量 +import net.micode.notes.data.Notes.NoteColumns; // 导入笔记列常量 +import net.micode.notes.gtask.exception.ActionFailureException; // 导入自定义异常类 +import net.micode.notes.tool.GTaskStringUtils; // 导入工具类，用于处理任务字符串 -import org.json.JSONArray; -import org.json.JSONException; -import org.json.JSONObject; +import org.json.JSONArray; // 导入 JSONArray 类，用于处理 JSON 数组 +import org.json.JSONException; // 导入 JSONException 类，用于处理 JSON 异常 +import org.json.JSONObject; // 导入 JSONObject 类，用于处理 JSON 对象 +// 定义 Task 类，继承自 Node 类 public class Task extends Node { - private static final String TAG = Task.class.getSimpleName(); + private static final String TAG = Task.class.getSimpleName(); // 定义日志标签 - private boolean mCompleted; + private boolean mCompleted; // 任务完成状态 - private String mNotes; + private String mNotes; // 任务备注 - private JSONObject mMetaInfo; + private JSONObject mMetaInfo; // 任务的元信息（JSON 格式） - private Task mPriorSibling; + private Task mPriorSibling; // 任务的前一个兄弟任务 - private TaskList mParent; + private TaskList mParent; // 任务的父任务列表 + // 构造函数，初始化任务的状态 public Task() { - super(); - mCompleted = false; - mNotes = null; - mPriorSibling = null; - mParent = null; - mMetaInfo = null; + super(); // 调用父类构造函数 + mCompleted = false; // 默认未完成 + mNotes = null; // 默认无备注 + mPriorSibling = null; // 默认无前一个兄弟任务 + mParent = null; // 默认无父任务列表 + mMetaInfo = null; // 默认无元信息 } + // 获取创建任务的操作 JSON 对象 public JSONObject getCreateAction(int actionId) { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建 JSON 对象 try { - // action_type + // action_type - 设置操作类型为创建 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); - // action_id + // action_id - 设置操作 ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // index + // index - 任务在父任务中的索引位置 js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); - // entity_delta + // 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_NAME, getName()); // 任务名称 + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); // 创建者 ID，初始化为 null entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, - GTaskStringUtils.GTASK_JSON_TYPE_TASK); + GTaskStringUtils.GTASK_JSON_TYPE_TASK); // 实体类型为任务 if (getNotes() != null) { - entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); // 任务备注 } - js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将实体数据加入 JSON 对象 - // parent_id + // parent_id - 设置父任务 ID js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); - // dest_parent_type + // dest_parent_type - 设置目标父类型 js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, GTaskStringUtils.GTASK_JSON_TYPE_GROUP); - // list_id + // list_id - 设置任务列表 ID js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); - // prior_sibling_id + // prior_sibling_id - 设置前一个兄弟任务 ID if (mPriorSibling != null) { js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("fail to generate task-create jsonobject"); + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 + throw new ActionFailureException("fail to generate task-create jsonobject"); // 抛出自定义异常 } - return js; + return js; // 返回创建操作的 JSON 对象 } + // 获取更新任务的操作 JSON 对象 public JSONObject getUpdateAction(int actionId) { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建 JSON 对象 try { - // action_type + // action_type - 设置操作类型为更新 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); - // action_id + // action_id - 设置操作 ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // id + // id - 设置任务 ID js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); - // entity_delta + // entity_delta - 更新的实体数据 JSONObject entity = new JSONObject(); - entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 任务名称 if (getNotes() != null) { - entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); // 任务备注 } - entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); - js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); // 任务删除状态 + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将实体数据加入 JSON 对象 - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("fail to generate task-update jsonobject"); + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 + throw new ActionFailureException("fail to generate task-update jsonobject"); // 抛出自定义异常 } - return js; + return js; // 返回更新操作的 JSON 对象 } + // 根据远程 JSON 设置任务内容 public void setContentByRemoteJSON(JSONObject js) { - if (js != null) { + if (js != null) { // 如果 JSON 对象不为空 try { - // id + // id - 获取任务 ID if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); } - // last_modified + // last_modified - 获取最后修改时间 if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); } - // name + // name - 获取任务名称 if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); } - // notes + // notes - 获取任务备注 if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) { setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); } - // deleted + // deleted - 获取任务删除状态 if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) { setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); } - // completed + // completed - 获取任务完成状态 if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) { setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("fail to get task content from jsonobject"); + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 + throw new ActionFailureException("fail to get task content from jsonobject"); // 抛出自定义异常 } } } + // 根据本地 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"); + || !js.has(GTaskStringUtils.META_HEAD_DATA)) { // 检查 JSON 对象是否包含必要字段 + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); // 记录警告日志 } try { - JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); - JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + 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; + 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)) { - setName(data.getString(DataColumns.CONTENT)); - break; + setName(data.getString(DataColumns.CONTENT)); // 设置任务名称 + break; // 找到后退出循环 } } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 } } + // 从任务内容生成本地 JSON public JSONObject getLocalJSONFromContent() { - String name = getName(); + 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; + if (mMetaInfo == null) { // 如果元信息为空（表示从网页创建的任务） + if (name == null) { // 检查任务名称是否为空 + Log.w(TAG, "the note seems to be an empty one"); // 记录警告日志 + return null; // 返回空 } - JSONObject js = new JSONObject(); - JSONObject note = new JSONObject(); - JSONArray dataArray = new JSONArray(); - JSONObject data = new JSONObject(); - data.put(DataColumns.CONTENT, name); - dataArray.put(data); - js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); - note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); - 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); + JSONObject js = new JSONObject(); // 创建 JSON 对象 + JSONObject note = new JSONObject(); // 创建笔记对象 + JSONArray dataArray = new JSONArray(); // 创建数据数组 + JSONObject data = new JSONObject(); // 创建数据对象 + data.put(DataColumns.CONTENT, name); // 设置内容为任务名称 + dataArray.put(data); // 将数据对象加入数据数组 + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); // 将数据数组加入 JSON 对象 + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 设置笔记类型 + js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 将笔记对象加入 JSON 对象 + return js; // 返回 JSON 对象 + } else { // 处理已同步的任务 + 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()); - break; + data.put(DataColumns.CONTENT, getName()); // 更新内容为任务名称 + break; // 找到后退出循环 } } - note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); - return mMetaInfo; + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 设置笔记类型 + return mMetaInfo; // 返回元信息 JSON 对象 } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - return null; + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 + return null; // 返回空 } } + // 设置任务的元信息 public void setMetaInfo(MetaData metaData) { - if (metaData != null && metaData.getNotes() != null) { + if (metaData != null && metaData.getNotes() != null) { // 检查元数据和笔记是否为空 try { - mMetaInfo = new JSONObject(metaData.getNotes()); - } catch (JSONException e) { - Log.w(TAG, e.toString()); - mMetaInfo = null; + mMetaInfo = new JSONObject(metaData.getNotes()); // 将笔记设置为元信息的 JSON 对象 + } catch (JSONException e) { // 捕获 JSON 异常 + Log.w(TAG, e.toString()); // 记录警告日志 + mMetaInfo = null; // 将元信息设置为 null } } } + // 获取同步操作类型 public int getSyncAction(Cursor c) { try { JSONObject noteInfo = null; if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) { - noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); // 获取笔记信息 } - if (noteInfo == null) { - Log.w(TAG, "it seems that note meta has been deleted"); - return SYNC_ACTION_UPDATE_REMOTE; + if (noteInfo == null) { // 检查笔记信息是否为 null + Log.w(TAG, "it seems that note meta has been deleted"); // 记录警告日志 + return SYNC_ACTION_UPDATE_REMOTE; // 返回远程更新操作 } - if (!noteInfo.has(NoteColumns.ID)) { - Log.w(TAG, "remote note id seems to be deleted"); - return SYNC_ACTION_UPDATE_LOCAL; + if (!noteInfo.has(NoteColumns.ID)) { // 检查笔记 ID 是否存在 + Log.w(TAG, "remote note id seems to be deleted"); // 记录警告日志 + 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; + 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.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { // 检查本地是否未修改 + // 无本地更新 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 + // 验证 gtask ID if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { - Log.e(TAG, "gtask id doesn't match"); - return SYNC_ACTION_ERROR; + 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; + // 仅本地修改 + 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(); + } catch (Exception e) { // 捕获异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 } - return SYNC_ACTION_ERROR; + return SYNC_ACTION_ERROR; // 默认返回错误操作 } + // 判断任务是否值得保存 public boolean isWorthSaving() { return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) - || (getNotes() != null && getNotes().trim().length() > 0); + || (getNotes() != null && getNotes().trim().length() > 0); // 检查是否有元信息、名称或备注 } + // 设置任务完成状态 public void setCompleted(boolean completed) { - this.mCompleted = completed; + this.mCompleted = completed; // 赋值完成状态 } + // 设置任务备注 public void setNotes(String notes) { - this.mNotes = notes; + this.mNotes = notes; // 赋值备注 } + // 设置前一个兄弟任务 public void setPriorSibling(Task priorSibling) { - this.mPriorSibling = priorSibling; + this.mPriorSibling = priorSibling; // 赋值前一个兄弟任务 } + // 设置父任务列表 public void setParent(TaskList parent) { - this.mParent = parent; + this.mParent = parent; // 赋值父任务列表 } + // 获取任务完成状态 public boolean getCompleted() { - return this.mCompleted; + return this.mCompleted; // 返回完成状态 } + // 获取任务备注 public String getNotes() { - return this.mNotes; + return this.mNotes; // 返回备注 } + // 获取前一个兄弟任务 public Task getPriorSibling() { - return this.mPriorSibling; + return this.mPriorSibling; // 返回前一个兄弟任务 } + // 获取父任务列表 public TaskList getParent() { - return this.mParent; + return this.mParent; // 返回父任务列表 } } 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..d76b4b7 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/TaskList.java +++ b/Notes-master/src/net/micode/notes/gtask/data/TaskList.java @@ -16,156 +16,169 @@ package net.micode.notes.gtask.data; +// 导入所需的类 import android.database.Cursor; import android.util.Log; - import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.gtask.exception.ActionFailureException; import net.micode.notes.tool.GTaskStringUtils; - import org.json.JSONException; import org.json.JSONObject; - import java.util.ArrayList; - +// TaskList类继承自Node类，表示一个任务列表 public class TaskList extends Node { + // 定义日志标签 private static final String TAG = TaskList.class.getSimpleName(); + // 任务列表的索引 private int mIndex; + // 存储子任务的列表 private ArrayList mChildren; + // TaskList的构造函数，初始化子任务列表和索引 public TaskList() { super(); mChildren = new ArrayList(); - mIndex = 1; + mIndex = 1; // 默认索引为1 } + // 获取创建任务列表的JSON对象 public JSONObject getCreateAction(int actionId) { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建一个新的JSON对象 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"); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 设置名称 + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); // 创建者ID entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, - GTaskStringUtils.GTASK_JSON_TYPE_GROUP); - js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); // 实体类型 + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将实体变化对象放入主对象中 } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); - throw new ActionFailureException("fail to generate tasklist-create jsonobject"); + throw new ActionFailureException("fail to generate tasklist-create jsonobject"); // 抛出异常 } - return js; + return js; // 返回生成的JSON对象 } + // 获取更新任务列表的JSON对象 public JSONObject getUpdateAction(int actionId) { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建一个新的JSON对象 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()); - js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 设置名称 + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); // 设置删除状态 + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将实体变化对象放入主对象中 } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); - throw new ActionFailureException("fail to generate tasklist-update jsonobject"); + throw new ActionFailureException("fail to generate tasklist-update jsonobject"); // 抛出异常 } - return js; + return js; // 返回生成的JSON对象 } + // 根据远程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)); } } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); - throw new ActionFailureException("fail to get tasklist content from jsonobject"); + throw new ActionFailureException("fail to get tasklist content from jsonobject"); // 抛出异常 } } } + // 根据本地JSON设置任务列表的内容 public void setContentByLocalJSON(JSONObject js) { + // 检查JSON对象是否有效 if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { - Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); // 发出警告日志 } 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); + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name); // 设置文件夹名称 } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { + // 检查系统文件夹ID并设置相应名称 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); else - Log.e(TAG, "invalid system folder"); + Log.e(TAG, "invalid system folder"); // 打印错误日志 } else { - Log.e(TAG, "error type"); + Log.e(TAG, "error type"); // 打印错误日志 } } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); } } + // 从内容生成本地JSON对象 public JSONObject getLocalJSONFromContent() { try { - JSONObject js = new JSONObject(); - JSONObject folder = new JSONObject(); + JSONObject js = new JSONObject(); // 创建一个新的JSON对象 + JSONObject folder = new JSONObject(); // 创建文件夹的JSON对象 - String folderName = getName(); + String folderName = getName(); // 获取任务列表名称 if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), - folderName.length()); + folderName.length()); // 去掉前缀 + + // 设置文件夹名称和类型 folder.put(NoteColumns.SNIPPET, folderName); if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT) || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE)) @@ -173,171 +186,183 @@ public class TaskList extends Node { else folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); - js.put(GTaskStringUtils.META_HEAD_NOTE, folder); + js.put(GTaskStringUtils.META_HEAD_NOTE, folder); // 将文件夹对象放入主对象中 - return js; + return js; // 返回生成的JSON对象 } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); - return null; + return null; // 出现异常时返回null } } + // 获取同步操作 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; + // 本地和远程都没有更新 + 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; + 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; } } } catch (Exception e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); } - return SYNC_ACTION_ERROR; + return SYNC_ACTION_ERROR; // 出现异常时返回错误状态 } + // 获取子任务数量 public int getChildTaskCount() { - return mChildren.size(); + return mChildren.size(); // 返回子任务列表大小 } + // 添加子任务 public boolean addChildTask(Task task) { boolean ret = false; if (task != null && !mChildren.contains(task)) { - ret = mChildren.add(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); + task.setParent(this); // 设置父任务 } } - return ret; + return ret; // 返回添加结果 } + // 根据索引添加子任务 public boolean addChildTask(Task task, int index) { if (index < 0 || index > mChildren.size()) { - Log.e(TAG, "add child task: invalid index"); - return false; + Log.e(TAG, "add child task: invalid index"); // 打印错误日志 + return false; // 返回失败 } - int pos = mChildren.indexOf(task); + int pos = mChildren.indexOf(task); // 查找任务在列表中的位置 if (task != null && pos == -1) { - mChildren.add(index, task); + mChildren.add(index, task); // 根据索引添加任务 - // update the task list + // 更新任务列表 Task preTask = null; Task afterTask = null; if (index != 0) - preTask = mChildren.get(index - 1); + preTask = mChildren.get(index - 1); // 获取前一个任务 if (index != mChildren.size() - 1) - afterTask = mChildren.get(index + 1); + afterTask = mChildren.get(index + 1); // 获取后一个任务 - task.setPriorSibling(preTask); + task.setPriorSibling(preTask); // 设置前一个兄弟任务 if (afterTask != null) - afterTask.setPriorSibling(task); + afterTask.setPriorSibling(task); // 设置后一个兄弟任务 } - return true; + return true; // 返回成功 } + // 移除子任务 public boolean removeChildTask(Task task) { boolean ret = false; - int index = mChildren.indexOf(task); + int index = mChildren.indexOf(task); // 查找任务在列表中的位置 if (index != -1) { - ret = mChildren.remove(task); + 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)); + index == 0 ? null : mChildren.get(index - 1)); // 更新前一个兄弟任务 } } } - return ret; + return ret; // 返回移除结果 } + // 移动子任务 public boolean moveChildTask(Task task, int index) { - if (index < 0 || index >= mChildren.size()) { - Log.e(TAG, "move child task: invalid index"); - return false; + Log.e(TAG, "move child task: invalid index"); // 打印错误日志 + return false; // 返回失败 } - int pos = mChildren.indexOf(task); + int pos = mChildren.indexOf(task); // 查找任务在列表中的位置 if (pos == -1) { - Log.e(TAG, "move child task: the task should in the list"); - return false; + Log.e(TAG, "move child task: the task should in the list"); // 打印错误日志 + return false; // 返回失败 } if (pos == index) - return true; - return (removeChildTask(task) && addChildTask(task, index)); + return true; // 位置不变返回成功 + return (removeChildTask(task) && addChildTask(task, index)); // 移除并重新添加任务 } + // 根据GID查找子任务 public Task findChildTaskByGid(String gid) { for (int i = 0; i < mChildren.size(); i++) { Task t = mChildren.get(i); if (t.getGid().equals(gid)) { - return t; + return t; // 找到任务返回 } } - return null; + return null; // 未找到返回null } + // 获取子任务索引 public int getChildTaskIndex(Task task) { - return mChildren.indexOf(task); + return mChildren.indexOf(task); // 返回任务在列表中的位置 } + // 根据索引获取子任务 public Task getChildTaskByIndex(int index) { if (index < 0 || index >= mChildren.size()) { - Log.e(TAG, "getTaskByIndex: invalid index"); - return null; + Log.e(TAG, "getTaskByIndex: invalid index"); // 打印错误日志 + return null; // 返回null } - return mChildren.get(index); + return mChildren.get(index); // 返回任务 } + // 根据GID获取子任务 public Task getChilTaskByGid(String gid) { for (Task task : mChildren) { if (task.getGid().equals(gid)) - return task; + return task; // 找到任务返回 } - return null; + return null; // 未找到返回null } + // 获取子任务列表 public ArrayList getChildTaskList() { - return this.mChildren; + return this.mChildren; // 返回子任务列表 } + // 设置索引 public void setIndex(int index) { - this.mIndex = index; + this.mIndex = index; // 设置任务列表索引 } + // 获取索引 public int getIndex() { - return this.mIndex; + return this.mIndex; // 返回任务列表索引 } }