|
|
|
|
@ -0,0 +1,496 @@
|
|
|
|
|
/*
|
|
|
|
|
* 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
|
|
|
|
|
*
|
|
|
|
|
* 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;
|
|
|
|
|
|
|
|
|
|
import android.database.Cursor;
|
|
|
|
|
import android.text.TextUtils;
|
|
|
|
|
import android.util.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 org.json.JSONArray;
|
|
|
|
|
import org.json.JSONException;
|
|
|
|
|
import org.json.JSONObject;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Task类继承自Node类，用于表示一个任务相关的对象，可能在任务管理等业务场景中使用，包含了任务的一些属性以及操作方法。
|
|
|
|
|
public class Task extends Node {
|
|
|
|
|
// 定义一个用于日志记录的标签，其值为类的简单名称（不含包名部分），方便在查看日志时能快速识别与该类相关的输出信息。
|
|
|
|
|
private static final String TAG = Task.class.getSimpleName();
|
|
|
|
|
|
|
|
|
|
// 用于标记任务是否已完成的布尔变量，初始值为false，表示任务初始状态是未完成的。
|
|
|
|
|
private boolean mCompleted;
|
|
|
|
|
|
|
|
|
|
// 用于存储任务相关的备注信息（可能是文字描述等内容），初始值为null，后续可以根据实际情况进行赋值。
|
|
|
|
|
private String mNotes;
|
|
|
|
|
|
|
|
|
|
// 用于存储任务的元信息，以JSONObject的形式表示，可能包含一些额外的自定义属性等内容，初始值为null，会按需填充数据。
|
|
|
|
|
private JSONObject mMetaInfo;
|
|
|
|
|
|
|
|
|
|
// 用于指向该任务的前一个兄弟任务（在同一层级的任务列表中，排在当前任务之前的任务对象），初始值为null，若不存在前序兄弟任务则保持为null。
|
|
|
|
|
private Task mPriorSibling;
|
|
|
|
|
|
|
|
|
|
// 用于指向该任务所属的父任务列表（可以理解为包含该任务的集合或者分组），初始值为null，后续会进行相应的赋值关联操作。
|
|
|
|
|
private TaskList mParent;
|
|
|
|
|
|
|
|
|
|
// 无参构造函数，用于创建Task对象时进行默认的初始化操作，调用父类（Node类）的无参构造函数，并对本类的一些成员变量赋初始值。
|
|
|
|
|
public Task() {
|
|
|
|
|
super();
|
|
|
|
|
mCompleted = false;
|
|
|
|
|
mNotes = null;
|
|
|
|
|
mPriorSibling = null;
|
|
|
|
|
mParent = null;
|
|
|
|
|
mMetaInfo = null;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// getCreateAction方法用于生成一个表示创建任务操作的JSONObject对象，该JSON对象包含了创建任务所需的各种相关信息，
|
|
|
|
|
// 例如操作类型、任务的基本属性、在父任务列表中的位置等信息，若在构建JSON过程中出现异常，则抛出ActionFailureException异常。
|
|
|
|
|
public JSONObject getCreateAction(int actionId) {
|
|
|
|
|
// 创建一个新的JSONObject对象，用于组装并最终返回包含创建任务操作相关信息的JSON数据结构。
|
|
|
|
|
JSONObject js = new JSONObject();
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
// 设置JSON对象中的"action_type"字段，表示操作类型，将其值设为GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE，
|
|
|
|
|
// 意味着这个JSON数据代表的是创建任务的操作，方便后续解析该JSON数据的模块能识别操作意图。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
|
|
|
|
|
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
|
|
|
|
|
|
|
|
|
|
// 设置JSON对象中的"action_id"字段，将传入的actionId参数值赋给该字段，actionId可能是用于唯一标识这个创建任务操作的序号等，
|
|
|
|
|
// 在整个任务管理系统中便于区分不同的操作实例。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
|
|
|
|
|
|
|
|
|
|
// 设置JSON对象中的"index"字段，通过调用mParent（所属的父任务列表对象）的getChildTaskIndex方法，传入当前任务对象（this），
|
|
|
|
|
// 获取当前任务在父任务列表中的索引位置，并将其赋给该字段，用于表示任务在所属分组中的顺序等情况。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this));
|
|
|
|
|
|
|
|
|
|
// 创建一个新的JSONObject对象，用于组装任务实体相关的详细信息，后续会将其作为整体放入外层的js对象中，代表要创建的任务主体内容。
|
|
|
|
|
JSONObject entity = new JSONObject();
|
|
|
|
|
|
|
|
|
|
// 设置entity JSON对象中的"name"字段，通过调用getName方法（该方法应该是在父类Node或者本类中定义的用于获取任务名称的方法）获取任务名称，
|
|
|
|
|
// 并将其赋给该字段，这样在创建任务的JSON数据中包含了任务的名称信息，方便识别任务。
|
|
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
|
|
|
|
|
|
|
|
|
|
// 设置entity JSON对象中的"creator_id"字段，暂时将其值设为"null"，可能后续需要根据实际的创建者标识来进行准确赋值，
|
|
|
|
|
// 这里先占位表示创建者信息暂未明确或者还未填充。
|
|
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
|
|
|
|
|
|
|
|
|
|
// 设置entity JSON对象中的"entity_type"字段，将其值设为GTaskStringUtils.GTASK_JSON_TYPE_TASK，
|
|
|
|
|
// 明确表示这个实体是任务类型，便于系统区分不同类型的实体（比如可能还有分组类型等其他实体）。
|
|
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
|
|
|
|
|
GTaskStringUtils.GTASK_JSON_TYPE_TASK);
|
|
|
|
|
|
|
|
|
|
// 判断任务的备注信息（mNotes）是否不为null，如果有备注内容，则将其添加到entity JSON对象的"notes"字段中，
|
|
|
|
|
// 使得创建任务的JSON数据可以包含任务相关的备注描述信息，方便查看任务详情时有更多参考内容。
|
|
|
|
|
if (getNotes()!= null) {
|
|
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 将包含任务实体详细信息的entity对象，以GTaskStringUtils.GTASK_JSON_ENTITY_DELTA为键，添加到外层的js对象中，
|
|
|
|
|
// 这样整个JSON数据结构就完整地包含了创建任务操作以及要创建的任务具体内容等信息。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
|
|
|
|
|
|
|
|
|
|
// 设置JSON对象中的"parent_id"字段，通过调用mParent（所属的父任务列表对象）的getGid方法获取父任务列表的唯一标识符（Gid），
|
|
|
|
|
// 并将其赋给该字段，表示要创建的任务所属的父任务分组，建立任务的层级关系。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
|
|
|
|
|
|
|
|
|
|
// 设置JSON对象中的"dest_parent_type"字段，将其值设为GTaskStringUtils.GTASK_JSON_TYPE_GROUP，
|
|
|
|
|
// 表示目标父级的类型是分组，用于明确创建任务时其所属的父级实体在整个系统中的类型定位。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
|
|
|
|
|
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
|
|
|
|
|
|
|
|
|
|
// 设置JSON对象中的"list_id"字段，同样通过调用mParent（所属的父任务列表对象）的getGid方法获取父任务列表的唯一标识符（Gid），
|
|
|
|
|
// 并将其赋给该字段，可能用于在列表相关操作中进一步标识任务所属的列表情况，与"parent_id"字段作用类似但可能在不同场景下使用。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
|
|
|
|
|
|
|
|
|
|
// 判断前序兄弟任务（mPriorSibling）是否不为null，如果存在前序兄弟任务，则调用其getGid方法获取前序兄弟任务的唯一标识符（Gid），
|
|
|
|
|
// 并将其赋给JSON对象的"prior_sibling_id"字段，用于表示任务在兄弟任务序列中的先后顺序关系，方便在插入任务等操作时确定位置。
|
|
|
|
|
if (mPriorSibling!= null) {
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
} catch (JSONException e) {
|
|
|
|
|
// 如果在构建JSON对象（如往JSONObject中添加元素等操作）过程中出现了JSONException异常，记录错误日志，打印异常堆栈信息，
|
|
|
|
|
// 方便排查问题，同时抛出ActionFailureException异常，表示生成创建任务的JSON对象失败，以便上层调用者能捕获并处理该异常情况。
|
|
|
|
|
Log.e(TAG, e.toString());
|
|
|
|
|
e.printStackTrace();
|
|
|
|
|
throw new ActionFailureException("fail to generate task-create jsonobject");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 如果成功构建了包含创建任务操作相关信息的JSON对象，没有出现异常情况，则返回该js对象，供后续操作（比如发送给服务器等场景）使用。
|
|
|
|
|
return js;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
// getUpdateAction方法用于生成一个表示更新任务操作的JSONObject对象，该JSON对象包含了更新任务所需的各种关键信息，
|
|
|
|
|
// 例如操作类型、任务的唯一标识符以及要更新的任务具体属性等内容，若在构建JSON过程中出现异常，则抛出ActionFailureException异常。
|
|
|
|
|
public JSONObject getUpdateAction(int actionId) {
|
|
|
|
|
// 创建一个新的JSONObject对象，用于组装并最终返回包含更新任务操作相关信息的JSON数据结构。
|
|
|
|
|
JSONObject js = new JSONObject();
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
// 设置JSON对象中的"action_type"字段，表示操作类型，将其值设为GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE，
|
|
|
|
|
// 意味着这个JSON数据代表的是更新任务的操作，方便后续解析该JSON数据的模块能识别操作意图。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
|
|
|
|
|
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
|
|
|
|
|
|
|
|
|
|
// 设置JSON对象中的"action_id"字段，将传入的actionId参数值赋给该字段，actionId可能是用于唯一标识这个更新任务操作的序号等，
|
|
|
|
|
// 在整个任务管理系统中便于区分不同的操作实例。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
|
|
|
|
|
|
|
|
|
|
// 设置JSON对象中的"id"字段，通过调用getGid方法（该方法应该是在当前类或者父类中定义的用于获取任务唯一标识符的方法）获取任务的唯一标识符（Gid），
|
|
|
|
|
// 并将其赋给该字段，用于明确要更新的是哪个具体任务，建立与具体任务实体的关联。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
|
|
|
|
|
|
|
|
|
|
// 创建一个新的JSONObject对象，用于组装任务实体相关的详细信息，这些信息就是此次更新操作中涉及要改变的任务属性内容，
|
|
|
|
|
// 后续会将其作为整体放入外层的js对象中，代表更新任务时具体的变更内容。
|
|
|
|
|
JSONObject entity = new JSONObject();
|
|
|
|
|
|
|
|
|
|
// 设置entity JSON对象中的"name"字段，通过调用getName方法（用于获取任务名称的方法）获取任务名称，
|
|
|
|
|
// 并将其赋给该字段，这样在更新任务的JSON数据中包含了可能要更新的任务名称信息，方便根据实际需求修改任务的显示名称等情况。
|
|
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
|
|
|
|
|
|
|
|
|
|
// 判断任务的备注信息（getNotes方法获取）是否不为null，如果有备注内容，则将其添加到entity JSON对象的"notes"字段中，
|
|
|
|
|
// 意味着更新任务操作可以包含对任务备注信息的修改，使得任务的相关描述内容能按需更新。
|
|
|
|
|
if (getNotes()!= null) {
|
|
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 设置entity JSON对象中的"deleted"字段，通过调用getDeleted方法（用于获取任务是否已删除状态的方法）获取任务的删除状态，
|
|
|
|
|
// 并将其赋给该字段，表明更新任务操作也可以涉及任务删除状态的变更，比如将未删除的任务标记为已删除等情况。
|
|
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
|
|
|
|
|
|
|
|
|
|
// 将包含任务实体详细信息（要更新的具体属性内容）的entity对象，以GTaskStringUtils.GTASK_JSON_ENTITY_DELTA为键，添加到外层的js对象中，
|
|
|
|
|
// 这样整个JSON数据结构就完整地包含了更新任务操作以及具体要更新的任务内容等信息。
|
|
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
|
|
|
|
|
|
|
|
|
|
} catch (JSONException e) {
|
|
|
|
|
// 如果在构建JSON对象（如往JSONObject中添加元素等操作）过程中出现了JSONException异常，记录错误日志，打印异常堆栈信息，
|
|
|
|
|
// 方便排查问题，同时抛出ActionFailureException异常，表示生成更新任务的JSON对象失败，以便上层调用者能捕获并处理该异常情况。
|
|
|
|
|
Log.e(TAG, e.toString());
|
|
|
|
|
e.printStackTrace();
|
|
|
|
|
throw new ActionFailureException("fail to generate task-update jsonobject");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 如果成功构建了包含更新任务操作相关信息的JSON对象，没有出现异常情况，则返回该js对象，供后续操作（比如发送给服务器等场景）使用。
|
|
|
|
|
return js;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// setContentByRemoteJSON方法用于根据传入的JSONObject对象（通常是从远程获取的包含任务相关信息的JSON数据）来设置当前Task对象的各项属性值，
|
|
|
|
|
// 若传入的JSON对象为null或者在解析JSON过程中出现异常，则抛出ActionFailureException异常。
|
|
|
|
|
public void setContentByRemoteJSON(JSONObject js) {
|
|
|
|
|
if (js!= null) {
|
|
|
|
|
try {
|
|
|
|
|
// 判断传入的JSON对象（js）中是否包含"id"字段，如果包含，则调用setGid方法（用于设置任务唯一标识符的方法），
|
|
|
|
|
// 并将该字段对应的字符串值（通过getString方法获取）传递进去，实现根据远程JSON数据更新当前任务对象的唯一标识符属性。
|
|
|
|
|
if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
|
|
|
|
|
setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 判断传入的JSON对象（js）中是否包含"last_modified"字段，如果包含，则调用setLastModified方法（用于设置任务最后修改时间的方法），
|
|
|
|
|
// 并将该字段对应的长整型值（通过getLong方法获取）传递进去，实现根据远程JSON数据更新当前任务对象的最后修改时间属性，用于记录任务最新的修改情况。
|
|
|
|
|
if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
|
|
|
|
|
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 判断传入的JSON对象（js）中是否包含"name"字段，如果包含，则调用setName方法（用于设置任务名称的方法），
|
|
|
|
|
// 并将该字段对应的字符串值（通过getString方法获取）传递进去，实现根据远程JSON数据更新当前任务对象的任务名称属性，以便任务显示正确的名称。
|
|
|
|
|
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
|
|
|
|
|
setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 判断传入的JSON对象（js）中是否包含"notes"字段，如果包含，则调用setNotes方法（用于设置任务备注信息的方法），
|
|
|
|
|
// 并将该字段对应的字符串值（通过getString方法获取）传递进去，实现根据远程JSON数据更新当前任务对象的备注信息属性，使备注内容与远程数据保持一致。
|
|
|
|
|
if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) {
|
|
|
|
|
setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 判断传入的JSON对象（js）中是否包含"deleted"字段，如果包含，则调用setDeleted方法（用于设置任务是否已删除状态的方法），
|
|
|
|
|
// 并将该字段对应的布尔值（通过getBoolean方法获取）传递进去，实现根据远程JSON数据更新当前任务对象的删除状态属性，比如标记任务是否已被删除。
|
|
|
|
|
if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) {
|
|
|
|
|
setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 判断传入的JSON对象（js）中是否包含"completed"字段，如果包含，则调用setCompleted方法（用于设置任务是否已完成状态的方法），
|
|
|
|
|
// 并将该字段对应的布尔值（通过getBoolean方法获取）传递进去，实现根据远程JSON数据更新当前任务对象的完成状态属性，准确反映任务的完成情况。
|
|
|
|
|
if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) {
|
|
|
|
|
setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED));
|
|
|
|
|
}
|
|
|
|
|
} catch (JSONException e) {
|
|
|
|
|
// 如果在解析JSON对象（如获取对应字段的值等操作）过程中出现了JSONException异常，记录错误日志，打印异常堆栈信息，
|
|
|
|
|
// 方便排查问题，同时抛出ActionFailureException异常，表示从JSON对象中获取任务内容并设置到当前对象失败，以便上层调用者能捕获并处理该异常情况。
|
|
|
|
|
Log.e(TAG, e.toString());
|
|
|
|
|
e.printStackTrace();
|
|
|
|
|
throw new ActionFailureException("fail to get task content from jsonobject");
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// setContentByLocalJSON方法用于根据本地的JSONObject对象来设置当前Task对象的相关内容，
|
|
|
|
|
// 如果传入的JSON对象不符合要求（为null或者缺少关键的节点信息），则记录警告日志；若解析JSON出现异常也会记录错误日志。
|
|
|
|
|
public void setContentByLocalJSON(JSONObject js) {
|
|
|
|
|
// 判断传入的JSON对象是否为null，或者是否不包含名为GTaskStringUtils.META_HEAD_NOTE的节点，
|
|
|
|
|
// 又或者是否不包含名为GTaskStringUtils.META_HEAD_DATA的节点，如果满足这些情况之一，则表示该JSON对象不符合处理要求。
|
|
|
|
|
if (js == null ||!js.has(GTaskStringUtils.META_HEAD_NOTE)
|
|
|
|
|
||!js.has(GTaskStringUtils.META_HEAD_DATA)) {
|
|
|
|
|
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
// 从传入的JSON对象中获取名为GTaskStringUtils.META_HEAD_NOTE的子JSON对象，该对象预期包含了笔记主体相关的属性信息，比如类型等关键内容。
|
|
|
|
|
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
|
|
|
|
|
// 从传入的JSON对象中获取名为GTaskStringUtils.META_HEAD_DATA的JSON数组，该数组预期包含了与该任务相关的多条具体数据内容。
|
|
|
|
|
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
|
|
|
|
|
|
|
|
|
|
// 判断笔记类型是否不等于普通笔记类型（Notes.TYPE_NOTE），如果不是普通笔记类型，则记录错误日志表示类型无效，然后直接返回，不进行后续操作。
|
|
|
|
|
if (note.getInt(NoteColumns.TYPE)!= Notes.TYPE_NOTE) {
|
|
|
|
|
Log.e(TAG, "invalid type");
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 遍历GTaskStringUtils.META_HEAD_DATA数组中的每一个JSON对象（即遍历与该任务相关的每一条具体数据内容）。
|
|
|
|
|
for (int i = 0; i < dataArray.length(); i++) {
|
|
|
|
|
JSONObject data = dataArray.getJSONObject(i);
|
|
|
|
|
// 判断当前具体数据对象（data）中的DataColumns.MIME_TYPE字段对应的字符串值是否等于DataConstants.NOTE，
|
|
|
|
|
// 如果相等，表示找到了与任务名称相关的数据内容（这里根据特定的类型标识来判断是否是任务名称相关的数据）。
|
|
|
|
|
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
|
|
|
|
|
// 调用setName方法（用于设置任务名称的方法），将该数据对象中DataColumns.CONTENT字段对应的字符串值作为任务名称传递进去，实现根据本地JSON数据更新任务名称，
|
|
|
|
|
// 找到符合要求的数据后就通过break跳出循环，因为只需要找到任务名称对应的那部分数据进行处理即可。
|
|
|
|
|
setName(data.getString(DataColumns.CONTENT));
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
} catch (JSONException e) {
|
|
|
|
|
// 如果在解析JSON对象（如获取子对象、获取数组元素、获取字段值等操作）过程中出现了JSONException异常，记录错误日志，打印异常堆栈信息，方便排查问题。
|
|
|
|
|
Log.e(TAG, e.toString());
|
|
|
|
|
e.printStackTrace();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// getLocalJSONFromContent方法用于根据当前Task对象的内容生成对应的本地JSONObject表示形式，
|
|
|
|
|
// 如果在构建JSON过程中出现异常，则记录错误日志并返回null；会根据不同情况（新创建任务或已同步任务）进行不同的JSON组装逻辑。
|
|
|
|
|
public JSONObject getLocalJSONFromContent() {
|
|
|
|
|
// 获取当前任务对象的名称，后续会根据名称以及其他相关属性来组装JSON数据。
|
|
|
|
|
String name = getName();
|
|
|
|
|
try {
|
|
|
|
|
// 判断当前任务对象的元信息（mMetaInfo，以JSONObject形式存储，可能包含了更丰富的任务相关信息）是否为null。
|
|
|
|
|
if (mMetaInfo == null) {
|
|
|
|
|
// 如果mMetaInfo为null，表示这可能是一个从网页端新创建的任务（根据注释推测的情况）。
|
|
|
|
|
// 进一步判断任务名称是否为null，如果名称也为null，则记录警告日志表示这个笔记似乎是空的，然后直接返回null，因为没有足够信息构建JSON。
|
|
|
|
|
if (name == null) {
|
|
|
|
|
Log.w(TAG, "the note seems to be an empty one");
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 创建一个新的JSONObject对象，用于组装并最终返回包含任务相关信息的本地JSON数据结构。
|
|
|
|
|
JSONObject js = new JSONObject();
|
|
|
|
|
// 创建一个新的JSONObject对象，用于存放笔记主体相关的属性信息，后续会往里面添加相应字段数据。
|
|
|
|
|
JSONObject note = new JSONObject();
|
|
|
|
|
// 创建一个新的JSONArray对象，用于存放与该任务相关的具体数据内容对应的JSON对象，这些具体数据可能是任务正文等详细信息。
|
|
|
|
|
JSONArray dataArray = new JSONArray();
|
|
|
|
|
// 创建一个新的JSONObject对象，用于表示一条具体的数据内容，这里先准备组装任务名称相关的数据。
|
|
|
|
|
JSONObject data = new JSONObject();
|
|
|
|
|
|
|
|
|
|
// 将任务名称（name）添加到data对象的DataColumns.CONTENT字段中，这样就在数据对象中记录了任务名称相关信息。
|
|
|
|
|
data.put(DataColumns.CONTENT, name);
|
|
|
|
|
// 将包含任务名称数据的data对象添加到dataArray数组中，使得dataArray包含了任务相关的具体数据内容（目前只有名称相关的这一条数据）。
|
|
|
|
|
dataArray.put(data);
|
|
|
|
|
|
|
|
|
|
// 将包含具体数据内容的dataArray数组，以GTaskStringUtils.META_HEAD_DATA为键，添加到外层的js对象中，完善整个任务的JSON数据结构的一部分。
|
|
|
|
|
js.put(GTaskStringUtils.META_HEAD_DATA, dataArray);
|
|
|
|
|
|
|
|
|
|
// 将笔记类型字段（NoteColumns.TYPE）的值设为普通笔记类型（Notes.TYPE_NOTE），并添加到note对象中，明确任务的类型属性。
|
|
|
|
|
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
|
|
|
|
|
|
|
|
|
|
// 将包含笔记主体属性信息的note对象，以GTaskStringUtils.META_HEAD_NOTE为键，添加到外层的js对象中，形成完整的符合要求的本地JSON数据结构，代表新创建任务的情况。
|
|
|
|
|
js.put(GTaskStringUtils.META_HEAD_NOTE, note);
|
|
|
|
|
|
|
|
|
|
// 返回组装好的js对象，即包含了新创建任务相关信息的本地JSON表示形式。
|
|
|
|
|
return js;
|
|
|
|
|
} else {
|
|
|
|
|
// 如果mMetaInfo不为null，表示这是一个已同步过的任务，已有完整的元信息，基于这些元信息来生成要返回的本地JSON数据。
|
|
|
|
|
|
|
|
|
|
// 从mMetaInfo中获取名为GTaskStringUtils.META_HEAD_NOTE的子JSON对象，该对象包含了笔记主体相关属性信息。
|
|
|
|
|
JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
|
|
|
|
|
// 从mMetaInfo中获取名为GTaskStringUtils.META_HEAD_DATA的JSON数组，该数组包含了与任务相关的多条具体数据内容。
|
|
|
|
|
JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
|
|
|
|
|
|
|
|
|
|
// 遍历GTaskStringUtils.META_HEAD_DATA数组中的每一个JSON对象（即遍历与该任务相关的每一条具体数据内容），查找与任务名称相关的数据部分。
|
|
|
|
|
for (int i = 0; i < dataArray.length(); i++) {
|
|
|
|
|
JSONObject data = dataArray.getJSONObject(i);
|
|
|
|
|
// 判断当前具体数据对象（data）中的DataColumns.MIME_TYPE字段对应的字符串值是否等于DataConstants.NOTE，
|
|
|
|
|
// 如果相等，表示找到了与任务名称相关的数据内容（这里根据特定的类型标识来判断是否是任务名称相关的数据）。
|
|
|
|
|
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
|
|
|
|
|
// 将任务名称（通过getName方法获取当前任务对象的名称）更新到该数据对象的DataColumns.CONTENT字段中，实现将最新的任务名称同步到JSON数据里，
|
|
|
|
|
// 找到符合要求的数据后就通过break跳出循环，因为只需要更新任务名称对应的那部分数据即可。
|
|
|
|
|
data.put(DataColumns.CONTENT, getName());
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 将笔记类型字段（NoteColumns.TYPE）的值设为普通笔记类型（Notes.TYPE_NOTE），并更新到note对象中，再次明确任务的类型属性，确保JSON数据中类型正确。
|
|
|
|
|
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
|
|
|
|
|
|
|
|
|
|
// 返回mMetaInfo对象，此时mMetaInfo已经更新了任务名称相关数据以及明确了任务类型，它代表了已同步任务的本地JSON数据结构，可供外部使用。
|
|
|
|
|
return mMetaInfo;
|
|
|
|
|
}
|
|
|
|
|
} catch (JSONException e) {
|
|
|
|
|
// 如果在构建JSON对象（如往JSONObject或JSONArray中添加元素等操作）过程中出现了JSONException异常，记录错误日志，打印异常堆栈信息，方便排查问题。
|
|
|
|
|
Log.e(TAG, e.toString());
|
|
|
|
|
e.printStackTrace();
|
|
|
|
|
// 如果出现异常情况，最终返回null，表示无法成功获取任务对应的本地JSON内容表示形式。
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// setMetaInfo方法用于设置当前Task对象的元信息（mMetaInfo），它会尝试将传入的MetaData对象中的笔记信息（以字符串形式）转换为JSONObject格式并赋值给mMetaInfo，
|
|
|
|
|
// 如果在转换过程中出现JSONException异常，则记录警告日志，并将mMetaInfo设为null，表示设置元信息失败。
|
|
|
|
|
public void setMetaInfo(MetaData metaData) {
|
|
|
|
|
// 首先判断传入的metaData对象不为null，并且其getNotes方法返回的笔记信息也不为null，才进行后续操作，
|
|
|
|
|
// 即只有当有有效元数据且其中的笔记信息存在时才尝试处理。
|
|
|
|
|
if (metaData!= null && metaData.getNotes()!= null) {
|
|
|
|
|
try {
|
|
|
|
|
// 使用传入的MetaData对象中获取到的笔记信息字符串创建一个新的JSONObject对象，
|
|
|
|
|
// 这一步是将字符串形式的笔记信息转换为便于操作的JSON对象格式，方便后续根据JSON结构获取具体的属性等内容，然后将其赋值给mMetaInfo，完成元信息的设置。
|
|
|
|
|
mMetaInfo = new JSONObject(metaData.getNotes());
|
|
|
|
|
} catch (JSONException e) {
|
|
|
|
|
// 如果在创建JSONObject对象的过程中（也就是解析字符串为JSON格式时）出现了JSONException异常，记录警告日志（因为这只是一个可能不影响整体流程继续的错误情况），
|
|
|
|
|
// 并将mMetaInfo设为null，表示此次设置元信息操作失败，后续使用mMetaInfo时需要考虑其为null的情况。
|
|
|
|
|
Log.w(TAG, e.toString());
|
|
|
|
|
mMetaInfo = null;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// getSyncAction方法用于根据传入的Cursor对象（通常用于从数据库查询结果中获取数据）以及当前Task对象的相关状态，
|
|
|
|
|
// 来确定在数据同步操作中应该执行的具体动作，返回对应的同步动作标识（SYNC_ACTION_* 系列常量之一），若出现异常则返回SYNC_ACTION_ERROR。
|
|
|
|
|
public int getSyncAction(Cursor c) {
|
|
|
|
|
try {
|
|
|
|
|
JSONObject noteInfo = null;
|
|
|
|
|
// 判断当前Task对象的元信息（mMetaInfo）不为null，并且其中包含名为GTaskStringUtils.META_HEAD_NOTE的节点，
|
|
|
|
|
// 如果满足条件，则尝试获取该节点对应的JSONObject对象，这个对象预期包含了笔记主体相关的关键属性信息，后续用于各种判断和比较。
|
|
|
|
|
if (mMetaInfo!= null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) {
|
|
|
|
|
noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 如果noteInfo为null，意味着可能笔记的元信息已经被删除了（根据逻辑推测），记录警告日志，并返回SYNC_ACTION_UPDATE_REMOTE，
|
|
|
|
|
// 表示在同步操作中需要将远程数据更新到本地，可能本地的相关数据已经不完整或缺失了。
|
|
|
|
|
if (noteInfo == null) {
|
|
|
|
|
Log.w(TAG, "it seems that note meta has been deleted");
|
|
|
|
|
return SYNC_ACTION_UPDATE_REMOTE;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 判断noteInfo中是否不包含名为NoteColumns.ID的字段，如果不包含，说明远程笔记的ID似乎被删除了（根据逻辑推测），
|
|
|
|
|
// 记录警告日志，并返回SYNC_ACTION_UPDATE_LOCAL，表示在同步操作中需要用本地数据去更新远程数据，可能远程数据出现了关键信息缺失的情况。
|
|
|
|
|
if (!noteInfo.has(NoteColumns.ID)) {
|
|
|
|
|
Log.w(TAG, "remote note id seems to be deleted");
|
|
|
|
|
return SYNC_ACTION_UPDATE_LOCAL;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 验证笔记的ID是否匹配，通过比较从Cursor对象（数据库查询结果）中获取的笔记ID（通过SqlNote.ID_COLUMN指定的列获取长整型ID值），
|
|
|
|
|
// 和从noteInfo中获取的笔记ID（通过NoteColumns.ID字段获取长整型ID值）是否相等，如果不相等，记录警告日志，
|
|
|
|
|
// 并返回SYNC_ACTION_UPDATE_LOCAL，表示需要以本地数据为准进行更新，可能存在两边数据不一致的情况。
|
|
|
|
|
if (c.getLong(SqlNote.ID_COLUMN)!= noteInfo.getLong(NoteColumns.ID)) {
|
|
|
|
|
Log.w(TAG, "note id doesn't match");
|
|
|
|
|
return SYNC_ACTION_UPDATE_LOCAL;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 判断本地是否没有更新，通过检查Cursor对象中代表本地修改状态的列（SqlNote.LOCAL_MODIFIED_COLUMN指定的列）的值是否为0来确定，
|
|
|
|
|
// 如果为0，表示本地没有进行过更新操作。
|
|
|
|
|
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
|
|
|
|
|
// 进一步判断远程和本地是否都没有更新，通过比较Cursor对象中代表同步ID的列（SqlNote.SYNC_ID_COLUMN指定的列）的值，
|
|
|
|
|
// 和当前Task对象的最后修改时间（通过getLastModified方法获取）是否相等来确定，如果相等，说明两边数据都没有更新，
|
|
|
|
|
// 则返回SYNC_ACTION_NONE，表示不需要进行任何同步操作，两边数据是一致的。
|
|
|
|
|
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
|
|
|
|
|
return SYNC_ACTION_NONE;
|
|
|
|
|
} else {
|
|
|
|
|
// 如果同步ID不相等，说明远程有更新，需要将远程数据应用到本地，返回SYNC_ACTION_UPDATE_LOCAL，表示以远程数据更新本地数据。
|
|
|
|
|
return SYNC_ACTION_UPDATE_LOCAL;
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
// 如果本地有更新（即本地修改状态列的值不为0），则需要进一步验证任务的Gtask ID是否匹配，
|
|
|
|
|
// 通过比较Cursor对象中代表Gtask ID的列（SqlNote.GTASK_ID_COLUMN指定的列）获取的字符串值，
|
|
|
|
|
// 和当前Task对象通过getGid方法获取的Gtask ID是否相等来确定，如果不相等，记录错误日志（因为这可能是比较严重的不一致情况），
|
|
|
|
|
// 并返回SYNC_ACTION_ERROR，表示出现了同步错误，两边的关键标识不一致了。
|
|
|
|
|
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
|
|
|
|
|
Log.e(TAG, "gtask id doesn't match");
|
|
|
|
|
return SYNC_ACTION_ERROR;
|
|
|
|
|
}
|
|
|
|
|
// 再次判断远程和本地的更新情况，通过比较Cursor对象中代表同步ID的列（SqlNote.SYNC_ID_COLUMN指定的列）的值，
|
|
|
|
|
// 和当前Task对象的最后修改时间（通过getLastModified方法获取）是否相等来确定，如果相等，说明只有本地进行了修改，
|
|
|
|
|
// 则返回SYNC_ACTION_UPDATE_REMOTE，表示需要将本地的修改同步到远程，让远程数据也更新为本地修改后的状态。
|
|
|
|
|
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
|
|
|
|
|
return SYNC_ACTION_UPDATE_REMOTE;
|
|
|
|
|
} else {
|
|
|
|
|
// 如果同步ID不相等，说明远程和本地都有不同的修改，出现了数据冲突情况，返回SYNC_ACTION_UPDATE_CONFLICT，表示需要处理同步冲突，
|
|
|
|
|
// 例如可能需要人工介入或者按照特定的冲突解决策略来决定以哪边数据为准等操作。
|
|
|
|
|
return SYNC_ACTION_UPDATE_CONFLICT;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
} catch (Exception e) {
|
|
|
|
|
// 如果在整个方法执行过程中出现了任何异常（捕获了Exception类型，涵盖了各种可能的运行时异常等情况），记录错误日志，打印异常堆栈信息，方便排查问题，
|
|
|
|
|
// 并返回SYNC_ACTION_ERROR，表示出现了同步相关的错误情况，无法准确判断同步动作。
|
|
|
|
|
Log.e(TAG, e.toString());
|
|
|
|
|
e.printStackTrace();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 如果前面执行过程中出现了未处理的情况或者最终正常流程执行完毕但没有返回合适的同步动作标识，默认返回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);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setCompleted(boolean completed) {
|
|
|
|
|
this.mCompleted = completed;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setNotes(String notes) {
|
|
|
|
|
this.mNotes = notes;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setPriorSibling(Task priorSibling) {
|
|
|
|
|
this.mPriorSibling = priorSibling;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setParent(TaskList parent) {
|
|
|
|
|
this.mParent = parent;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public boolean getCompleted() {
|
|
|
|
|
return this.mCompleted;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public String getNotes() {
|
|
|
|
|
return this.mNotes;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public Task getPriorSibling() {
|
|
|
|
|
return this.mPriorSibling;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public TaskList getParent() {
|
|
|
|
|
return this.mParent;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
