|
|
/*
|
|
|
* 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.
|
|
|
*/
|
|
|
// 版权声明部分，说明了代码的版权归属、遵循的Apache License 2.0开源协议以及协议获取的链接等信息
|
|
|
|
|
|
package net.micode.notes.gtask.data;
|
|
|
// 定义该类所属的包名，表明这个类在net.micode.notes.gtask.data这个包下，便于在项目中对代码进行组织和管理
|
|
|
|
|
|
import android.database.Cursor;
|
|
|
import org.json.JSONObject;
|
|
|
// 导入了必要的类，其中Cursor用于操作数据库游标，以便后续可能从数据库获取数据等操作；JSONObject用于处理JSON格式的数据，可能在与外部交互或者存储数据时会使用到JSON格式
|
|
|
|
|
|
public abstract class Node {
|
|
|
// 定义一个抽象类Node，抽象类意味着它不能被直接实例化，通常是作为其他具体类的基类，为子类定义一些通用的属性和方法规范
|
|
|
|
|
|
public static final int SYNC_ACTION_NONE = 0;
|
|
|
// 定义一个公共静态的最终整型常量，用于表示同步操作中的无操作情况，可能在判断同步状态等场景下使用，值为0
|
|
|
public static final int SYNC_ACTION_ADD_REMOTE = 1;
|
|
|
// 定义一个公共静态的最终整型常量，用于表示向远程添加数据的同步操作类型，值为1
|
|
|
public static final int SYNC_ACTION_ADD_LOCAL = 2;
|
|
|
// 定义一个公共静态的最终整型常量，用于表示在本地添加数据的同步操作类型，值为2
|
|
|
public static final int SYNC_ACTION_DEL_REMOTE = 3;
|
|
|
// 定义一个公共静态的最终整型常量，用于表示从远程删除数据的同步操作类型，值为3
|
|
|
public static final int SYNC_ACTION_DEL_LOCAL = 4;
|
|
|
// 定义一个公共静态的最终整型常量，用于表示在本地删除数据的同步操作类型，值为4
|
|
|
public static final int SYNC_ACTION_UPDATE_REMOTE = 5;
|
|
|
// 定义一个公共静态的最终整型常量，用于表示远程数据更新的同步操作类型，值为5
|
|
|
public static final int SYNC_ACTION_UPDATE_LOCAL = 6;
|
|
|
// 定义一个公共静态的最终整型常量，用于表示本地数据更新的同步操作类型，值为6
|
|
|
public static final int SYNC_ACTION_UPDATE_CONFLICT = 7;
|
|
|
// 定义一个公共静态的最终整型常量，用于表示更新数据时出现冲突的同步操作类型，值为7
|
|
|
public static final int SYNC_ACTION_ERROR = 8;
|
|
|
// 定义一个公共静态的最终整型常量，用于表示同步操作出现错误的情况，值为8，这些常量整体用于清晰地标识各种同步相关的操作状态
|
|
|
|
|
|
private String mGid;
|
|
|
// 定义一个私有字符串变量，从变量名推测可能用于存储全局唯一标识符（Global Identifier，可能和数据的唯一标识等相关），初始值未给定
|
|
|
private String mName;
|
|
|
// 定义一个私有字符串变量，用于存储节点的名称，初始值未给定
|
|
|
private long mLastModified;
|
|
|
// 定义一个私有长整型变量，用于存储节点最后一次被修改的时间戳之类的数据，初始值为0
|
|
|
private boolean mDeleted;
|
|
|
// 定义一个私有布尔型变量，用于表示节点是否已被删除的状态，初始值为false
|
|
|
|
|
|
public Node() {
|
|
|
// 定义Node类的默认构造函数，用于初始化类中的各个成员变量
|
|
|
mGid = null;
|
|
|
// 将mGid初始化为null，表示初始时全局唯一标识符为空
|
|
|
mName = "";
|
|
|
// 将mName初始化为空字符串，表示初始时节点名称为空字符串
|
|
|
mLastModified = 0;
|
|
|
// 将mLastModified重新赋值为0，明确初始化最后修改时间为0
|
|
|
mDeleted = false;
|
|
|
// 将mDeleted赋值为false，明确初始化节点的删除状态为未删除
|
|
|
}
|
|
|
|
|
|
public abstract JSONObject getCreateAction(int actionId);
|
|
|
// 定义一个抽象方法，要求子类必须实现该方法，用于根据给定的操作ID（actionId）获取创建操作对应的JSON对象，具体的创建操作逻辑由子类根据自身需求来实现，返回的JSONObject应该包含创建相关的必要信息
|
|
|
public abstract JSONObject getUpdateAction(int actionId);
|
|
|
// 定义一个抽象方法，要求子类必须实现该方法，用于根据给定的操作ID（actionId）获取更新操作对应的JSON对象，同样，具体的更新操作逻辑由子类来定制，返回的JSONObject会包含更新相关的数据等内容
|
|
|
public abstract void setContentByRemoteJSON(JSONObject js);
|
|
|
// 定义一个抽象方法，子类必须实现，用于根据传入的远程JSON对象（js）来设置节点的相关内容，意味着子类要根据自身的数据结构和需求从JSON对象中解析并设置相应的属性值等
|
|
|
public abstract void setContentByLocalJSON(JSONObject js);
|
|
|
// 定义一个抽象方法，子类要实现，用于根据传入的本地JSON对象（js）来设置节点的相关内容，和前面设置远程JSON内容类似，只是数据源是本地的JSON数据
|
|
|
public abstract JSONObject getLocalJSONFromContent();
|
|
|
// 定义一个抽象方法，子类需实现，用于从节点的当前内容中获取对应的本地JSON对象，即把节点内部的相关属性等信息转换为JSON格式的数据对象返回
|
|
|
public abstract int getSyncAction(Cursor c);
|
|
|
// 定义一个抽象方法，子类必须实现，用于根据传入的数据库游标（c）获取当前节点对应的同步操作类型，子类需要根据游标所指向的数据等情况来判断并返回合适的同步操作类型（前面定义的那些同步操作常量之一）
|
|
|
|
|
|
public void setGid(String gid) {
|
|
|
this.mGid = gid;
|
|
|
}
|
|
|
// 定义一个公共方法，用于设置节点的全局唯一标识符（mGid），接受一个字符串类型的参数gid，并将其赋值给mGid变量
|
|
|
public void setName(String name) {
|
|
|
this.mName = name;
|
|
|
}
|
|
|
// 定义一个公共方法，用于设置节点的名称（mName），接受一个字符串类型的参数name，并将其赋值给mName变量
|
|
|
public void setLastModified(long lastModified) {
|
|
|
this.mLastModified = lastModified;
|
|
|
}
|
|
|
// 定义一个公共方法，用于设置节点的最后修改时间（mLastModified），接受一个长整型参数lastModified，并将其赋值给mLastModified变量
|
|
|
public void setDeleted(boolean deleted) {
|
|
|
this.mDeleted = deleted;
|
|
|
}
|
|
|
// 定义一个公共方法，用于设置节点的删除状态（mDeleted），接受一个布尔型参数deleted，将其赋值给mDeleted变量，以更新节点是否已被删除的标识
|
|
|
|
|
|
public String getGid() {
|
|
|
return this.mGid;
|
|
|
}
|
|
|
// 定义一个公共方法，用于获取节点的全局唯一标识符（mGid），直接返回mGid变量的值
|
|
|
public String getName() {
|
|
|
return this.mName;
|
|
|
}
|
|
|
// 定义一个公共方法，用于获取节点的名称（mName），直接返回mName变量的值
|
|
|
public long getLastModified() {
|
|
|
return this.mLastModified;
|
|
|
}
|
|
|
// 定义一个公共方法，用于获取节点的最后修改时间（mLastModified），直接返回mLastModified变量的值
|
|
|
public boolean getDeleted() {
|
|
|
return this.mDeleted;
|
|
|
}
|
|
|
// 定义一个公共方法，用于获取节点的删除状态（mDeleted），直接返回mDeleted变量的值
|
|
|
} |
