diff --git a/src/Notes-master/app/src/main/java/net/micode/notes/model/WorkingNote.java b/src/Notes-master/app/src/main/java/net/micode/notes/model/WorkingNote.java index be081e4..28ab74c 100644 --- a/src/Notes-master/app/src/main/java/net/micode/notes/model/WorkingNote.java +++ b/src/Notes-master/app/src/main/java/net/micode/notes/model/WorkingNote.java @@ -31,37 +31,44 @@ import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.Notes.TextNote; import net.micode.notes.tool.ResourceParser.NoteBgResources; - +/** + * WorkingNote 类用于管理和操作笔记数据，提供创建、加载、保存和更新笔记的功能。 + * 该类封装了笔记的各种属性和设置，包括内容、背景颜色、提醒日期、便签小部件等。 + * 它内部使用 Note 类来处理实际的数据存储操作，并提供了更高级的业务逻辑处理。 + */ public class WorkingNote { - // Note for the working note + // 内部使用的Note对象，用于处理实际的数据存储 private Note mNote; - // Note Id + // 笔记ID private long mNoteId; - // Note content + // 笔记内容 private String mContent; - // Note mode + // 笔记模式（普通文本或检查列表） private int mMode; - + // 提醒日期（毫秒时间戳） private long mAlertDate; - + // 修改日期 private long mModifiedDate; - + // 背景颜色ID private int mBgColorId; - + // 便签小部件ID private int mWidgetId; - + // 便签小部件类型 private int mWidgetType; - + // 所属文件夹ID private long mFolderId; - + // 应用上下文 private Context mContext; - + // 日志标签 private static final String TAG = "WorkingNote"; - + // 标记笔记是否已删除 private boolean mIsDeleted; - + // 笔记设置变更监听器 private NoteSettingChangedListener mNoteSettingStatusListener; + /** + * 数据查询投影，定义从数据表中查询的列 + */ public static final String[] DATA_PROJECTION = new String[] { DataColumns.ID, DataColumns.CONTENT, @@ -72,6 +79,9 @@ public class WorkingNote { DataColumns.DATA4, }; + /** + * 笔记查询投影，定义从笔记表中查询的列 + */ public static final String[] NOTE_PROJECTION = new String[] { NoteColumns.PARENT_ID, NoteColumns.ALERTED_DATE, @@ -81,27 +91,26 @@ public class WorkingNote { NoteColumns.MODIFIED_DATE }; + // 数据查询结果集中各列的索引 private static final int DATA_ID_COLUMN = 0; - private static final int DATA_CONTENT_COLUMN = 1; - private static final int DATA_MIME_TYPE_COLUMN = 2; - private static final int DATA_MODE_COLUMN = 3; + // 笔记查询结果集中各列的索引 private static final int NOTE_PARENT_ID_COLUMN = 0; - private static final int NOTE_ALERTED_DATE_COLUMN = 1; - private static final int NOTE_BG_COLOR_ID_COLUMN = 2; - private static final int NOTE_WIDGET_ID_COLUMN = 3; - private static final int NOTE_WIDGET_TYPE_COLUMN = 4; - private static final int NOTE_MODIFIED_DATE_COLUMN = 5; - // New note construct + /** + * 私有构造函数，用于创建新笔记 + * + * @param context 应用上下文 + * @param folderId 笔记所属文件夹ID + */ private WorkingNote(Context context, long folderId) { mContext = context; mAlertDate = 0; @@ -114,7 +123,13 @@ public class WorkingNote { mWidgetType = Notes.TYPE_WIDGET_INVALIDE; } - // Existing note construct + /** + * 私有构造函数，用于加载现有笔记 + * + * @param context 应用上下文 + * @param noteId 笔记ID + * @param folderId 笔记所属文件夹ID + */ private WorkingNote(Context context, long noteId, long folderId) { mContext = context; mNoteId = noteId; @@ -124,13 +139,20 @@ public class WorkingNote { loadNote(); } + /** + * 从数据库加载笔记的基本信息 + * + * @throws IllegalArgumentException 当找不到指定ID的笔记时抛出 + */ private void loadNote() { + // 查询笔记基本信息 Cursor cursor = mContext.getContentResolver().query( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null, null, null); if (cursor != null) { if (cursor.moveToFirst()) { + // 从查询结果中提取笔记属性 mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN); mBgColorId = cursor.getInt(NOTE_BG_COLOR_ID_COLUMN); mWidgetId = cursor.getInt(NOTE_WIDGET_ID_COLUMN); @@ -143,10 +165,17 @@ public class WorkingNote { Log.e(TAG, "No note with id:" + mNoteId); throw new IllegalArgumentException("Unable to find note with id " + mNoteId); } + // 加载笔记的详细数据 loadNoteData(); } + /** + * 从数据库加载笔记的详细数据（内容、类型等） + * + * @throws IllegalArgumentException 当找不到指定ID的笔记数据时抛出 + */ private void loadNoteData() { + // 查询笔记的详细数据 Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { String.valueOf(mNoteId) @@ -154,13 +183,16 @@ public class WorkingNote { if (cursor != null) { if (cursor.moveToFirst()) { + // 遍历查询结果，处理不同类型的数据 do { String type = cursor.getString(DATA_MIME_TYPE_COLUMN); if (DataConstants.NOTE.equals(type)) { + // 处理文本笔记数据 mContent = cursor.getString(DATA_CONTENT_COLUMN); mMode = cursor.getInt(DATA_MODE_COLUMN); mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); } else if (DataConstants.CALL_NOTE.equals(type)) { + // 处理通话记录笔记数据 mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); } else { Log.d(TAG, "Wrong note type with type:" + type); @@ -174,6 +206,16 @@ public class WorkingNote { } } + /** + * 创建一个空笔记 + * + * @param context 应用上下文 + * @param folderId 笔记所属文件夹ID + * @param widgetId 便签小部件ID + * @param widgetType 便签小部件类型 + * @param defaultBgColorId 默认背景颜色ID + * @return 新创建的WorkingNote对象 + */ public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, int widgetType, int defaultBgColorId) { WorkingNote note = new WorkingNote(context, folderId); @@ -183,12 +225,25 @@ public class WorkingNote { return note; } + /** + * 从数据库加载指定ID的笔记 + * + * @param context 应用上下文 + * @param id 笔记ID + * @return 加载的WorkingNote对象 + */ public static WorkingNote load(Context context, long id) { return new WorkingNote(context, id, 0); } + /** + * 保存笔记到数据库 + * + * @return 保存成功返回true，失败返回false + */ public synchronized boolean saveNote() { if (isWorthSaving()) { + // 如果笔记在数据库中不存在，创建新笔记 if (!existInDatabase()) { if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { Log.e(TAG, "Create new note fail with id:" + mNoteId); @@ -196,10 +251,11 @@ public class WorkingNote { } } + // 同步笔记数据到数据库 mNote.syncNote(mContext, mNoteId); /** - * Update widget content if there exist any widget of this note + * 如果存在该笔记的便签小部件，更新小部件内容 */ if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID && mWidgetType != Notes.TYPE_WIDGET_INVALIDE @@ -212,11 +268,22 @@ public class WorkingNote { } } + /** + * 检查笔记是否已存在于数据库中 + * + * @return 如果笔记已存在返回true，否则返回false + */ public boolean existInDatabase() { return mNoteId > 0; } + /** + * 判断笔记是否值得保存 + * + * @return 如果值得保存返回true，否则返回false + */ private boolean isWorthSaving() { + // 如果笔记已删除、为空且未在数据库中存在、或已存在但无修改，则不值得保存 if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) || (existInDatabase() && !mNote.isLocalModified())) { return false; @@ -225,10 +292,21 @@ public class WorkingNote { } } + /** + * 设置笔记设置变更监听器 + * + * @param l 监听器对象 + */ public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) { mNoteSettingStatusListener = l; } + /** + * 设置笔记的提醒日期 + * + * @param date 提醒日期（毫秒时间戳） + * @param set 是否设置提醒 + */ public void setAlertDate(long date, boolean set) { if (date != mAlertDate) { mAlertDate = date; @@ -239,6 +317,11 @@ public class WorkingNote { } } + /** + * 标记笔记为已删除或未删除 + * + * @param mark true表示已删除，false表示未删除 + */ public void markDeleted(boolean mark) { mIsDeleted = mark; if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID @@ -247,6 +330,11 @@ public class WorkingNote { } } + /** + * 设置笔记的背景颜色 + * + * @param id 背景颜色ID + */ public void setBgColorId(int id) { if (id != mBgColorId) { mBgColorId = id; @@ -257,6 +345,11 @@ public class WorkingNote { } } + /** + * 设置笔记的检查列表模式 + * + * @param mode 模式值 + */ public void setCheckListMode(int mode) { if (mMode != mode) { if (mNoteSettingStatusListener != null) { @@ -267,6 +360,11 @@ public class WorkingNote { } } + /** + * 设置笔记的便签小部件类型 + * + * @param type 小部件类型 + */ public void setWidgetType(int type) { if (type != mWidgetType) { mWidgetType = type; @@ -274,6 +372,11 @@ public class WorkingNote { } } + /** + * 设置笔记的便签小部件ID + * + * @param id 小部件ID + */ public void setWidgetId(int id) { if (id != mWidgetId) { mWidgetId = id; @@ -281,6 +384,11 @@ public class WorkingNote { } } + /** + * 设置笔记的工作文本内容 + * + * @param text 文本内容 + */ public void setWorkingText(String text) { if (!TextUtils.equals(mContent, text)) { mContent = text; @@ -288,80 +396,153 @@ public class WorkingNote { } } + /** + * 将笔记转换为通话记录笔记 + * + * @param phoneNumber 电话号码 + * @param callDate 通话日期 + */ public void convertToCallNote(String phoneNumber, long callDate) { mNote.setCallData(CallNote.CALL_DATE, String.valueOf(callDate)); mNote.setCallData(CallNote.PHONE_NUMBER, phoneNumber); mNote.setNoteValue(NoteColumns.PARENT_ID, String.valueOf(Notes.ID_CALL_RECORD_FOLDER)); } + /** + * 检查笔记是否设置了时钟提醒 + * + * @return 如果设置了提醒返回true，否则返回false + */ public boolean hasClockAlert() { return (mAlertDate > 0 ? true : false); } + /** + * 获取笔记内容 + * + * @return 笔记内容字符串 + */ public String getContent() { return mContent; } + /** + * 获取笔记的提醒日期 + * + * @return 提醒日期（毫秒时间戳） + */ public long getAlertDate() { return mAlertDate; } + /** + * 获取笔记的修改日期 + * + * @return 修改日期（毫秒时间戳） + */ public long getModifiedDate() { return mModifiedDate; } + /** + * 获取笔记背景颜色的资源ID + * + * @return 背景颜色资源ID + */ public int getBgColorResId() { return NoteBgResources.getNoteBgResource(mBgColorId); } + /** + * 获取笔记背景颜色ID + * + * @return 背景颜色ID + */ public int getBgColorId() { return mBgColorId; } + /** + * 获取笔记标题背景的资源ID + * + * @return 标题背景资源ID + */ public int getTitleBgResId() { return NoteBgResources.getNoteTitleBgResource(mBgColorId); } + /** + * 获取笔记的检查列表模式 + * + * @return 检查列表模式值 + */ public int getCheckListMode() { return mMode; } + /** + * 获取笔记ID + * + * @return 笔记ID + */ public long getNoteId() { return mNoteId; } + /** + * 获取笔记所属文件夹ID + * + * @return 文件夹ID + */ public long getFolderId() { return mFolderId; } + /** + * 获取笔记的便签小部件ID + * + * @return 小部件ID + */ public int getWidgetId() { return mWidgetId; } + /** + * 获取笔记的便签小部件类型 + * + * @return 小部件类型 + */ public int getWidgetType() { return mWidgetType; } + /** + * 笔记设置变更监听器接口，用于通知笔记设置的变化 + */ public interface NoteSettingChangedListener { /** - * Called when the background color of current note has just changed + * 当笔记的背景颜色发生变化时调用 */ void onBackgroundColorChanged(); /** - * Called when user set clock + * 当用户设置或取消时钟提醒时调用 + * + * @param date 提醒日期 + * @param set 是否设置提醒 */ void onClockAlertChanged(long date, boolean set); /** - * Call when user create note from widget + * 当用户从便签小部件创建笔记时调用 */ void onWidgetChanged(); /** - * Call when switch between check list mode and normal mode - * @param oldMode is previous mode before change - * @param newMode is new mode + * 当在检查列表模式和普通模式之间切换时调用 + * + * @param oldMode 切换前的模式 + * @param newMode 切换后的模式 */ void onCheckListModeChanged(int oldMode, int newMode); }