/*
 * 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 是一个抽象基类，代表 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;           // 同步错误

    // 基本属性
    private String mGid;           // Google Tasks 全局唯一标识符
    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);

    // ------------------------ 公共访问方法 ------------------------

    public void setGid(String gid) {
        this.mGid = gid;
    }

    public void setName(String name) {
        this.mName = name;
    }

    public void setLastModified(long lastModified) {
        this.mLastModified = lastModified;
    }

    public void setDeleted(boolean deleted) {
        this.mDeleted = deleted;
    }

    public String getGid() {
        return this.mGid;
    }

    public String getName() {
        return this.mName;
    }

    public long getLastModified() {
        return this.mLastModified;
    }

    public boolean getDeleted() {
        return this.mDeleted;
    }
}