|
|
/*
|
|
|
* 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;
|
|
|
|
|
|
|
|
|
public class Task extends Node {//一个task类（任务），继承自Node类
|
|
|
private static final String TAG = Task.class.getSimpleName();//调用 getSimpleName ()函数来得到类的简写名称并存入字符串TAG中
|
|
|
|
|
|
private boolean mCompleted;//以下四个变量用于Task构造，mCompleted判断是否完成
|
|
|
|
|
|
private String mNotes;//将在实例中存储数据的类型
|
|
|
|
|
|
private JSONObject mMetaInfo;
|
|
|
|
|
|
private Task mPriorSibling;//优先兄弟task的指针
|
|
|
|
|
|
private TaskList mParent;//任务列表的指针
|
|
|
|
|
|
public Task() {//Task类的构造函数，对对象进行初始化
|
|
|
super();
|
|
|
mCompleted = false;
|
|
|
mNotes = null;
|
|
|
mPriorSibling = null;
|
|
|
mParent = null;
|
|
|
mMetaInfo = null;//对类的变量进行初始化
|
|
|
}
|
|
|
|
|
|
public JSONObject getCreateAction(int actionId) {//对操作号即actionId 进行一些操作的公用函数
|
|
|
JSONObject js = new JSONObject();
|
|
|
|
|
|
try {//共享数据存入动作类型
|
|
|
// action_type
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
|
|
|
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
|
|
|
|
|
|
// action_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();//创建实体数据并将name，创建者id，实体类型存入数据
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
|
|
|
GTaskStringUtils.GTASK_JSON_TYPE_TASK);
|
|
|
if (getNotes() != null) {//如果有文本输入
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
|
|
|
}
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
|
|
|
|
|
|
// parent_id
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
|
|
|
|
|
|
// dest_parent_type
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,//所在列表的id存入父id
|
|
|
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
|
|
|
|
|
|
// list_id
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());//存入列表id
|
|
|
|
|
|
// prior_sibling_id
|
|
|
if (mPriorSibling != null) {
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());//那么将其存入优先ID序列中
|
|
|
}
|
|
|
|
|
|
} catch (JSONException e) {//抛出异常处理机制
|
|
|
Log.e(TAG, e.toString());
|
|
|
e.printStackTrace();
|
|
|
throw new ActionFailureException("fail to generate task-create jsonobject");//生成任务创建的数据传输失败
|
|
|
}
|
|
|
|
|
|
return js;//将这个存储字符串的变量返回
|
|
|
}
|
|
|
|
|
|
public JSONObject getUpdateAction(int actionId) {//接收更新action
|
|
|
JSONObject js = new JSONObject();
|
|
|
|
|
|
try {//同样是使用try和catch进行异常处理操作，跟上面的差不多就不再赘述了
|
|
|
// action_type
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
|
|
|
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
|
|
|
|
|
|
// action_id
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
|
|
|
|
|
|
// id
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
|
|
|
|
|
|
// entity_delta
|
|
|
JSONObject entity = new JSONObject();
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
|
|
|
if (getNotes() != null) {//如果存在 notes ，则将其也放入 entity 中
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
|
|
|
}
|
|
|
entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
|
|
|
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
|
|
|
|
|
|
} catch (JSONException e) {//获取异常类型和异常详细消息
|
|
|
Log.e(TAG, e.toString());
|
|
|
e.printStackTrace();
|
|
|
throw new ActionFailureException("fail to generate task-update jsonobject");//生成任务更新的数据传输失败
|
|
|
}
|
|
|
|
|
|
return js;
|
|
|
}
|
|
|
|
|
|
public void setContentByRemoteJSON(JSONObject js) {//通过云端传输的数据设置内容
|
|
|
if (js != null) {
|
|
|
try {//用try和catch进行异常处理操作
|
|
|
// 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)) {//设置notes
|
|
|
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
|
|
|
}
|
|
|
|
|
|
// name
|
|
|
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {//设置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));//异常处理
|
|
|
}
|
|
|
} catch (JSONException e) {
|
|
|
Log.e(TAG, e.toString());
|
|
|
e.printStackTrace();
|
|
|
throw new ActionFailureException("fail to get task content from jsonobject");
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
|
|
|
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 {//否则进行try和catch的异常处理操作
|
|
|
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
|
|
|
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
|
|
|
|
|
|
if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) {//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)) {//遍历 dataArray 查找与数据库中DataConstants.NOTE 记录信息一致的 data
|
|
|
setName(data.getString(DataColumns.CONTENT));
|
|
|
break;
|
|
|
}
|
|
|
}
|
|
|
|
|
|
} catch (JSONException e) {//异常处理操作
|
|
|
Log.e(TAG, e.toString());
|
|
|
e.printStackTrace();
|
|
|
}
|
|
|
}
|
|
|
|
|
|
public JSONObject getLocalJSONFromContent() {//从content获取本地json
|
|
|
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;
|
|
|
}
|
|
|
|
|
|
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);//获取metainfo中的head_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++) {//遍历 dataArray 查找与数据库中DataConstants.NOTE 记录信息一致的 data
|
|
|
JSONObject data = dataArray.getJSONObject(i);
|
|
|
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
|
|
|
data.put(DataColumns.CONTENT, getName());
|
|
|
break;
|
|
|
}
|
|
|
}
|
|
|
|
|
|
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
|
|
|
return mMetaInfo;
|
|
|
}
|
|
|
} catch (JSONException e) {
|
|
|
Log.e(TAG, e.toString());//e.toString()获取异常类型和异常详细消息
|
|
|
e.printStackTrace();
|
|
|
return null;
|
|
|
}
|
|
|
}
|
|
|
|
|
|
public void setMetaInfo(MetaData metaData) {
|
|
|
if (metaData != null && metaData.getNotes() != null) {
|
|
|
try {
|
|
|
mMetaInfo = new JSONObject(metaData.getNotes());//那么进行异常处理，更新数据
|
|
|
} catch (JSONException e) {
|
|
|
Log.w(TAG, e.toString());
|
|
|
mMetaInfo = 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);//便签元数据已被删除，不存在，返回更新云端数据的同步行为
|
|
|
}
|
|
|
|
|
|
if (noteInfo == null) {//云端便签 id 已被删除，不存在，返回更新本地数据的同步行为
|
|
|
Log.w(TAG, "it seems that note meta has been deleted");
|
|
|
return SYNC_ACTION_UPDATE_REMOTE;
|
|
|
}
|
|
|
|
|
|
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
|
|
|
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
|
|
|
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {//判断gtask的id与获取的id是否匹配
|
|
|
Log.e(TAG, "gtask id doesn't match");
|
|
|
return SYNC_ACTION_ERROR;
|
|
|
}
|
|
|
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {//本地id与云端id一致，即更新云端
|
|
|
// local modification only
|
|
|
return SYNC_ACTION_UPDATE_REMOTE;
|
|
|
} else {
|
|
|
return SYNC_ACTION_UPDATE_CONFLICT;
|
|
|
}
|
|
|
}
|
|
|
} catch (Exception e) {
|
|
|
Log.e(TAG, e.toString());
|
|
|
e.printStackTrace();
|
|
|
}
|
|
|
|
|
|
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;
|
|
|
}//设定是note成员变量
|
|
|
|
|
|
public void setPriorSibling(Task priorSibling) {
|
|
|
this.mPriorSibling = priorSibling;
|
|
|
}//设置优先兄弟 task 的优先级
|
|
|
|
|
|
public void setParent(TaskList parent) {
|
|
|
this.mParent = parent;
|
|
|
}//设置这个任务的父节点
|
|
|
|
|
|
public boolean getCompleted() {
|
|
|
return this.mCompleted;
|
|
|
}//获取 task 是否修改完毕的记录
|
|
|
|
|
|
public String getNotes() {
|
|
|
return this.mNotes;
|
|
|
}//获取成员变量 mNotes 的信息
|
|
|
|
|
|
public Task getPriorSibling() {
|
|
|
return this.mPriorSibling;
|
|
|
}//获取优先兄弟 task
|
|
|
|
|
|
public TaskList getParent() {
|
|
|
return this.mParent;
|
|
|
}//获取父节点列表
|
|
|
|
|
|
}
|
