/*
 * 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 同步节点抽象基类
 * <p>
 * 定义所有可同步数据模型（Task、TaskList、MetaData）的公共属性和抽象方法。
 * 负责管理同步状态、Google ID、名称、最后修改时间和删除标记等通用属性。
 * 子类需要实现具体的 JSON 转换和同步动作生成逻辑。
 * </p>
 */
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 ID，用于唯一标识远程任务
     */
    private String mGid;

    /**
     * 节点名称
     */
    private String mName;

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

    /**
     * 删除标记，true 表示已删除
     */
    private boolean mDeleted;

    /**
     * 构造一个新的节点实例
     * <p>
     * 初始化所有属性为默认值：GID 为 null，名称为空字符串，最后修改时间为 0，删除标记为 false。
     * </p>
     */
    public Node() {
        mGid = null;
        mName = "";
        mLastModified = 0;
        mDeleted = false;
    }

    /**
     * 获取创建动作的 JSON 对象
     * <p>
     * 根据指定的动作 ID 生成用于在远程服务器创建节点的 JSON 请求。
     * </p>
     * 
     * @param actionId 动作 ID，标识具体的创建操作类型
     * @return 包含创建动作信息的 JSON 对象
     */
    public abstract JSONObject getCreateAction(int actionId);

    /**
     * 获取更新动作的 JSON 对象
     * <p>
     * 根据指定的动作 ID 生成用于在远程服务器更新节点的 JSON 请求。
     * </p>
     * 
     * @param actionId 动作 ID，标识具体的更新操作类型
     * @return 包含更新动作信息的 JSON 对象
     */
    public abstract JSONObject getUpdateAction(int actionId);

    /**
     * 根据远程 JSON 设置节点内容
     * <p>
     * 从远程服务器返回的 JSON 对象中解析并设置节点的属性值。
     * </p>
     * 
     * @param js 远程服务器返回的 JSON 对象
     */
    public abstract void setContentByRemoteJSON(JSONObject js);

    /**
     * 根据本地 JSON 设置节点内容
     * <p>
     * 从本地数据库存储的 JSON 对象中解析并设置节点的属性值。
     * </p>
     * 
     * @param js 本地数据库存储的 JSON 对象
     */
    public abstract void setContentByLocalJSON(JSONObject js);

    /**
     * 从节点内容生成本地 JSON 对象
     * <p>
     * 将节点的当前属性值转换为 JSON 对象，用于存储到本地数据库。
     * </p>
     * 
     * @return 包含节点内容的 JSON 对象
     */
    public abstract JSONObject getLocalJSONFromContent();

    /**
     * 根据数据库游标获取同步动作
     * <p>
     * 比较本地数据库中的数据与当前节点状态，确定需要执行的同步动作类型。
     * </p>
     * 
     * @param c 指向本地数据库记录的游标
     * @return 同步动作类型，取值为 SYNC_ACTION_* 常量之一
     */
    public abstract int getSyncAction(Cursor c);

    /**
     * 设置 Google Tasks ID
     * 
     * @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 表示已删除
     */
    public void setDeleted(boolean deleted) {
        this.mDeleted = deleted;
    }

    /**
     * 获取 Google Tasks ID
     * 
     * @return Google Tasks ID，如果未设置则返回 null
     */
    public String getGid() {
        return this.mGid;
    }

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

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

    /**
     * 获取删除标记
     * 
     * @return 删除标记，true 表示已删除
     */
    public boolean getDeleted() {
        return this.mDeleted;
    }

}
