From 88d5b2849d051d4518a69f30c0fd848602e6b6eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=B0=AD=E6=B7=91=E6=B6=B5?= <1508386176@qq.com> Date: Fri, 6 Dec 2024 21:18:51 +0800 Subject: [PATCH] Signed-off-by: --- MetaData.java | 115 ++++++++++ Node.java | 158 +++++++++++++ SqlData.java | 243 ++++++++++++++++++++ SqlNote.java | 618 ++++++++++++++++++++++++++++++++++++++++++++++++++ Task.java | 454 ++++++++++++++++++++++++++++++++++++ TaskList.java | 465 +++++++++++++++++++++++++++++++++++++ 6 files changed, 2053 insertions(+) create mode 100644 MetaData.java create mode 100644 Node.java create mode 100644 SqlData.java create mode 100644 SqlNote.java create mode 100644 Task.java create mode 100644 TaskList.java diff --git a/MetaData.java b/MetaData.java new file mode 100644 index 0000000..1f73277 --- /dev/null +++ b/MetaData.java @@ -0,0 +1,115 @@ +/* + * 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 android.util.Log; + +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONException; +import org.json.JSONObject; + +/* + *MetaData 类继承自 Task 类，用于处理与 Google Task 相关的元数据。 + * 该类主要用于存储和获取与 Google Task 相关的元数据信息。 + */ +public class MetaData extends Task { + private final static String TAG = MetaData.class.getSimpleName(); + + private String mRelatedGid = null; // 相关 Google Task 的 ID +/* + * 设置元数据信息。 + * 该方法用于将 Google Task 的 ID 和元数据信息存储到任务的备注字段中。 + * @param gid Google Task 的 ID。 + * @param metaInfo 元数据信息的 JSON 对象。 + */ + public void setMeta(String gid, JSONObject metaInfo) { + try { + metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); // 将 Google Task 的 ID 添加到元数据信息中 + } catch (JSONException e) { + Log.e(TAG, "failed to put related gid"); // 记录日志，添加失败 + } + setNotes(metaInfo.toString()); // 将元数据信息存储到任务的备注字段中 + setName(GTaskStringUtils.META_NOTE_NAME); // 设置任务的名称为元数据名称 + } +/* + * 获取相关 Google Task 的 ID。 + * @return 返回相关 Google Task 的 ID。 + */ + public String getRelatedGid() { + return mRelatedGid; + } +/* + * 判断任务是否值得保存。 + * 该方法用于判断任务是否包含有效的备注信息。 + * @return 如果任务包含有效的备注信息，则返回 true，否则返回 false。 + */ + @Override + public boolean isWorthSaving() { + return getNotes() != null; + } +/* + * 根据远程 JSON 对象设置任务内容。 + * 该方法用于从远程 JSON 对象中提取元数据信息，并设置相关 Google Task 的 ID。 + * @param js 远程 JSON 对象。 + */ + @Override + public void setContentByRemoteJSON(JSONObject js) { + super.setContentByRemoteJSON(js); // 调用父类方法设置任务内容 + if (getNotes() != null) { + try { + JSONObject metaInfo = new JSONObject(getNotes().trim()); // 解析备注字段中的元数据信息 + mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); // 获取相关 Google Task 的 ID + } catch (JSONException e) { + Log.w(TAG, "failed to get related gid"); // 记录日志，获取失败 + mRelatedGid = null; + } + } + } +/* + * 根据本地 JSON 对象设置任务内容。 + * 该方法不应被调用，因为元数据任务不应从本地 JSON 对象中设置内容。 + * @param js 本地 JSON 对象。 + */ + @Override + public void setContentByLocalJSON(JSONObject js) { + // this function should not be called + // 该方法不应被调用 + throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + } +/* + * 从任务内容中获取本地 JSON 对象。 + * 该方法不应被调用，因为元数据任务不应生成本地 JSON 对象。 + * @return 抛出异常，表示该方法不应被调用。 + */ + @Override + public JSONObject getLocalJSONFromContent() { + throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + } +/* + * 获取同步操作。 + * 该方法不应被调用，因为元数据任务不应进行同步操作。 + * @param c 数据库游标。 + * @return 抛出异常，表示该方法不应被调用。 + */ + @Override + public int getSyncAction(Cursor c) { + throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + } + +} diff --git a/Node.java b/Node.java new file mode 100644 index 0000000..670361c --- /dev/null +++ b/Node.java @@ -0,0 +1,158 @@ +/* + * 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 类是一个抽象类，用于表示 Google Task 中的节点。 + * 该类定义了节点的基本属性和操作，并提供了抽象方法供子类实现。 + */ +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; // Google Task 的 ID + + private String mName; // 节点名称 + + private long mLastModified; // 最后修改时间 + + private boolean mDeleted; // 是否已删除 +/* + * 构造函数，初始化节点属性。 + */ + public Node() { + mGid = null; + mName = ""; + mLastModified = 0; + mDeleted = false; + } +/* + * 获取创建操作的 JSON 对象。 + * 该方法用于生成创建操作的 JSON 对象。 + * @param actionId 操作 ID。 + * @return 返回创建操作的 JSON 对象。 + */ + public abstract JSONObject getCreateAction(int actionId); +/* + * 获取更新操作的 JSON 对象。 + * 该方法用于生成更新操作的 JSON 对象。 + * @param actionId 操作 ID。 + * @return 返回更新操作的 JSON 对象。 + */ + public abstract JSONObject getUpdateAction(int actionId); +/* + * 根据远程 JSON 对象设置节点内容。 + * 该方法用于从远程 JSON 对象中提取节点内容。 + * @param js 远程 JSON 对象。 + */ + public abstract void setContentByRemoteJSON(JSONObject js); +/* + * 根据本地 JSON 对象设置节点内容。 + * 该方法用于从本地 JSON 对象中提取节点内容。 + * @param js 本地 JSON 对象。 + */ + public abstract void setContentByLocalJSON(JSONObject js); +/* + *从节点内容中获取本地 JSON 对象。 + * 该方法用于将节点内容转换为本地 JSON 对象。 + * @return 返回本地 JSON 对象。 + */ + public abstract JSONObject getLocalJSONFromContent(); +/* + * 获取同步操作。 + * 该方法用于根据数据库游标获取同步操作。 + * @param c 数据库游标。 + * @return 返回同步操作。 + */ + public abstract int getSyncAction(Cursor c); +/* + * 设置 Google Task 的 ID。 + * @param gid Google Task 的 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 Task 的 ID + * @return 返回 Google Task 的 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; + } + +} diff --git a/SqlData.java b/SqlData.java new file mode 100644 index 0000000..4cdeb85 --- /dev/null +++ b/SqlData.java @@ -0,0 +1,243 @@ +/* + * 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.content.ContentResolver; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +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.NotesDatabaseHelper.TABLE; +import net.micode.notes.gtask.exception.ActionFailureException; + +import org.json.JSONException; +import org.json.JSONObject; + +/* + * SqlData 类用于处理与数据库相关的数据操作。 + * 该类主要用于加载、设置、获取和提交数据。 + */ +public class SqlData { + private static final String TAG = SqlData.class.getSimpleName(); + + private static final int INVALID_ID = -99999; // 无效的 ID + // 数据表的投影字段 + public static final String[] PROJECTION_DATA = new String[] { + DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, + DataColumns.DATA3 + }; + // 数据表的列索引 + public static final int DATA_ID_COLUMN = 0; + + public static final int DATA_MIME_TYPE_COLUMN = 1; + + public static final int DATA_CONTENT_COLUMN = 2; + + public static final int DATA_CONTENT_DATA_1_COLUMN = 3; + + public static final int DATA_CONTENT_DATA_3_COLUMN = 4; + + private ContentResolver mContentResolver; // 内容解析器 + + private boolean mIsCreate; // 是否为创建操作 + + private long mDataId; // 数据 ID + + private String mDataMimeType; // 数据 MIME 类型 + + private String mDataContent; // 数据内容 + + private long mDataContentData1; // 数据内容数据 1 + + private String mDataContentData3; // 数据内容数据 3 + + private ContentValues mDiffDataValues; // 差异数据值 +/* + * 构造函数，用于创建新的数据对象。 + * 该构造函数初始化数据对象的各个属性，并设置为创建操作。 + * @param context 应用程序上下文。 + */ + public SqlData(Context context) { + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = true; // 设置为创建操作 + mDataId = INVALID_ID; // 初始化数据 ID 为无效值 + mDataMimeType = DataConstants.NOTE; // 初始化数据 MIME 类型为笔记类型 + mDataContent = ""; // 初始化数据内容为空字符串 + mDataContentData1 = 0; // 初始化数据内容数据 1 为 0 + mDataContentData3 = ""; // 初始化数据内容数据 3 为空字符串 + mDiffDataValues = new ContentValues(); // 初始化差异数据值 + } +/* + * 构造函数，用于从数据库游标加载数据对象。 + * 该构造函数初始化数据对象的各个属性，并设置为非创建操作。 + * @param context 应用程序上下文。 + * @param c 数据库游标。 + */ + public SqlData(Context context, Cursor c) { + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非创建操作 + loadFromCursor(c); // 从数据库游标加载数据 + mDiffDataValues = new ContentValues(); // 初始化差异数据值 + } +/* + * 从数据库游标加载数据。 + * 该方法从数据库游标中提取数据，并初始化数据对象的各个属性。 + * @param c 数据库游标。 + */ + private void loadFromCursor(Cursor c) { + mDataId = c.getLong(DATA_ID_COLUMN); // 获取数据 ID + mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); // 获取数据 MIME 类型 + mDataContent = c.getString(DATA_CONTENT_COLUMN); // 获取数据内容 + mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); // 获取数据内容数据 1 + mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); // 获取数据内容数据 3 + } +/* + * 设置数据内容。 + * 该方法从 JSON 对象中提取数据，并更新数据对象的各个属性。 + * 如果数据对象是新创建的，或者 JSON 对象中的数据与当前数据对象的数据不同，则更新差异数据值。 + * @param js JSON 对象，包含数据内容。 + * @throws JSONException 如果解析 JSON 对象时发生异常。 + */ + public void setContent(JSONObject js) throws JSONException { + // 从 JSON 对象中获取数据 ID，如果 JSON 对象中没有数据 ID，则使用无效 ID + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; + // 如果数据对象是新创建的，或者数据 ID 不同，则更新差异数据值 + if (mIsCreate || mDataId != dataId) { + mDiffDataValues.put(DataColumns.ID, dataId); + } + mDataId = dataId; // 更新数据 ID + // 从 JSON 对象中获取数据 MIME 类型，如果 JSON 对象中没有数据 MIME 类型，则使用默认的笔记类型 + String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) + : DataConstants.NOTE; + // 如果数据对象是新创建的，或者数据 MIME 类型不同，则更新差异数据值 + if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { + mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); + } + mDataMimeType = dataMimeType; // 更新数据 MIME 类型 + // 从 JSON 对象中获取数据内容，如果 JSON 对象中没有数据内容，则使用空字符串 + String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; + // 如果数据对象是新创建的，或者数据内容不同，则更新差异数据值 + if (mIsCreate || !mDataContent.equals(dataContent)) { + mDiffDataValues.put(DataColumns.CONTENT, dataContent); + } + mDataContent = dataContent; // 更新数据内容 + // 从 JSON 对象中获取数据内容数据 1，如果 JSON 对象中没有数据内容数据 1，则使用 0 + long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; + // 如果数据对象是新创建的，或者数据内容数据 1 不同，则更新差异数据值 + if (mIsCreate || mDataContentData1 != dataContentData1) { + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); + } + mDataContentData1 = dataContentData1; // 更新数据内容数据 1 + // 从 JSON 对象中获取数据内容数据 3，如果 JSON 对象中没有数据内容数据 3，则使用空字符串 + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; + // 如果数据对象是新创建的，或者数据内容数据 3 不同，则更新差异数据值 + if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); + } + mDataContentData3 = dataContentData3; // 更新数据内容数据 3 + } +/* + * 获取数据内容。 + * 该方法将数据对象的各个属性转换为 JSON 对象，并返回该 JSON 对象。 + * @return 返回包含数据内容的 JSON 对象。 + * @throws JSONException 如果生成 JSON 对象时发生异常。 + */ + public JSONObject getContent() throws JSONException { + // 如果数据对象是新创建的，则记录错误日志并返回 null + if (mIsCreate) { + Log.e(TAG, "it seems that we haven't created this in database yet"); + return null; + } + JSONObject js = new JSONObject(); // 创建一个新的 JSON 对象 + js.put(DataColumns.ID, mDataId); // 将数据 ID 添加到 JSON 对象中 + js.put(DataColumns.MIME_TYPE, mDataMimeType); // 将数据 MIME 类型添加到 JSON 对象中 + js.put(DataColumns.CONTENT, mDataContent); // 将数据内容添加到 JSON 对象中 + js.put(DataColumns.DATA1, mDataContentData1); // 将数据内容数据 1 添加到 JSON 对象中 + js.put(DataColumns.DATA3, mDataContentData3); // 将数据内容数据 3 添加到 JSON 对象中 + return js; // 返回 JSON 对象 + } +/* + * 提交数据。 + * 该方法根据数据对象的状态（创建或更新）执行相应的数据库操作。 + * 如果是创建操作，则插入数据到数据库中；如果是更新操作，则更新数据库中的数据。 + * @param noteId 笔记 ID。 + * @param validateVersion 是否验证版本。 + * @param version 版本号。 + */ + public void commit(long noteId, boolean validateVersion, long version) { + // 如果是创建操作 + if (mIsCreate) { + // 如果数据 ID 是无效的，并且差异数据值中包含数据 ID，则移除数据 ID + if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { + mDiffDataValues.remove(DataColumns.ID); + } + // 将笔记 ID 添加到差异数据值中 + mDiffDataValues.put(DataColumns.NOTE_ID, noteId); + // 插入数据到数据库中 + Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); + try { + // 获取插入数据后的数据 ID + mDataId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + // 记录错误日志，并抛出操作失败异常 + Log.e(TAG, "Get note id error :" + e.toString()); + throw new ActionFailureException("create note failed"); + } + } else { + // 如果是更新操作，并且差异数据值不为空 + if (mDiffDataValues.size() > 0) { + int result = 0; + // 如果不验证版本 + if (!validateVersion) { + // 更新数据库中的数据 + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); + } else { + // 如果验证版本，则更新数据库中的数据，并验证版本 + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, + " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.VERSION + "=?)", new String[] { + String.valueOf(noteId), String.valueOf(version) + }); + } + // 如果没有更新，则记录警告日志 + if (result == 0) { + Log.w(TAG, "there is no update. maybe user updates note when syncing"); + } + } + } + // 清空差异数据值 + mDiffDataValues.clear(); + mIsCreate = false; // 设置为非创建操作 + } +/* + * 获取数据 ID。 + * 该方法返回数据对象的数据 ID。 + * @return 返回数据 ID。 + */ + public long getId() { + return mDataId; + } +} diff --git a/SqlNote.java b/SqlNote.java new file mode 100644 index 0000000..0283258 --- /dev/null +++ b/SqlNote.java @@ -0,0 +1,618 @@ +/* + * 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.appwidget.AppWidgetManager; +import android.content.ContentResolver; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; +import net.micode.notes.tool.ResourceParser; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.ArrayList; + +/* + * SqlNote 类用于处理与数据库相关的笔记操作。 + * 该类主要用于加载、设置、获取和提交笔记数据。 + */ +public class SqlNote { + private static final String TAG = SqlNote.class.getSimpleName(); + + private static final int INVALID_ID = -99999; // 无效的 ID + // 笔记表的投影字段 + public static final String[] PROJECTION_NOTE = new String[] { + NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, + NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE, + NoteColumns.NOTES_COUNT, NoteColumns.PARENT_ID, NoteColumns.SNIPPET, NoteColumns.TYPE, + NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE, NoteColumns.SYNC_ID, + NoteColumns.LOCAL_MODIFIED, NoteColumns.ORIGIN_PARENT_ID, NoteColumns.GTASK_ID, + NoteColumns.VERSION + }; + // 笔记表的列索引 + public static final int ID_COLUMN = 0; + + public static final int ALERTED_DATE_COLUMN = 1; + + public static final int BG_COLOR_ID_COLUMN = 2; + + public static final int CREATED_DATE_COLUMN = 3; + + public static final int HAS_ATTACHMENT_COLUMN = 4; + + public static final int MODIFIED_DATE_COLUMN = 5; + + public static final int NOTES_COUNT_COLUMN = 6; + + public static final int PARENT_ID_COLUMN = 7; + + public static final int SNIPPET_COLUMN = 8; + + public static final int TYPE_COLUMN = 9; + + public static final int WIDGET_ID_COLUMN = 10; + + public static final int WIDGET_TYPE_COLUMN = 11; + + public static final int SYNC_ID_COLUMN = 12; + + public static final int LOCAL_MODIFIED_COLUMN = 13; + + public static final int ORIGIN_PARENT_ID_COLUMN = 14; + + public static final int GTASK_ID_COLUMN = 15; + + public static final int VERSION_COLUMN = 16; + + private Context mContext; // 应用程序上下文 + + private ContentResolver mContentResolver; // 内容解析器 + + private boolean mIsCreate; // 是否为创建操作 + + private long mId; // 笔记 ID + + private long mAlertDate; // 提醒日期 + + private int mBgColorId; // 背景颜色 ID + + private long mCreatedDate; // 创建日期 + + private int mHasAttachment; // 是否有附件 + + private long mModifiedDate; // 修改日期 + + private long mParentId; // 父笔记 ID + + private String mSnippet; // 笔记摘要 + + private int mType; // 笔记类型 + + private int mWidgetId; // 小部件 ID + + private int mWidgetType; // 小部件类型 + + private long mOriginParent; // 原始父笔记 ID + + private long mVersion; // 版本号 + + private ContentValues mDiffNoteValues; // 差异笔记值 + + private ArrayList mDataList; // 数据列表 +/* + * 构造函数，用于创建新的笔记对象。 + * 该构造函数初始化笔记对象的各个属性，并设置为创建操作。 + * @param context 应用程序上下文。 + */ + public SqlNote(Context context) { + mContext = context; // 设置应用程序上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = true; // 设置为创建操作 + mId = INVALID_ID; // 初始化笔记 ID 为无效值 + mAlertDate = 0; // 初始化提醒日期为 0 + mBgColorId = ResourceParser.getDefaultBgId(context); // 初始化背景颜色 ID 为默认值 + mCreatedDate = System.currentTimeMillis(); // 初始化创建日期为当前时间 + mHasAttachment = 0; // 初始化是否有附件为 0 + mModifiedDate = System.currentTimeMillis(); // 初始化修改日期为当前时间 + mParentId = 0; // 初始化父笔记 ID 为 0 + mSnippet = ""; // 初始化笔记摘要为空字符串 + mType = Notes.TYPE_NOTE; // 初始化笔记类型为普通笔记 + mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; // 初始化小部件 ID 为无效值 + mWidgetType = Notes.TYPE_WIDGET_INVALIDE; // 初始化小部件类型为无效值 + mOriginParent = 0; // 初始化原始父笔记 ID 为 0 + mVersion = 0; // 初始化版本号为 0 + mDiffNoteValues = new ContentValues(); // 初始化差异笔记值 + mDataList = new ArrayList(); // 初始化数据列表 + } +/* + * 构造函数，用于从数据库游标加载笔记对象。 + * 该构造函数初始化笔记对象的各个属性，并设置为非创建操作。 + * @param context 应用程序上下文。 + * @param c 数据库游标。 + */ + public SqlNote(Context context, Cursor c) { + mContext = context; // 设置应用程序上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非创建操作 + loadFromCursor(c); // 从数据库游标加载笔记对象 + mDataList = new ArrayList(); // 初始化数据列表 + if (mType == Notes.TYPE_NOTE) // 如果笔记类型为普通笔记 + loadDataContent(); // 加载笔记的数据内容 + mDiffNoteValues = new ContentValues(); // 初始化差异笔记值 + } +/* + * 构造函数，用于从数据库中加载指定 ID 的笔记对象。 + * 该构造函数初始化笔记对象的各个属性，并设置为非创建操作。 + * @param context 应用程序上下文。 + * @param id 笔记 ID。 + */ + public SqlNote(Context context, long id) { + mContext = context; // 设置应用程序上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非创建操作 + loadFromCursor(id); // 从数据库中加载指定 ID 的笔记对象 + mDataList = new ArrayList(); // 初始化数据列表 + if (mType == Notes.TYPE_NOTE) // 如果笔记类型为普通笔记 + loadDataContent(); // 加载笔记的数据内容 + mDiffNoteValues = new ContentValues(); // 初始化差异笔记值 + + } +/* + * 从数据库中加载指定 ID 的笔记对象。 + * 该方法从数据库中查询指定 ID 的笔记数据，并调用 `loadFromCursor(Cursor c)` 方法加载笔记对象。 + * @param id 笔记 ID。 + */ + private void loadFromCursor(long id) { + Cursor c = null; + try { + // 查询指定 ID 的笔记数据 + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", + new String[] { + String.valueOf(id) + }, null); + if (c != null) { + c.moveToNext(); // 移动到游标的第一行 + loadFromCursor(c); // 加载笔记对象 + } else { + Log.w(TAG, "loadFromCursor: cursor = null"); // 记录警告日志，游标为空 + } + } finally { + if (c != null) + c.close(); // 关闭游标 + } + } +/* + * 从数据库游标加载笔记对象。 + * 该方法从数据库游标中提取笔记数据，并初始化笔记对象的各个属性。 + * @param c 数据库游标。 + */ + private void loadFromCursor(Cursor c) { + mId = c.getLong(ID_COLUMN); // 获取笔记 ID + mAlertDate = c.getLong(ALERTED_DATE_COLUMN); // 获取提醒日期 + mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); // 获取背景颜色 ID + mCreatedDate = c.getLong(CREATED_DATE_COLUMN); // 获取创建日期 + mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); // 获取是否有附件 + mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); // 获取修改日期 + mParentId = c.getLong(PARENT_ID_COLUMN); // 获取父笔记 ID + mSnippet = c.getString(SNIPPET_COLUMN); // 获取笔记摘要 + mType = c.getInt(TYPE_COLUMN); // 获取笔记类型 + mWidgetId = c.getInt(WIDGET_ID_COLUMN); // 获取小部件 ID + mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); // 获取小部件类型 + mVersion = c.getLong(VERSION_COLUMN); // 获取版本号 + } +/* + * 加载笔记的数据内容。 + * 该方法从数据库中查询与笔记相关的数据内容，并将其加载到数据列表中。 + */ + private void loadDataContent() { + Cursor c = null; + mDataList.clear(); // 清空数据列表 + try { + // 查询与笔记相关的数据内容 + c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA, + "(note_id=?)", new String[] { + String.valueOf(mId) + }, null); + if (c != null) { + if (c.getCount() == 0) { + Log.w(TAG, "it seems that the note has not data"); // 记录警告日志，笔记没有数据内容 + return; + } + while (c.moveToNext()) { + SqlData data = new SqlData(mContext, c); // 从游标中加载数据 + mDataList.add(data); // 将数据内容添加到数据列表中 + } + } else { + Log.w(TAG, "loadDataContent: cursor = null"); // 记录警告日志，游标为空 + } + } finally { + if (c != null) + c.close(); // 关闭游标 + } + } +/* + * 设置内容的方法，接受一个JSONObject作为参数，并根据其中的数据更新当前对象的属性。 + * @param js 包含笔记信息的JSONObject + * @return 如果设置成功返回true，否则返回false + */ + public boolean setContent(JSONObject js) { + try { + // 从JSONObject中获取笔记的元数据 + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + // 检查笔记的类型 + if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { + // 如果是系统文件夹，则不能设置内容，记录警告日志 + Log.w(TAG, "cannot set system 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 + .getString(NoteColumns.SNIPPET) : ""; + // 如果是新建笔记或摘要有变化，则更新摘要 + if (mIsCreate || !mSnippet.equals(snippet)) { + mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); + } + mSnippet = snippet; + // 获取类型，如果未提供则默认为普通笔记类型 + int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) + : Notes.TYPE_NOTE; + // 如果是新建笔记或类型有变化，则更新类型 + if (mIsCreate || mType != type) { + mDiffNoteValues.put(NoteColumns.TYPE, type); + } + mType = type; + } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { + // 如果是普通笔记类型，则更新所有相关属性 + // 获取数据数组 + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + // 获取笔记ID，如果未提供则默认为无效ID + long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID; + // 如果是新建笔记或ID有变化，则更新ID + if (mIsCreate || mId != id) { + mDiffNoteValues.put(NoteColumns.ID, id); + } + mId = id; + // 获取提醒日期，如果未提供则默认为0 + long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note + .getLong(NoteColumns.ALERTED_DATE) : 0; + // 如果是新建笔记或提醒日期有变化，则更新提醒日期 + if (mIsCreate || mAlertDate != alertDate) { + mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); + } + mAlertDate = alertDate; + // 获取背景颜色ID，如果未提供则默认为默认背景颜色ID + int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note + .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); + // 如果是新建笔记或背景颜色ID有变化，则更新背景颜色ID + if (mIsCreate || mBgColorId != bgColorId) { + mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); + } + mBgColorId = bgColorId; + // 获取创建日期，如果未提供则默认为当前时间 + long createDate = note.has(NoteColumns.CREATED_DATE) ? note + .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); + // 如果是新建笔记或创建日期有变化，则更新创建日期 + if (mIsCreate || mCreatedDate != createDate) { + mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate); + } + mCreatedDate = createDate; + // 获取是否有附件，如果未提供则默认为0（无附件） + int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note + .getInt(NoteColumns.HAS_ATTACHMENT) : 0; + // 如果是新建笔记或是否有附件有变化，则更新是否有附件 + if (mIsCreate || mHasAttachment != hasAttachment) { + mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment); + } + mHasAttachment = hasAttachment; + // 获取修改日期，如果未提供则默认为当前时间 + long modifiedDate = note.has(NoteColumns.MODIFIED_DATE) ? note + .getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis(); + // 如果是新建笔记或修改日期有变化，则更新修改日期 + if (mIsCreate || mModifiedDate != modifiedDate) { + mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate); + } + mModifiedDate = modifiedDate; + // 获取父ID，如果未提供则默认为0 + long parentId = note.has(NoteColumns.PARENT_ID) ? note + .getLong(NoteColumns.PARENT_ID) : 0; + // 如果是新建笔记或父ID有变化，则更新父ID + if (mIsCreate || mParentId != parentId) { + mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); + } + mParentId = parentId; + // 获取摘要，如果未提供则默认为空字符串 + String snippet = note.has(NoteColumns.SNIPPET) ? note + .getString(NoteColumns.SNIPPET) : ""; + // 如果是新建笔记或摘要有变化，则更新摘要 + if (mIsCreate || !mSnippet.equals(snippet)) { + mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); + } + mSnippet = snippet; + // 获取类型，如果未提供则默认为普通笔记类型 + int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) + : Notes.TYPE_NOTE; + // 如果是新建笔记或类型有变化，则更新类型 + if (mIsCreate || mType != type) { + mDiffNoteValues.put(NoteColumns.TYPE, type); + } + mType = type; + // 获取小部件ID，如果未提供则默认为无效小部件ID + int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID) + : AppWidgetManager.INVALID_APPWIDGET_ID; + // 如果是新建笔记或小部件ID有变化，则更新小部件ID + if (mIsCreate || mWidgetId != widgetId) { + mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); + } + mWidgetId = widgetId; + // 获取小部件类型，如果未提供则默认为无效小部件类型 + int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note + .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; + // 如果是新建笔记或小部件类型有变化，则更新小部件类型 + if (mIsCreate || mWidgetType != widgetType) { + mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); + } + mWidgetType = widgetType; + // 获取原始父ID，如果未提供则默认为0 + long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note + .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; + // 如果是新建笔记或原始父ID有变化，则更新原始父ID + if (mIsCreate || mOriginParent != originParent) { + mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); + } + mOriginParent = originParent; + // 遍历数据数组，更新数据列表 + for (int i = 0; i < dataArray.length(); i++) { + JSONObject data = dataArray.getJSONObject(i); + SqlData sqlData = null; + // 如果数据对象包含ID，则在现有数据列表中查找匹配的SqlData对象 + if (data.has(DataColumns.ID)) { + long dataId = data.getLong(DataColumns.ID); + for (SqlData temp : mDataList) { + if (dataId == temp.getId()) { + sqlData = temp; + } + } + } + // 如果未找到匹配的SqlData对象，则创建一个新的SqlData对象并添加到数据列表中 + if (sqlData == null) { + sqlData = new SqlData(mContext); + mDataList.add(sqlData); + } + // 设置SqlData对象的内容 + sqlData.setContent(data); + } + } + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + return false; + } + return true; + } +/* + * 获取当前对象的内容，并将其封装为一个JSONObject返回。 + * @return 包含当前对象内容的JSONObject，如果发生错误则返回null + */ + public JSONObject getContent() { + try { + // 创建一个新的JSONObject用于存储内容 + JSONObject js = new JSONObject(); + // 如果当前对象尚未在数据库中创建，记录错误日志并返回null + if (mIsCreate) { + Log.e(TAG, "it seems that we haven't created this in database yet"); + return null; + } + // 创建一个新的JSONObject用于存储笔记信息 + JSONObject note = new JSONObject(); + // 如果当前对象是普通笔记类型 + if (mType == Notes.TYPE_NOTE) { + // 将笔记的各个属性添加到note JSONObject中 + note.put(NoteColumns.ID, mId); + note.put(NoteColumns.ALERTED_DATE, mAlertDate); + note.put(NoteColumns.BG_COLOR_ID, mBgColorId); + note.put(NoteColumns.CREATED_DATE, mCreatedDate); + note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); + note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); + note.put(NoteColumns.PARENT_ID, mParentId); + note.put(NoteColumns.SNIPPET, mSnippet); + note.put(NoteColumns.TYPE, mType); + note.put(NoteColumns.WIDGET_ID, mWidgetId); + note.put(NoteColumns.WIDGET_TYPE, mWidgetType); + note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); + // 将note JSONObject添加到js JSONObject中 + js.put(GTaskStringUtils.META_HEAD_NOTE, note); + // 创建一个新的JSONArray用于存储数据列表 + JSONArray dataArray = new JSONArray(); + // 遍历数据列表，将每个SqlData对象的内容添加到dataArray中 + for (SqlData sqlData : mDataList) { + JSONObject data = sqlData.getContent(); + if (data != null) { + dataArray.put(data); + } + } + // 将dataArray添加到js JSONObject中 + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); + } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { + // 如果当前对象是文件夹或系统文件夹类型 + // 将笔记的ID、类型和摘要添加到note JSONObject中 + note.put(NoteColumns.ID, mId); + note.put(NoteColumns.TYPE, mType); + note.put(NoteColumns.SNIPPET, mSnippet); + // 将note JSONObject添加到js JSONObject中 + js.put(GTaskStringUtils.META_HEAD_NOTE, note); + } + // 返回包含内容的JSONObject + return js; + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + return null; + } +/* + * 设置父ID，并将其添加到差异值中。 + * @param id 新的父ID + */ + public void setParentId(long id) { + mParentId = id; + mDiffNoteValues.put(NoteColumns.PARENT_ID, id); + } +/* + * 设置Google任务ID，并将其添加到差异值中。 + * @param gid 新的Google任务ID + */ + public void setGtaskId(String gid) { + mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); + } +/* + * 设置同步ID，并将其添加到差异值中。 + * @param syncId 新的同步ID + */ + public void setSyncId(long syncId) { + mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); + } +/* + * 重置本地修改标志，将其设置为0。 + */ + public void resetLocalModified() { + mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); + } +/* + * 获取当前笔记的ID。 + * @return 当前笔记的ID + */ + public long getId() { + return mId; + } +/* + * 获取当前笔记的父ID。 + * @return 当前笔记的父ID + */ + public long getParentId() { + return mParentId; + } +/* + * 获取当前笔记的摘要。 + * @return 当前笔记的摘要 + */ + public String getSnippet() { + return mSnippet; + } +/* + * 判断当前笔记是否为普通笔记类型。 + * @return 如果当前笔记是普通笔记类型，返回true；否则返回false + */ + public boolean isNoteType() { + return mType == Notes.TYPE_NOTE; + } +/* + * 提交更改，将当前对象的差异值保存到数据库中。 + * @param validateVersion 是否验证版本号 + */ + public void commit(boolean validateVersion) { + // 如果是新建笔记 + if (mIsCreate) { + // 如果ID无效且差异值中包含ID，则移除ID + if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { + mDiffNoteValues.remove(NoteColumns.ID); + } + // 插入笔记到数据库，并获取插入后的URI + Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); + try { + // 从URI中提取新插入笔记的ID + mId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + // 如果提取ID失败，记录错误日志并抛出异常 + Log.e(TAG, "Get note id error :" + e.toString()); + throw new ActionFailureException("create note failed"); + } + // 如果ID为0，表示插入失败，抛出异常 + if (mId == 0) { + throw new IllegalStateException("Create thread id failed"); + } + // 如果当前笔记是普通笔记类型 + if (mType == Notes.TYPE_NOTE) { + // 遍历数据列表，提交每个SqlData对象的更改 + for (SqlData sqlData : mDataList) { + sqlData.commit(mId, false, -1); + } + } + } else { + // 如果不是新建笔记 + // 如果ID无效且不是根文件夹或通话记录文件夹，记录错误日志并抛出异常 + if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) { + Log.e(TAG, "No such note"); + throw new IllegalStateException("Try to update note with invalid id"); + } + // 如果差异值中有更新内容 + if (mDiffNoteValues.size() > 0) { + // 增加版本号 + mVersion ++; + int result = 0; + // 如果不验证版本号 + if (!validateVersion) { + // 更新笔记内容 + result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + + NoteColumns.ID + "=?)", new String[] { + String.valueOf(mId) + }); + } else { + // 如果验证版本号，更新笔记内容并检查版本号 + result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", + new String[] { + String.valueOf(mId), String.valueOf(mVersion) + }); + } + // 如果没有更新内容，记录警告日志 + if (result == 0) { + Log.w(TAG, "there is no update. maybe user updates note when syncing"); + } + } + // 如果当前笔记是普通笔记类型 + if (mType == Notes.TYPE_NOTE) { + // 遍历数据列表，提交每个SqlData对象的更改 + for (SqlData sqlData : mDataList) { + sqlData.commit(mId, validateVersion, mVersion); + } + } + } + + // refresh local info + // 刷新本地信息 + loadFromCursor(mId); + if (mType == Notes.TYPE_NOTE) + loadDataContent(); + // 清空差异值并设置为非新建状态 + mDiffNoteValues.clear(); + mIsCreate = false; + } +} diff --git a/Task.java b/Task.java new file mode 100644 index 0000000..8314242 --- /dev/null +++ b/Task.java @@ -0,0 +1,454 @@ +/* + * 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 android.text.TextUtils; +import android.util.Log; + +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.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +/* + * Task类表示一个任务，继承自Node类。 + * 该类包含了任务的各种属性和操作方法，如创建、更新、设置内容等。 + */ +public class Task extends Node { + private static final String TAG = Task.class.getSimpleName(); + + private boolean mCompleted; // 任务是否已完成 + + private String mNotes; // 任务的备注 + + private JSONObject mMetaInfo; // 任务的元数据信息 + + private Task mPriorSibling; // 前一个兄弟任务 + + private TaskList mParent; // 父任务列表 +/* + * 构造函数，初始化任务对象。 + * 初始化任务的完成状态、备注、前一个兄弟任务、父任务列表和元数据信息。 + */ + public Task() { + super(); // 调用父类Node的构造函数 + mCompleted = false; // 初始化任务为未完成状态 + mNotes = null; // 初始化备注为空 + mPriorSibling = null; // 初始化前一个兄弟任务为空 + mParent = null; // 初始化父任务列表为空 + mMetaInfo = null; // 初始化元数据信息为空 + } +/* + *生成创建任务的JSON对象。 + * @param actionId 操作ID + * @return 包含创建任务信息的JSONObject + */ + public JSONObject getCreateAction(int actionId) { + JSONObject js = new JSONObject(); + + try { + // action_type + // 设置操作类型为创建 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); + + // action_id + // 设置操作ID + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // index + // 设置任务在父任务列表中的索引 + js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); + + // entity_delta + // 设置任务的实体信息 + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); + entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_TASK); + if (getNotes() != null) { + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + } + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + // parent_id + // 设置父任务列表的ID + js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); + + // dest_parent_type + // 设置目标父类型 + js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); + + // list_id + // 设置任务列表的ID + js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); + + // prior_sibling_id + // 设置前一个兄弟任务的ID + if (mPriorSibling != null) { + js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); + } + + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + // 抛出自定义异常，表示生成JSON对象失败 + throw new ActionFailureException("fail to generate task-create jsonobject"); + } + + return js; // 返回包含创建任务信息的JSONObject + } +/* + * 生成更新任务的JSON对象。 + * @param actionId 操作ID + * @return 包含更新任务信息的JSONObject + */ + public JSONObject getUpdateAction(int actionId) { + JSONObject js = new JSONObject(); + + try { + // action_type + // 设置操作类型为更新 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); + + // action_id + // 设置操作ID + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // id + // 设置任务的ID + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); + + // entity_delta + // 设置任务的实体信息 + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + if (getNotes() != null) { + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + } + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + // 抛出自定义异常，表示生成JSON对象失败 + throw new ActionFailureException("fail to generate task-update jsonobject"); + } + + return js; // 返回包含更新任务信息的JSONObject + } +/* + * 根据远程JSON对象设置任务的内容。 + * @param js 包含任务信息的远程JSON对象 + */ + public void setContentByRemoteJSON(JSONObject js) { + if (js != null) { + try { + // id + // 如果JSON对象中包含ID字段，则设置任务的ID + if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { + setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); + } + + // last_modified + // 如果JSON对象中包含最后修改时间字段，则设置任务的最后修改时间 + if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { + setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); + } + + // name + // 如果JSON对象中包含名称字段，则设置任务的名称 + if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { + setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); + } + + // notes + // 如果JSON对象中包含备注字段，则设置任务的备注 + if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) { + setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); + } + + // deleted + // 如果JSON对象中包含删除状态字段，则设置任务的删除状态 + if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) { + setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); + } + + // completed + // 如果JSON对象中包含完成状态字段，则设置任务的完成状态 + if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) { + setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); + } + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + // 抛出自定义异常，表示从JSON对象获取任务内容失败 + throw new ActionFailureException("fail to get task content from jsonobject"); + } + } + } +/* + * 根据本地JSON对象设置任务的内容。 + * @param js 包含任务信息的本地JSON对象 + */ + public void setContentByLocalJSON(JSONObject js) { + // 检查JSON对象是否为空或是否包含必要的字段 + if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) + || !js.has(GTaskStringUtils.META_HEAD_DATA)) { + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); + } + + try { + // 获取笔记的元数据 + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + // 获取数据数组 + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + // 检查笔记的类型是否为普通笔记类型 + if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) { + Log.e(TAG, "invalid type"); + return; + } + // 遍历数据数组，查找MIME类型为DataConstants.NOTE的数据 + for (int i = 0; i < dataArray.length(); i++) { + JSONObject data = dataArray.getJSONObject(i); + if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { + // 设置任务的名称 + setName(data.getString(DataColumns.CONTENT)); + break; + } + } + + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + } +/* + * 根据任务内容生成本地JSON对象。 + * @return 包含任务内容的本地JSON对象，如果发生错误则返回null + */ + public JSONObject getLocalJSONFromContent() { + String name = getName(); + try { + if (mMetaInfo == null) { + // new task created from web + // 如果是从网页创建的新任务 + if (name == null) { + Log.w(TAG, "the note seems to be an empty one"); + return null; + } + // 创建一个新的JSON对象 + JSONObject js = new JSONObject(); + JSONObject note = new JSONObject(); + JSONArray dataArray = new JSONArray(); + JSONObject data = new JSONObject(); + data.put(DataColumns.CONTENT, name); + dataArray.put(data); + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); + js.put(GTaskStringUtils.META_HEAD_NOTE, note); + return js; + } else { + // synced task + // 如果是已同步的任务 + 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) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + return null; + } + } +/* + * 设置任务的元数据信息。 + * @param metaData 包含元数据信息的MetaData对象 + */ + public void setMetaInfo(MetaData metaData) { + // 检查MetaData对象是否为空，并且是否包含笔记信息 + if (metaData != null && metaData.getNotes() != null) { + try { + // 将笔记信息转换为JSONObject对象 + mMetaInfo = new JSONObject(metaData.getNotes()); + } catch (JSONException e) { + // 捕获JSON异常并记录警告日志 + Log.w(TAG, e.toString()); + mMetaInfo = null; + // 如果转换失败，将mMetaInfo设置为null + } + } + } +/* + * 获取同步操作类型。 + * @param c 包含本地笔记信息的Cursor对象 + * @return 同步操作类型 + */ + public int getSyncAction(Cursor c) { + 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; + } + // 如果笔记信息中不包含ID字段，表示远程笔记ID已被删除 + if (!noteInfo.has(NoteColumns.ID)) { + Log.w(TAG, "remote note id seems to be deleted"); + return SYNC_ACTION_UPDATE_LOCAL; + } + + // validate the note id now + // 验证笔记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) { + // there is no local update + // 如果本地没有修改 + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { + // no update both side + // 如果没有更新，返回SYNC_ACTION_NONE + return SYNC_ACTION_NONE; + } else { + // apply remote to local + // 应用远程更新到本地 + return SYNC_ACTION_UPDATE_LOCAL; + } + } else { + // validate gtask id + // 验证Google任务ID是否匹配 + if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { + Log.e(TAG, "gtask id doesn't match"); + return SYNC_ACTION_ERROR; + } + // 如果同步ID与最后修改时间匹配，表示只有本地修改 + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { + // local modification only + return SYNC_ACTION_UPDATE_REMOTE; + } else { + // 返回冲突更新 + return SYNC_ACTION_UPDATE_CONFLICT; + } + } + } catch (Exception e) { + // 捕获异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + + return SYNC_ACTION_ERROR; // 默认返回SYNC_ACTION_ERROR + } +/* + * 判断任务是否值得保存。 + * @return 如果任务值得保存，返回true；否则返回false + */ + public boolean isWorthSaving() { + // 检查元数据信息是否存在，或者任务名称和备注是否不为空且不为空白字符串 + return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) + || (getNotes() != null && getNotes().trim().length() > 0); + } +/* + * 设置任务的完成状态。 + * @param completed 任务的完成状态，true表示已完成，false表示未完成 + */ + public void setCompleted(boolean completed) { + this.mCompleted = completed; + } +/* + * 设置任务的备注。 + * @param notes 任务的备注 + */ + public void setNotes(String notes) { + this.mNotes = notes; + } +/* + * 设置前一个兄弟任务。 + * @param priorSibling 前一个兄弟任务 + */ + public void setPriorSibling(Task priorSibling) { + this.mPriorSibling = priorSibling; + } +/* + * 设置父任务列表。 + * @param parent 父任务列表 + */ + public void setParent(TaskList parent) { + this.mParent = parent; + } +/* + * 获取任务的完成状态。 + * @return 任务的完成状态，true表示已完成，false表示未完成 + */ + public boolean getCompleted() { + return this.mCompleted; + } +/* + * 获取任务的备注。 + * @return 任务的备注 + */ + public String getNotes() { + return this.mNotes; + } +/* + * 获取前一个兄弟任务。 + * @return 前一个兄弟任务 + */ + public Task getPriorSibling() { + return this.mPriorSibling; + } +/* + * 获取父任务列表。 + * @return 父任务列表 + */ + public TaskList getParent() { + return this.mParent; + } + +} diff --git a/TaskList.java b/TaskList.java new file mode 100644 index 0000000..4c6b5bd --- /dev/null +++ b/TaskList.java @@ -0,0 +1,465 @@ +/* + * 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 android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.ArrayList; + +/* + * TaskList类表示一个任务列表，继承自Node类。 + * 该类包含了任务列表的各种属性和操作方法，如创建、更新、设置内容等。 + */ +public class TaskList extends Node { + private static final String TAG = TaskList.class.getSimpleName(); + + private int mIndex; // 任务列表的索引 + + private ArrayList mChildren; // 子任务列表 +/* + * 构造函数，初始化任务列表对象。 + */ + public TaskList() { + super(); + mChildren = new ArrayList(); + mIndex = 1; + } +/* + * 生成创建任务列表的JSON对象。 + * @param actionId 操作ID + * @return 包含创建任务列表信息的JSONObject + */ + public JSONObject getCreateAction(int actionId) { + JSONObject js = new JSONObject(); + + try { + // action_type + // 设置操作类型为创建 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); + + // action_id + // 设置操作ID + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // index + // 设置索引 + js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex); + + // entity_delta + // 设置实体信息 + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); + entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to generate tasklist-create jsonobject"); + } + + return js; + } +/* + * 生成更新任务列表的JSON对象。 + * @param actionId 操作ID + * @return 包含更新任务列表信息的JSONObject + */ + public JSONObject getUpdateAction(int actionId) { + JSONObject js = new JSONObject(); + + try { + // action_type + // 设置操作类型为更新 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); + + // action_id + // 设置操作ID + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // id + // 设置任务列表的ID + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); + + // entity_delta + // 设置任务列表的实体信息 + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + // 抛出自定义异常，表示生成JSON对象失败 + throw new ActionFailureException("fail to generate tasklist-update jsonobject"); + } + + return js; // 返回包含更新任务列表信息的JSONObject + } +/* + * 根据远程JSON对象设置任务列表的内容。 + * @param js 包含任务列表信息的远程JSON对象 + */ + public void setContentByRemoteJSON(JSONObject js) { + if (js != null) { + try { + // id + // 如果JSON对象中包含ID字段，则设置任务列表的ID + if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { + setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); + } + + // last_modified + // 如果JSON对象中包含最后修改时间字段，则设置任务列表的最后修改时间 + if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { + setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); + } + + // name + // 如果JSON对象中包含名称字段，则设置任务列表的名称 + if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { + setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); + } + + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + // 抛出自定义异常，表示从JSON对象获取任务列表内容失败 + throw new ActionFailureException("fail to get tasklist content from jsonobject"); + } + } + } +/* + * 根据本地JSON对象设置任务列表的内容。 + * @param js 包含任务列表信息的本地JSON对象 + */ + public void setContentByLocalJSON(JSONObject js) { + // 检查JSON对象是否为空或是否包含必要的字段 + if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); + } + + try { + // 获取文件夹的元数据 + JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + // 检查文件夹的类型 + if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { + // 如果是普通文件夹类型，获取文件夹名称并设置任务列表名称 + String name = folder.getString(NoteColumns.SNIPPET); + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name); + } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { + // 如果是系统文件夹类型，根据文件夹ID设置任务列表名称 + if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER) + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT); + else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER) + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + + GTaskStringUtils.FOLDER_CALL_NOTE); + else + Log.e(TAG, "invalid system folder"); + } else { + // 如果文件夹类型无效，记录错误日志 + Log.e(TAG, "error type"); + } + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + } +/* + * 根据任务列表内容生成本地JSON对象。 + * @return 包含任务列表内容的本地JSON对象，如果发生错误则返回null + */ + public JSONObject getLocalJSONFromContent() { + try { + // 创建一个新的JSON对象 + JSONObject js = new JSONObject(); + JSONObject folder = new JSONObject(); + // 获取任务列表的名称 + String folderName = getName(); + // 如果名称以GTaskStringUtils.MIUI_FOLDER_PREFFIX开头，则去掉前缀 + if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) + folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), + folderName.length()); + // 设置文件夹名称 + folder.put(NoteColumns.SNIPPET, folderName); + // 根据文件夹名称设置文件夹类型 + if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT) + || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE)) + folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + else + folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); + // 将文件夹信息添加到JSON对象中 + js.put(GTaskStringUtils.META_HEAD_NOTE, folder); + // 返回包含任务列表内容的本地JSON对象 + return js; + } catch (JSONException e) { + // 捕获JSON异常并记录错误日志 + Log.e(TAG, e.toString()); + e.printStackTrace(); + // 如果发生错误，返回null + return null; + } + } +/* + * 获取同步操作类型。 + * @param c 包含本地笔记信息的Cursor对象 + * @return 同步操作类型 + */ + public int getSyncAction(Cursor c) { + try { + // 如果本地没有修改 + if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { + // there is no local update + // 如果没有更新，返回SYNC_ACTION_NONE + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { + // no update both side + return SYNC_ACTION_NONE; + } else { + // 应用远程更新到本地 + // apply remote to local + return SYNC_ACTION_UPDATE_LOCAL; + } + } else { + // 验证Google任务ID是否匹配 + // validate gtask id + if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { + Log.e(TAG, "gtask id doesn't match"); + return SYNC_ACTION_ERROR; + } + // 如果同步ID与最后修改时间匹配，表示只有本地修改 + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { + // local modification only + return SYNC_ACTION_UPDATE_REMOTE; + } else { + // for folder conflicts, just apply local modification + // 对于文件夹冲突，直接应用本地修改 + return SYNC_ACTION_UPDATE_REMOTE; + } + } + } catch (Exception e) { + Log.e(TAG, e.toString()); + // 捕获异常并记录错误日志 + e.printStackTrace(); + } + + return SYNC_ACTION_ERROR; // 默认返回SYNC_ACTION_ERROR + } +/* + * 获取子任务的数量。 + * @return 子任务的数量 + */ + public int getChildTaskCount() { + return mChildren.size(); + } +/* + * 添加子任务到任务列表中。 + * @param task 要添加的子任务 + * @return 如果成功添加子任务，返回true；否则返回false + */ + 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; + } +/* + * 在指定索引位置添加子任务到任务列表中。 + * @param task 要添加的子任务 + * @param index 要添加的索引位置 + * @return 如果成功添加子任务，返回true；否则返回false + */ + 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; + } +/* + * 从任务列表中移除指定的子任务。 + * @param task 要移除的子任务 + * @return 如果成功移除子任务，返回true；否则返回false + */ + public boolean removeChildTask(Task task) { + boolean ret = false; + // 获取任务在子任务列表中的索引 + int index = mChildren.indexOf(task); + 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; + } +/* + * 将子任务移动到指定索引位置。 + * @param task 要移动的子任务 + * @param index 目标索引位置 + * @return 如果成功移动子任务，返回true；否则返回false + */ + public boolean moveChildTask(Task task, int index) { + // 检查目标索引是否有效 + if (index < 0 || index >= mChildren.size()) { + 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)); + } +/* + * 根据任务的全局唯一标识符（GID）查找子任务。 + * @param gid 任务的全局唯一标识符 + * @return 找到的子任务，如果未找到则返回null + */ + public Task findChildTaskByGid(String gid) { + // 遍历子任务列表 + for (int i = 0; i < mChildren.size(); i++) { + Task t = mChildren.get(i); + // 如果任务的GID与传入的GID匹配，则返回该任务 + if (t.getGid().equals(gid)) { + return t; + } + } + // 如果未找到匹配的任务，返回null + return null; + } +/* + * 获取子任务在任务列表中的索引。 + * @param task 子任务 + * @return 子任务在任务列表中的索引，如果未找到则返回-1 + */ + public int getChildTaskIndex(Task task) { + return mChildren.indexOf(task); + } +/* + * 根据索引获取子任务。 + * @param index 子任务的索引 + * @return 指定索引位置的子任务，如果索引无效则返回null + */ + public Task getChildTaskByIndex(int index) { + if (index < 0 || index >= mChildren.size()) { + Log.e(TAG, "getTaskByIndex: invalid index"); + return null; + } + return mChildren.get(index); + } +/* + * 根据任务的全局唯一标识符（GID）获取子任务。 + * @param gid 任务的全局唯一标识符 + * @return 找到的子任务，如果未找到则返回null + */ + public Task getChilTaskByGid(String gid) { + for (Task task : mChildren) { + if (task.getGid().equals(gid)) + return task; + } + return null; + } +/* + * 获取子任务列表。 + * @return 子任务列表 + */ + public ArrayList getChildTaskList() { + return this.mChildren; + } +/* + * 设置任务列表的索引。 + * @param index 任务列表的索引 + */ + public void setIndex(int index) { + this.mIndex = index; + } +/* + * 获取任务列表的索引。 + * @return 任务列表的索引 + */ + public int getIndex() { + return this.mIndex; + } +}