ReadMiNotes/TaskList.java

package net.micode.notes.gtask.data;
 
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;
    }
 
    /* (non-Javadoc)
     * @see net.micode.notes.gtask.data.Node#getCreateAction(int)
     * 生成并返回一个包含了一定数据的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;
    }
 
    /* (non-Javadoc)
     * @see net.micode.notes.gtask.data.Node#getUpdateAction(int)
     * 生成并返回一个包含了一定数据的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) {
        // 判断js是否为空，或者js中是否有GTaskStringUtils.META_HEAD_NOTE
        if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) {
            Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
        }
 
        try {
            // 获取js中的JSONObject
            JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
 
            // 判断folder的类型是否为folder
            if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
                // 获取folder的name
                String name = folder.getString(NoteColumns.SNIPPET);
                // 设置name
                setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name);
            } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
                // 判断folder的id是否为Notes.ID_ROOT_FOLDER
                if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER)
                    // 设置name
                    setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT);
                // 判断folder的id是否为Notes.ID_CALL_RECORD_FOLDER
                else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER)
                    // 设置name
                    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对象
            JSONObject js = new JSONObject();
            // 创建一个JSONObject对象，用于存放文件夹信息
            JSONObject folder = new JSONObject();
 
            // 获取文件夹名
            String folderName = getName();
            // 如果文件夹名以MIUI_FOLDER_PREFFIX开头，则截取文件夹名
            if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX))
                folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(),
                        folderName.length());
            // 将文件夹名放入JSONObject对象中
            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);
 
            // 将文件夹信息放入JSONObject对象中
            js.put(GTaskStringUtils.META_HEAD_NOTE, folder);
 
            // 返回JSONObject对象
            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;
    }
 
    /**
     * @return
     * 功能：获得TaskList的大小，即mChildren的大小
     */
    public int getChildTaskCount() {
        return mChildren.size();
    }
 
    /**
     * @param task
     * @return 返回值为是否成功添加任务。
     * 功能：在当前任务表末尾添加新的任务。
     */
    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;
    }
 
    /**
     * @param task
     * @param index
     * @return
     * 功能：在当前任务表的指定位置添加新的任务。
     */
    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;
    }
 
    /**
     * @param task
     * @return 返回删除是否成功
     * 功能：删除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;
    }
 
    /**
     * @param task
     * @param index
     * @return
     * 功能：将当前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));
        //利用已实现好的功能完成当下功能；
    }
 
    /**
     * @param gid
     * @return返回寻找结果
     * 功能：按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;
    }
 
    /**
     * @param task
     * @return
     * 功能：返回指定Task的index
     */
    public int getChildTaskIndex(Task task) {
        return mChildren.indexOf(task);
    }
 
    /**
     * @param index
     * @return
     * 功能：返回指定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);
    }
 
    /**
     * @param gid
     * @return
     * 功能：返回指定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;
    }
}