MiNote/model/WorkingNote.java

/*
 * 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;

// 工作笔记类，用于处理笔记的创建、加载、保存和属性管理
public class WorkingNote {
    // 笔记对象
    private Note mNote;
    // 笔记ID
    private long mNoteId;
    // 笔记内容
    private String mContent;
    // 笔记模式（普通模式/清单模式）
    private int mMode;

    private long mAlertDate;      // 提醒日期
    private long mModifiedDate;   // 最后修改日期
    private int mBgColorId;       // 背景颜色ID
    private int mWidgetId;        // 关联的小部件ID
    private int mWidgetType;      // 小部件类型
    private long mFolderId;       // 所属文件夹ID
    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;

    // 构造函数：创建新笔记
    private WorkingNote(Context context, long folderId) {
        mContext = context;
        mAlertDate = 0;  // 初始无提醒
        mModifiedDate = System.currentTimeMillis(); // 设置当前时间为修改时间
        mFolderId = folderId; // 设置文件夹ID
        mNote = new Note(); // 创建空的Note对象
        mNoteId = 0;        // 新笔记ID为0
        mIsDeleted = false; // 未删除状态
        mMode = 0;          // 默认模式
        mWidgetType = Notes.TYPE_WIDGET_INVALIDE; // 无效小部件类型
    }

    // 构造函数：加载现有笔记
    private WorkingNote(Context context, long noteId, long folderId) {
        mContext = context;
        mNoteId = noteId;   // 设置笔记ID
        mFolderId = folderId; // 设置文件夹ID
        mIsDeleted = false; // 未删除状态
        mNote = new Note(); // 创建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);
        }
    }

    // 创建空笔记的静态方法
    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);         // 设置小部件ID
        note.setWidgetType(widgetType);     // 设置小部件类型
        return note;
    }

    // 加载现有笔记的静态方法
    public static WorkingNote load(Context context, long id) {
        return new WorkingNote(context, id, 0);
    }

    // 保存笔记到数据库
    public synchronized boolean saveNote() {
        if (isWorthSaving()) { // 检查是否需要保存
            if (!existInDatabase()) {
                // 为新笔记生成ID
                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;
        }
    }

    // 检查笔记是否已存在数据库中
    public boolean existInDatabase() {
        return mNoteId > 0;
    }

    // 判断笔记是否需要保存
    private boolean isWorthSaving() {
        if (mIsDeleted || // 已删除
                (!existInDatabase() && TextUtils.isEmpty(mContent)) || // 新笔记且内容为空
                (existInDatabase() && !mNote.isLocalModified())) { // 已有笔记但未修改
            return false;
        } else {
            return true;
        }
    }

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

    // 设置提醒日期
    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;
        // 如果有关联小部件，通知更新
        if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
                && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) {
                mNoteSettingStatusListener.onWidgetChanged();
        }
    }

    // 设置背景颜色ID
    public void setBgColorId(int id) {
        if (id != mBgColorId) {
            mBgColorId = id;
            if (mNoteSettingStatusListener != null) {
                mNoteSettingStatusListener.onBackgroundColorChanged(); // 通知颜色变更
            }
            mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); // 更新Note对象
        }
    }

    // 设置清单模式
    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));
        }
    }

    // 设置小部件ID
    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); // 更新内容
        }
    }

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

    public int getBgColorResId() {
        return NoteBgResources.getNoteBgResource(mBgColorId);
    }

    public int getBgColorId() {
        return mBgColorId;
    }

    public int getTitleBgResId() {
        return NoteBgResources.getNoteTitleBgResource(mBgColorId);
    }

    public int getCheckListMode() {
        return mMode;
    }

    public long getNoteId() {
        return mNoteId;
    }

    public long getFolderId() {
        return mFolderId;
    }

    public int getWidgetId() {
        return mWidgetId;
    }

    public int getWidgetType() {
        return mWidgetType;
    }

    // 笔记设置变更监听器接口
    public interface NoteSettingChangedListener {
        // 背景颜色变更回调
        void onBackgroundColorChanged();

        // 提醒设置变更回调
        void onClockAlertChanged(long date, boolean set);

        // 小部件变更回调
        void onWidgetChanged();

        /**
         * 清单模式切换回调
         * @param oldMode 切换前的模式
         * @param newMode 切换后的模式
         */
        void onCheckListModeChanged(int oldMode, int newMode);
    }
}