phbaois7m
/
xiaomi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update TaskList.java

Browse Source
main
phbaois7m 8 months ago
parent 7200230850
commit 55298f15b9
1 changed files with 80 additions and 53 deletions
Show Stats Download Patch File Download Diff File

133
src/Notes-master/src/net/micode/notes/gtask/data/TaskList.java
Unescape View File

@ -1,19 +1,3 @@
/*
* 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;
@ -29,43 +13,52 @@ import org.json.JSONObject;
import java.util.ArrayList;
// TaskList类继承自Node类，代表任务列表相关的实体，用于管理一组任务，比如添加、删除、移动任务等操作，同时也涉及和JSON数据的交互来处理任务列表的创建、更新等情况
public class TaskList extends Node {
// 用于日志输出的标签，方便在日志中识别是这个类输出的相关信息，值为类的简单名称
private static final String TAG = TaskList.class.getSimpleName();
// 用于表示任务列表的索引，初始化为1（具体含义由业务逻辑确定）
private int mIndex;
// 用于存储该任务列表包含的所有任务的集合，初始化为一个空的ArrayList
private ArrayList<Task> mChildren;
// 任务列表类的默认构造函数，初始化任务列表的各项属性
public TaskList() {
super();
mChildren = new ArrayList<Task>();
mIndex = 1;
}
// 根据给定的actionId创建一个用于表示创建任务列表操作的JSONObject对象
public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// action_type
// 设置action_type字段，表示操作类型为创建任务列表，使用GTaskStringUtils中定义的常量
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
// action_id
// 设置action_id字段，传入给定的actionId
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// index
// 设置index字段，使用任务列表自身的索引mIndex
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex);
// entity_delta
// 创建一个表示任务列表实体信息的JSONObject对象
JSONObject entity = new JSONObject();
// 设置任务列表名称，调用getName方法获取
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
// 设置创建者ID为"null"，具体含义可能根据业务逻辑确定
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
// 设置实体类型为分组类型（任务列表在业务概念上可能属于分组），使用GTaskStringUtils中定义的常量
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
// 将任务列表实体信息对象添加到总的操作对象js中，对应字段为entity_delta
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) {
// 如果出现JSON解析异常，记录错误日志，打印堆栈信息，并抛出一个操作失败异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-create jsonobject");
@ -74,27 +67,32 @@ public class TaskList extends Node {
return js;
}
// 根据给定的actionId创建一个用于表示更新任务列表操作的JSONObject对象
public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// action_type
// 设置action_type字段，表示操作类型为更新任务列表，使用GTaskStringUtils中定义的常量
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
// action_id
// 设置action_id字段，传入给定的actionId
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// id
// 设置id字段，通过调用getGid方法获取任务列表的唯一标识符
js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
// entity_delta
// 创建一个表示任务列表实体信息更新内容的JSONObject对象
JSONObject entity = new JSONObject();
// 设置任务列表名称，调用getName方法获取
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
// 设置任务列表是否已删除的状态，调用getDeleted方法获取（此处未看到其定义，推测是TaskList或其父类的方法）
entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
// 将任务列表实体信息更新对象添加到总的操作对象js中，对应字段为entity_delta
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) {
// 如果出现JSON解析异常，记录错误日志，打印堆栈信息，并抛出一个操作失败异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-update jsonobject");
@ -103,25 +101,27 @@ public class TaskList extends Node {
return js;
}
// 根据远程传来的JSONObject对象设置任务列表的内容信息，比如ID、最后修改时间、名称等
public void setContentByRemoteJSON(JSONObject js) {
if (js != null) {
if (js!= null) {
try {
// id
// 如果JSON对象中包含id字段，则设置任务列表的唯一标识符，通过getString方法获取对应的值
if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
}
// last_modified
// 如果JSON对象中包含last_modified字段，则设置任务列表的最后修改时间，通过getLong方法获取对应的值
if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
}
// name
// 如果JSON对象中包含name字段，则设置任务列表的名称，通过getString方法获取对应的值
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
}
} catch (JSONException e) {
// 如果出现JSON解析异常，记录错误日志，打印堆栈信息，并抛出一个操作失败异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to get tasklist content from jsonobject");
@ -129,18 +129,24 @@ public class TaskList extends Node {
}
}
// 根据本地的JSONObject对象设置任务列表的内容信息，根据不同的文件夹类型等情况来设置任务列表的名称
public void setContentByLocalJSON(JSONObject js) {
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) {
// 如果传入的JSON对象为空，或者不包含关键的元数据头信息（此处是META_HEAD_NOTE），则记录一个警告日志并返回
if (js == null ||!js.has(GTaskStringUtils.META_HEAD_NOTE)) {
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
}
try {
// 获取JSON对象中对应文件夹相关信息的JSONObject对象
JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
// 如果文件夹类型是Notes.TYPE_FOLDER（具体含义由业务逻辑确定）
if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
// 获取文件夹名称，并添加特定前缀（GTaskStringUtils.MIUI_FOLDER_PREFFIX具体含义由业务逻辑确定）后设置为任务列表名称
String name = folder.getString(NoteColumns.SNIPPET);
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)
@ -157,22 +163,27 @@ public class TaskList extends Node {
}
}
// 根据任务列表当前的内容生成对应的本地JSONObject表示，用于存储或传输本地任务列表相关信息
public JSONObject getLocalJSONFromContent() {
try {
JSONObject js = new JSONObject();
JSONObject folder = new JSONObject();
String folderName = getName();
// 如果任务列表名称以特定前缀开头（GTaskStringUtils.MIUI_FOLDER_PREFFIX具体含义由业务逻辑确定），则去除前缀获取实际名称
if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX))
folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(),
folderName.length());
// 设置文件夹名称信息到folder对象中
folder.put(NoteColumns.SNIPPET, folderName);
// 根据文件夹名称判断其类型（是默认文件夹、通话记录文件夹等对应系统文件夹类型，还是普通文件夹类型）并设置到folder对象中
if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT)
|| folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE))
folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
else
folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER);
// 将folder对象添加到总的JSON对象js中，对应字段为META_HEAD_NOTE
js.put(GTaskStringUtils.META_HEAD_NOTE, folder);
return js;
@ -183,28 +194,29 @@ public class TaskList extends Node {
}
}
// 根据传入的Cursor（数据库查询结果游标）确定任务列表的同步操作类型
public int getSyncAction(Cursor c) {
try {
// 如果本地没有更新（本地修改时间为0）
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
// there is no local update
// 如果同步ID和任务列表最后修改时间相等，表示两边都没有更新
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// no update both side
return SYNC_ACTION_NONE;
} else {
// apply remote to local
// 如果同步ID和任务列表最后修改时间不相等，表示需要将远程应用到本地
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;
}
// 如果同步ID和任务列表最后修改时间相等，表示只有本地有修改，需要更新远程
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// local modification only
return SYNC_ACTION_UPDATE_REMOTE;
} else {
// for folder conflicts, just apply local modification
// 对于文件夹冲突情况（此处可能是特定业务逻辑下的处理），直接应用本地修改，返回更新远程的操作类型
return SYNC_ACTION_UPDATE_REMOTE;
}
}
@ -216,73 +228,80 @@ public class TaskList extends Node {
return SYNC_ACTION_ERROR;
}
// 获取任务列表中包含的任务数量，通过返回存储任务的ArrayList的大小来实现
public int getChildTaskCount() {
return mChildren.size();
}
// 向任务列表中添加一个任务，设置任务的前一个兄弟任务和父任务（即当前任务列表）等关联信息
public boolean addChildTask(Task task) {
boolean ret = false;
if (task != null && !mChildren.contains(task)) {
if (task!= null &&!mChildren.contains(task)) {
ret = mChildren.add(task);
if (ret) {
// need to set prior sibling and parent
task.setPriorSibling(mChildren.isEmpty() ? null : mChildren
.get(mChildren.size() - 1));
// 如果添加成功，设置任务的前一个兄弟任务（如果列表为空则为null，否则为列表中最后一个任务），并设置任务的父任务为当前任务列表
task.setPriorSibling(mChildren.isEmpty()? null : mChildren
.get(mChildren.size() - 1));
task.setParent(this);
}
}
return ret;
}
// 在指定索引位置向任务列表中添加一个任务，同时更新任务列表中相关任务的前一个兄弟任务的关联关系
public boolean addChildTask(Task task, int index) {
// 如果索引不合法（小于0或者大于任务列表中任务数量），记录错误日志并返回false
if (index < 0 || index > mChildren.size()) {
Log.e(TAG, "add child task: invalid index");
return false;
}
int pos = mChildren.indexOf(task);
if (task != null && pos == -1) {
if (task!= null && pos == -1) {
mChildren.add(index, task);
// update the task list
// 更新任务列表相关任务的前一个兄弟任务关联关系
Task preTask = null;
Task afterTask = null;
if (index != 0)
if (index!= 0)
preTask = mChildren.get(index - 1);
if (index != mChildren.size() - 1)
if (index!= mChildren.size() - 1)
afterTask = mChildren.get(index + 1);
task.setPriorSibling(preTask);
if (afterTask != null)
if (afterTask!= null)
afterTask.setPriorSibling(task);
}
return true;
}
// 从任务列表中移除指定的任务，同时重置任务的前一个兄弟任务和父任务等关联信息，并更新任务列表中剩余任务的前一个兄弟任务关联关系
public boolean removeChildTask(Task task) {
boolean ret = false;
int index = mChildren.indexOf(task);
if (index != -1) {
if (index!= -1) {
ret = mChildren.remove(task);
if (ret) {
// reset prior sibling and parent
// 如果移除成功，重置任务的前一个兄弟任务和父任务关联信息为null
task.setPriorSibling(null);
task.setParent(null);
// update the task list
if (index != mChildren.size()) {
// 更新任务列表中剩余任务的前一个兄弟任务关联关系
if (index!= mChildren.size()) {
mChildren.get(index).setPriorSibling(
index == 0 ? null : mChildren.get(index - 1));
index == 0? null : mChildren.get(index - 1));
}
}
}
return ret;
}
// 将指定任务移动到任务列表中的指定索引位置，通过先移除再添加任务来实现移动操作
public boolean moveChildTask(Task task, int index) {
// 如果索引不合法（小于0或者大于等于任务列表中任务数量），记录错误日志并返回false
if (index < 0 || index >= mChildren.size()) {
Log.e(TAG, "move child task: invalid index");
return false;
@ -294,11 +313,13 @@ public class TaskList extends Node {
return false;
}
// 如果任务当前位置和目标位置相同，则无需移动，直接返回true
if (pos == index)
return true;
return (removeChildTask(task) && addChildTask(task, index));
}
// 根据任务的唯一标识符（gid）在任务列表中查找对应的任务并返回，如果没找到则返回null
public Task findChildTaskByGid(String gid) {
for (int i = 0; i < mChildren.size(); i++) {
Task t = mChildren.get(i);
@ -309,10 +330,12 @@ public class TaskList extends Node {
return null;
}
// 获取指定任务在任务列表中的索引位置，通过ArrayList的indexOf方法来实现
public int getChildTaskIndex(Task task) {
return mChildren.indexOf(task);
}
// 根据索引获取任务列表中对应的任务，如果索引不合法则记录错误日志并返回null
public Task getChildTaskByIndex(int index) {
if (index < 0 || index >= mChildren.size()) {
Log.e(TAG, "getTaskByIndex: invalid index");
@ -321,7 +344,8 @@ public class TaskList extends Node {
return mChildren.get(index);
}
public Task getChilTaskByGid(String gid) {
// 根据任务的唯一标识符（gid）在任务列表中查找对应的任务并返回，如果没找到则返回null
public Task getChildTaskByGid(String gid) {
for (Task task : mChildren) {
if (task.getGid().equals(gid))
return task;
@ -329,15 +353,18 @@ public class TaskList extends Node {
return null;
}
// 获取任务列表包含的所有任务的列表（即返回存储任务的ArrayList）
public ArrayList<Task> getChildTaskList() {
return this.mChildren;
}
// 设置任务列表的索引值
public void setIndex(int index) {
this.mIndex = index;
}
// 获取任务列表的索引值并返回
public int getIndex() {
return this.mIndex;
}
}
}
Write Preview
Loading…
Cancel
Save