/*
 * 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类是GTask同步框架中的抽象基类
 * 定义了所有可同步节点的基本属性和行为
 * 提供了同步操作类型常量和基本数据访问方法
 */
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;
        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 删除状态
     */
    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 删除状态
     */
    public boolean getDeleted() {
        return this.mDeleted;
    }
}
