最后一个---gtask---data

TaskList.java

@@ -0,0 +1,347 @@
+/*
+ * 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.util.Log;
+
+import net.micode.notes.data.Notes;
+import net.micode.notes.data.Notes.NoteColumns;
+import net.micode.notes.gtask.exception.ActionFailureException;
+import net.micode.notes.tool.GTaskStringUtils;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.util.ArrayList;
+
+
+public class TaskList extends Node {
+    private static final String TAG = TaskList.class.getSimpleName();//tag标记
+
+    private int mIndex;//当前TaskList的指针
+
+    private ArrayList<Task> mChildren;//类中主要的保存数据的单元，用来实现一个以Task为元素的ArrayList
+
+    public TaskList() {
+        super();
+        mChildren = new ArrayList<Task>();
+        mIndex = 1;
+    }
+/**生成并返回一个包含了一定数据的JSONObject实体 */
+    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
+            js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
+
+            // index
+            js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex);
+
+            // entity_delta
+            JSONObject entity = new JSONObject();//entity实体
+            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_GROUP);
+            js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
+
+        } catch (JSONException e) {
+            Log.e(TAG, e.toString());
+            e.printStackTrace();
+            throw new ActionFailureException("fail to generate tasklist-create jsonobject");
+        }
+
+        return js;
+    }
+/**生成并返回一个包含了一定数据的JSONObject实体 */
+    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
+            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());
+            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 tasklist-update jsonobject");
+        }
+
+        return js;
+    }
+
+    public void setContentByRemoteJSON(JSONObject js) {
+        if (js != null) {
+            try {
+                // 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));
+                }
+
+            } catch (JSONException e) {
+                Log.e(TAG, e.toString());
+                e.printStackTrace();
+                throw new ActionFailureException("fail to get tasklist content from jsonobject");
+            }
+        }
+    }
+
+    public void setContentByLocalJSON(JSONObject js) {
+        if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) {
+            Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
+        }
+
+        try {
+            JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
+
+            if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
+                String name = folder.getString(NoteColumns.SNIPPET);
+                setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name);
+            } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
+                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)
+                    setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX
+                            + GTaskStringUtils.FOLDER_CALL_NOTE);
+                else
+                    Log.e(TAG, "invalid system folder");
+            } else {
+                Log.e(TAG, "error type");
+            }
+        } catch (JSONException e) {
+            Log.e(TAG, e.toString());
+            e.printStackTrace();
+        }
+    }
+
+    public JSONObject getLocalJSONFromContent() {
+        try {
+            JSONObject js = new JSONObject();
+            JSONObject folder = new JSONObject();
+
+            String folderName = getName();
+            if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX))
+                folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(),
+                        folderName.length());
+            folder.put(NoteColumns.SNIPPET, folderName);
+            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);
+
+            js.put(GTaskStringUtils.META_HEAD_NOTE, folder);
+
+            return js;
+        } catch (JSONException e) {
+            Log.e(TAG, e.toString());
+            e.printStackTrace();
+            return null;
+        }
+    }
+
+    public int getSyncAction(Cursor c) {
+        try {
+            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())) {
+                    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 {
+                    // for folder conflicts, just apply local modification
+                    return SYNC_ACTION_UPDATE_REMOTE;
+                }
+            }
+        } catch (Exception e) {
+            Log.e(TAG, e.toString());
+            e.printStackTrace();
+        }
+
+        return SYNC_ACTION_ERROR;
+    }
+/**获得TaskList的大小，即mChildren的大小 */
+    public int getChildTaskCount() {
+        return mChildren.size();
+    }
+/**返回值为是否成功添加任务
+ * 实现功能：在当前任务表末尾添加新的任务
+ */
+    public boolean addChildTask(Task task) {
+        boolean ret = false;
+        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));
+                task.setParent(this);
+                //注意：每一次ArrayList的变化都要紧跟相关Task中的PriorSibling的更改，接下来几个函数都有相关操作
+            }
+        }
+        return ret;
+    }
+/**在当前任务表的指定位置添加新的任务 */
+    public boolean addChildTask(Task task, int index) {
+        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) {
+            mChildren.add(index, task);
+
+            // update the task list
+            Task preTask = null;
+            Task afterTask = null;
+            if (index != 0)
+                preTask = mChildren.get(index - 1);
+            if (index != mChildren.size() - 1)
+                afterTask = mChildren.get(index + 1);
+
+            task.setPriorSibling(preTask);
+            if (afterTask != null)
+                afterTask.setPriorSibling(task);
+        }
+
+        return true;
+    }
+/**返回删除是否成功，删除TaskList中的一个Task */
+    public boolean removeChildTask(Task task) {
+        boolean ret = false;
+        int index = mChildren.indexOf(task);
+        if (index != -1) {
+            ret = mChildren.remove(task);
+
+            if (ret) {
+                // reset prior sibling and parent
+                task.setPriorSibling(null);
+                task.setParent(null);
+
+                // update the task list
+                if (index != mChildren.size()) {
+                    mChildren.get(index).setPriorSibling(
+                            index == 0 ? null : mChildren.get(index - 1));
+                }
+            }
+        }
+        return ret;
+    }
+/**将当前TaskList中含有的某个Task移到index位置 */
+    public boolean moveChildTask(Task task, int index) {
+
+        if (index < 0 || index >= mChildren.size()) {
+            Log.e(TAG, "move child task: invalid index");
+            return false;
+        }
+
+        int pos = mChildren.indexOf(task);
+        if (pos == -1) {
+            Log.e(TAG, "move child task: the task should in the list");
+            return false;
+        }
+
+        if (pos == index)
+            return true;
+        return (removeChildTask(task) && addChildTask(task, index));
+        //利用已实现好的功能完成当下功能
+    }
+/**返回寻找结果，按照gid寻找Task */
+    public Task findChildTaskByGid(String gid) {
+        for (int i = 0; i < mChildren.size(); i++) {
+            Task t = mChildren.get(i);
+            if (t.getGid().equals(gid)) {
+                return t;
+            }
+        }
+        return null;
+    }
+/**返回指定Task的index */
+    public int getChildTaskIndex(Task task) {
+        return mChildren.indexOf(task);
+    }
+/**返回指定index的Task */
+    public Task getChildTaskByIndex(int index) {
+        if (index < 0 || index >= mChildren.size()) {
+            Log.e(TAG, "getTaskByIndex: invalid index");
+            return null;
+        }
+        return mChildren.get(index);
+    }
+/**返回指定gid的Task */
+    public Task getChilTaskByGid(String gid) {
+        for (Task task : mChildren) {//一种常见的ArrayList的遍历方法
+            if (task.getGid().equals(gid))
+                return task;
+        }
+        return null;
+    }
+
+    public ArrayList<Task> getChildTaskList() {
+        return this.mChildren;
+    }
+
+    public void setIndex(int index) {
+        this.mIndex = index;
+    }
+
+    public int getIndex() {
+        return this.mIndex;
+    }
+}