diff --git a/src/net/micode/notes/gtask/data/SqlNote.java b/src/net/micode/notes/gtask/data/SqlNote.java index 79a4095..f89a238 100644 --- a/src/net/micode/notes/gtask/data/SqlNote.java +++ b/src/net/micode/notes/gtask/data/SqlNote.java @@ -37,12 +37,17 @@ import org.json.JSONObject; import java.util.ArrayList; - +/** + * SqlNote 类用于处理笔记的数据库操作,包括创建、更新、加载笔记数据等。 + * 它封装了笔记的基本属性和与数据库交互的方法。 + */ public class SqlNote { - private static final String TAG = SqlNote.class.getSimpleName(); + private static final String TAG = SqlNote.class.getSimpleName(); // 日志标签 + // 无效 ID 的标识 private static final int INVALID_ID = -99999; + // 数据库中笔记表的字段映射 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, @@ -52,89 +57,79 @@ public class SqlNote { 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; - + // 笔记的 ID private long mId; - + // 提醒日期 private long mAlertDate; - + // 背景颜色 ID private int mBgColorId; - + // 创建日期 private long mCreatedDate; - + // 是否有附件 private int mHasAttachment; - + // 修改日期 private long mModifiedDate; - + // 父笔记 ID private long mParentId; - + // 笔记摘要 private String mSnippet; - + // 笔记类型 private int mType; - + // 小部件 ID private int mWidgetId; - + // 小部件类型 private int mWidgetType; - + // 原始父笔记 ID private long mOriginParent; - + // 笔记版本 private long mVersion; - + // 用于记录修改的 ContentValues private ContentValues mDiffNoteValues; - + // 笔记数据列表 private ArrayList mDataList; + /** + * 构造函数,用于创建一个新的 SqlNote 对象。 + * @param context 上下文对象 + */ public SqlNote(Context context) { mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = true; mId = INVALID_ID; mAlertDate = 0; - mBgColorId = ResourceParser.getDefaultBgId(context); - mCreatedDate = System.currentTimeMillis(); + mBgColorId = ResourceParser.getDefaultBgId(context); // 默认背景颜色 + mCreatedDate = System.currentTimeMillis(); // 当前时间 mHasAttachment = 0; - mModifiedDate = System.currentTimeMillis(); + mModifiedDate = System.currentTimeMillis(); // 当前时间 mParentId = 0; mSnippet = ""; - mType = Notes.TYPE_NOTE; + mType = Notes.TYPE_NOTE; // 默认为普通笔记类型 mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; mWidgetType = Notes.TYPE_WIDGET_INVALIDE; mOriginParent = 0; @@ -143,39 +138,52 @@ public class SqlNote { mDataList = new ArrayList(); } + /** + * 构造函数,用于从数据库中的 Cursor 加载笔记数据。 + * @param context 上下文对象 + * @param c 数据库查询结果的 Cursor + */ public SqlNote(Context context, Cursor c) { mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = false; - loadFromCursor(c); + loadFromCursor(c); // 从 Cursor 加载笔记数据 mDataList = new ArrayList(); if (mType == Notes.TYPE_NOTE) - loadDataContent(); + 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); + loadFromCursor(id); // 通过 ID 加载笔记数据 mDataList = new ArrayList(); if (mType == Notes.TYPE_NOTE) - loadDataContent(); + loadDataContent(); // 如果是普通笔记,加载笔记内容 mDiffNoteValues = new ContentValues(); - } + /** + * 通过笔记 ID 从数据库加载笔记数据。 + * @param id 笔记的 ID + */ private void loadFromCursor(long id) { Cursor c = null; try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", new String[] { - String.valueOf(id) + String.valueOf(id) }, null); if (c != null) { c.moveToNext(); - loadFromCursor(c); + loadFromCursor(c); // 从 Cursor 加载笔记数据 } else { Log.w(TAG, "loadFromCursor: cursor = null"); } @@ -185,6 +193,10 @@ public class SqlNote { } } + /** + * 从 Cursor 中加载笔记数据。 + * @param c 数据库查询结果的 Cursor + */ private void loadFromCursor(Cursor c) { mId = c.getLong(ID_COLUMN); mAlertDate = c.getLong(ALERTED_DATE_COLUMN); @@ -200,13 +212,16 @@ public class SqlNote { 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) + String.valueOf(mId) }, null); if (c != null) { if (c.getCount() == 0) { @@ -226,13 +241,18 @@ public class SqlNote { } } + /** + * 设置笔记内容,从 JSON 对象中解析数据。 + * @param js 包含笔记数据的 JSON 对象 + * @return 是否设置成功 + */ public boolean setContent(JSONObject js) { try { 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)) { @@ -247,6 +267,7 @@ public class SqlNote { } mType = type; } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { + // 对于普通笔记,解析所有字段 JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID; if (mIsCreate || mId != id) { @@ -331,6 +352,7 @@ public class SqlNote { } mOriginParent = originParent; + // 解析笔记内容数据 for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); SqlData sqlData = null; @@ -359,6 +381,10 @@ public class SqlNote { return true; } + /** + * 获取笔记内容,以 JSON 对象的形式返回。 + * @return 包含笔记数据的 JSON 对象 + */ public JSONObject getContent() { try { JSONObject js = new JSONObject(); @@ -370,6 +396,7 @@ public class SqlNote { JSONObject note = new JSONObject(); if (mType == Notes.TYPE_NOTE) { + // 普通笔记,包含详细字段 note.put(NoteColumns.ID, mId); note.put(NoteColumns.ALERTED_DATE, mAlertDate); note.put(NoteColumns.BG_COLOR_ID, mBgColorId); @@ -393,6 +420,7 @@ public class SqlNote { } 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); @@ -407,41 +435,77 @@ public class SqlNote { return null; } + /** + * 设置笔记的父笔记 ID。 + * @param id 父笔记 ID + */ public void setParentId(long id) { mParentId = id; mDiffNoteValues.put(NoteColumns.PARENT_ID, id); } + /** + * 设置笔记的 GTask ID。 + * @param gid GTask 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); } + /** + * 重置本地修改标记。 + */ 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 是否为普通笔记类型 + */ public boolean isNoteType() { return mType == Notes.TYPE_NOTE; } + /** + * 提交笔记数据到数据库。 + * @param validateVersion 是否验证版本号 + */ public void commit(boolean validateVersion) { if (mIsCreate) { + // 新建笔记 if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { mDiffNoteValues.remove(NoteColumns.ID); } @@ -463,21 +527,22 @@ public class SqlNote { } } } else { + // 更新笔记 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 ++; + mVersion++; int result = 0; if (!validateVersion) { result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?)", new String[] { - String.valueOf(mId) + String.valueOf(mId) }); } else { result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" - + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", + + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", new String[] { String.valueOf(mId), String.valueOf(mVersion) }); @@ -494,7 +559,7 @@ public class SqlNote { } } - // refresh local info + // 刷新本地信息 loadFromCursor(mId); if (mType == Notes.TYPE_NOTE) loadDataContent(); @@ -502,4 +567,4 @@ public class SqlNote { mDiffNoteValues.clear(); mIsCreate = false; } -} +} \ No newline at end of file