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

/**
 * 节点抽象类,用于表示Google Task中的节点数据
 */
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;           // 同步错误

    // 节点基本属性
    private String mGid;           // Google Task ID

    private String mName;          // 节点名称

    private long mLastModified;    // 最后修改时间

    private boolean mDeleted;      // 删除标记

    /**
     * 构造函数,初始化节点基本属性
     */
    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);

    /**
     * 设置Google Task ID
     * @param gid Google Task ID
     */
    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;
    }

    /**
     * 获取Google Task ID
     * @return Google Task ID
     */
    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;
    }

}
