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

/**
 * @Package: net.micode.notes.gtask.data
 * @ClassName:  Node
 * @Description:
 * Node类是一个抽象类，定义了一些常量字段以及一些方法，还定义了节点对象的基本属性和操作，
 *  * 同时提供了抽象方法来处理节点内容的设置和同步操作的创建按，以及普通方法来设置和获取节点的属性。
 * @Author: Dong Jiaqi
 * @CreateDate: 12/24/2023 10:23 AM
 */
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;

    private String mName;

    private long mLastModified;

    private boolean mDeleted;

    public Node() {
        mGid = null;
        mName = "";
        mLastModified = 0;
        mDeleted = false;
    }

    public abstract JSONObject getCreateAction(int actionId);

    public abstract JSONObject getUpdateAction(int actionId);

    public abstract void setContentByRemoteJSON(JSONObject js);

    public abstract void setContentByLocalJSON(JSONObject js);

    public abstract JSONObject getLocalJSONFromContent();

    public abstract int getSyncAction(Cursor c);

    /**
     * 设置节点对象的全局唯一标识符（gid）。
     * @param gid 表示要设置的全局唯一标识符，它是一个字符串类型的参数。可以是任意有效的字符串，用于对节点进行唯一标识和区分。
     */
    public void setGid(String gid) {
        this.mGid = gid;
    }

    /**
     * 设置节点对象的名称。它通过将传入的字符串参数 name 赋值给节点对象的成员变量 mName 来实现。
     * @param name 表示要设置的节点名称，它是一个字符串类型的参数。可以是任意有效的字符串，用于标识节点的名称或描述。
     */
    public void setName(String name) {
        this.mName = name;
    }

    /**
     * 设置节点对象的最后修改时间。它通过将传入的长整型参数 lastModified 赋值给节点对象的成员变量 mLastModified 来实现。
     * @param lastModified 表示要设置的节点的最后修改时间，它是一个长整型参数，用来记录节点对象的最后修改时间
     */
    public void setLastModified(long lastModified) {
        this.mLastModified = lastModified;
    }

    /**
     * 设置节点对象的删除状态。它通过将传入的布尔类型参数 deleted 赋值给节点对象的成员变量 mDeleted 来实现。
     * @param deleted 表示要设置的节点的删除状态，它是一个布尔类型的参数。当该参数为 true 时，表示节点被标记为已删除；当该参数为 false 时，表示节点未被删除。
     */
    public void setDeleted(boolean deleted) {
        this.mDeleted = deleted;
    }

    /**
     * 获取节点对象的全局唯一标识符（gid）。它通过返回节点对象的成员变量 mGid 的值来实现。
     * @return  this.mGid表示节点的全局唯一标识符。这是一个字符串类型的返回值，用于表示节点对象的唯一标识符。
     */
    public String getGid() {
        return this.mGid;
    }

    /**
     * 获取节点对象的名称。它通过返回节点对象的成员变量 mName 的值来实现。
     * @return this.mName表示节点的名称。这是一个字符串类型的返回值，用于表示节点对象的名称或描述。
     */
    public String getName() {
        return this.mName;
    }

    /**
     * 获取节点对象的最后修改时间。它通过返回节点对象的成员变量 mLastModified 的值来实现。
     * @return this.mLastModified表示节点的最后修改时间。这是一个长整型的返回值
     */
    public long getLastModified() {
        return this.mLastModified;
    }

    /**
     * 获取节点对象的删除状态。它通过返回节点对象的成员变量 mDeleted 的布尔值来实现。
     * @return 表示节点的删除状态。当返回值为 true 时，表示节点已被标记为已删除；当返回值为 false 时，表示节点未被删除。
     */
    public boolean getDeleted() {
        return this.mDeleted;
    }

}
