You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
git-test/src/main/java/net/micode/notes/gtask/data/Node.java

198 lines
5.0 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

/*
* 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 - 节点抽象类
* <p>
* 定义了Google Task同步的基本节点类包含同步操作常量和抽象方法
* 子类需要实现具体的创建、更新和同步逻辑
* </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; // 同步错误
private String mGid; // 全局唯一标识符
private String mName; // 节点名称
private long mLastModified; // 最后修改时间
private boolean mDeleted; // 是否已删除
/**
* 构造方法
* <p>
* 初始化节点的默认值
* </p>
*/
public Node() {
mGid = null;
mName = "";
mLastModified = 0;
mDeleted = false;
}
/**
* 获取创建操作的JSON对象
* <p>
* 子类需要实现生成创建节点的JSON操作
* </p>
*
* @param actionId 操作ID
* @return 创建操作的JSON对象
*/
public abstract JSONObject getCreateAction(int actionId);
/**
* 获取更新操作的JSON对象
* <p>
* 子类需要实现生成更新节点的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 同步操作类型
*/
public abstract int getSyncAction(Cursor c);
/**
* 设置全局唯一标识符
*
* @param gid 全局唯一标识符
*/
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;
}
/**
* 获取全局唯一标识符
*
* @return 全局唯一标识符
*/
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;
}
}