pnxf6w84l 7 months ago
parent b645204b2b
commit ada8cdece0

@ -1,104 +1,64 @@
package net.micode.notes.gtask.data; package net.micode.notes.gtask.data;
// 定义MetaData类它继承自Task类
public class MetaData extends Task { public class MetaData extends Task {
/* // 定义一个私有静态常量TAG用于记录类的简单名称通常用于日志输出
* TAG
* getSimpleName ()
*/
private final static String TAG = MetaData.class.getSimpleName(); private final static String TAG = MetaData.class.getSimpleName();
// 定义一个私有成员变量mRelatedGid用于存储相关的Gid初始化为null
private String mRelatedGid = null; private String mRelatedGid = null;
/* // 此方法接受一个字符串gid和一个JSONObject类型的metaInfo作为参数
* public void setMeta(String gid, JSONObject metaInfo) {
* JSONObjectput ()TasksetNotes ()setName ()
*
*/
public void setMeta(String gid, JSONObject metaInfo)
{
//对函数块进行注释
try { try {
// 尝试将gid放入metaInfo对象中键为GTaskStringUtils.META_HEAD_GTASK_ID
metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
/*
* metaInfojsonobject
*/
} catch (JSONException e) { } catch (JSONException e) {
// 如果发生JSON异常在日志中记录错误信息表示无法放入相关gid
Log.e(TAG, "failed to put related gid"); Log.e(TAG, "failed to put related gid");
/*
*
*/
} }
// 将metaInfo转换为字符串后设置为笔记内容
setNotes(metaInfo.toString()); setNotes(metaInfo.toString());
// 设置名称为GTaskStringUtils.META_NOTE_NAME
setName(GTaskStringUtils.META_NOTE_NAME); setName(GTaskStringUtils.META_NOTE_NAME);
} }
/* // 此方法用于获取相关的Gid
* Gid
*/
public String getRelatedGid() { public String getRelatedGid() {
return mRelatedGid; return mRelatedGid;
} }
/* // 重写isWorthSaving方法判断笔记内容是否不为空如果不为空则表示值得保存
*
* Made By CuiCan
*/
@Override @Override
public boolean isWorthSaving() { public boolean isWorthSaving() {
return getNotes() != null; return getNotes()!= null;
} }
/* // 重写setContentByRemoteJSON方法
* 使json
* TasksetContentByRemoteJSON ()
*
*/
@Override @Override
public void setContentByRemoteJSON(JSONObject js) { public void setContentByRemoteJSON(JSONObject js) {
super.setContentByRemoteJSON(js); super.setContentByRemoteJSON(js);
if (getNotes() != null) { if (getNotes()!= null) {
try { try {
// 如果笔记内容不为空将其转换为JSONObject类型的metaInfo
JSONObject metaInfo = new JSONObject(getNotes().trim()); JSONObject metaInfo = new JSONObject(getNotes().trim());
// 从metaInfo中获取相关的Gid字符串
mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
} catch (JSONException e) { } catch (JSONException e) {
// 如果发生JSON异常在日志中记录警告信息表示无法获取相关gid
Log.w(TAG, "failed to get related gid"); Log.w(TAG, "failed to get related gid");
/*
*
*/
mRelatedGid = null; mRelatedGid = null;
} }
} }
} }
/* // 重写setContentByLocalJSON方法此方法不应该被调用如果调用则抛出IllegalAccessError异常
* 使json
* Made By CuiCan
*/
@Override @Override
public void setContentByLocalJSON(JSONObject js) { public void setContentByLocalJSON(JSONObject js) {
// this function should not be called
throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
/*
*
*/
} }
/* // 重写getLocalJSONFromContent方法此方法不应该被调用如果调用则抛出IllegalAccessError异常
* json
* Made By CuiCan
*/
@Override @Override
public JSONObject getLocalJSONFromContent() { public JSONObject getLocalJSONFromContent() {
throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
/*
*
* Made By Cui Can
*/
} }
/* // 重写getSyncAction方法此方法不应该被调用如果调用则抛出IllegalAccessError异常
*
* Made By CuiCan
*/
@Override @Override
public int getSyncAction(Cursor c) { public int getSyncAction(Cursor c) {
throw new IllegalAccessError("MetaData:getSyncAction should not be called"); throw new IllegalAccessError("MetaData:getSyncAction should not be called");
/*
*
* Made By Cui Can
*/
} }
} }

@ -1,90 +1,111 @@
package net.micode.notes.gtask.data; package net.micode.notes.gtask.data;
// 导入用于数据库游标操作的类
import android.database.Cursor; import android.database.Cursor;
// 导入用于处理JSON对象的类
import org.json.JSONObject; import org.json.JSONObject;
/** // Node类是一个抽象类可能是同步操作的基础数据类型其中定义了与同步操作相关的常量
*
* abstract
*/
public abstract class Node { 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_NONE = 0;
public static final int SYNC_ACTION_ADD_LOCAL = 2;// 需要在本地增加内容 // 需要在远程云端增加内容时的同步操作类型
public static final int SYNC_ACTION_ADD_REMOTE = 1;
public static final int SYNC_ACTION_DEL_REMOTE = 3;// 需要在远程云端删除内容
// 需要在本地增加内容时的同步操作类型
public static final int SYNC_ACTION_DEL_LOCAL = 4;// 需要在本地删除内容 public static final int SYNC_ACTION_ADD_LOCAL = 2;
public static final int SYNC_ACTION_UPDATE_REMOTE = 5;// 需要将本地内容更新到远程云端 // 需要在远程云端删除内容时的同步操作类型
public static final int SYNC_ACTION_DEL_REMOTE = 3;
public static final int SYNC_ACTION_UPDATE_LOCAL = 6;// 需要将远程云端内容更新到本地
// 需要在本地删除内容时的同步操作类型
public static final int SYNC_ACTION_UPDATE_CONFLICT = 7;// 同步出现冲突 public static final int SYNC_ACTION_DEL_LOCAL = 4;
public static final int SYNC_ACTION_ERROR = 8;// 同步出现错误 // 需要将本地内容更新到远程云端时的同步操作类型
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 mGid;
// 用于存储名称
private String mName; private String mName;
// 用于记录最后一次修改的时间
private long mLastModified;
// 用于表示是否被删除的标志
private boolean mDeleted;
private long mLastModified;//记录最后一次修改时间 // 构造函数,用于初始化成员变量
private boolean mDeleted;//表征是否被删除
public Node() { public Node() {
mGid = null; mGid = null;
mName = ""; mName = "";
mLastModified = 0; mLastModified = 0;
mDeleted = false; mDeleted = false;
} }
// 抽象方法根据给定的操作ID创建一个用于执行创建操作的JSONObject
public abstract JSONObject getCreateAction(int actionId); public abstract JSONObject getCreateAction(int actionId);
// 抽象方法根据给定的操作ID创建一个用于执行更新操作的JSONObject
public abstract JSONObject getUpdateAction(int actionId); public abstract JSONObject getUpdateAction(int actionId);
// 抽象方法根据远程的JSON对象设置内容
public abstract void setContentByRemoteJSON(JSONObject js); public abstract void setContentByRemoteJSON(JSONObject js);
// 抽象方法根据本地的JSON对象设置内容
public abstract void setContentByLocalJSON(JSONObject js); public abstract void setContentByLocalJSON(JSONObject js);
// 抽象方法从内容中获取本地的JSON对象
public abstract JSONObject getLocalJSONFromContent(); public abstract JSONObject getLocalJSONFromContent();
// 抽象方法,根据数据库游标获取同步操作类型
public abstract int getSyncAction(Cursor c); public abstract int getSyncAction(Cursor c);
// 设置Gid的方法
public void setGid(String gid) { public void setGid(String gid) {
this.mGid = gid; this.mGid = gid;
} }
// 设置名称的方法
public void setName(String name) { public void setName(String name) {
this.mName = name; this.mName = name;
} }
// 设置最后一次修改时间的方法
public void setLastModified(long lastModified) { public void setLastModified(long lastModified) {
this.mLastModified = lastModified; this.mLastModified = lastModified;
} }
// 设置是否被删除的方法
public void setDeleted(boolean deleted) { public void setDeleted(boolean deleted) {
this.mDeleted = deleted; this.mDeleted = deleted;
} }
// 获取Gid的方法
public String getGid() { public String getGid() {
return this.mGid; return this.mGid;
} }
// 获取名称的方法
public String getName() { public String getName() {
return this.mName; return this.mName;
} }
// 获取最后一次修改时间的方法
public long getLastModified() { public long getLastModified() {
return this.mLastModified; return this.mLastModified;
} }
// 获取是否被删除状态的方法
public boolean getDeleted() { public boolean getDeleted() {
return this.mDeleted; return this.mDeleted;
} }
} }

@ -16,120 +16,137 @@
package net.micode.notes.gtask.data; package net.micode.notes.gtask.data;
// 导入用于操作内容提供者相关的类
import android.content.ContentResolver; import android.content.ContentResolver;
import android.content.ContentUris; import android.content.ContentUris;
import android.content.ContentValues; import android.content.ContentValues;
import android.content.Context; import android.content.Context;
// 导入用于数据库游标操作的类
import android.database.Cursor; import android.database.Cursor;
// 导入用于处理URI的类
import android.net.Uri; import android.net.Uri;
import android.util.Log; import android.util.Log;
// 导入与笔记数据相关的类和常量
import net.micode.notes.data.Notes; import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.DataConstants; import net.micode.notes.data.Notes.DataConstants;
import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.data.NotesDatabaseHelper.TABLE; import net.micode.notes.data.NotesDatabaseHelper.TABLE;
// 导入自定义的异常类
import net.micode.notes.gtask.exception.ActionFailureException; import net.micode.notes.gtask.exception.ActionFailureException;
// 导入用于处理JSON对象的相关类
import org.json.JSONException; import org.json.JSONException;
import org.json.JSONObject; import org.json.JSONObject;
// SqlData类可能用于处理与SQL相关的数据操作如从数据库读取或写入数据等
public class SqlData { public class SqlData {
// 定义一个私有静态常量TAG用于记录类的简单名称通常用于日志输出
private static final String TAG = SqlData.class.getSimpleName(); private static final String TAG = SqlData.class.getSimpleName();
// 定义一个表示无效ID的常量可能用于初始化或者标识无效的数据库记录ID
private static final int INVALID_ID = -99999; private static final int INVALID_ID = -99999;
// 定义一个字符串数组,用于指定从数据库查询数据时要获取的列名
public static final String[] PROJECTION_DATA = new String[] { public static final String[] PROJECTION_DATA = new String[] {
DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1,
DataColumns.DATA3 DataColumns.DATA3
}; };
// 定义常量表示在查询结果中ID列的索引位置
public static final int DATA_ID_COLUMN = 0; public static final int DATA_ID_COLUMN = 0;
// 定义常量表示在查询结果中MIME_TYPE列的索引位置
public static final int DATA_MIME_TYPE_COLUMN = 1; public static final int DATA_MIME_TYPE_COLUMN = 1;
// 定义常量表示在查询结果中CONTENT列的索引位置
public static final int DATA_CONTENT_COLUMN = 2; public static final int DATA_CONTENT_COLUMN = 2;
// 定义常量表示在查询结果中DATA1列的索引位置
public static final int DATA_CONTENT_DATA_1_COLUMN = 3; public static final int DATA_CONTENT_DATA_1_COLUMN = 3;
// 定义常量表示在查询结果中DATA3列的索引位置
public static final int DATA_CONTENT_DATA_3_COLUMN = 4; public static final int DATA_CONTENT_DATA_3_COLUMN = 4;
private ContentResolver mContentResolver; // 构造函数用于创建新的SqlData对象传入上下文对象
private boolean mIsCreate;
private long mDataId;
private String mDataMimeType;
private String mDataContent;
private long mDataContentData1;
private String mDataContentData3;
private ContentValues mDiffDataValues;
public SqlData(Context context) { public SqlData(Context context) {
// 获取内容提供者解析器
mContentResolver = context.getContentResolver(); mContentResolver = context.getContentResolver();
// 标记为创建操作
mIsCreate = true; mIsCreate = true;
// 初始化数据ID为无效ID
mDataId = INVALID_ID; mDataId = INVALID_ID;
// 初始化MIME类型为DataConstants.NOTE
mDataMimeType = DataConstants.NOTE; mDataMimeType = DataConstants.NOTE;
// 初始化数据内容为空字符串
mDataContent = ""; mDataContent = "";
// 初始化相关长整型数据为0
mDataContentData1 = 0; mDataContentData1 = 0;
// 初始化相关字符串数据为空字符串
mDataContentData3 = ""; mDataContentData3 = "";
// 初始化用于存储数据差异值的ContentValues对象
mDiffDataValues = new ContentValues(); mDiffDataValues = new ContentValues();
} }
// 构造函数用于从数据库游标创建SqlData对象传入上下文对象和游标对象
public SqlData(Context context, Cursor c) { public SqlData(Context context, Cursor c) {
// 获取内容提供者解析器
mContentResolver = context.getContentResolver(); mContentResolver = context.getContentResolver();
// 标记为非创建操作(即更新操作)
mIsCreate = false; mIsCreate = false;
// 从游标加载数据到成员变量
loadFromCursor(c); loadFromCursor(c);
// 初始化用于存储数据差异值的ContentValues对象
mDiffDataValues = new ContentValues(); mDiffDataValues = new ContentValues();
} }
// 从数据库游标加载数据到成员变量的私有方法
private void loadFromCursor(Cursor c) { private void loadFromCursor(Cursor c) {
// 从游标获取数据ID
mDataId = c.getLong(DATA_ID_COLUMN); mDataId = c.getLong(DATA_ID_COLUMN);
// 从游标获取MIME类型
mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN);
// 从游标获取数据内容
mDataContent = c.getString(DATA_CONTENT_COLUMN); mDataContent = c.getString(DATA_CONTENT_COLUMN);
// 从游标获取相关长整型数据
mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN);
// 从游标获取相关字符串数据
mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN);
} }
// 根据传入的JSONObject设置对象的成员变量可能会根据创建标记和已有数据判断是否需要更新差异值
public void setContent(JSONObject js) throws JSONException { public void setContent(JSONObject js) throws JSONException {
long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; // 从JSON对象获取数据ID如果不存在则使用无效ID
if (mIsCreate || mDataId != dataId) { long dataId = js.has(DataColumns.ID)? js.getLong(DataColumns.ID) : INVALID_ID;
if (mIsCreate || mDataId!= dataId) {
mDiffDataValues.put(DataColumns.ID, dataId); mDiffDataValues.put(DataColumns.ID, dataId);
} }
mDataId = dataId; mDataId = dataId;
String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) // 从JSON对象获取MIME类型如果不存在则使用默认的DataConstants.NOTE
String dataMimeType = js.has(DataColumns.MIME_TYPE)? js.getString(DataColumns.MIME_TYPE)
: DataConstants.NOTE; : DataConstants.NOTE;
if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { if (mIsCreate ||!mDataMimeType.equals(dataMimeType)) {
mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType);
} }
mDataMimeType = dataMimeType; mDataMimeType = dataMimeType;
String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; // 从JSON对象获取数据内容如果不存在则使用空字符串
if (mIsCreate || !mDataContent.equals(dataContent)) { String dataContent = js.has(DataColumns.CONTENT)? js.getString(DataColumns.CONTENT) : "";
if (mIsCreate ||!mDataContent.equals(dataContent)) {
mDiffDataValues.put(DataColumns.CONTENT, dataContent); mDiffDataValues.put(DataColumns.CONTENT, dataContent);
} }
mDataContent = dataContent; mDataContent = dataContent;
long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; // 从JSON对象获取相关长整型数据如果不存在则使用0
if (mIsCreate || mDataContentData1 != dataContentData1) { long dataContentData1 = js.has(DataColumns.DATA1)? js.getLong(DataColumns.DATA1) : 0;
if (mIsCreate || mDataContentData1!= dataContentData1) {
mDiffDataValues.put(DataColumns.DATA1, dataContentData1); mDiffDataValues.put(DataColumns.DATA1, dataContentData1);
} }
mDataContentData1 = dataContentData1; mDataContentData1 = dataContentData1;
String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; // 从JSON对象获取相关字符串数据如果不存在则使用空字符串
if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { String dataContentData3 = js.has(DataColumns.DATA3)? js.getString(DataColumns.DATA3) : "";
if (mIsCreate ||!mDataContentData3.equals(dataContentData3)) {
mDiffDataValues.put(DataColumns.DATA3, dataContentData3); mDiffDataValues.put(DataColumns.DATA3, dataContentData3);
} }
mDataContentData3 = dataContentData3; mDataContentData3 = dataContentData3;
} }
// 获取对象的成员变量并转换为JSONObject如果是创建操作则记录错误日志并返回null
public JSONObject getContent() throws JSONException { public JSONObject getContent() throws JSONException {
if (mIsCreate) { if (mIsCreate) {
Log.e(TAG, "it seems that we haven't created this in database yet"); Log.e(TAG, "it seems that we haven't created this in database yet");
@ -144,31 +161,39 @@ public class SqlData {
return js; return js;
} }
// 将数据提交到数据库的方法,根据是创建操作还是更新操作执行不同的逻辑,同时可根据版本验证进行更新操作
public void commit(long noteId, boolean validateVersion, long version) { public void commit(long noteId, boolean validateVersion, long version) {
if (mIsCreate) { if (mIsCreate) {
// 如果是创建操作并且数据ID为无效ID且差异值中包含ID键则移除该键
if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) {
mDiffDataValues.remove(DataColumns.ID); mDiffDataValues.remove(DataColumns.ID);
} }
// 将noteId放入差异值中可能表示与笔记相关的ID
mDiffDataValues.put(DataColumns.NOTE_ID, noteId); mDiffDataValues.put(DataColumns.NOTE_ID, noteId);
// 使用内容提供者解析器插入数据到指定的URI并获取插入后的URI
Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues);
try { try {
// 从URI中获取插入后的ID如果转换失败则记录错误日志并抛出异常
mDataId = Long.valueOf(uri.getPathSegments().get(1)); mDataId = Long.valueOf(uri.getPathSegments().get(1));
} catch (NumberFormatException e) { } catch (NumberFormatException e) {
Log.e(TAG, "Get note id error :" + e.toString()); Log.e(TAG, "Get note id error :" + e.toString());
throw new ActionFailureException("create note failed"); throw new ActionFailureException("create note failed");
} }
} else { } else {
// 如果是更新操作并且差异值不为空
if (mDiffDataValues.size() > 0) { if (mDiffDataValues.size() > 0) {
int result = 0; int result = 0;
if (!validateVersion) { if (!validateVersion) {
// 如果不进行版本验证,直接更新数据
result = mContentResolver.update(ContentUris.withAppendedId( result = mContentResolver.update(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null);
} else { } else {
// 如果进行版本验证,使用特定的条件更新数据
result = mContentResolver.update(ContentUris.withAppendedId( result = mContentResolver.update(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues,
" ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE "? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE
+ " WHERE " + NoteColumns.VERSION + "=?)", new String[] { + " WHERE " + NoteColumns.VERSION + "=?)", new String[] {
String.valueOf(noteId), String.valueOf(version) String.valueOf(noteId), String.valueOf(version)
}); });
@ -179,11 +204,14 @@ public class SqlData {
} }
} }
// 清除差异值
mDiffDataValues.clear(); mDiffDataValues.clear();
// 标记为非创建操作(更新操作完成后)
mIsCreate = false; mIsCreate = false;
} }
// 获取数据ID的方法
public long getId() { public long getId() {
return mDataId; return mDataId;
} }
} }

@ -13,36 +13,46 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package net.micode.notes.gtask.data; package net.micode.notes.gtask.data;
// 导入用于操作App Widget相关的类
import android.appwidget.AppWidgetManager; import android.appwidget.AppWidgetManager;
// 导入用于操作内容提供者相关的类
import android.content.ContentResolver; import android.content.ContentResolver;
import android.content.ContentValues; import android.content.ContentValues;
// 导入上下文相关类,用于获取系统服务等操作
import android.content.Context; import android.content.Context;
// 导入数据库游标相关类,用于查询和遍历数据库结果
import android.database.Cursor; import android.database.Cursor;
// 导入处理URI相关的类
import android.net.Uri; import android.net.Uri;
import android.util.Log; import android.util.Log;
// 导入与笔记数据相关的类、常量和列定义
import net.micode.notes.data.Notes; import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.Notes.NoteColumns;
// 导入自定义的异常类
import net.micode.notes.gtask.exception.ActionFailureException; import net.micode.notes.gtask.exception.ActionFailureException;
// 导入自定义的工具类可能用于处理GTask相关的字符串操作
import net.micode.notes.tool.GTaskStringUtils; import net.micode.notes.tool.GTaskStringUtils;
// 导入可能用于解析资源的工具类
import net.micode.notes.tool.ResourceParser; import net.micode.notes.tool.ResourceParser;
// 导入用于处理JSON对象和数组的相关类
import org.json.JSONArray; import org.json.JSONArray;
import org.json.JSONException; import org.json.JSONException;
import org.json.JSONObject; import org.json.JSONObject;
import java.util.ArrayList; // 导入用于存储对象列表的ArrayList类
// SqlNote类可能用于处理与笔记Note相关的SQL操作如从数据库读取或写入笔记数据等
public class SqlNote { public class SqlNote {
// 定义一个私有静态常量TAG用于记录类的简单名称通常用于日志输出
private static final String TAG = SqlNote.class.getSimpleName(); private static final String TAG = SqlNote.class.getSimpleName();
// 定义一个表示无效ID的常量可能用于初始化或者标识无效的数据库记录ID
private static final int INVALID_ID = -99999; private static final int INVALID_ID = -99999;
// 定义一个字符串数组,用于指定从数据库查询笔记数据时要获取的列名
public static final String[] PROJECTION_NOTE = new String[] { public static final String[] PROJECTION_NOTE = new String[] {
NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID,
NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE, NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE,
@ -51,168 +61,224 @@ public class SqlNote {
NoteColumns.LOCAL_MODIFIED, NoteColumns.ORIGIN_PARENT_ID, NoteColumns.GTASK_ID, NoteColumns.LOCAL_MODIFIED, NoteColumns.ORIGIN_PARENT_ID, NoteColumns.GTASK_ID,
NoteColumns.VERSION NoteColumns.VERSION
}; };
// 定义常量表示在查询结果中ID列的索引位置
public static final int ID_COLUMN = 0; public static final int ID_COLUMN = 0;
// 定义常量表示在查询结果中ALERTED_DATE列的索引位置
public static final int ALERTED_DATE_COLUMN = 1; public static final int ALERTED_DATE_COLUMN = 1;
// 定义常量表示在查询结果中BG_COLOR_ID列的索引位置
public static final int BG_COLOR_ID_COLUMN = 2; public static final int BG_COLOR_ID_COLUMN = 2;
// 定义常量表示在查询结果中CREATED_DATE列的索引位置
public static final int CREATED_DATE_COLUMN = 3; public static final int CREATED_DATE_COLUMN = 3;
// 定义常量表示在查询结果中HAS_ATTACHMENT列的索引位置
public static final int HAS_ATTACHMENT_COLUMN = 4; public static final int HAS_ATTACHMENT_COLUMN = 4;
// 定义常量表示在查询结果中MODIFIED_DATE列的索引位置
public static final int MODIFIED_DATE_COLUMN = 5; public static final int MODIFIED_DATE_COLUMN = 5;
// 定义常量表示在查询结果中NOTES_COUNT列的索引位置
public static final int NOTES_COUNT_COLUMN = 6; public static final int NOTES_COUNT_COLUMN = 6;
// 定义常量表示在查询结果中PARENT_ID列的索引位置
public static final int PARENT_ID_COLUMN = 7; public static final int PARENT_ID_COLUMN = 7;
// 定义常量表示在查询结果中SNIPPET列的索引位置
public static final int SNIPPET_COLUMN = 8; public static final int SNIPPET_COLUMN = 8;
// 定义常量表示在查询结果中TYPE列的索引位置
public static final int TYPE_COLUMN = 9; public static final int TYPE_COLUMN = 9;
// 定义常量表示在查询结果中WIDGET_ID列的索引位置
public static final int WIDGET_ID_COLUMN = 10; public static final int WIDGET_ID_COLUMN = 10;
// 定义常量表示在查询结果中WIDGET_TYPE列的索引位置
public static final int WIDGET_TYPE_COLUMN = 11; public static final int WIDGET_TYPE_COLUMN = 11;
// 定义常量表示在查询结果中SYNC_ID列的索引位置
public static final int SYNC_ID_COLUMN = 12; public static final int SYNC_ID_COLUMN = 12;
// 定义常量表示在查询结果中LOCAL_MODIFIED列的索引位置
public static final int LOCAL_MODIFIED_COLUMN = 13; public static final int LOCAL_MODIFIED_COLUMN = 13;
// 定义常量表示在查询结果中ORIGIN_PARENT_ID列的索引位置
public static final int ORIGIN_PARENT_ID_COLUMN = 14; public static final int ORIGIN_PARENT_ID_COLUMN = 14;
// 定义常量表示在查询结果中GTASK_ID列的索引位置
public static final int GTASK_ID_COLUMN = 15; public static final int GTASK_ID_COLUMN = 15;
// 定义常量表示在查询结果中VERSION_COLUMN列的索引位置
public static final int VERSION_COLUMN = 16; public static final int VERSION_COLUMN = 16;
// 上下文对象,用于获取系统资源、服务等操作
private Context mContext; private Context mContext;
// 内容提供者解析器,用于操作内容提供者(如数据库内容提供者)
private ContentResolver mContentResolver; private ContentResolver mContentResolver;
// 标记是否是创建操作(用于区分是新建笔记还是更新已有笔记)
private boolean mIsCreate; private boolean mIsCreate;
// 存储笔记的ID初始化为无效ID
private long mId; private long mId;
// 存储笔记的提醒日期初始化为0
private long mAlertDate; private long mAlertDate;
// 存储笔记的背景颜色ID初始化为默认背景颜色ID
private int mBgColorId; private int mBgColorId;
// 存储笔记的创建日期,初始化为当前系统时间
private long mCreatedDate; private long mCreatedDate;
// 存储笔记是否有附件的标识初始化为0表示无附件
private int mHasAttachment; private int mHasAttachment;
// 存储笔记的修改日期,初始化为当前系统时间
private long mModifiedDate; private long mModifiedDate;
// 存储笔记的父级ID初始化为0
private long mParentId; private long mParentId;
// 存储笔记的摘要内容,初始化为空字符串
private String mSnippet; private String mSnippet;
// 存储笔记的类型初始化为Notes.TYPE_NOTE
private int mType; private int mType;
// 存储与App Widget相关的ID初始化为无效的App Widget ID
private int mWidgetId; private int mWidgetId;
// 存储与App Widget相关的类型初始化为无效的类型
private int mWidgetType; private int mWidgetType;
// 存储笔记的原始父级ID初始化为0
private long mOriginParent; private long mOriginParent;
// 存储笔记的版本号初始化为0
private long mVersion; private long mVersion;
// 用于存储笔记数据差异值(可能用于在更新操作中只更新有变化的值)
private ContentValues mDiffNoteValues; private ContentValues mDiffNoteValues;
// 存储与笔记相关的数据列表可能是多个SqlData对象每个对象代表笔记的一部分数据
private ArrayList<SqlData> mDataList; private ArrayList<SqlData> mDataList;
// 构造函数用于创建新的SqlNote对象传入上下文对象
public SqlNote(Context context) { public SqlNote(Context context) {
// 初始化上下文对象
mContext = context; mContext = context;
// 获取内容提供者解析器
mContentResolver = context.getContentResolver(); mContentResolver = context.getContentResolver();
// 标记为创建操作
mIsCreate = true; mIsCreate = true;
// 初始化笔记ID为无效ID
mId = INVALID_ID; mId = INVALID_ID;
// 初始化提醒日期为0
mAlertDate = 0; mAlertDate = 0;
// 初始化背景颜色ID为默认背景颜色ID
mBgColorId = ResourceParser.getDefaultBgId(context); mBgColorId = ResourceParser.getDefaultBgId(context);
// 初始化创建日期为当前系统时间
mCreatedDate = System.currentTimeMillis(); mCreatedDate = System.currentTimeMillis();
// 初始化是否有附件标识为0
mHasAttachment = 0; mHasAttachment = 0;
// 初始化修改日期为当前系统时间
mModifiedDate = System.currentTimeMillis(); mModifiedDate = System.currentTimeMillis();
// 初始化父级ID为0
mParentId = 0; mParentId = 0;
// 初始化摘要内容为空字符串
mSnippet = ""; mSnippet = "";
// 初始化笔记类型为Notes.TYPE_NOTE
mType = Notes.TYPE_NOTE; mType = Notes.TYPE_NOTE;
// 初始化与App Widget相关的ID为无效的App Widget ID
mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID;
// 初始化与App Widget相关的类型为无效的类型
mWidgetType = Notes.TYPE_WIDGET_INVALIDE; mWidgetType = Notes.TYPE_WIDGET_INVALIDE;
// 初始化原始父级ID为0
mOriginParent = 0; mOriginParent = 0;
// 初始化版本号为0
mVersion = 0; mVersion = 0;
// 初始化用于存储笔记数据差异值的ContentValues对象
mDiffNoteValues = new ContentValues(); mDiffNoteValues = new ContentValues();
// 初始化与笔记相关的数据列表
mDataList = new ArrayList<SqlData>(); mDataList = new ArrayList<SqlData>();
} }
// 构造函数用于从数据库游标创建SqlNote对象传入上下文对象和游标对象
public SqlNote(Context context, Cursor c) { public SqlNote(Context context, Cursor c) {
// 初始化上下文对象
mContext = context; mContext = context;
// 获取内容提供者解析器
mContentResolver = context.getContentResolver(); mContentResolver = context.getContentResolver();
// 标记为非创建操作(即更新操作)
mIsCreate = false; mIsCreate = false;
// 从游标加载笔记数据到成员变量
loadFromCursor(c); loadFromCursor(c);
// 初始化与笔记相关的数据列表
mDataList = new ArrayList<SqlData>(); mDataList = new ArrayList<SqlData>();
// 如果是笔记类型,则加载数据内容
if (mType == Notes.TYPE_NOTE) if (mType == Notes.TYPE_NOTE)
loadDataContent(); loadDataContent();
// 初始化用于存储笔记数据差异值的ContentValues对象
mDiffNoteValues = new ContentValues(); mDiffNoteValues = new ContentValues();
} }
// 构造函数用于根据笔记ID从数据库创建SqlNote对象传入上下文对象和笔记ID
public SqlNote(Context context, long id) { public SqlNote(Context context, long id) {
// 初始化上下文对象
mContext = context; mContext = context;
// 获取内容提供者解析器
mContentResolver = context.getContentResolver(); mContentResolver = context.getContentResolver();
// 标记为非创建操作(即更新操作)
mIsCreate = false; mIsCreate = false;
// 根据笔记ID从游标加载笔记数据到成员变量
loadFromCursor(id); loadFromCursor(id);
// 初始化与笔记相关的数据列表
mDataList = new ArrayList<SqlData>(); mDataList = new ArrayList<SqlData>();
// 如果是笔记类型,则加载数据内容
if (mType == Notes.TYPE_NOTE) if (mType == Notes.TYPE_NOTE)
loadDataContent(); loadDataContent();
// 初始化用于存储笔记数据差异值的ContentValues对象
mDiffNoteValues = new ContentValues(); mDiffNoteValues = new ContentValues();
} }
// 根据笔记ID从数据库游标加载数据到成员变量的私有方法
private void loadFromCursor(long id) { private void loadFromCursor(long id) {
Cursor c = null; Cursor c = null;
try { try {
// 通过内容提供者解析器查询指定笔记ID的记录
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)",
new String[] { new String[] {
String.valueOf(id) String.valueOf(id)
}, null); }, null);
if (c != null) { if (c!= null) {
// 将游标移动到查询结果的第一条记录(假设只有一条结果)
c.moveToNext(); c.moveToNext();
// 从游标加载笔记数据到成员变量
loadFromCursor(c); loadFromCursor(c);
} else { } else {
Log.w(TAG, "loadFromCursor: cursor = null"); Log.w(TAG, "loadFromCursor: cursor = null");
} }
} finally { } finally {
if (c != null) // 如果游标不为空,则关闭游标以释放资源
if (c!= null)
c.close(); c.close();
} }
} }
// 从数据库游标加载笔记数据到成员变量的私有方法
private void loadFromCursor(Cursor c) { private void loadFromCursor(Cursor c) {
// 从游标获取笔记ID
mId = c.getLong(ID_COLUMN); mId = c.getLong(ID_COLUMN);
// 从游标获取提醒日期
mAlertDate = c.getLong(ALERTED_DATE_COLUMN); mAlertDate = c.getLong(ALERTED_DATE_COLUMN);
// 从游标获取背景颜色ID
mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); mBgColorId = c.getInt(BG_COLOR_ID_COLUMN);
// 从游标获取创建日期
mCreatedDate = c.getLong(CREATED_DATE_COLUMN); mCreatedDate = c.getLong(CREATED_DATE_COLUMN);
// 从游标获取是否有附件标识
mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN);
// 从游标获取修改日期
mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN);
// 从游标获取父级ID
mParentId = c.getLong(PARENT_ID_COLUMN); mParentId = c.getLong(PARENT_ID_COLUMN);
// 从游标获取摘要内容
mSnippet = c.getString(SNIPPET_COLUMN); mSnippet = c.getString(SNIPPET_COLUMN);
// 从游标获取笔记类型
mType = c.getInt(TYPE_COLUMN); mType = c.getInt(TYPE_COLUMN);
// 从游标获取与App Widget相关的ID
mWidgetId = c.getInt(WIDGET_ID_COLUMN); mWidgetId = c.getInt(WIDGET_ID_COLUMN);
// 从游标获取与App Widget相关的类型
mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); mWidgetType = c.getInt(WIDGET_TYPE_COLUMN);
// 从游标获取版本号
mVersion = c.getLong(VERSION_COLUMN); mVersion = c.getLong(VERSION_COLUMN);
} }
// 加载与笔记相关的数据内容的私有方法,仅在笔记类型时调用
private void loadDataContent() { private void loadDataContent() {
Cursor c = null; Cursor c = null;
mDataList.clear(); mDataList.clear();
try { try {
// 通过内容提供者解析器查询与当前笔记ID相关的数据记录
c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA, c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA,
"(note_id=?)", new String[] { "(note_id=?)", new String[] {
String.valueOf(mId) String.valueOf(mId)
}, null); }, null);
if (c != null) { if (c!= null) {
// 如果查询结果数量为0表示笔记没有数据则记录警告日志并返回
if (c.getCount() == 0) { if (c.getCount() == 0) {
Log.w(TAG, "it seems that the note has not data"); Log.w(TAG, "it seems that the note has not data");
return; return;
} }
// 遍历查询结果创建SqlData对象并添加到数据列表中
while (c.moveToNext()) { while (c.moveToNext()) {
SqlData data = new SqlData(mContext, c); SqlData data = new SqlData(mContext, c);
mDataList.add(data); mDataList.add(data);
@ -221,49 +287,56 @@ public class SqlNote {
Log.w(TAG, "loadDataContent: cursor = null"); Log.w(TAG, "loadDataContent: cursor = null");
} }
} finally { } finally {
if (c != null) // 如果游标不为空,则关闭游标以释放资源
if (c!= null)
c.close(); c.close();
} }
} }
// 根据传入的JSONObject设置对象的成员变量根据笔记类型处理不同的属性设置
// 并对数据列表中的SqlData对象进行相应设置返回设置是否成功
public boolean setContent(JSONObject js) { public boolean setContent(JSONObject js) {
try { try {
// 从JSON对象中获取与笔记相关的JSONObject
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
// 如果笔记类型为系统类型,则记录警告日志,因为不能设置系统文件夹
if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
Log.w(TAG, "cannot set system folder"); Log.w(TAG, "cannot set system folder");
} else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
// for folder we can only update the snnipet and type // 如果是文件夹类型,只能更新摘要和类型属性
String snippet = note.has(NoteColumns.SNIPPET) ? note String snippet = note.has(NoteColumns.SNIPPET)? note
.getString(NoteColumns.SNIPPET) : ""; .getString(NoteColumns.SNIPPET) : "";
if (mIsCreate || !mSnippet.equals(snippet)) { if (mIsCreate ||!mSnippet.equals(snippet)) {
mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); mDiffNoteValues.put(NoteColumns.SNIPPET, snippet);
} }
mSnippet = snippet; mSnippet = snippet;
int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) int type = note.has(NoteColumns.TYPE)? note.getInt(NoteColumns.TYPE)
: Notes.TYPE_NOTE; : Notes.TYPE_NOTE;
if (mIsCreate || mType != type) { if (mIsCreate || mType!= type) {
mDiffNoteValues.put(NoteColumns.TYPE, type); mDiffNoteValues.put(NoteColumns.TYPE, type);
} }
mType = type; mType = type;
} else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) {
// 如果是笔记类型
// 从JSON对象中获取数据数组
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID; long id = note.has(NoteColumns.ID)? note.getLong(NoteColumns.ID) : INVALID_ID;
if (mIsCreate || mId != id) { if (mIsCreate || mId!= id) {
mDiffNoteValues.put(NoteColumns.ID, id); mDiffNoteValues.put(NoteColumns.ID, id);
} }
mId = id; mId = id;
long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note long alertDate = note.has(NoteColumns.ALERTED_DATE)? note
.getLong(NoteColumns.ALERTED_DATE) : 0; .getLong(NoteColumns.ALERTED_DATE) : 0;
if (mIsCreate || mAlertDate != alertDate) { if (mIsCreate || mAlertDate!= alertDate) {
mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate);
} }
mAlertDate = alertDate; mAlertDate = alertDate;
int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note int bgColorId = note.has(NoteColumns.BG_COLOR_ID)? note
.getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext);
if (mIsCreate || mBgColorId != bgColorId) { if (mIsCreate || mBgColorId!= bgColorId) {
mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId);
} }
mBgColorId = bgColorId; mBgColorId = bgColorId;
@ -359,147 +432,155 @@ public class SqlNote {
return true; return true;
} }
public JSONObject getContent() { // 将对象的成员变量转换为JSONObject根据笔记类型构建不同结构的JSON对象
try { public JSONObject getContent() {
JSONObject js = new JSONObject(); try {
JSONObject js = new JSONObject();
if (mIsCreate) { if (mIsCreate) {
Log.e(TAG, "it seems that we haven't created this in database yet"); Log.e(TAG, "it seems that we haven't created this in database yet");
return null; return null;
} }
JSONObject note = new JSONObject(); JSONObject note = new JSONObject();
if (mType == Notes.TYPE_NOTE) { if (mType == Notes.TYPE_NOTE) {
note.put(NoteColumns.ID, mId); note.put(NoteColumns.ID, mId);
note.put(NoteColumns.ALERTED_DATE, mAlertDate); note.put(NoteColumns.ALERTED_DATE, mAlertDate);
note.put(NoteColumns.BG_COLOR_ID, mBgColorId); note.put(NoteColumns.BG_COLOR_ID, mBgColorId);
note.put(NoteColumns.CREATED_DATE, mCreatedDate); note.put(NoteColumns.CREATED_DATE, mCreatedDate);
note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment);
note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); note.put(NoteColumns.MODIFIED_DATE, mModifiedDate);
note.put(NoteColumns.PARENT_ID, mParentId); note.put(NoteColumns.PARENT_ID, mParentId);
note.put(NoteColumns.SNIPPET, mSnippet); note.put(NoteColumns.SNIPPET, mSnippet);
note.put(NoteColumns.TYPE, mType); note.put(NoteColumns.TYPE, mType);
note.put(NoteColumns.WIDGET_ID, mWidgetId); note.put(NoteColumns.WIDGET_ID, mWidgetId);
note.put(NoteColumns.WIDGET_TYPE, mWidgetType); note.put(NoteColumns.WIDGET_TYPE, mWidgetType);
note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent);
js.put(GTaskStringUtils.META_HEAD_NOTE, note); js.put(GTaskStringUtils.META_HEAD_NOTE, note);
JSONArray dataArray = new JSONArray(); JSONArray dataArray = new JSONArray();
for (SqlData sqlData : mDataList) { for (SqlData sqlData : mDataList) {
JSONObject data = sqlData.getContent(); JSONObject data = sqlData.getContent();
if (data != null) { if (data!= null) {
dataArray.put(data); dataArray.put(data);
}
} }
js.put(GTaskStringUtils.META_HEAD_DATA, dataArray);
} else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) {
note.put(NoteColumns.ID, mId);
note.put(NoteColumns.TYPE, mType);
note.put(NoteColumns.SNIPPET, mSnippet);
js.put(GTaskStringUtils.META_HEAD_NOTE, note);
} }
js.put(GTaskStringUtils.META_HEAD_DATA, dataArray);
return js; } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) {
} catch (JSONException e) { note.put(NoteColumns.ID, mId);
Log.e(TAG, e.toString()); note.put(NoteColumns.TYPE, mType);
e.printStackTrace(); note.put(NoteColumns.SNIPPET, mSnippet);
js.put(GTaskStringUtils.META_HEAD_NOTE, note);
} }
return null;
}
public void setParentId(long id) { return js;
mParentId = id; } catch (JSONException e) {
mDiffNoteValues.put(NoteColumns.PARENT_ID, id); Log.e(TAG, e.toString());
} e.printStackTrace();
public void setGtaskId(String gid) {
mDiffNoteValues.put(NoteColumns.GTASK_ID, gid);
}
public void setSyncId(long syncId) {
mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId);
} }
return null;
}
public void resetLocalModified() { // 设置笔记的父级ID并将其添加到用于更新的数据差异值ContentValues中
mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); public void setParentId(long id) {
} mParentId = id;
mDiffNoteValues.put(NoteColumns.PARENT_ID, id);
}
public long getId() { // 设置笔记的Gtask ID将其添加到用于更新的数据差异值ContentValues中
return mId; public void setGtaskId(String gid) {
} mDiffNoteValues.put(NoteColumns.GTASK_ID, gid);
}
public long getParentId() { // 设置笔记的同步ID将其添加到用于更新的数据差异值ContentValues中
return mParentId; public void setSyncId(long syncId) {
} mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId);
}
public String getSnippet() { // 将本地修改标记重置为0将其添加到用于更新的数据差异值ContentValues中
return mSnippet; public void resetLocalModified() {
} mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0);
}
// 返回笔记的ID
public long getId() {
return mId;
}
// 返回笔记的父级ID
public long getParentId() {
return mParentId;
}
public boolean isNoteType() { // 返回笔记的摘要内容
return mType == Notes.TYPE_NOTE; public String getSnippet() {
} return mSnippet;
}
// 如果笔记类型为Notes.TYPE_NOTE则返回true否则返回false
public boolean isNoteType() {
return mType == Notes.TYPE_NOTE;
}
public void commit(boolean validateVersion) { // 将笔记的更改提交到数据库,根据是否是创建操作以及是否验证版本进行不同的操作
if (mIsCreate) { public void commit(boolean validateVersion) {
if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { if (mIsCreate) {
mDiffNoteValues.remove(NoteColumns.ID); // 如果是创建操作
} if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) {
mDiffNoteValues.remove(NoteColumns.ID);
}
Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues);
try { try {
mId = Long.valueOf(uri.getPathSegments().get(1)); mId = Long.valueOf(uri.getPathSegments().get(1));
} catch (NumberFormatException e) { } catch (NumberFormatException e) {
Log.e(TAG, "Get note id error :" + e.toString()); Log.e(TAG, "Get note id error :" + e.toString());
throw new ActionFailureException("create note failed"); throw new ActionFailureException("create note failed");
} }
if (mId == 0) { if (mId == 0) {
throw new IllegalStateException("Create thread id failed"); throw new IllegalStateException("Create thread id failed");
} }
if (mType == Notes.TYPE_NOTE) { if (mType == Notes.TYPE_NOTE) {
for (SqlData sqlData : mDataList) { for (SqlData sqlData : mDataList) {
sqlData.commit(mId, false, -1); sqlData.commit(mId, false, -1);
}
} }
} else { }
if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) { } else {
Log.e(TAG, "No such note"); // 如果是更新操作
throw new IllegalStateException("Try to update note with invalid id"); if (mId <= 0 && mId!= Notes.ID_ROOT_FOLDER && mId!= Notes.ID_CALL_RECORD_FOLDER) {
} Log.e(TAG, "No such note");
if (mDiffNoteValues.size() > 0) { throw new IllegalStateException("Try to update note with invalid id");
mVersion ++; }
int result = 0; if (mDiffNoteValues.size() > 0) {
if (!validateVersion) { mVersion++;
result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" int result = 0;
+ NoteColumns.ID + "=?)", new String[] { if (!validateVersion) {
result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "("
+ NoteColumns.ID + "=?)", new String[] {
String.valueOf(mId) String.valueOf(mId)
}); });
} else { } else {
result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "("
+ NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)",
new String[] { new String[] {
String.valueOf(mId), String.valueOf(mVersion) String.valueOf(mId), String.valueOf(mVersion)
}); });
}
if (result == 0) {
Log.w(TAG, "there is no update. maybe user updates note when syncing");
}
} }
if (result == 0) {
Log.w(TAG, "there is no update. maybe user updates note when syncing");
}
}
if (mType == Notes.TYPE_NOTE) { if (mType == Notes.TYPE_NOTE) {
for (SqlData sqlData : mDataList) { for (SqlData sqlData : mDataList) {
sqlData.commit(mId, validateVersion, mVersion); sqlData.commit(mId, validateVersion, mVersion);
}
} }
} }
}
// refresh local info // 重新从数据库加载笔记数据,以刷新本地信息
loadFromCursor(mId); loadFromCursor(mId);
if (mType == Notes.TYPE_NOTE) if (mType == Notes.TYPE_NOTE)
loadDataContent(); loadDataContent();
mDiffNoteValues.clear(); mDiffNoteValues.clear();
mIsCreate = false; mIsCreate = false;
} }
}

@ -13,7 +13,6 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package net.micode.notes.gtask.data; package net.micode.notes.gtask.data;
import android.database.Cursor; import android.database.Cursor;
@ -31,20 +30,22 @@ import org.json.JSONArray;
import org.json.JSONException; import org.json.JSONException;
import org.json.JSONObject; import org.json.JSONObject;
// Task类表示一个任务继承自Node类
public class Task extends Node { public class Task extends Node {
private static final String TAG = Task.class.getSimpleName(); private static final String TAG = Task.class.getSimpleName();
// 任务是否完成的标志
private boolean mCompleted; private boolean mCompleted;
// 任务的备注信息
private String mNotes; private String mNotes;
// 任务的元信息以JSONObject形式存储
private JSONObject mMetaInfo; private JSONObject mMetaInfo;
// 任务的前一个兄弟任务
private Task mPriorSibling; private Task mPriorSibling;
// 任务的父任务以TaskList形式
private TaskList mParent; private TaskList mParent;
// 构造函数,初始化任务对象的默认属性
public Task() { public Task() {
super(); super();
mCompleted = false; mCompleted = false;
@ -54,116 +55,110 @@ public class Task extends Node {
mMetaInfo = null; mMetaInfo = null;
} }
// 根据给定的actionId创建一个用于表示创建任务动作的JSONObject
public JSONObject getCreateAction(int actionId) { public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject(); JSONObject js = new JSONObject();
try { try {
// action_type // 设置动作类型为创建任务
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
// 设置动作ID
// action_id
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// 设置任务在父任务中的索引
// index
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this));
// entity_delta // 创建表示任务实体信息的JSONObject
JSONObject entity = new JSONObject(); JSONObject entity = new JSONObject();
// 设置任务名称
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
// 设置创建者ID这里为null
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
// 设置实体类型为任务类型
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_TASK); GTaskStringUtils.GTASK_JSON_TYPE_TASK);
if (getNotes() != null) { // 如果有备注信息,设置备注信息
if (getNotes()!= null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
} }
// 将任务实体信息添加到表示动作的JSONObject中
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
// parent_id // 设置父任务的ID
js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
// 设置目标父类型为组类型
// dest_parent_type
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP); GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
// 设置列表ID为父任务的Gid
// list_id
js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
// 如果有前一个兄弟任务设置其ID
// prior_sibling_id if (mPriorSibling!= null) {
if (mPriorSibling != null) {
js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());
} }
} catch (JSONException e) { } catch (JSONException e) {
Log.e(TAG, e.toString()); Log.e(TAG, e.toString());
e.printStackTrace(); e.printStackTrace();
throw new ActionFailureException("fail to generate task-create jsonobject"); throw new ActionFailureException("fail to generate task - create jsonobject");
} }
return js; return js;
} }
// 根据给定的actionId创建一个用于表示更新任务动作的JSONObject
public JSONObject getUpdateAction(int actionId) { public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject(); JSONObject js = new JSONObject();
try { try {
// action_type // 设置动作类型为更新任务
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
// 设置动作ID
// action_id
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// 设置任务的Gid唯一标识符
// id
js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
// entity_delta // 创建表示任务实体信息的JSONObject
JSONObject entity = new JSONObject(); JSONObject entity = new JSONObject();
// 设置任务名称
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
if (getNotes() != null) { // 如果有备注信息,设置备注信息
if (getNotes()!= null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
} }
// 设置任务是否被删除的标志
entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
// 将任务实体信息添加到表示动作的JSONObject中
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) { } catch (JSONException e) {
Log.e(TAG, e.toString()); Log.e(TAG, e.toString());
e.printStackTrace(); e.printStackTrace();
throw new ActionFailureException("fail to generate task-update jsonobject"); throw new ActionFailureException("fail to generate task - update jsonobject");
} }
return js; return js;
} }
// 根据远程的JSONObject设置任务内容
public void setContentByRemoteJSON(JSONObject js) { public void setContentByRemoteJSON(JSONObject js) {
if (js != null) { if (js!= null) {
try { try {
// id // 如果JSONObject包含任务的Gid设置任务的Gid
if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
} }
// 如果包含最后修改时间,设置最后修改时间
// last_modified
if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
} }
// 如果包含任务名称,设置任务名称
// name
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
} }
// 如果包含备注信息,设置备注信息
// notes
if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) { if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) {
setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES));
} }
// 如果包含任务是否被删除的标志,设置该标志
// deleted
if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) { if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) {
setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED));
} }
// 如果包含任务是否完成的标志,设置该标志
// completed
if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) { if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) {
setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED));
} }
@ -175,21 +170,23 @@ public class Task extends Node {
} }
} }
// 根据本地的JSONObject设置任务内容
public void setContentByLocalJSON(JSONObject js) { public void setContentByLocalJSON(JSONObject js) {
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) if (js == null ||!js.has(GTaskStringUtils.META_HEAD_NOTE)
|| !js.has(GTaskStringUtils.META_HEAD_DATA)) { ||!js.has(GTaskStringUtils.META_HEAD_DATA)) {
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
} }
try { try {
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) { // 如果笔记类型不是Notes.TYPE_NOTE打印错误日志并返回
if (note.getInt(NoteColumns.TYPE)!= Notes.TYPE_NOTE) {
Log.e(TAG, "invalid type"); Log.e(TAG, "invalid type");
return; return;
} }
// 遍历数据数组找到类型为NOTE的数据设置任务名称
for (int i = 0; i < dataArray.length(); i++) { for (int i = 0; i < dataArray.length(); i++) {
JSONObject data = dataArray.getJSONObject(i); JSONObject data = dataArray.getJSONObject(i);
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
@ -197,23 +194,22 @@ public class Task extends Node {
break; break;
} }
} }
} catch (JSONException e) { } catch (JSONException e) {
Log.e(TAG, e.toString()); Log.e(TAG, e.toString());
e.printStackTrace(); e.printStackTrace();
} }
} }
// 根据任务内容生成一个本地的JSONObject
public JSONObject getLocalJSONFromContent() { public JSONObject getLocalJSONFromContent() {
String name = getName(); String name = getName();
try { try {
if (mMetaInfo == null) { if (mMetaInfo == null) {
// new task created from web // 如果是从网络创建的新任务
if (name == null) { if (name == null) {
Log.w(TAG, "the note seems to be an empty one"); Log.w(TAG, "the note seems to be an empty one");
return null; return null;
} }
JSONObject js = new JSONObject(); JSONObject js = new JSONObject();
JSONObject note = new JSONObject(); JSONObject note = new JSONObject();
JSONArray dataArray = new JSONArray(); JSONArray dataArray = new JSONArray();
@ -225,7 +221,7 @@ public class Task extends Node {
js.put(GTaskStringUtils.META_HEAD_NOTE, note); js.put(GTaskStringUtils.META_HEAD_NOTE, note);
return js; return js;
} else { } else {
// synced task // 如果是已同步的任务
JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA); JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
@ -247,8 +243,9 @@ public class Task extends Node {
} }
} }
// 设置任务的元信息
public void setMetaInfo(MetaData metaData) { public void setMetaInfo(MetaData metaData) {
if (metaData != null && metaData.getNotes() != null) { if (metaData!= null && metaData.getNotes()!= null) {
try { try {
mMetaInfo = new JSONObject(metaData.getNotes()); mMetaInfo = new JSONObject(metaData.getNotes());
} catch (JSONException e) { } catch (JSONException e) {
@ -258,10 +255,11 @@ public class Task extends Node {
} }
} }
// 根据给定的游标Cursor确定同步动作类型
public int getSyncAction(Cursor c) { public int getSyncAction(Cursor c) {
try { try {
JSONObject noteInfo = null; JSONObject noteInfo = null;
if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) { if (mMetaInfo!= null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) {
noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
} }
@ -275,29 +273,29 @@ public class Task extends Node {
return SYNC_ACTION_UPDATE_LOCAL; return SYNC_ACTION_UPDATE_LOCAL;
} }
// validate the note id now // 验证笔记ID是否匹配
if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.ID)) { if (c.getLong(SqlNote.ID_COLUMN)!= noteInfo.getLong(NoteColumns.ID)) {
Log.w(TAG, "note id doesn't match"); Log.w(TAG, "note id doesn't match");
return SYNC_ACTION_UPDATE_LOCAL; return SYNC_ACTION_UPDATE_LOCAL;
} }
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
// there is no local update // 如果本地没有更新
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// no update both side // 两边都没有更新
return SYNC_ACTION_NONE; return SYNC_ACTION_NONE;
} else { } else {
// apply remote to local // 将远程更新应用到本地
return SYNC_ACTION_UPDATE_LOCAL; return SYNC_ACTION_UPDATE_LOCAL;
} }
} else { } else {
// validate gtask id // 验证gtask ID是否匹配
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
Log.e(TAG, "gtask id doesn't match"); Log.e(TAG, "gtask id doesn't match");
return SYNC_ACTION_ERROR; return SYNC_ACTION_ERROR;
} }
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// local modification only // 只有本地修改
return SYNC_ACTION_UPDATE_REMOTE; return SYNC_ACTION_UPDATE_REMOTE;
} else { } else {
return SYNC_ACTION_UPDATE_CONFLICT; return SYNC_ACTION_UPDATE_CONFLICT;
@ -311,41 +309,49 @@ public class Task extends Node {
return SYNC_ACTION_ERROR; return SYNC_ACTION_ERROR;
} }
// 判断任务是否值得保存(有元信息或者有名称或者有备注信息)
public boolean isWorthSaving() { public boolean isWorthSaving() {
return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) return mMetaInfo!= null || (getName()!= null && getName().trim().length() > 0)
|| (getNotes() != null && getNotes().trim().length() > 0); || (getNotes()!= null && getNotes().trim().length() > 0);
} }
// 设置任务是否完成
public void setCompleted(boolean completed) { public void setCompleted(boolean completed) {
this.mCompleted = completed; this.mCompleted = completed;
} }
// 设置任务的备注信息
public void setNotes(String notes) { public void setNotes(String notes) {
this.mNotes = notes; this.mNotes = notes;
} }
// 设置任务的前一个兄弟任务
public void setPriorSibling(Task priorSibling) { public void setPriorSibling(Task priorSibling) {
this.mPriorSibling = priorSibling; this.mPriorSibling = priorSibling;
} }
// 设置任务的父任务
public void setParent(TaskList parent) { public void setParent(TaskList parent) {
this.mParent = parent; this.mParent = parent;
} }
// 获取任务是否完成的标志
public boolean getCompleted() { public boolean getCompleted() {
return this.mCompleted; return this.mCompleted;
} }
// 获取任务的备注信息
public String getNotes() { public String getNotes() {
return this.mNotes; return this.mNotes;
} }
// 获取任务的前一个兄弟任务
public Task getPriorSibling() { public Task getPriorSibling() {
return this.mPriorSibling; return this.mPriorSibling;
} }
// 获取任务的父任务
public TaskList getParent() { public TaskList getParent() {
return this.mParent; return this.mParent;
} }
}
}

@ -13,143 +13,186 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package net.micode.notes.gtask.data; package net.micode.notes.gtask.data;
import android.database.Cursor; import android.database.Cursor;
import android.text.TextUtils;
import android.util.Log; import android.util.Log;
import net.micode.notes.data.Notes; import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.DataConstants;
import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.gtask.exception.ActionFailureException; import net.micode.notes.gtask.exception.ActionFailureException;
import net.micode.notes.tool.GTaskStringUtils; import net.micode.notes.tool.GTaskStringUtils;
import org.json.JSONArray;
import org.json.JSONException; import org.json.JSONException;
import org.json.JSONObject; import org.json.JSONObject;
import java.util.ArrayList; // Task类表示一个任务继承自Node类
public class Task extends Node {
private static final String TAG = Task.class.getSimpleName();
public class TaskList extends Node {
private static final String TAG = TaskList.class.getSimpleName(); // 任务是否完成的标志
private boolean mCompleted;
private int mIndex; // 任务的备注信息
private String mNotes;
private ArrayList<Task> mChildren; // 任务的元信息以JSONObject形式存储
private JSONObject mMetaInfo;
public TaskList() { // 任务的前一个兄弟任务
private Task mPriorSibling;
// 任务的父任务以TaskList形式
private TaskList mParent;
// 构造函数,初始化任务对象的默认属性
public Task() {
super(); super();
mChildren = new ArrayList<Task>(); mCompleted = false;
mIndex = 1; mNotes = null;
mPriorSibling = null;
mParent = null;
mMetaInfo = null;
} }
// 根据给定的actionId创建一个用于表示创建任务动作的JSONObject
public JSONObject getCreateAction(int actionId) { public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject(); JSONObject js = new JSONObject();
try { try {
// action_type // 设置动作类型为创建任务
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
// 设置动作ID
// action_id
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// 设置任务在父任务中的索引
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this));
// index // 创建表示任务实体信息的JSONObject
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex);
// entity_delta
JSONObject entity = new JSONObject(); JSONObject entity = new JSONObject();
// 设置任务名称
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
// 设置创建者ID这里为null
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
// 设置实体类型为任务类型
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP); GTaskStringUtils.GTASK_JSON_TYPE_TASK);
// 如果有备注信息,设置备注信息
if (getNotes()!= null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
}
// 将任务实体信息添加到表示动作的JSONObject中
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
// 设置父任务的ID
js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
// 设置目标父类型为组类型
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
// 设置列表ID为父任务的Gid
js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
// 如果有前一个兄弟任务设置其ID
if (mPriorSibling!= null) {
js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());
}
} catch (JSONException e) { } catch (JSONException e) {
Log.e(TAG, e.toString()); Log.e(TAG, e.toString());
e.printStackTrace(); e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-create jsonobject"); throw new ActionFailureException("fail to generate task - create jsonobject");
} }
return js; return js;
} }
// 根据给定的actionId创建一个用于表示更新任务动作的JSONObject
public JSONObject getUpdateAction(int actionId) { public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject(); JSONObject js = new JSONObject();
try { try {
// action_type // 设置动作类型为更新任务
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
// 设置动作ID
// action_id
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// 设置任务的Gid唯一标识符
// id
js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
// entity_delta // 创建表示任务实体信息的JSONObject
JSONObject entity = new JSONObject(); JSONObject entity = new JSONObject();
// 设置任务名称
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
// 如果有备注信息,设置备注信息
if (getNotes()!= null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
}
// 设置任务是否被删除的标志
entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
// 将任务实体信息添加到表示动作的JSONObject中
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) { } catch (JSONException e) {
Log.e(TAG, e.toString()); Log.e(TAG, e.toString());
e.printStackTrace(); e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-update jsonobject"); throw new ActionFailureException("fail to generate task - update jsonobject");
} }
return js; return js;
} }
// 根据远程的JSONObject设置任务内容
public void setContentByRemoteJSON(JSONObject js) { public void setContentByRemoteJSON(JSONObject js) {
if (js != null) { if (js!= null) {
try { try {
// id // 如果JSONObject包含任务的Gid设置任务的Gid
if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
} }
// 如果包含最后修改时间,设置最后修改时间
// last_modified
if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
} }
// 如果包含任务名称,设置任务名称
// name
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
} }
// 如果包含备注信息,设置备注信息
if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) {
setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES));
}
// 如果包含任务是否被删除的标志,设置该标志
if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) {
setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED));
}
// 如果包含任务是否完成的标志,设置该标志
if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) {
setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED));
}
} catch (JSONException e) { } catch (JSONException e) {
Log.e(TAG, e.toString()); Log.e(TAG, e.toString());
e.printStackTrace(); e.printStackTrace();
throw new ActionFailureException("fail to get tasklist content from jsonobject"); throw new ActionFailureException("fail to get task content from jsonobject");
} }
} }
} }
// 根据本地的JSONObject设置任务内容
public void setContentByLocalJSON(JSONObject js) { public void setContentByLocalJSON(JSONObject js) {
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { if (js == null ||!js.has(GTaskStringUtils.META_HEAD_NOTE)
||!js.has(GTaskStringUtils.META_HEAD_DATA)) {
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
} }
try { try {
JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
String name = folder.getString(NoteColumns.SNIPPET); // 如果笔记类型不是Notes.TYPE_NOTE打印错误日志并返回
setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name); if (note.getInt(NoteColumns.TYPE)!= Notes.TYPE_NOTE) {
} else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { Log.e(TAG, "invalid type");
if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER) return;
setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT); }
else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER)
setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX // 遍历数据数组找到类型为NOTE的数据设置任务名称
+ GTaskStringUtils.FOLDER_CALL_NOTE); for (int i = 0; i < dataArray.length(); i++) {
else JSONObject data = dataArray.getJSONObject(i);
Log.e(TAG, "invalid system folder"); if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
} else { setName(data.getString(DataColumns.CONTENT));
Log.e(TAG, "error type"); break;
}
} }
} catch (JSONException e) { } catch (JSONException e) {
Log.e(TAG, e.toString()); Log.e(TAG, e.toString());
@ -157,25 +200,42 @@ public class TaskList extends Node {
} }
} }
// 根据任务内容生成一个本地的JSONObject
public JSONObject getLocalJSONFromContent() { public JSONObject getLocalJSONFromContent() {
String name = getName();
try { try {
JSONObject js = new JSONObject(); if (mMetaInfo == null) {
JSONObject folder = new JSONObject(); // 如果是从网络创建的新任务
if (name == null) {
String folderName = getName(); Log.w(TAG, "the note seems to be an empty one");
if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) return null;
folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), }
folderName.length()); JSONObject js = new JSONObject();
folder.put(NoteColumns.SNIPPET, folderName); JSONObject note = new JSONObject();
if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT) JSONArray dataArray = new JSONArray();
|| folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE)) JSONObject data = new JSONObject();
folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); data.put(DataColumns.CONTENT, name);
else dataArray.put(data);
folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); js.put(GTaskStringUtils.META_HEAD_DATA, dataArray);
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
js.put(GTaskStringUtils.META_HEAD_NOTE, folder); js.put(GTaskStringUtils.META_HEAD_NOTE, note);
return js;
return js; } else {
// 如果是已同步的任务
JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
for (int i = 0; i < dataArray.length(); i++) {
JSONObject data = dataArray.getJSONObject(i);
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
data.put(DataColumns.CONTENT, getName());
break;
}
}
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
return mMetaInfo;
}
} catch (JSONException e) { } catch (JSONException e) {
Log.e(TAG, e.toString()); Log.e(TAG, e.toString());
e.printStackTrace(); e.printStackTrace();
@ -183,29 +243,62 @@ public class TaskList extends Node {
} }
} }
// 设置任务的元信息
public void setMetaInfo(MetaData metaData) {
if (metaData!= null && metaData.getNotes()!= null) {
try {
mMetaInfo = new JSONObject(metaData.getNotes());
} catch (JSONException e) {
Log.w(TAG, e.toString());
mMetaInfo = null;
}
}
}
// 根据给定的游标Cursor确定同步动作类型
public int getSyncAction(Cursor c) { public int getSyncAction(Cursor c) {
try { try {
JSONObject noteInfo = null;
if (mMetaInfo!= null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) {
noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
}
if (noteInfo == null) {
Log.w(TAG, "it seems that note meta has been deleted");
return SYNC_ACTION_UPDATE_REMOTE;
}
if (!noteInfo.has(NoteColumns.ID)) {
Log.w(TAG, "remote note id seems to be deleted");
return SYNC_ACTION_UPDATE_LOCAL;
}
// 验证笔记ID是否匹配
if (c.getLong(SqlNote.ID_COLUMN)!= noteInfo.getLong(NoteColumns.ID)) {
Log.w(TAG, "note id doesn't match");
return SYNC_ACTION_UPDATE_LOCAL;
}
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
// there is no local update // 如果本地没有更新
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// no update both side // 两边都没有更新
return SYNC_ACTION_NONE; return SYNC_ACTION_NONE;
} else { } else {
// apply remote to local // 将远程更新应用到本地
return SYNC_ACTION_UPDATE_LOCAL; return SYNC_ACTION_UPDATE_LOCAL;
} }
} else { } else {
// validate gtask id // 验证gtask ID是否匹配
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
Log.e(TAG, "gtask id doesn't match"); Log.e(TAG, "gtask id doesn't match");
return SYNC_ACTION_ERROR; return SYNC_ACTION_ERROR;
} }
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// local modification only // 只有本地修改
return SYNC_ACTION_UPDATE_REMOTE; return SYNC_ACTION_UPDATE_REMOTE;
} else { } else {
// for folder conflicts, just apply local modification return SYNC_ACTION_UPDATE_CONFLICT;
return SYNC_ACTION_UPDATE_REMOTE;
} }
} }
} catch (Exception e) { } catch (Exception e) {
@ -216,128 +309,49 @@ public class TaskList extends Node {
return SYNC_ACTION_ERROR; return SYNC_ACTION_ERROR;
} }
public int getChildTaskCount() { // 判断任务是否值得保存(有元信息或者有名称或者有备注信息)
return mChildren.size(); public boolean isWorthSaving() {
} return mMetaInfo!= null || (getName()!= null && getName().trim().length() > 0)
|| (getNotes()!= null && getNotes().trim().length() > 0);
public boolean addChildTask(Task task) {
boolean ret = false;
if (task != null && !mChildren.contains(task)) {
ret = mChildren.add(task);
if (ret) {
// need to set prior sibling and parent
task.setPriorSibling(mChildren.isEmpty() ? null : mChildren
.get(mChildren.size() - 1));
task.setParent(this);
}
}
return ret;
}
public boolean addChildTask(Task task, int index) {
if (index < 0 || index > mChildren.size()) {
Log.e(TAG, "add child task: invalid index");
return false;
}
int pos = mChildren.indexOf(task);
if (task != null && pos == -1) {
mChildren.add(index, task);
// update the task list
Task preTask = null;
Task afterTask = null;
if (index != 0)
preTask = mChildren.get(index - 1);
if (index != mChildren.size() - 1)
afterTask = mChildren.get(index + 1);
task.setPriorSibling(preTask);
if (afterTask != null)
afterTask.setPriorSibling(task);
}
return true;
} }
public boolean removeChildTask(Task task) { // 设置任务是否完成
boolean ret = false; public void setCompleted(boolean completed) {
int index = mChildren.indexOf(task); this.mCompleted = completed;
if (index != -1) {
ret = mChildren.remove(task);
if (ret) {
// reset prior sibling and parent
task.setPriorSibling(null);
task.setParent(null);
// update the task list
if (index != mChildren.size()) {
mChildren.get(index).setPriorSibling(
index == 0 ? null : mChildren.get(index - 1));
}
}
}
return ret;
} }
public boolean moveChildTask(Task task, int index) { // 设置任务的备注信息
public void setNotes(String notes) {
if (index < 0 || index >= mChildren.size()) { this.mNotes = notes;
Log.e(TAG, "move child task: invalid index");
return false;
}
int pos = mChildren.indexOf(task);
if (pos == -1) {
Log.e(TAG, "move child task: the task should in the list");
return false;
}
if (pos == index)
return true;
return (removeChildTask(task) && addChildTask(task, index));
} }
public Task findChildTaskByGid(String gid) { // 设置任务的前一个兄弟任务
for (int i = 0; i < mChildren.size(); i++) { public void setPriorSibling(Task priorSibling) {
Task t = mChildren.get(i); this.mPriorSibling = priorSibling;
if (t.getGid().equals(gid)) {
return t;
}
}
return null;
} }
public int getChildTaskIndex(Task task) { // 设置任务的父任务
return mChildren.indexOf(task); public void setParent(TaskList parent) {
this.mParent = parent;
} }
public Task getChildTaskByIndex(int index) { // 获取任务是否完成的标志
if (index < 0 || index >= mChildren.size()) { public boolean getCompleted() {
Log.e(TAG, "getTaskByIndex: invalid index"); return this.mCompleted;
return null;
}
return mChildren.get(index);
}
public Task getChilTaskByGid(String gid) {
for (Task task : mChildren) {
if (task.getGid().equals(gid))
return task;
}
return null;
} }
public ArrayList<Task> getChildTaskList() { // 获取任务的备注信息
return this.mChildren; public String getNotes() {
return this.mNotes;
} }
public void setIndex(int index) { // 获取任务的前一个兄弟任务
this.mIndex = index; public Task getPriorSibling() {
return this.mPriorSibling;
} }
public int getIndex() { // 获取任务的父任务
return this.mIndex; public TaskList getParent() {
return this.mParent;
} }
} }
Loading…
Cancel
Save