/* * 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.model; import android.appwidget.AppWidgetManager; import android.content.ContentUris; import android.content.Context; import android.database.Cursor; import android.text.TextUtils; import android.util.Log; import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.CallNote; 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.TextNote; import net.micode.notes.tool.ResourceParser.NoteBgResources; /** *

工作笔记管理类，负责处理笔记的编辑、保存、加载等操作。

*

设计意图：作为Note类的包装类，提供更便捷的笔记操作接口，处理用户交互和数据同步。

* *

关键关联：

* */ public class WorkingNote { /** *

笔记的核心数据管理对象。

*

业务含义：封装笔记的元数据和内容数据的变更管理。

*/ private Note mNote; /** *

笔记的唯一标识符。

*

业务含义：在数据库中唯一标识一条笔记记录。

*

约束条件：0表示笔记尚未保存到数据库。

*/ private long mNoteId; /** *

笔记的内容文本。

*

业务含义：笔记的主要内容数据。

*/ private String mContent; /** *

笔记的模式。

*

业务含义：表示笔记的显示模式，如普通文本模式或清单模式。

*/ private int mMode; /** *

笔记的提醒时间。

*

业务含义：笔记的闹钟提醒时间戳。

*

约束条件：0表示无提醒。

*/ private long mAlertDate; /** *

笔记的最后修改时间。

*

业务含义：记录笔记最后一次修改的时间戳。

*/ private long mModifiedDate; /** *

笔记的背景颜色ID。

*

业务含义：标识笔记使用的背景颜色资源。

*/ private int mBgColorId; /** *

笔记关联的小组件ID。

*

业务含义：与笔记关联的桌面小组件的唯一标识符。

*

约束条件：{@link AppWidgetManager#INVALID_APPWIDGET_ID}表示无关联小组件。

*/ private int mWidgetId; /** *

笔记关联的小组件类型。

*

业务含义：标识与笔记关联的桌面小组件的类型。

*

约束条件：{@link Notes#TYPE_WIDGET_INVALIDE}表示无关联小组件。

*/ private int mWidgetType; /** *

笔记所在的文件夹ID。

*

业务含义：标识笔记所属的文件夹。

*/ private long mFolderId; /** *

上下文对象。

*

业务含义：用于访问系统服务和资源。

*/ private Context mContext; /** *

日志标签。

*

业务含义：用于在日志中标识WorkingNote类的相关操作。

*/ private static final String TAG = "WorkingNote"; /** *

笔记是否已删除的标记。

*

业务含义：标识笔记是否已被标记为删除。

*/ private boolean mIsDeleted; /** *

笔记设置变更监听器。

*

业务含义：用于监听笔记设置的变更事件。

*/ private NoteSettingChangedListener mNoteSettingStatusListener; /** *

笔记内容数据的查询投影。

*

业务含义：定义从Notes.CONTENT_DATA_URI查询时需要获取的列。

*/ public static final String[] DATA_PROJECTION = new String[] { DataColumns.ID, DataColumns.CONTENT, DataColumns.MIME_TYPE, DataColumns.DATA1, DataColumns.DATA2, DataColumns.DATA3, DataColumns.DATA4, }; /** *

笔记元数据的查询投影。

*

业务含义：定义从Notes.CONTENT_NOTE_URI查询时需要获取的列。

*/ public static final String[] NOTE_PROJECTION = new String[] { NoteColumns.PARENT_ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE, NoteColumns.MODIFIED_DATE }; /** *

DATA_PROJECTION中ID列的索引。

*/ private static final int DATA_ID_COLUMN = 0; /** *

DATA_PROJECTION中CONTENT列的索引。

*/ private static final int DATA_CONTENT_COLUMN = 1; /** *

DATA_PROJECTION中MIME_TYPE列的索引。

*/ private static final int DATA_MIME_TYPE_COLUMN = 2; /** *

DATA_PROJECTION中DATA1列的索引，用于存储模式信息。

*/ private static final int DATA_MODE_COLUMN = 3; /** *

NOTE_PROJECTION中PARENT_ID列的索引。

*/ private static final int NOTE_PARENT_ID_COLUMN = 0; /** *

NOTE_PROJECTION中ALERTED_DATE列的索引。

*/ private static final int NOTE_ALERTED_DATE_COLUMN = 1; /** *

NOTE_PROJECTION中BG_COLOR_ID列的索引。

*/ private static final int NOTE_BG_COLOR_ID_COLUMN = 2; /** *

NOTE_PROJECTION中WIDGET_ID列的索引。

*/ private static final int NOTE_WIDGET_ID_COLUMN = 3; /** *

NOTE_PROJECTION中WIDGET_TYPE列的索引。

*/ private static final int NOTE_WIDGET_TYPE_COLUMN = 4; /** *

NOTE_PROJECTION中MODIFIED_DATE列的索引。

*/ private static final int NOTE_MODIFIED_DATE_COLUMN = 5; /** *

创建新笔记的构造函数。

*

功能：初始化一个新的工作笔记对象，设置默认值。

* * @param context 上下文对象，用于访问系统服务 * @param folderId 文件夹ID，新笔记将被添加到该文件夹 * *

默认初始化：

* */ private WorkingNote(Context context, long folderId) { mContext = context; mAlertDate = 0; mModifiedDate = System.currentTimeMillis(); mFolderId = folderId; mNote = new Note(); mNoteId = 0; mIsDeleted = false; mMode = 0; mWidgetType = Notes.TYPE_WIDGET_INVALIDE; } /** *

加载现有笔记的构造函数。

*

功能：初始化一个工作笔记对象，并从数据库加载现有笔记数据。

* * @param context 上下文对象，用于访问系统服务 * @param noteId 笔记ID，要加载的现有笔记 * @param folderId 文件夹ID，笔记所属的文件夹 * *

加载流程：

* */ private WorkingNote(Context context, long noteId, long folderId) { mContext = context; mNoteId = noteId; mFolderId = folderId; mIsDeleted = false; mNote = new Note(); loadNote(); } /** *

加载笔记的元数据。

*

功能：从数据库查询并加载笔记的元数据信息。

* *

加载流程：

*
    *
  1. 通过ContentResolver查询{@link Notes#CONTENT_NOTE_URI}获取笔记元数据
    2. *
  2. 如果查询成功，提取并保存元数据字段
    3. *
  3. 关闭Cursor
    4. *
  4. 如果查询失败，记录日志并抛出异常
    5. *
  5. 调用{@link #loadNoteData()}加载笔记内容数据
    6. *
* *

加载的元数据字段：

* * *

错误处理：

* */ 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); mWidgetType = cursor.getInt(NOTE_WIDGET_TYPE_COLUMN); mAlertDate = cursor.getLong(NOTE_ALERTED_DATE_COLUMN); mModifiedDate = cursor.getLong(NOTE_MODIFIED_DATE_COLUMN); } cursor.close(); } else { Log.e(TAG, "No note with id:" + mNoteId); throw new IllegalArgumentException("Unable to find note with id " + mNoteId); } loadNoteData(); } /** *

加载笔记的内容数据。

*

功能：从数据库查询并加载笔记的内容数据信息。

* *

加载流程：

*
    *
  1. 通过ContentResolver查询{@link Notes#CONTENT_DATA_URI}获取笔记内容数据
    2. *
  2. 如果查询成功，遍历所有结果
    3. *
  3. 根据数据类型处理不同类型的内容数据：
    4. * *
  4. 关闭Cursor
    5. *
  5. 如果查询失败，记录日志并抛出异常
    6. *
* *

错误处理：

* */ private void loadNoteData() { Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { String.valueOf(mNoteId) }, null); 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); } } while (cursor.moveToNext()); } cursor.close(); } else { Log.e(TAG, "No data with id:" + mNoteId); throw new IllegalArgumentException("Unable to find note's data with id " + mNoteId); } } /** *

创建一个空的工作笔记。

*

功能：创建一个新的工作笔记对象，并设置默认属性。

* * @param context 上下文对象，用于访问系统服务 * @param folderId 文件夹ID，新笔记将被添加到该文件夹 * @param widgetId 小组件ID，如果笔记关联到小组件 * @param widgetType 小组件类型，如果笔记关联到小组件 * @param defaultBgColorId 默认背景颜色ID * * @return 创建的工作笔记对象 * *

初始化步骤：

*
    *
  1. 创建新的WorkingNote实例
    2. *
  2. 设置默认背景颜色
    3. *
  3. 设置小组件ID（如果有）
    4. *
  4. 设置小组件类型（如果有）
    5. *
  5. 返回创建的笔记对象
    6. *
*/ public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, int widgetType, int defaultBgColorId) { WorkingNote note = new WorkingNote(context, folderId); note.setBgColorId(defaultBgColorId); note.setWidgetId(widgetId); note.setWidgetType(widgetType); return note; } /** *

从数据库加载现有笔记。

*

功能：根据笔记ID从数据库加载笔记数据，并创建工作笔记对象。

* * @param context 上下文对象，用于访问系统服务 * @param id 笔记ID，要加载的现有笔记 * * @return 加载的工作笔记对象 * *

加载流程：

* */ public static WorkingNote load(Context context, long id) { return new WorkingNote(context, id, 0); } /** *

保存笔记到数据库。

*

功能：将工作笔记的内容和设置保存到数据库中。

* * @return 保存是否成功 * *

保存流程：

*
    *
  1. 检查笔记是否值得保存（{@link #isWorthSaving()}）
    2. *
  2. 如果笔记不存在于数据库：
    3. * *
  3. 调用{@link Note#syncNote(Context, long)}同步笔记数据到数据库
    4. *
  4. 如果笔记关联到小组件，通知小组件更新
    5. *
  5. 返回保存结果
    6. *
* *

线程安全：

* */ 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); return false; } } 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 && mNoteSettingStatusListener != null) { mNoteSettingStatusListener.onWidgetChanged(); } return true; } else { return false; } } /** *

检查笔记是否存在于数据库中。

*

功能：根据笔记ID判断笔记是否已保存到数据库。

* * @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; } else { return true; } } /** *

设置笔记设置变更监听器。

*

功能：注册一个监听器，用于接收笔记设置变更的通知。

* * @param l 笔记设置变更监听器 */ public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) { mNoteSettingStatusListener = l; } /** *

设置笔记的提醒时间。

*

功能：更新笔记的提醒时间，并通知监听器。

* * @param date 提醒时间戳 * @param set 是否设置提醒（true表示设置，false表示取消） * *

处理流程：

*
    *
  1. 如果提醒时间发生变化：
    2. * *
  2. 通知监听器提醒时间已变更
    3. *
*/ public void setAlertDate(long date, boolean set) { if (date != mAlertDate) { mAlertDate = date; mNote.setNoteValue(NoteColumns.ALERTED_DATE, String.valueOf(mAlertDate)); } if (mNoteSettingStatusListener != null) { mNoteSettingStatusListener.onClockAlertChanged(date, set); } } /** *

标记笔记是否已删除。

*

功能：设置笔记的删除标记，并通知关联的小组件。

* * @param mark 删除标记（true表示已删除，false表示未删除） * *

处理流程：

*
    *
  1. 更新内部删除标记字段
    2. *
  2. 如果笔记关联到小组件，通知小组件更新
    3. *
*/ public void markDeleted(boolean mark) { mIsDeleted = mark; if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { mNoteSettingStatusListener.onWidgetChanged(); } } public void setBgColorId(int id) { if (id != mBgColorId) { mBgColorId = id; if (mNoteSettingStatusListener != null) { mNoteSettingStatusListener.onBackgroundColorChanged(); } mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); } } public void setCheckListMode(int mode) { if (mMode != mode) { if (mNoteSettingStatusListener != null) { mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode); } mMode = mode; mNote.setTextData(TextNote.MODE, String.valueOf(mMode)); } } public void setWidgetType(int type) { if (type != mWidgetType) { mWidgetType = type; mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType)); } } public void setWidgetId(int id) { if (id != mWidgetId) { mWidgetId = id; mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId)); } } public void setWorkingText(String text) { if (!TextUtils.equals(mContent, text)) { mContent = text; mNote.setTextData(DataColumns.CONTENT, mContent); } } /** *

将笔记转换为通话笔记。

*

功能：设置笔记为通话笔记类型，并添加通话相关信息。

* * @param phoneNumber 电话号码 * @param callDate 通话时间戳 * *

转换流程：

*
    *
  1. 设置通话日期
    2. *
  2. 设置电话号码
    3. *
  3. 将笔记移动到通话记录文件夹
    4. *
*/ 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 清单模式（0表示普通模式，1表示清单模式） */ public int getCheckListMode() { return mMode; } /** *

获取笔记的ID。

* @return 笔记的唯一标识符 */ public long getNoteId() { return mNoteId; } /** *

获取笔记所属的文件夹ID。

* @return 文件夹ID */ public long getFolderId() { return mFolderId; } /** *

获取笔记关联的小组件ID。

* @return 小组件ID（无效时返回{@link AppWidgetManager#INVALID_APPWIDGET_ID}） */ public int getWidgetId() { return mWidgetId; } /** *

获取笔记关联的小组件类型。

* @return 小组件类型（无效时返回{@link Notes#TYPE_WIDGET_INVALIDE}） */ 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 */ 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 */ void onCheckListModeChanged(int oldMode, int newMode); } }