Notes-master/Task.java

/*
 * 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;

// 导入Android SDK中用于数据库操作、文本处理、日志记录的类
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;
// 导入项目中的工具类，用于处理GTask相关的字符串常量
import net.micode.notes.tool.GTaskStringUtils;

// 导入JSON处理相关的类
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

// Task类继承自Node类，表示一个任务
public class Task extends Node {
    // 类的标签，用于日志记录
    private static final String TAG = Task.class.getSimpleName();

    // 任务的完成状态
    private boolean mCompleted;

    // 任务的备注信息
    private String mNotes;

    // 任务的元信息，以JSON对象形式存储
    private JSONObject mMetaInfo;

    // 任务的前一个兄弟任务
    private Task mPriorSibling;

    // 任务所在的任务列表
    private TaskList mParent;

    // 构造函数，初始化任务的属性
    public Task() {
        super();
        mCompleted = false;
        mNotes = null;
        mPriorSibling = null;
        mParent = null;
        mMetaInfo = null;
    }

    // 生成创建任务的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
            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");
            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,
                    GTaskStringUtils.GTASK_JSON_TYPE_GROUP);

            // list_id
            js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());

            // prior_sibling_id
            if (mPriorSibling != null) {
                js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());
            }

        } catch (JSONException e) {
            Log.e(TAG, e.toString());
            e.printStackTrace();
            throw new ActionFailureException("fail to generate task-create jsonobject");
        }

        return js;
    }

    // 生成更新任务的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
            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) {
                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;
    }
   /**
 * 使用远程JSON对象设置任务内容。
 * @param js 远程JSON对象，包含任务的数据。
 */
public void setContentByRemoteJSON(JSONObject js) {
    if (js != null) {
        try {
            // 如果JSON对象中有id字段，则设置任务的全局标识符
            if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
                setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
            }

            // 如果JSON对象中有last_modified字段，则设置任务的最后修改时间
            if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
                setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
            }

            // 如果JSON对象中有name字段，则设置任务的名称
            if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
                setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
            }

            // 如果JSON对象中有notes字段，则设置任务的备注
            if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) {
                setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES));
            }

            // 如果JSON对象中有deleted字段，则设置任务的删除状态
            if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) {
                setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED));
            }

            // 如果JSON对象中有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");
        }
    }
}

/**
 * 使用本地JSON对象设置任务内容。
 * @param js 本地JSON对象，包含任务的数据。
 */
public void setContentByLocalJSON(JSONObject js) {
    if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)
            || !js.has(GTaskStringUtils.META_HEAD_DATA)) {
        Log.w(TAG, "setContentByLocalJSON: nothing is available");
    }

    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)) {
                setName(data.getString(DataColumns.CONTENT));
                break;
            }
        }

    } catch (JSONException e) {
        Log.e(TAG, e.toString());
        e.printStackTrace();
    }
}

/**
 * 从任务内容生成本地JSON对象。
 * @return 本地JSON对象。
 */
public JSONObject getLocalJSONFromContent() {
    String name = getName();
    try {
        if (mMetaInfo == null) {
            // 新任务从网页创建
            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);
            return js;
        } else {
            // 已同步的任务
            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)) {
                    data.put(DataColumns.CONTENT, getName());
                    break;
                }
            }

            note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
            return mMetaInfo;
        }
    } catch (JSONException e) {
        Log.e(TAG, e.toString());
        e.printStackTrace();
        return null;
    }
}

/**
 * 设置任务的元信息。
 * @param metaData 包含元信息的数据对象。
 */
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;
        }
    }
}

/**
 * 根据数据库游标和任务的元信息确定同步操作。
 * @param c 数据库游标。
 * @return 同步操作的类型。
 */
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) {
            Log.w(TAG, "it seems that note meta has been deleted");
            return SYNC_ACTION_UPDATE_REMOTE;
        }

        if (!noteInfo.has(NoteColumns.ID)) {
            Log.w(TAG, "remote note id seems to be deleted");
            return SYNC_ACTION_UPDATE_LOCAL;
        }

        // 验证笔记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) {
            // 没有本地更新
            if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
                // 双方都没有更新
                return SYNC_ACTION_NONE;
            } else {
                // 应用远程更新到本地
                return SYNC_ACTION_UPDATE_LOCAL;
            }
        } else {
            // 验证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()) {
                // 只有本地修改
                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;
}

/**
 * 判断任务是否值得保存。
 * @return 如果任务有元信息、名称或备注，则返回true。
 */
public boolean isWorthSaving() {
    return mMetaInfo != null || (getName() != null && getName().trim().length() > 0)
            || (getNotes() != null && getNotes().trim().length() > 0);
}

/**
 * 设置任务的完成状态。
 * @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;
}
}