Compare commits

...

9 Commits

Binary file not shown.

After

Width:  |  Height:  |  Size: 545 KiB

@ -2,32 +2,52 @@
* Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* Apache 2.0使
* 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.data;
// 定义该类所属的包名用于在Java项目中对类进行组织和管理方便区分不同功能模块的类等。
import android.content.Context;
// 引入Android系统的上下文类用于获取系统相关资源、访问系统服务等操作。
import android.database.Cursor;
// 用于处理数据库查询结果集的类,通过它可以遍历查询返回的数据行等。
import android.provider.ContactsContract.CommonDataKinds.Phone;
// 用于访问联系人中电话号码相关信息的常量和接口等,方便操作联系人电话号码相关的数据。
import android.provider.ContactsContract.Data;
// 用于访问联系人数据的相关常量和接口,可用于构建查询联系人相关信息的语句等。
import android.telephony.PhoneNumberUtils;
// 提供了一些处理电话号码相关的实用工具方法,比如格式化、匹配等操作。
import android.util.Log;
// Android系统提供的用于记录日志的类方便调试和查看程序运行过程中的相关信息。
import java.util.HashMap;
// Java中用于存储键值对数据的集合类在这里用于缓存联系人相关信息。
public class Contact {
// 定义Contact类用于处理与联系人相关的操作比如根据电话号码查找联系人姓名等。
private static HashMap<String, String> sContactCache;
// 定义一个静态的HashMap用于缓存电话号码和对应的联系人姓名这样可以避免重复查询数据库提高效率。
// 键为电话号码字符串,值为对应的联系人姓名字符串。
private static final String TAG = "Contact";
// 定义一个日志标签字符串常量,用于在记录日志时标识是该类产生的日志信息,方便在查看日志时进行筛选和定位。
private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER
+ ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'"
@ -35,39 +55,65 @@ public class Contact {
+ "(SELECT raw_contact_id "
+ " FROM phone_lookup"
+ " WHERE min_match = '+')";
// 定义一个静态的字符串常量用于构建查询联系人信息的SQL语句的选择条件部分。
// 它通过多个条件组合来筛选出符合特定电话号码对应的联系人信息例如通过电话号码相等比较、数据类型匹配、原始联系人ID相关条件等进行筛选。
public static String getContact(Context context, String phoneNumber) {
if(sContactCache == null) {
// 定义一个静态方法,用于根据给定的上下文(用于访问系统资源等)和电话号码来获取对应的联系人姓名。
// 参数context是Android系统上下文phoneNumber是要查找联系人对应的电话号码字符串。
if (sContactCache == null) {
// 判断联系人缓存集合是否为空,如果为空则进行初始化操作。
sContactCache = new HashMap<String, String>();
// 创建一个新的HashMap实例用于后续缓存联系人信息。
}
if(sContactCache.containsKey(phoneNumber)) {
if (sContactCache.containsKey(phoneNumber)) {
// 判断缓存中是否已经存在给定电话号码对应的联系人姓名,如果存在则直接返回缓存中的姓名。
return sContactCache.get(phoneNumber);
}
String selection = CALLER_ID_SELECTION.replace("+",
PhoneNumberUtils.toCallerIDMinMatch(phoneNumber));
// 根据给定的电话号码,对之前定义的查询选择条件字符串常量进行替换操作,将其中的 '+' 替换为适合该电话号码的最小匹配格式通过PhoneNumberUtils工具类方法转换得到实际用于查询的选择条件字符串。
Cursor cursor = context.getContentResolver().query(
Data.CONTENT_URI,
new String [] { Phone.DISPLAY_NAME },
new String[]{Phone.DISPLAY_NAME},
selection,
new String[] { phoneNumber },
new String[]{phoneNumber},
null);
// 通过上下文的ContentResolver对象发起一个数据库查询操作查询联系人数据。
// 参数Data.CONTENT_URI指定了查询的内容提供者的URI即联系人数据的访问地址。
// 第二个参数指定了要查询返回的列这里只查询联系人的显示名称Phone.DISPLAY_NAME
// 第三个参数是前面构建好的查询选择条件字符串。
// 第四个参数是查询选择条件中占位符对应的实际值,这里就是要查找联系人对应的电话号码。
// 最后一个参数为null表示不进行排序等额外操作。
if (cursor != null && cursor.moveToFirst()) {
if (cursor!= null && cursor.moveToFirst()) {
// 判断查询返回的游标是否不为空并且游标可以移动到第一条数据(即有查询到符合条件的数据)。
try {
String name = cursor.getString(0);
// 从游标中获取第一条数据也就是查询到的联系人信息中的联系人姓名因为前面只查询了显示名称这一列所以这里索引为0获取该列的值。
sContactCache.put(phoneNumber, name);
// 将获取到的联系人姓名存入缓存集合中,键为传入的电话号码,方便下次查找相同电话号码时直接从缓存获取。
return name;
// 返回获取到的联系人姓名。
} catch (IndexOutOfBoundsException e) {
// 如果在从游标获取字符串数据时出现越界异常(比如查询结果列数与预期不符等情况),则捕获该异常。
Log.e(TAG, " Cursor get string error " + e.toString());
// 使用Log.e记录错误级别的日志标记是在游标获取字符串时出现错误并输出异常的字符串表示形式方便调试查看问题。
return null;
// 返回null表示获取联系人姓名失败。
} finally {
cursor.close();
// 无论是否成功获取到联系人姓名,都要关闭游标,释放相关资源,避免内存泄漏等问题。
}
} else {
Log.d(TAG, "No contact matched with number:" + phoneNumber);
// 如果游标为空或者游标中没有可移动到的第一条数据(即没有查询到符合条件的联系人信息),则记录一条调试级别的日志,提示没有找到与给定电话号码匹配的联系人。
return null;
// 返回null表示没有找到对应的联系人姓名。
}
}
}

@ -17,24 +17,32 @@
package net.micode.notes.data;
import android.net.Uri;
public class Notes {
// 定义授权标识符
public static final String AUTHORITY = "micode_notes";
// 日志标记
public static final String TAG = "Notes";
// 定义常量用于表示不同的笔记类型
public static final int TYPE_NOTE = 0;
public static final int TYPE_FOLDER = 1;
public static final int TYPE_SYSTEM = 2;
/**
* Following IDs are system folders' identifiers
* {@link Notes#ID_ROOT_FOLDER } is default folder
* {@link Notes#ID_TEMPARAY_FOLDER } is for notes belonging no folder
* {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records
*
* {@link Notes#ID_ROOT_FOLDER }
* {@link Notes#ID_TEMPARAY_FOLDER }
* {@link Notes#ID_CALL_RECORD_FOLDER}
*/
public static final int ID_ROOT_FOLDER = 0;
public static final int ID_TEMPARAY_FOLDER = -1;
public static final int ID_CALL_RECORD_FOLDER = -2;
public static final int ID_TRASH_FOLER = -3;
// 用于intent传递附加数据的常量
public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date";
public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id";
public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id";
@ -42,238 +50,150 @@ public class Notes {
public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id";
public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date";
// 小部件类型常量
public static final int TYPE_WIDGET_INVALIDE = -1;
public static final int TYPE_WIDGET_2X = 0;
public static final int TYPE_WIDGET_4X = 1;
// 数据常量类用于存储笔记和通话记录的MIME类型
public static class DataConstants {
public static final String NOTE = TextNote.CONTENT_ITEM_TYPE;
public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE;
}
/**
* Uri to query all notes and folders
* Uri
*/
public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");
/**
* Uri to query data
* Uri
*/
public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");
// 笔记列常量接口,包含笔记的各个字段
public interface NoteColumns {
/**
* The unique ID for a row
* <P> Type: INTEGER (long) </P>
*/
// 唯一的行ID
public static final String ID = "_id";
/**
* The parent's id for note or folder
* <P> Type: INTEGER (long) </P>
*/
// 笔记或文件夹的父ID
public static final String PARENT_ID = "parent_id";
/**
* Created data for note or folder
* <P> Type: INTEGER (long) </P>
*/
// 笔记或文件夹的创建时间
public static final String CREATED_DATE = "created_date";
/**
* Latest modified date
* <P> Type: INTEGER (long) </P>
*/
// 笔记或文件夹的最新修改时间
public static final String MODIFIED_DATE = "modified_date";
/**
* Alert date
* <P> Type: INTEGER (long) </P>
*/
// 警告时间
public static final String ALERTED_DATE = "alert_date";
/**
* Folder's name or text content of note
* <P> Type: TEXT </P>
*/
// 文件夹名称或笔记的简短内容
public static final String SNIPPET = "snippet";
/**
* Note's widget id
* <P> Type: INTEGER (long) </P>
*/
// 笔记的小部件ID
public static final String WIDGET_ID = "widget_id";
/**
* Note's widget type
* <P> Type: INTEGER (long) </P>
*/
// 笔记的小部件类型
public static final String WIDGET_TYPE = "widget_type";
/**
* Note's background color's id
* <P> Type: INTEGER (long) </P>
*/
// 笔记的背景颜色ID
public static final String BG_COLOR_ID = "bg_color_id";
/**
* For text note, it doesn't has attachment, for multi-media
* note, it has at least one attachment
* <P> Type: INTEGER </P>
*/
// 笔记是否包含附件(对于多媒体笔记)
public static final String HAS_ATTACHMENT = "has_attachment";
/**
* Folder's count of notes
* <P> Type: INTEGER (long) </P>
*/
// 文件夹内笔记的数量
public static final String NOTES_COUNT = "notes_count";
/**
* The file type: folder or note
* <P> Type: INTEGER </P>
*/
// 文件类型:笔记或文件夹
public static final String TYPE = "type";
/**
* The last sync id
* <P> Type: INTEGER (long) </P>
*/
// 最后的同步ID
public static final String SYNC_ID = "sync_id";
/**
* Sign to indicate local modified or not
* <P> Type: INTEGER </P>
*/
// 本地是否修改的标志
public static final String LOCAL_MODIFIED = "local_modified";
/**
* Original parent id before moving into temporary folder
* <P> Type : INTEGER </P>
*/
// 移动到临时文件夹前的原父ID
public static final String ORIGIN_PARENT_ID = "origin_parent_id";
/**
* The gtask id
* <P> Type : TEXT </P>
*/
// gtask的ID
public static final String GTASK_ID = "gtask_id";
/**
* The version code
* <P> Type : INTEGER (long) </P>
*/
// 版本号
public static final String VERSION = "version";
}
// 数据列常量接口,包含数据表的各个字段
public interface DataColumns {
/**
* The unique ID for a row
* <P> Type: INTEGER (long) </P>
*/
// 唯一的行ID
public static final String ID = "_id";
/**
* The MIME type of the item represented by this row.
* <P> Type: Text </P>
*/
// 项目的MIME类型
public static final String MIME_TYPE = "mime_type";
/**
* The reference id to note that this data belongs to
* <P> Type: INTEGER (long) </P>
*/
// 数据所属于的笔记的ID
public static final String NOTE_ID = "note_id";
/**
* Created data for note or folder
* <P> Type: INTEGER (long) </P>
*/
// 数据的创建时间
public static final String CREATED_DATE = "created_date";
/**
* Latest modified date
* <P> Type: INTEGER (long) </P>
*/
// 数据的最新修改时间
public static final String MODIFIED_DATE = "modified_date";
/**
* Data's content
* <P> Type: TEXT </P>
*/
// 数据的内容
public static final String CONTENT = "content";
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
* integer data type
* <P> Type: INTEGER </P>
*/
// 用于存储特定MIME类型的整型数据
public static final String DATA1 = "data1";
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
* integer data type
* <P> Type: INTEGER </P>
*/
// 用于存储特定MIME类型的整型数据
public static final String DATA2 = "data2";
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
* TEXT data type
* <P> Type: TEXT </P>
*/
// 用于存储特定MIME类型的文本数据
public static final String DATA3 = "data3";
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
* TEXT data type
* <P> Type: TEXT </P>
*/
// 用于存储特定MIME类型的文本数据
public static final String DATA4 = "data4";
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
* TEXT data type
* <P> Type: TEXT </P>
*/
// 用于存储特定MIME类型的文本数据
public static final String DATA5 = "data5";
}
// 文本笔记相关的常量类
public static final class TextNote implements DataColumns {
/**
* Mode to indicate the text in check list mode or not
* <P> Type: Integer 1:check list mode 0: normal mode </P>
*/
// 表示笔记是否处于检查列表模式
public static final String MODE = DATA1;
// 检查列表模式标志
public static final int MODE_CHECK_LIST = 1;
// MIME类型文本笔记
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";
// 单个文本笔记的MIME类型
public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";
// 文本笔记的URI
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");
}
// 通话记录笔记相关的常量类
public static final class CallNote implements DataColumns {
/**
* Call date for this record
* <P> Type: INTEGER (long) </P>
*/
// 通话记录的日期
public static final String CALL_DATE = DATA1;
/**
* Phone number for this record
* <P> Type: TEXT </P>
*/
// 通话记录的电话号码
public static final String PHONE_NUMBER = DATA3;
// MIME类型通话记录笔记
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";
// 单个通话记录笔记的MIME类型
public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";
// 通话记录笔记的URI
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");
}
}

@ -1,3 +1,4 @@
// 版权信息,表明代码遵循 Apache License 2.0 开源协议
/*
* Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
*
@ -14,348 +15,544 @@
* limitations under the License.
*/
// 声明该类所在的包名为 net.micode.notes.data
package net.micode.notes.data;
// 导入所需的 Android 相关类,包括 ContentValues 用于存储数据Context 用于上下文信息SQLiteDatabase 用于操作 SQLite 数据库SQLiteOpenHelper 用于数据库辅助操作Log 用于日志记录
import android.content.ContentValues;
import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;
import android.util.Log;
// 导入自定义的笔记数据列和常量类
import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.DataConstants;
import net.micode.notes.data.Notes.NoteColumns;
// 定义一个继承自 SQLiteOpenHelper 的类 NotesDatabaseHelper用于管理笔记应用的数据库操作
public class NotesDatabaseHelper extends SQLiteOpenHelper {
// 定义数据库的名称为 "note.db",该数据库将存储笔记和相关数据
private static final String DB_NAME = "note.db";
// 数据库的版本号,用于管理数据库结构的更新,当数据库结构发生变化时,可以增加版本号并在 onUpgrade 方法中进行相应处理
private static final int DB_VERSION = 4;
// 定义一个内部接口 TABLE用于存储表名方便在代码中引用避免硬编码
public interface TABLE {
// 存储笔记信息的表名
public static final String NOTE = "note";
// 存储笔记数据的表名
public static final String DATA = "data";
}
// 定义一个日志标签,用于在日志中标识该类的日志信息,方便调试和追踪
private static final String TAG = "NotesDatabaseHelper";
// 定义一个静态变量 mInstance用于存储 NotesDatabaseHelper 的单例对象
private static NotesDatabaseHelper mInstance;
// 定义创建 NOTE 表的 SQL 语句,使用了 NoteColumns 中的列名
private static final String CREATE_NOTE_TABLE_SQL =
// 开始创建名为 "note" 的表
"CREATE TABLE " + TABLE.NOTE + "(" +
// 笔记的唯一标识符,使用 INTEGER 类型,并设置为主键
NoteColumns.ID + " INTEGER PRIMARY KEY," +
// 父笔记的 ID如果没有父笔记则默认为 0
NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
// 提醒日期,默认为 0
NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," +
// 背景颜色的 ID默认为 0
NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," +
// 创建日期,使用 SQLite 的 strftime 函数获取当前时间(以秒为单位)并乘以 1000 转换为毫秒,默认为当前时间
NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
// 是否有附件,默认为 0表示没有
NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," +
// 修改日期,使用 SQLite 的 strftime 函数获取当前时间(以秒为单位)并乘以 1000 转换为毫秒,默认为当前时间
NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
// 子笔记的数量,默认为 0
NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," +
// 笔记的摘要信息,默认为空字符串
NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," +
// 笔记的类型,默认为 0
NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," +
// 部件的 ID默认为 0
NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," +
// 部件的类型,默认为 -1
NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," +
// 同步的 ID默认为 0
NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," +
// 是否在本地修改过,默认为 0表示未修改
NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," +
// 原始父笔记的 ID默认为 0
NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
// GTASK 的 ID默认为空字符串
NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," +
// 版本号,默认为 0
NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" +
")";
// 定义创建 DATA 表的 SQL 语句,使用了 DataColumns 中的列名
private static final String CREATE_DATA_TABLE_SQL =
// 开始创建名为 "data" 的表
"CREATE TABLE " + TABLE.DATA + "(" +
// 数据的唯一标识符,使用 INTEGER 类型,并设置为主键
DataColumns.ID + " INTEGER PRIMARY KEY," +
// 数据的 MIME 类型,不能为空
DataColumns.MIME_TYPE + " TEXT NOT NULL," +
// 关联的笔记 ID默认为 0
DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," +
// 创建日期,使用 SQLite 的 strftime 函数获取当前时间(以秒为单位)并乘以 1000 转换为毫秒,默认为当前时间
NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
// 修改日期,使用 SQLite 的 strftime 函数获取当前时间(以秒为单位)并乘以 1000 转换为毫秒,默认为当前时间
NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
// 数据的内容,默认为空字符串
DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," +
// 存储数据的第一个整数数据,可为空
DataColumns.DATA1 + " INTEGER," +
// 存储数据的第二个整数数据,可为空
DataColumns.DATA2 + " INTEGER," +
// 存储数据的第一个文本数据,默认为空字符串
DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," +
// 存储数据的第二个文本数据,默认为空字符串
DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," +
// 存储数据的第三个文本数据,默认为空字符串
DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" +
")";
// 定义创建一个索引的 SQL 语句,基于 "data" 表的 "note_id" 列,如果该索引不存在则创建
private static final String CREATE_DATA_NOTE_ID_INDEX_SQL =
"CREATE INDEX IF NOT EXISTS note_id_index ON " +
TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";
/**
* Increase folder's note count when move note to the folder
*/
// 定义一个触发器 SQL 语句,当更新笔记表的父 ID 时,增加父笔记的笔记计数
private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =
// 创建名为 "increase_folder_count_on_update" 的触发器
"CREATE TRIGGER increase_folder_count_on_update "+
// 在 "note" 表更新 "PARENT_ID" 列之后触发
" AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE +
" BEGIN " +
// 更新 "note" 表,将父笔记的 "NOTES_COUNT" 列的值加 1
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
" WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
" END";
/**
* Decrease folder's note count when move note from folder
*/
// 定义一个触发器 SQL 语句,当更新笔记表的父 ID 时,减少父笔记的笔记计数
private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =
// 创建名为 "decrease_folder_count_on_update" 的触发器
"CREATE TRIGGER decrease_folder_count_on_update " +
// 在 "note" 表更新 "PARENT_ID" 列之后触发
" AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE +
" BEGIN " +
// 更新 "note" 表,将父笔记的 "NOTES_COUNT" 列的值减 1但仅当计数大于 0 时
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +
" WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
" AND " + NoteColumns.NOTES_COUNT + ">0" + ";" +
" END";
/**
* Increase folder's note count when insert new note to the folder
*/
// 定义一个触发器 SQL 语句,当在笔记表中插入新记录时,增加父笔记的笔记计数
private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER =
// 创建名为 "increase_folder_count_on_insert" 的触发器
"CREATE TRIGGER increase_folder_count_on_insert " +
// 在 "note" 表插入新记录之后触发
" AFTER INSERT ON " + TABLE.NOTE +
" BEGIN " +
// 更新 "note" 表,将父笔记的 "NOTES_COUNT" 列的值加 1
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
" WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
" END";
/**
* Decrease folder's note count when delete note from the folder
*/
// 定义一个触发器 SQL 语句,当从笔记表中删除记录时,减少父笔记的笔记计数
private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER =
// 创建名为 "decrease_folder_count_on_delete" 的触发器
"CREATE TRIGGER decrease_folder_count_on_delete " +
// 在 "note" 表删除记录之后触发
" AFTER DELETE ON " + TABLE.NOTE +
" BEGIN " +
// 更新 "note" 表,将父笔记的 "NOTES_COUNT" 列的值减 1但仅当计数大于 0 时
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +
" WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
" AND " + NoteColumns.NOTES_COUNT + ">0;" +
" END";
/**
* Update note's content when insert data with type {@link DataConstants#NOTE}
*/
// 定义一个触发器 SQL 语句,当在数据表中插入新的笔记数据时,更新相应笔记的摘要内容
private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER =
// 创建名为 "update_note_content_on_insert" 的触发器
"CREATE TRIGGER update_note_content_on_insert " +
// 在 "data" 表插入新记录之后触发
" AFTER INSERT ON " + TABLE.DATA +
" WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
" BEGIN" +
// 更新 "note" 表,将笔记的 "SNIPPET" 列设置为新插入数据的 "CONTENT" 列的值
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
" WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
" END";
/**
* Update note's content when data with {@link DataConstants#NOTE} type has changed
*/
// 定义一个触发器 SQL 语句,当更新数据表中的笔记数据时,更新相应笔记的摘要内容
private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER =
// 创建名为 "update_note_content_on_update" 的触发器
"CREATE TRIGGER update_note_content_on_update " +
// 在 "data" 表更新记录之后触发
" AFTER UPDATE ON " + TABLE.DATA +
" WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
" BEGIN" +
// 更新 "note" 表,将笔记的 "SNIPPET" 列设置为更新后的数据的 "CONTENT" 列的值
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
" WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
" END";
/**
* Update note's content when data with {@link DataConstants#NOTE} type has deleted
*/
// 定义一个触发器 SQL 语句,当从数据表中删除笔记数据时,更新相应笔记的摘要内容为空
private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER =
// 创建名为 "update_note_content_on_delete" 的触发器
"CREATE TRIGGER update_note_content_on_delete " +
// 在 "data" 表删除记录之后触发
" AFTER delete ON " + TABLE.DATA +
" WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
" BEGIN" +
// 更新 "note" 表,将笔记的 "SNIPPET" 列设置为空字符串
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.SNIPPET + "=''" +
" WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" +
" END";
/**
* Delete datas belong to note which has been deleted
*/
// 定义一个触发器 SQL 语句,当从笔记表中删除笔记时,删除该笔记的相关数据
private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER =
// 创建名为 "delete_data_on_delete" 的触发器
"CREATE TRIGGER delete_data_on_delete " +
// 在 "note" 表删除记录之后触发
" AFTER DELETE ON " + TABLE.NOTE +
" BEGIN" +
// 从 "data" 表中删除与该笔记关联的数据
" DELETE FROM " + TABLE.DATA +
" WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" +
" END";
/**
* Delete notes belong to folder which has been deleted
*/
// 定义一个触发器 SQL 语句,当从笔记表中删除文件夹时,删除该文件夹中的所有笔记
private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER =
// 创建名为 "folder_delete_notes_on_delete" 的触发器
"CREATE TRIGGER folder_delete_notes_on_delete " +
// 在 "note" 表删除记录之后触发
" AFTER DELETE ON " + TABLE.NOTE +
" BEGIN" +
// 从 "note" 表中删除父 ID 为被删除笔记的笔记
" DELETE FROM " + TABLE.NOTE +
" WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
" END";
/**
* Move notes belong to folder which has been moved to trash folder
*/
// 定义一个触发器 SQL 语句,当将文件夹移动到回收站时,将该文件夹中的所有笔记移动到回收站
private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER =
// 创建名为 "folder_move_notes_on_trash" 的触发器
"CREATE TRIGGER folder_move_notes_on_trash " +
// 在 "note" 表更新记录且新的父 ID 为回收站文件夹 ID 之后触发
" AFTER UPDATE ON " + TABLE.NOTE +
" WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
" BEGIN" +
// 更新 "note" 表,将父 ID 为原文件夹的笔记的父 ID 设置为回收站文件夹的 ID
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
" WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
" END";
// 构造函数,接收一个 Context 对象,调用父类 SQLiteOpenHelper 的构造函数
public NotesDatabaseHelper(Context context) {
// 调用父类 SQLiteOpenHelper 的构造函数,传入上下文、数据库名称、游标工厂(这里为 null和数据库版本号
super(context, DB_NAME, null, DB_VERSION);
}
// 创建笔记表的方法,接收一个 SQLiteDatabase 对象作为参数
public void createNoteTable(SQLiteDatabase db) {
// 执行创建笔记表的 SQL 语句,使用 db.execSQL 方法执行存储在 CREATE_NOTE_TABLE_SQL 中的 SQL 语句,创建笔记表
db.execSQL(CREATE_NOTE_TABLE_SQL);
// 调用 reCreateNoteTableTriggers 方法,重新创建笔记表相关的触发器
reCreateNoteTableTriggers(db);
// 调用 createSystemFolder 方法,创建系统文件夹
createSystemFolder(db);
// 使用 Log.d 方法输出日志,表明笔记表已经创建,日志标签为 TAG消息为 "note table has been created"
Log.d(TAG, "note table has been created");
}
// 重新创建笔记表触发器的私有方法,接收一个 SQLiteDatabase 对象作为参数
private void reCreateNoteTableTriggers(SQLiteDatabase db) {
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 increase_folder_count_on_update 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update");
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 decrease_folder_count_on_update 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update");
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 decrease_folder_count_on_delete 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_delete");
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 delete_data_on_delete 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete");
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 increase_folder_count_on_insert 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert");
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 folder_delete_notes_on_delete 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete");
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 folder_move_notes_on_trash 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash");
// 使用 db.execSQL 方法执行存储在 NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER 中的 SQL 语句,创建触发器,该触发器在更新笔记表的父 ID 时增加父笔记的笔记计数
db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER);
// 使用 db.execSQL 方法执行存储在 NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER 中的 SQL 语句,创建触发器,该触发器在更新笔记表的父 ID 时减少父笔记的笔记计数
db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER);
// 使用 db.execSQL 方法执行存储在 NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER 中的 SQL 语句,创建触发器,该触发器在从笔记表中删除记录时减少父笔记的笔记计数
db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER);
// 使用 db.execSQL 方法执行存储在 NOTE_DELETE_DATA_ON_DELETE_TRIGGER 中的 SQL 语句,创建触发器,该触发器在从笔记表中删除笔记时删除该笔记的相关数据
db.execSQL(NOTE_DELETE_DATA_ON_DELETE_TRIGGER);
// 使用 db.execSQL 方法执行存储在 NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER 中的 SQL 语句,创建触发器,该触发器在插入新笔记到笔记表时增加父笔记的笔记计数
db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER);
// 使用 db.execSQL 方法执行存储在 FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER 中的 SQL 语句,创建触发器,该触发器在从笔记表中删除文件夹时删除该文件夹中的所有笔记
db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER);
// 使用 db.execSQL 方法执行存储在 FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER 中的 SQL 语句,创建触发器,该触发器在将文件夹移动到回收站时将该文件夹中的所有笔记移动到回收站
db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER);
}
// 创建系统文件夹的私有方法,接收一个 SQLiteDatabase 对象作为参数
private void createSystemFolder(SQLiteDatabase db) {
// 创建一个 ContentValues 对象,用于存储插入数据的值
ContentValues values = new ContentValues();
// 以下是为不同类型的系统文件夹插入数据的部分
// 为通话记录创建系统文件夹
/**
* call record foler for call notes
*/
// 使用 put 方法将笔记的 ID 存储到 ContentValues 对象中,其值为 Notes.ID_CALL_RECORD_FOLDER
values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER);
// 使用 put 方法将笔记的类型存储到 ContentValues 对象中,其值为 Notes.TYPE_SYSTEM
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
// 使用 insert 方法将存储在 values 中的数据插入到 TABLE.NOTE 表中,第二个参数为 null 表示允许插入空列,第三个参数为存储数据的 ContentValues 对象
db.insert(TABLE.NOTE, null, values);
// 为根文件夹创建系统文件夹
/**
* root folder which is default folder
*/
// 清除 ContentValues 对象中的数据,以便存储新的数据
values.clear();
// 使用 put 方法将笔记的 ID 存储到 ContentValues 对象中,其值为 Notes.ID_ROOT_FOLDER
values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER);
// 使用 put 方法将笔记的类型存储到 ContentValues 对象中,其值为 Notes.TYPE_SYSTEM
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
// 使用 insert 方法将存储在 values 中的数据插入到 TABLE.NOTE 表中
db.insert(TABLE.NOTE, null, values);
// 为临时文件夹创建系统文件夹
/**
* temporary folder which is used for moving note
*/
// 清除 ContentValues 对象中的数据,以便存储新的数据
values.clear();
// 使用 put 方法将笔记的 ID 存储到 ContentValues 对象中,其值为 Notes.ID_TEMPARAY_FOLDER
values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER);
// 使用 put 方法将笔记的类型存储到 ContentValues 对象中,其值为 Notes.TYPE_SYSTEM
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
// 使用 insert 方法将存储在 values 中的数据插入到 TABLE.NOTE 表中
db.insert(TABLE.NOTE, null, values);
// 为回收站文件夹创建系统文件夹
/**
* create trash folder
*/
// 清除 ContentValues 对象中的数据,以便存储新的数据
values.clear();
// 使用 put 方法将笔记的 ID 存储到 ContentValues 对象中,其值为 Notes.ID_TRASH_FOLER
values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);
// 使用 put 方法将笔记的类型存储到 ContentValues 对象中,其值为 Notes.TYPE_SYSTEM
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
// 使用 insert 方法将存储在 values 中的数据插入到 TABLE.NOTE 表中
db.insert(TABLE.NOTE, null, values);
}
// 创建数据表格的方法,接收一个 SQLiteDatabase 对象作为参数
public void createDataTable(SQLiteDatabase db) {
// 执行创建数据表格的 SQL 语句,使用 db.execSQL 方法执行存储在 CREATE_DATA_TABLE_SQL 中的 SQL 语句,创建数据表格
db.execSQL(CREATE_DATA_TABLE_SQL);
// 调用 reCreateDataTableTriggers 方法,重新创建数据表格的触发器
reCreateDataTableTriggers(db);
// 执行创建数据表格索引的 SQL 语句,使用 db.execSQL 方法执行存储在 CREATE_DATA_NOTE_ID_INDEX_SQL 中的 SQL 语句,创建索引
db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL);
// 使用 Log.d 方法输出日志,表明数据表格已经创建,日志标签为 TAG消息为 "data table has been created"
Log.d(TAG, "data table has been created");
}
// 重新创建数据表格触发器的私有方法,接收一个 SQLiteDatabase 对象作为参数
private void reCreateDataTableTriggers(SQLiteDatabase db) {
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 update_note_content_on_insert 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert");
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 update_note_content_on_update 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update");
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的名为 update_note_content_on_delete 的触发器,如果该触发器不存在则不执行任何操作
db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete");
// 使用 db.execSQL 方法执行存储在 DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER 中的 SQL 语句,创建触发器,该触发器在插入新的数据时更新相应笔记的内容
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER);
// 使用 db.execSQL 方法执行存储在 DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER 中的 SQL 语句,创建触发器,该触发器在更新数据时更新相应笔记的内容
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER);
// 使用 db.execSQL 方法执行存储在 DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER 中的 SQL 语句,创建触发器,该触发器在删除数据时更新相应笔记的内容
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER);
}
// 获取 NotesDatabaseHelper 单例的静态方法,接收一个 Context 对象作为参数
static synchronized NotesDatabaseHelper getInstance(Context context) {
// 检查单例对象是否为 null
if (mInstance == null) {
// 如果单例对象为 null则创建一个新的 NotesDatabaseHelper 实例,并将其存储在 mInstance 中
mInstance = new NotesDatabaseHelper(context);
}
// 返回单例对象
return mInstance;
}
// 重写父类 SQLiteOpenHelper 的 onCreate 方法,接收一个 SQLiteDatabase 对象作为参数
@Override
public void onCreate(SQLiteDatabase db) {
// 调用 createNoteTable 方法创建笔记表
createNoteTable(db);
// 调用 createDataTable 方法创建数据表格
createDataTable(db);
}
// 重写父类 SQLiteOpenHelper 的 onUpgrade 方法,接收一个 SQLiteDatabase 对象、旧版本号和新版本号作为参数
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
// 定义一个布尔变量 reCreateTriggers用于标记是否需要重新创建触发器初始值为 false
boolean reCreateTriggers = false;
// 定义一个布尔变量 skipV2用于标记是否跳过版本 2 的升级,初始值为 false
boolean skipV2 = false;
// 当旧版本号为 1 时,执行以下升级操作
if (oldVersion == 1) {
// 调用 upgradeToV2 方法,将数据库从版本 1 升级到版本 2
upgradeToV2(db);
skipV2 = true; // this upgrade including the upgrade from v2 to v3
// 将 skipV2 标记为 true表示此升级包含从版本 2 到版本 3 的升级
skipV2 = true;
// 将旧版本号加 1
oldVersion++;
}
if (oldVersion == 2 && !skipV2) {
// 当旧版本号为 2 且 skipV2 为 false 时,执行以下升级操作
if (oldVersion == 2 &&!skipV2) {
// 调用 upgradeToV3 方法,将数据库从版本 2 升级到版本 3
upgradeToV3(db);
// 将 reCreateTriggers 标记为 true表示需要重新创建触发器
reCreateTriggers = true;
// 将旧版本号加 1
oldVersion++;
}
// 当旧版本号为 3 时,执行以下升级操作
if (oldVersion == 3) {
// 调用 upgradeToV4 方法,将数据库从版本 3 升级到版本 4
upgradeToV4(db);
// 将旧版本号加 1
oldVersion++;
}
// 如果需要重新创建触发器
if (reCreateTriggers) {
// 调用 reCreateNoteTableTriggers 方法,重新创建笔记表的触发器
reCreateNoteTableTriggers(db);
// 调用 reCreateDataTableTriggers 方法,重新创建数据表格的触发器
reCreateDataTableTriggers(db);
}
if (oldVersion != newVersion) {
// 如果旧版本号不等于新版本号,抛出 IllegalStateException 异常,表明数据库升级失败
if (oldVersion!= newVersion) {
throw new IllegalStateException("Upgrade notes database to version " + newVersion
+ "fails");
}
}
// 将数据库从版本 1 升级到版本 2 的私有方法,接收一个 SQLiteDatabase 对象作为参数
private void upgradeToV2(SQLiteDatabase db) {
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的 TABLE.NOTE 表,如果该表不存在则不执行任何操作
db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE);
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的 TABLE.DATA 表,如果该表不存在则不执行任何操作
db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA);
// 调用 createNoteTable 方法创建笔记表
createNoteTable(db);
// 调用 createDataTable 方法创建数据表格
createDataTable(db);
}
// 将数据库从版本 2 升级到版本 3 的私有方法,接收一个 SQLiteDatabase 对象作为参数
private void upgradeToV3(SQLiteDatabase db) {
// drop unused triggers
// 使用 db.execSQL 方法执行 SQL 语句,删除可能存在的触发器
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert");
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete");
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update");
// add a column for gtask id
// 使用 db.execSQL 方法执行 SQL 语句,为 TABLE.NOTE 表添加一个名为 GTASK_ID 的列,其数据类型为 TEXT不允许为空默认值为空字符串
db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID
+ " TEXT NOT NULL DEFAULT ''");
// add a trash system folder
// 创建一个 ContentValues 对象,用于存储插入数据的值
ContentValues values = new ContentValues();
// 使用 put 方法将笔记的 ID 存储到 ContentValues 对象中,其值为 Notes.ID_TRASH_FOLER
values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);
// 使用 put 方法将笔记的类型存储到 ContentValues 对象中,其值为 Notes.TYPE_SYSTEM
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
// 使用 insert 方法将存储在 values 中的数据插入到 TABLE.NOTE 表中,第二个参数为 null 表示允许插入空列,第三个参数为存储数据的 ContentValues 对象
db.insert(TABLE.NOTE, null, values);
}
// 将数据库从版本 3 升级到版本 4 的私有方法,接收一个 SQLiteDatabase 对象作为参数
private void upgradeToV4(SQLiteDatabase db) {
// 使用 db.execSQL 方法执行 SQL 语句,为 TABLE.NOTE 表添加一个名为 VERSION 的列,其数据类型为 INTEGER不允许为空默认值为 0
db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION
+ " INTEGER NOT NULL DEFAULT 0");
}

@ -1,3 +1,4 @@
// 该文件的版权信息,表明代码的版权属于 The MiCode Open Source Community使用 Apache License 2.0 协议
/*
* Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
*
@ -8,15 +9,17 @@
* 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,
* 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.data;
// 导入所需的 Android 类和接口
import android.app.SearchManager;
import android.content.ContentProvider;
import android.content.ContentUris;
@ -29,273 +32,403 @@ import android.net.Uri;
import android.text.TextUtils;
import android.util.Log;
// 导入自定义的类和资源
import net.micode.notes.R;
import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.data.NotesDatabaseHelper.TABLE;
// 定义一个名为 NotesProvider 的类,继承自 ContentProvider 类,用于提供数据存储和访问服务
public class NotesProvider extends ContentProvider {
// 声明一个静态的 UriMatcher 对象,用于匹配不同的 URI
private static final UriMatcher mMatcher;
// 声明一个 NotesDatabaseHelper 对象,用于操作数据库
private NotesDatabaseHelper mHelper;
// 定义一个日志标签,用于在 Logcat 中输出日志信息
private static final String TAG = "NotesProvider";
// 定义不同 URI 匹配结果的常量,分别代表不同的操作
private static final int URI_NOTE = 1;
private static final int URI_NOTE_ITEM = 2;
private static final int URI_DATA = 3;
private static final int URI_DATA_ITEM = 4;
private static final int URI_SEARCH = 5;
private static final int URI_SEARCH_SUGGEST = 6;
// 静态代码块,在类加载时执行,用于初始化 UriMatcher 对象
static {
// 创建一个新的 UriMatcher 对象,初始匹配结果为 NO_MATCH
mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/note" 时,匹配结果为 URI_NOTE
mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/note/#" 时,匹配结果为 URI_NOTE_ITEM
mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/data" 时,匹配结果为 URI_DATA
mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/data/#" 时,匹配结果为 URI_DATA_ITEM
mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/search" 时,匹配结果为 URI_SEARCH
mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/search/suggest_query" 时,匹配结果为 URI_SEARCH_SUGGEST
mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/search/suggest_query/*" 时,匹配结果为 URI_SEARCH_SUGGEST
mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST);
}
/**
* x'0A' represents the '\n' character in sqlite. For title and content in the search result,
* we will trim '\n' and white space in order to show more information.
* x'0A' SQLite '\n'
* '\n'
*/
// 定义一个 SQL 投影字符串,用于搜索结果的查询,包含笔记的各种信息
private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + ","
// 笔记的 ID
+ NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + ","
// 将笔记的 ID 作为额外的数据
+ "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + ","
// 去除换行符并修剪后的笔记片段作为搜索结果的第一行文本
+ "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + ","
// 搜索结果的图标
+ R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + ","
// 搜索结果的意图动作
+ "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + ","
// 搜索结果的意图数据类型
+ "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA;
// 定义一个 SQL 查询语句,用于根据笔记片段进行搜索
private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION
// 从笔记表中查询
+ " FROM " + TABLE.NOTE
+ " WHERE " + NoteColumns.SNIPPET + " LIKE ?"
// 筛选出包含搜索关键字的笔记片段,且不在回收站中的笔记
+ " WHERE " + NoteColumns.SNIPPET + " LIKE?"
+ " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER
+ " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE;
// 重写 ContentProvider 的 onCreate 方法,在创建时调用
@Override
public boolean onCreate() {
// 获取数据库帮助类的实例,用于后续的数据库操作
mHelper = NotesDatabaseHelper.getInstance(getContext());
// 返回 true 表示创建成功
return true;
}
// 重写 ContentProvider 的 query 方法,用于执行查询操作
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
String sortOrder) {
// 声明一个 Cursor 对象,用于存储查询结果
Cursor c = null;
// 获取一个可读的 SQLite 数据库对象
SQLiteDatabase db = mHelper.getReadableDatabase();
// 声明一个字符串,用于存储 URI 中的 ID
String id = null;
// 使用 mMatcher 匹配 URI根据匹配结果执行不同的查询操作
switch (mMatcher.match(uri)) {
// 当 URI 匹配为 URI_NOTE 时,查询笔记表
case URI_NOTE:
// 执行查询操作,返回一个 Cursor 对象
c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null,
sortOrder);
break;
// 当 URI 匹配为 URI_NOTE_ITEM 时,查询笔记表中的特定项
case URI_NOTE_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 根据 ID 执行查询操作,将选择条件与原始选择条件拼接
c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs, null, null, sortOrder);
break;
// 当 URI 匹配为 URI_DATA 时,查询数据表格
case URI_DATA:
// 执行查询操作,返回一个 Cursor 对象
c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null,
sortOrder);
break;
// 当 URI 匹配为 URI_DATA_ITEM 时,查询数据表格中的特定项
case URI_DATA_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 根据 ID 执行查询操作,将选择条件与原始选择条件拼接
c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs, null, null, sortOrder);
break;
// 当 URI 匹配为 URI_SEARCH 或 URI_SEARCH_SUGGEST 时,执行搜索操作
case URI_SEARCH:
case URI_SEARCH_SUGGEST:
if (sortOrder != null || projection != null) {
// 如果指定了排序顺序、选择条件、选择参数或投影,则抛出异常
if (sortOrder!= null || projection!= null) {
throw new IllegalArgumentException(
"do not specify sortOrder, selection, selectionArgs, or projection" + "with this query");
}
// 声明一个字符串,用于存储搜索关键字
String searchString = null;
// 如果 URI 匹配为 URI_SEARCH_SUGGEST 且路径段数量大于 1则获取搜索关键字
if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {
if (uri.getPathSegments().size() > 1) {
searchString = uri.getPathSegments().get(1);
}
} else {
// 从 URI 的查询参数中获取搜索关键字
searchString = uri.getQueryParameter("pattern");
}
// 如果搜索关键字为空,返回 null
if (TextUtils.isEmpty(searchString)) {
return null;
}
try {
// 格式化搜索关键字,添加通配符,以便进行模糊搜索
searchString = String.format("%%%s%%", searchString);
// 执行原始查询操作,使用 NOTES_SNIPPET_SEARCH_QUERY 进行搜索
c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY,
new String[] { searchString });
} catch (IllegalStateException ex) {
// 捕获异常并输出日志
Log.e(TAG, "got exception: " + ex.toString());
}
break;
// 如果 URI 不匹配任何已知的 URI抛出异常
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
if (c != null) {
// 如果查询结果不为空,设置通知 URI以便在数据发生变化时通知监听者
if (c!= null) {
c.setNotificationUri(getContext().getContentResolver(), uri);
}
// 返回查询结果
return c;
}
// 重写 ContentProvider 的 insert 方法,用于执行插入操作
@Override
public Uri insert(Uri uri, ContentValues values) {
// 获取一个可写的 SQLite 数据库对象
SQLiteDatabase db = mHelper.getWritableDatabase();
// 声明三个变量,用于存储插入操作的结果 ID
long dataId = 0, noteId = 0, insertedId = 0;
// 使用 mMatcher 匹配 URI根据匹配结果执行不同的插入操作
switch (mMatcher.match(uri)) {
// 当 URI 匹配为 URI_NOTE 时,插入一条笔记
case URI_NOTE:
// 插入笔记,并存储插入结果的 ID
insertedId = noteId = db.insert(TABLE.NOTE, null, values);
break;
// 当 URI 匹配为 URI_DATA 时,插入一条数据
case URI_DATA:
// 如果插入的数据包含笔记 ID则获取该笔记 ID
if (values.containsKey(DataColumns.NOTE_ID)) {
noteId = values.getAsLong(DataColumns.NOTE_ID);
} else {
// 日志输出错误信息
Log.d(TAG, "Wrong data format without note id:" + values.toString());
}
// 插入数据,并存储插入结果的 ID
insertedId = dataId = db.insert(TABLE.DATA, null, values);
break;
// 如果 URI 不匹配任何已知的 URI抛出异常
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
// Notify the note uri
// 如果插入的是笔记,通知笔记 URI 的数据发生了变化
if (noteId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null);
}
// Notify the data uri
// 如果插入的是数据,通知数据 URI 的数据发生了变化
if (dataId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null);
}
// 返回插入结果的 URI
return ContentUris.withAppendedId(uri, insertedId);
}
// 重写 ContentProvider 的 delete 方法,用于执行删除操作
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
// 声明一个变量,用于存储删除操作影响的行数
int count = 0;
// 声明一个字符串,用于存储 URI 中的 ID
String id = null;
// 获取一个可写的 SQLite 数据库对象
SQLiteDatabase db = mHelper.getWritableDatabase();
// 声明一个布尔变量,用于标记是否删除数据
boolean deleteData = false;
// 使用 mMatcher 匹配 URI根据匹配结果执行不同的删除操作
switch (mMatcher.match(uri)) {
// 当 URI 匹配为 URI_NOTE 时,删除笔记
case URI_NOTE:
// 添加额外的选择条件,只删除 ID 大于 0 的笔记
selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";
// 执行删除操作,返回删除的行数
count = db.delete(TABLE.NOTE, selection, selectionArgs);
break;
// 当 URI 匹配为 URI_NOTE_ITEM 时,删除笔记中的特定项
case URI_NOTE_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
/**
* ID that smaller than 0 is system folder which is not allowed to
* trash
* ID 0
*/
// 将 ID 转换为长整型
long noteId = Long.valueOf(id);
// 如果 ID 小于等于 0则不执行删除操作
if (noteId <= 0) {
break;
}
// 执行删除操作,将选择条件与原始选择条件拼接
count = db.delete(TABLE.NOTE,
NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
break;
// 当 URI 匹配为 URI_DATA 时,删除数据
case URI_DATA:
// 执行删除操作,返回删除的行数
count = db.delete(TABLE.DATA, selection, selectionArgs);
// 标记删除了数据
deleteData = true;
break;
// 当 URI 匹配为 URI_DATA_ITEM 时,删除数据中的特定项
case URI_DATA_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 执行删除操作,将选择条件与原始选择条件拼接
count = db.delete(TABLE.DATA,
DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
// 标记删除了数据
deleteData = true;
break;
// 如果 URI 不匹配任何已知的 URI抛出异常
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
// 如果删除操作影响的行数大于 0
if (count > 0) {
// 如果删除了数据,通知笔记 URI 的数据发生了变化
if (deleteData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
}
// 通知 URI 的数据发生了变化
getContext().getContentResolver().notifyChange(uri, null);
}
// 返回删除操作影响的行数
return count;
}
// 重写 ContentProvider 的 update 方法,用于执行更新操作
@Override
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
// 声明一个变量,用于存储更新操作影响的行数
int count = 0;
// 声明一个字符串,用于存储 URI 中的 ID
String id = null;
// 获取一个可写的 SQLite 数据库对象
SQLiteDatabase db = mHelper.getWritableDatabase();
// 声明一个布尔变量,用于标记是否更新数据
boolean updateData = false;
// 使用 mMatcher 匹配 URI根据匹配结果执行不同的更新操作
switch (mMatcher.match(uri)) {
// 当 URI 匹配为 URI_NOTE 时,更新笔记
case URI_NOTE:
// 调用 increaseNoteVersion 方法增加笔记的版本号
increaseNoteVersion(-1, selection, selectionArgs);
// 执行更新操作,返回更新的行数
count = db.update(TABLE.NOTE, values, selection, selectionArgs);
break;
// 当 URI 匹配为 URI_NOTE_ITEM 时,更新笔记中的特定项
case URI_NOTE_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 调用 increaseNoteVersion 方法增加笔记的版本号
increaseNoteVersion(Long.valueOf(id), selection, selectionArgs);
// 执行更新操作,将选择条件与原始选择条件拼接
count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs);
break;
// 当 URI 匹配为 URI_DATA 时,更新数据
case URI_DATA:
// 执行更新操作,返回更新的行数
count = db.update(TABLE.DATA, values, selection, selectionArgs);
// 标记更新了数据
updateData = true;
break;
// 当 URI 匹配为 URI_DATA_ITEM 时,更新数据中的特定项
case URI_DATA_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 执行更新操作,将选择条件与原始选择条件拼接
count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs);
// 标记更新了数据
updateData = true;
break;
// 如果 URI 不匹配任何已知的 URI抛出异常
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
// 如果更新操作影响的行数大于 0
if (count > 0) {
// 如果更新了数据,通知笔记 URI 的数据发生了变化
if (updateData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
}
// 通知 URI 的数据发生了变化
getContext().getContentResolver().notifyChange(uri, null);
}
// 返回更新操作影响的行数
return count;
}
// 辅助方法,用于解析选择条件,添加额外的逻辑
private String parseSelection(String selection) {
return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : "");
// 如果选择条件不为空,添加 AND 逻辑运算符和括号
return (!TextUtils.isEmpty(selection)? " AND (" + selection + ')' : "");
}
// 辅助方法,用于增加笔记的版本号
private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {
// 创建一个 StringBuilder 对象,用于构建 SQL 语句
StringBuilder sql = new StringBuilder(120);
// 开始构建 SQL 语句,更新笔记表
sql.append("UPDATE ");
sql.append(TABLE.NOTE);
sql.append(" SET ");
// 将笔记的版本号加 1
sql.append(NoteColumns.VERSION);
sql.append("=" + NoteColumns.VERSION + "+1 ");
if (id > 0 || !TextUtils.isEmpty(selection)) {
// 如果有 ID 或选择条件不为空,添加 WHERE 子句
if (id > 0 ||!TextUtils.isEmpty(selection)) {
sql.append(" WHERE ");
}
// 如果有 ID添加 ID 条件
if (id > 0) {
sql.append(NoteColumns.ID + "=" + String.valueOf(id));
}
// 如果选择条件不为空
if (!TextUtils.isEmpty(selection)) {
String selectString = id > 0 ? parseSelection(selection) : selection;
// 根据是否有 ID 选择不同的方式处理选择条件
String selectString = id > 0? parseSelection(selection) : selection;
// 将选择参数替换到选择条件中
for (String args : selectionArgs) {
selectString = selectString.replaceFirst("\\?", args);
}
// 添加选择条件
sql.append(selectString);
}
// 执行 SQL 语句
mHelper.getWritableDatabase().execSQL(sql.toString());
}
// 重写 ContentProvider 的 getType 方法,用于获取 URI 的 MIME 类型,未实现
@Override
public String getType(Uri uri) {
// TODO Auto-generated method stub

Loading…
Cancel
Save