xiaomi/src/net/micode/notes/model/WorkingNote.java

/**
 * 文件的版权声明，说明该文件是 MiCode 开源社区的版权所有，并且遵循 Apache License 2.0。
 */
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;

/**
 * WorkingNote 类表示一个正在工作的笔记实体，包含笔记的数据和相关操作。
 */
public class WorkingNote {
    // 笔记对象。
    private Note mNote;
    // 笔记ID。
    private long mNoteId;
    // 笔记内容。
    private String mContent;
    // 笔记模式。
    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,
            DataColumns.MIME_TYPE,
            DataColumns.DATA1,
            DataColumns.DATA2,
            DataColumns.DATA3,
            DataColumns.DATA4,
    };

    // 笔记数据库查询时使用的列投影。
    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
    };

    // 数据库查询列的索引。
    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;

    /**
     * WorkingNote 类的构造函数，用于创建一个新的笔记。
     * @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;
    }

    /**
     * WorkingNote 类的构造函数，用于加载一个已存在的笔记。
     * @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();
    }

    /**
     * 从数据库加载笔记数据。
     */
    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();
    }

    /**
     * 从数据库加载笔记的内容数据。
     */
    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 空的笔记实例。
     */
    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;
    }

    /**
     * 从数据库加载一个笔记实例。
     * @param context 应用程序上下文。
     * @param id 笔记ID。
     * @return 笔记实例。
     */
    public static WorkingNote load(Context context, long id) {
        return new WorkingNote(context, id, 0);
    }

    /**
     * 保存笔记到数据库。
     * @return 如果保存成功，返回 true。
     */
    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);

            /**
             * 如果存在任何小部件，则更新小部件内容
             */
            if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
                    && mWidgetType != Notes.TYPE_WIDGET_INVALIDE
                    && mNoteSettingStatusListener != null) {
                mNoteSettingStatusListener.onWidgetChanged();
            }
            return true;
        } else {
            return false;
        }
    }

    /**
     * 检查笔记是否存在于数据库中。
     * @return 如果存在，返回 true。
     */
    public boolean existInDatabase() {
        return mNoteId > 0;
    }

    /**
     * 检查笔记是否值得保存。
     * @return 如果值得保存，返回 true。
     */
    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 是否设置提醒。
     */
    // 设置提醒日期
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);
    }
}

// 标记笔记是否被删除
public void markDeleted(boolean mark) {
    mIsDeleted = mark;
    // 如果widget ID有效，widget类型有效，且设置了监听器，则通知监听器widget已更改
    if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
            && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) {
        mNoteSettingStatusListener.onWidgetChanged();
    }
}

// 设置笔记的背景颜色ID
public void setBgColorId(int id) {
    // 如果传入的颜色ID与当前颜色ID不同，则更新颜色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));
    }
}

// 设置widget类型
public void setWidgetType(int type) {
    // 如果传入的类型与当前类型不同，则更新类型
    if (type != mWidgetType) {
        mWidgetType = type;
        mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType));
    }
}

// 设置widget ID
public void setWidgetId(int id) {
    // 如果传入的ID与当前ID不同，则更新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);
    }
}

// 将笔记转换为通话记录笔记
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));
}

// 检查笔记是否有提醒
public boolean hasClockAlert() {
    return (mAlertDate > 0 ? true : false);
}

// 获取笔记的内容
public String getContent() {
    return mContent;
}

// 获取提醒日期
public long getAlertDate() {
    return mAlertDate;
}

// 获取笔记的修改日期
public long getModifiedDate() {
    return mModifiedDate;
}

// 获取背景颜色资源ID
public int getBgColorResId() {
    return NoteBgResources.getNoteBgResource(mBgColorId);
}

// 获取背景颜色ID
public int getBgColorId() {
    return mBgColorId;
}

// 获取标题背景资源ID
public int getTitleBgResId() {
    return NoteBgResources.getNoteTitleBgResource(mBgColorId);
}

// 获取清单模式
public int getCheckListMode() {
    return mMode;
}

// 获取笔记ID
public long getNoteId() {
    return mNoteId;
}

// 获取文件夹ID
public long getFolderId() {
    return mFolderId;
}

// 获取widget ID
public int getWidgetId() {
    return mWidgetId;
}

// 获取widget类型
public int getWidgetType() {
    return mWidgetType;
}

// 笔记设置更改监听器接口
public interface NoteSettingChangedListener {
    // 当前笔记的背景颜色刚刚更改时调用
    void onBackgroundColorChanged();

    // 用户设置时钟时调用
    void onClockAlertChanged(long date, boolean set);

    // 用户从widget创建笔记时调用
    void onWidgetChanged();

    // 用户在清单模式和普通模式之间切换时调用
    // oldMode 是更改前的模式
    // newMode 是新的模式
    void onCheckListModeChanged(int oldMode, int newMode);
}