pi9s7qa6c
/
MiNotesPlusDemo
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

提交代码注释

Browse Source
master
qw1ko 3 years ago
parent 11b254df83
commit 0081cb3c01
1 changed files with 67 additions and 37 deletions
Show Stats Download Patch File Download Diff File

104
Notes-master2/src/net/micode/notes/gtask/data/Task.java
Unescape View File

@ -35,62 +35,58 @@ import org.json.JSONObject;
public class Task extends Node {
private static final String TAG = Task.class.getSimpleName();
private boolean mCompleted;
private String mNotes;
private JSONObject mMetaInfo;
private Task mPriorSibling;
private TaskList mParent;
private boolean mCompleted; // 声明一个布尔类型的变量，表示任务是否已完成
private String mNotes; // 声明一个字符串类型的变量，表示任务的备注信息
private JSONObject mMetaInfo; // 声明一个JSONObject类型的变量，表示任务的元信息
private Task mPriorSibling; // 声明一个Task类型的变量，表示当前任务的上一个任务
private TaskList mParent; // 声明一个TaskList类型的变量，表示当前任务所属的任务列表
public Task() {
super();
mCompleted = false;
mNotes = null;
mPriorSibling = null;
mParent = null;
mMetaInfo = null;
super(); // 调用父类的无参构造函数
mCompleted = false; // 初始化mCompleted为false
mNotes = null; // 初始化mNotes为null
mPriorSibling = null; // 初始化mPriorSibling为null
mParent = null; // 初始化mParent为null
mMetaInfo = null; // 初始化mMetaInfo为null
}
public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject();
JSONObject js = new JSONObject(); // 声明并初始化一个JSONObject对象
try {
// action_type
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); // 将指定的键值对放入JSONObject对象中
// action_id
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); // 将指定的键值对放入JSONObject对象中
// index
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this));
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); // 将指定的键值对放入JSONObject对象中
// entity_delta
JSONObject entity = new JSONObject();
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
JSONObject entity = new JSONObject(); // 声明并初始化一个JSONObject对象
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 将指定的键值对放入JSONObject对象中
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); // 将指定的键值对放入JSONObject对象中
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_TASK);
if (getNotes() != null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
GTaskStringUtils.GTASK_JSON_TYPE_TASK); // 将指定的键值对放入JSONObject对象中
if (getNotes() != null) { // 如果任务备注信息不为空
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); // 将指定的键值对放入JSONObject对象中
}
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将指定的键值对放入JSONObject对象中
// parent_id
js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); // 将指定的键值对放入JSONObject对象中
// dest_parent_type
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
GTaskStringUtils.GTASK_JSON_TYPE_GROUP); // 将指定的键值对放入JSONObject对象中
// list_id
js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); // 将指定的键值对放入JSONObject对象中
// prior_sibling_id
if (mPriorSibling != null) {
if (mPriorSibling != null) { // 如果当前任务的上一个任务不为空
js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());
}
@ -102,7 +98,11 @@ public class Task extends Node {
return js;
}
/*方法getUpdateAction(int actionId)返回一个JSONObject对象，其中包含了对该对象进行更新的操作信息。
具体地，该方法首先创建一个空的JSONObject对象js。然后，将更新操作的类型action_type和更新操作的ID action_id分别存储到该对象中。
接着，将该对象的ID、名称、是否删除等属性信息封装成一个JSONObject对象entity，并将其存储到js对象中。
最后，如果有任何JSON异常，则会打印出错信息并抛出ActionFailureException异常。
*/
public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject();
@ -134,7 +134,11 @@ public class Task extends Node {
return js;
}
/*方法setContentByRemoteJSON(JSONObject js)根据传入的JSONObject对象，将该类的对象的属性值进行更新。
具体地，该方法首先检查传入的JSONObject对象是否为null，如果不是，则依次获取JSONObject对象中的id、last_modified、name、
notes、deleted和completed属性，然后将它们分别存储到该类的对象的相应属性中。
如果有任何JSON异常，则会打印出错信息并抛出ActionFailureException异常
*/
public void setContentByRemoteJSON(JSONObject js) {
if (js != null) {
try {
@ -176,20 +180,24 @@ public class Task extends Node {
}
public void setContentByLocalJSON(JSONObject js) {
// 检查传入的 JSON 对象是否合法
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)
|| !js.has(GTaskStringUtils.META_HEAD_DATA)) {
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
}
try {
// 获取元数据中的笔记和数据部分
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
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;
}
// 在数据部分中查找笔记内容
for (int i = 0; i < dataArray.length(); i++) {
JSONObject data = dataArray.getJSONObject(i);
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
@ -208,12 +216,13 @@ public class Task extends Node {
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 +234,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)) {
@ -237,6 +247,7 @@ public class Task extends Node {
}
}
// 设置笔记类型为 Notes.TYPE_NOTE
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
return mMetaInfo;
}
@ -246,7 +257,12 @@ public class Task extends Node {
return null;
}
}
/*这个方法的作用是设置一些元数据信息。
MetaData是一个对象，包含了需要设置的元数据信息。
metaData.getNotes()方法返回一个字符串，表示需要设置的元数据信息。
如果metaData对象不为null并且metaData.getNotes()不为null，则会将这个字符串转换为一个JSONObject对象，并将这个对象赋值给成员变量mMetaInfo。
如果转换失败，则会打印一个警告日志，并将mMetaInfo设置为null
*/
public void setMetaInfo(MetaData metaData) {
if (metaData != null && metaData.getNotes() != null) {
try {
@ -257,7 +273,12 @@ public class Task extends Node {
}
}
}
/*这个方法的作用是获取一个同步操作的类型。
Cursor是一个对象，代表了一个查询结果集。
这个方法返回一个整数，表示需要执行的同步操作类型。
首先，声明一个noteInfo对象，并将其初始化为null。
如果mMetaInfo不为null并且包含了特定键名的键值对，则将noteInfo初始化为mMetaInfo中该键值对的JSONObject对象。
*/
public int getSyncAction(Cursor c) {
try {
JSONObject noteInfo = null;
@ -310,7 +331,16 @@ public class Task extends Node {
return SYNC_ACTION_ERROR;
}
/*isWorthSaving(): 判断Task对象是否值得被保存。如果mMetaInfo不为null，或者name和notes属性都不为空，则返回true，否则返回false。
setCompleted(boolean completed): 设置Task对象的completed属性为传入的参数。
setNotes(String notes): 设置Task对象的notes属性为传入的参数。
setPriorSibling(Task priorSibling): 设置Task对象的priorSibling属性为传入的参数。
setParent(TaskList parent): 设置Task对象的parent属性为传入的参数。
getCompleted(): 获取Task对象的completed属性。
getNotes(): 获取Task对象的notes属性。
getPriorSibling(): 获取Task对象的priorSibling属性。
getParent(): 获取Task对象的parent属性。
*/
public boolean isWorthSaving() {
return mMetaInfo != null || (getName() != null && getName().trim().length() > 0)
|| (getNotes() != null && getNotes().trim().length() > 0);

Write Preview
Loading…
Cancel
Save