pgxof73jh
/
rkm_gitpracticed
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

添加注释

Browse Source
pull/1/head
luchan 2 months ago
parent 74de7ebaa8
commit f8a52f309c
1 changed files with 138 additions and 29 deletions
Show Stats Download Patch File Download Diff File

167
src/Notes-master/app/src/main/java/net/micode/notes/gtask/data/Task.java
Unescape View File

@ -31,20 +31,31 @@ import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
/**
* Task类表示Google Tasks中的单个任务，继承自Node类，
* 负责处理任务的创建、更新、同步等操作，并维护任务的属性和关系。
*/
public class Task extends Node {
private static final String TAG = Task.class.getSimpleName();
// 任务完成状态
private boolean mCompleted;
// 任务备注信息
private String mNotes;
// 任务元信息，存储本地任务的结构化数据
private JSONObject mMetaInfo;
// 同级前一个任务，用于确定任务在列表中的顺序
private Task mPriorSibling;
// 任务所属的任务列表
private TaskList mParent;
/**
* 构造函数，初始化任务对象的默认值
*/
public Task() {
super();
mCompleted = false;
@ -54,21 +65,28 @@ public class Task extends Node {
mMetaInfo = null;
}
/**
* 生成用于创建任务的JSON对象
*
* @param actionId 操作ID，用于标识此次创建操作
* @return 包含创建任务所需参数的JSON对象
* @throws ActionFailureException 如果生成JSON对象失败
*/
public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// action_type
// 设置操作类型为创建任务
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
// action_id
// 设置操作ID
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// index
// 设置任务在父列表中的索引位置
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this));
// entity_delta
// 构建任务实体信息
JSONObject entity = new JSONObject();
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
@ -79,17 +97,17 @@ public class Task extends Node {
}
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
// parent_id
// 设置父任务列表ID
js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
// dest_parent_type
// 设置目标父类型为任务组
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
// list_id
// 设置任务列表ID
js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
// prior_sibling_id
// 设置同级前一个任务ID（如果存在）
if (mPriorSibling != null) {
js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());
}
@ -103,21 +121,28 @@ public class Task extends Node {
return js;
}
/**
* 生成用于更新任务的JSON对象
*
* @param actionId 操作ID，用于标识此次更新操作
* @return 包含更新任务所需参数的JSON对象
* @throws ActionFailureException 如果生成JSON对象失败
*/
public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// action_type
// 设置操作类型为更新任务
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
// action_id
// 设置操作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());
if (getNotes() != null) {
@ -135,35 +160,41 @@ public class Task extends Node {
return js;
}
/**
* 从远程JSON数据设置任务内容
*
* @param js 包含任务信息的JSON对象
* @throws ActionFailureException 如果解析JSON对象失败
*/
public void setContentByRemoteJSON(JSONObject js) {
if (js != null) {
try {
// id
// 从JSON中提取任务ID
if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
}
// last_modified
// 提取最后修改时间
if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
}
// name
// 提取任务名称
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
}
// notes
// 提取任务备注
if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) {
setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES));
}
// deleted
// 提取删除状态
if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) {
setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED));
}
// completed
// 提取完成状态
if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) {
setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED));
}
@ -175,6 +206,11 @@ public class Task extends Node {
}
}
/**
* 从本地JSON数据设置任务内容
*
* @param js 包含本地任务信息的JSON对象
*/
public void setContentByLocalJSON(JSONObject js) {
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)
|| !js.has(GTaskStringUtils.META_HEAD_DATA)) {
@ -182,14 +218,17 @@ public class Task extends Node {
}
try {
// 提取笔记信息
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
// 验证笔记类型
if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) {
Log.e(TAG, "invalid type");
return;
}
// 提取笔记内容作为任务名称
for (int i = 0; i < dataArray.length(); i++) {
JSONObject data = dataArray.getJSONObject(i);
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
@ -204,16 +243,22 @@ public class Task extends Node {
}
}
/**
* 根据任务内容生成本地JSON对象
*
* @return 包含任务信息的本地JSON对象
*/
public JSONObject getLocalJSONFromContent() {
String name = getName();
try {
if (mMetaInfo == null) {
// new task created from web
// 从网页创建的新任务
if (name == null) {
Log.w(TAG, "the note seems to be an empty one");
return null;
}
// 构建新的本地JSON结构
JSONObject js = new JSONObject();
JSONObject note = new JSONObject();
JSONArray dataArray = new JSONArray();
@ -225,10 +270,11 @@ public class Task extends Node {
js.put(GTaskStringUtils.META_HEAD_NOTE, note);
return js;
} else {
// synced task
// 已同步的任务，更新现有元信息
JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
// 更新任务内容
for (int i = 0; i < dataArray.length(); i++) {
JSONObject data = dataArray.getJSONObject(i);
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
@ -247,6 +293,11 @@ public class Task extends Node {
}
}
/**
* 设置任务的元信息
*
* @param metaData 包含元信息的MetaData对象
*/
public void setMetaInfo(MetaData metaData) {
if (metaData != null && metaData.getNotes() != null) {
try {
@ -258,6 +309,13 @@ public class Task extends Node {
}
}
/**
* 根据本地数据库游标确定同步操作类型
*
* @param c 数据库游标，包含本地任务信息
* @return 同步操作类型（SYNC_ACTION_NONE, SYNC_ACTION_UPDATE_LOCAL,
* SYNC_ACTION_UPDATE_REMOTE, SYNC_ACTION_UPDATE_CONFLICT, SYNC_ACTION_ERROR）
*/
public int getSyncAction(Cursor c) {
try {
JSONObject noteInfo = null;
@ -265,41 +323,46 @@ public class Task extends Node {
noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
}
// 检查元信息是否存在
if (noteInfo == null) {
Log.w(TAG, "it seems that note meta has been deleted");
return SYNC_ACTION_UPDATE_REMOTE;
}
// 检查本地笔记ID是否存在
if (!noteInfo.has(NoteColumns.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;
}
// 检查本地修改状态
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
// there is no local update
// 本地没有修改
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// no update both side
// 双方都没有更新
return SYNC_ACTION_NONE;
} else {
// apply remote to local
// 应用远程更新到本地
return SYNC_ACTION_UPDATE_LOCAL;
}
} else {
// validate gtask id
// 本地有修改
// 验证Google Tasks ID
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
Log.e(TAG, "gtask id doesn't match");
return SYNC_ACTION_ERROR;
}
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// local modification only
// 只有本地修改
return SYNC_ACTION_UPDATE_REMOTE;
} else {
// 双方都有修改，发生冲突
return SYNC_ACTION_UPDATE_CONFLICT;
}
}
@ -311,41 +374,87 @@ public class Task extends Node {
return SYNC_ACTION_ERROR;
}
/**
* 判断任务是否值得保存
*
* @return 如果任务有名称、备注或元信息，则返回true，否则返回false
*/
public boolean isWorthSaving() {
return mMetaInfo != null || (getName() != null && getName().trim().length() > 0)
|| (getNotes() != null && getNotes().trim().length() > 0);
}
// 以下是任务属性的getter和setter方法
/**
* 设置任务完成状态
*
* @param completed 任务是否完成
*/
public void setCompleted(boolean completed) {
this.mCompleted = completed;
}
/**
* 设置任务备注信息
*
* @param notes 任务备注文本
*/
public void setNotes(String notes) {
this.mNotes = notes;
}
/**
* 设置同级前一个任务
*
* @param priorSibling 同级前一个任务对象
*/
public void setPriorSibling(Task priorSibling) {
this.mPriorSibling = priorSibling;
}
/**
* 设置任务所属的任务列表
*
* @param parent 任务列表对象
*/
public void setParent(TaskList parent) {
this.mParent = parent;
}
/**
* 获取任务完成状态
*
* @return 任务是否完成
*/
public boolean getCompleted() {
return this.mCompleted;
}
/**
* 获取任务备注信息
*
* @return 任务备注文本
*/
public String getNotes() {
return this.mNotes;
}
/**
* 获取同级前一个任务
*
* @return 同级前一个任务对象
*/
public Task getPriorSibling() {
return this.mPriorSibling;
}
/**
* 获取任务所属的任务列表
*
* @return 任务列表对象
*/
public TaskList getParent() {
return this.mParent;
}
}
}
Write Preview
Loading…
Cancel
Save