/*
 * 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 Tasks同步系统中的一个节点的抽象基类
 * 定义了节点的基本属性和同步操作
 */
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;

    // Google Tasks服务中的唯一标识符
    private String mGid;

    // 节点名称/标题
    private String mName;

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

    // 标记节点是否已删除
    private boolean mDeleted;

    /**
     * 默认构造函数，初始化节点属性
     */
    public Node() {
        mGid = null;          // 初始化为空，等待从服务器获取或本地生成
        mName = "";           // 默认空名称
        mLastModified = 0;    // 默认时间戳为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 Tasks标识符
     * @param gid Google Tasks服务中的唯一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 true表示已删除，false表示未删除
     */
    public void setDeleted(boolean deleted) {
        this.mDeleted = deleted;
    }

    /**
     * 获取节点的Google Tasks标识符
     * @return Google Tasks ID
     */
    public String getGid() {
        return this.mGid;
    }

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

    /**
     * 获取节点最后修改时间
     * @return 时间戳（毫秒）
     */
    public long getLastModified() {
        return this.mLastModified;
    }

    /**
     * 获取节点删除状态
     * @return true表示已删除，false表示未删除
     */
    public boolean getDeleted() {
        return this.mDeleted;
    }
}