/*
 * 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 org.json.JSONObject;

/**
 * Node类是一个抽象类，用于表示任务节点。
 * 该类定义了任务节点的基本属性和操作，包括同步动作的常量、任务节点的GID、名称、最后修改时间、删除状态等。
 * 具体的任务节点需要继承该类并实现抽象方法。
 */
public abstract class Node {
    // 同步动作的常量
    public static final int SYNC_ACTION_NONE = 0;
    public static final int SYNC_ACTION_ADD_REMOTE = 1;
    public static final int SYNC_ACTION_ADD_LOCAL = 2;
    public static final int SYNC_ACTION_DEL_REMOTE = 3;
    public static final int SYNC_ACTION_DEL_LOCAL = 4;
    public static final int SYNC_ACTION_UPDATE_REMOTE = 5;
    public static final int SYNC_ACTION_UPDATE_LOCAL = 6;
    public static final int SYNC_ACTION_UPDATE_CONFLICT = 7;
    public static final int SYNC_ACTION_ERROR = 8;

    // 任务节点的GID
    private String mGid;

    // 任务节点的名称
    private String mName;

    // 任务节点的最后修改时间
    private long mLastModified;

    // 任务节点的删除状态
    private boolean mDeleted;

    /**
     * Node类的构造函数，初始化任务节点的属性
     */
    public Node() {
        mGid = null;
        mName = "";
        mLastModified = 0;
        mDeleted = false;
    }

    /**
     * 获取创建操作的JSON对象
     * @param actionId 操作ID
     * @return 创建操作的JSON对象
     */
    public abstract JSONObject getCreateAction(int actionId);

    /**
     * 获取更新操作的JSON对象
     * @param actionId 操作ID
     * @return 更新操作的JSON对象
     */
    public abstract JSONObject getUpdateAction(int actionId);

    /**
     * 通过远程JSON对象设置任务节点的内容
     * @param js 远程JSON对象
     */
    public abstract void setContentByRemoteJSON(JSONObject js);

    /**
     * 通过本地JSON对象设置任务节点的内容
     * @param js 本地JSON对象
     */
    public abstract void setContentByLocalJSON(JSONObject js);

    /**
     * 从任务节点的内容中获取本地JSON对象
     * @return 本地JSON对象
     */
    public abstract JSONObject getLocalJSONFromContent();

    /**
     * 获取同步动作
     * @param c 游标对象
     * @return 同步动作
     */
    public abstract int getSyncAction(Cursor c);

    /**
     * 设置任务节点的GID
     * @param gid 任务节点的GID
     */
    public void setGid(String gid) {
        this.mGid = gid;
    }

    /**
     * 设置任务节点的名称
     * @param name 任务节点的名称
     */
    public void setName(String name) {
        this.mName = name;
    }

    /**
     * 设置任务节点的最后修改时间
     * @param lastModified 任务节点的最后修改时间
     */
    public void setLastModified(long lastModified) {
        this.mLastModified = lastModified;
    }

    /**
     * 设置任务节点的删除状态
     * @param deleted 任务节点的删除状态
     */
    public void setDeleted(boolean deleted) {
        this.mDeleted = deleted;
    }

    /**
     * 获取任务节点的GID
     * @return 任务节点的GID
     */
    public String getGid() {
        return this.mGid;
    }

    /**
     * 获取任务节点的名称
     * @return 任务节点的名称
     */
    public String getName() {
        return this.mName;
    }

    /**
     * 获取任务节点的最后修改时间
     * @return 任务节点的最后修改时间
     */
    public long getLastModified() {
        return this.mLastModified;
    }

    /**
     * 获取任务节点的删除状态
     * @return 任务节点的删除状态
     */
    public boolean getDeleted() {
        return this.mDeleted;
    }

}
