Type: INTEGER (long)
+ */ + public static final String ID = "_id";//这些常量主要是定义便签的属性的。 + + /** + * The parent's id for note or folder 文件夹id + *Type: INTEGER (long)
+ */ + public static final String PARENT_ID = "parent_id";//父节点id的字符串 + + /** + * Created data for note or folder 创建一个属于note或者folder的数据 + *Type: INTEGER (long)
+ */ + public static final String CREATED_DATE = "created_date";//创建note和文件夹时的数据,如创建时间等 + + /** + * Latest modified date 更改时间 + *Type: INTEGER (long)
+ */ + public static final String MODIFIED_DATE = "modified_date";//设置一个提醒时间 + + + /** + * Alert date 设定的提醒时间 + *Type: INTEGER (long)
+ */ + public static final String ALERTED_DATE = "alert_date"; //储存 提醒时间 + + /** + * Folder's name or text content of note 文件夹名字或者文件内容 + *Type: TEXT
+ */ + public static final String SNIPPET = "snippet";//文件夹的名称或便签的内容等数据 + + /** + * Note's widget id note小物件id + *Type: INTEGER (long)
+ */ + public static final String WIDGET_ID = "widget_id";//布局的id + + /** + * Note's widget type 便签页数 + *Type: INTEGER (long)
note小物件类型 + */ + public static final String WIDGET_TYPE = "widget_type";//小部件类型 + + /** + * Note's background color's id 便签背景颜色备注id + *Type: INTEGER (long)
note背景颜色id + */ + public static final String BG_COLOR_ID = "bg_color_id";//便签背景颜色的ID + + /** + * For text note, it doesn't has attachment, for multi-media + * note, it has at least one attachment + *Type: INTEGER
对于文字note,它没有附件,对于多个Note,它至少有一个附件 + */ + public static final String HAS_ATTACHMENT = "has_attachment";//是否有附件 + + /** + * Folder's count of notes + *Type: INTEGER (long)
文件夹内有多少个note + */ + public static final String NOTES_COUNT = "notes_count";//文件夹中Notes的数量 + + /** + * The file type: folder or note 文件类型:folder 或者 note + *Type: INTEGER
+ */ + public static final String TYPE = "type";//文件夹类型还是note类型 + + /** + * The last sync id + *Type: INTEGER (long)
最后一个sync id + */ + public static final String SYNC_ID = "sync_id";//最后一次同步的ID + + /** + * Sign to indicate local modified or not + *Type: INTEGER
标识是否本地修改 + */ + public static final String LOCAL_MODIFIED = "local_modified";//是否导出到本地信号 + + /** + * Original parent id before moving into temporary folder 移动到临时文件夹之前的原始父id + *Type : INTEGER
+ */ + public static final String ORIGIN_PARENT_ID = "origin_parent_id";//移动到临时文件夹之前的父文件夹 + + /** + * The gtask id + *Type : TEXT
+ */ + public static final String GTASK_ID = "gtask_id";//后台任务的ID + + /** + * The version code + *Type : INTEGER (long)
版本信息 + */ + public static final String VERSION = "version";//版本代号 + } //些常量主要是定义便签的属性的 + + public interface DataColumns {//定义DataColumns的常量,用于后面创建数据库的表头。主要是定义存储便签数据内容 + /** + * The unique ID for a row + *Type: INTEGER (long)
+ */ + public static final String ID = "_id";//定义DataColumns的部分常量 + + /** + * The MIME type of the item represented by this row. + *Type: Text
+ */ + public static final String MIME_TYPE = "mime_type";//MIME类型能包含视频、图像、文本、音频、应用程序等数据 + + /** + * The reference id to note that this data belongs to + *Type: INTEGER (long)
+ */ + public static final String NOTE_ID = "note_id";//设置标签的id + + /** + * Created data for note or folder + *Type: INTEGER (long)
+ */ + public static final String CREATED_DATE = "created_date";//创建时间 + + /** + * Latest modified date 调整时间 + *Type: INTEGER (long)
+ */ + public static final String MODIFIED_DATE = "modified_date";//.内容 + + /** + * Data's content + *Type: TEXT
+ */ + public static final String CONTENT = "content";//数据包含的内容 + + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for//根据MIME类型的不同,对应下面5个不同属性 + * integer data type 定义两个整形变量 + *Type: INTEGER
+ */ + public static final String DATA1 = "data1";//文本内容的数据结构 + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * integer data type + *Type: INTEGER
+ */ + public static final String DATA2 = "data2";//文本模式 + + /** 三个文本类型数据栏 + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *Type: TEXT
+ */ + public static final String DATA3 = "data3";//定义常量 + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *Type: TEXT
+ */ // .CONTENT_TYPE是数据的大类别,vnd.android.cursor.dir这个类型表示的访问多个资源的Uri + public static final String DATA4 = "data4";//定义常量 + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *Type: TEXT
+ */ //parse方法返回的是一个URI类型,通过这个URI可以访问一个网络上或者是本地的资源 + public static final String DATA5 = "data5";//电话内容的数据结构 + }//主要是定义存储便签内容数据的 + + public static final class TextNote implements DataColumns {//文本数据(TextNote)通过关键字implements来实现接口,继承了DataColumns的所有定义常量 + /** + * Mode to indicate the text in check list mode or not//清单模式的MODE=0,正常模式的MODE=1 + *Type: Integer 1:check list mode 0: normal mode
//清单模式的MODE=0,正常模式的MODE=1 + */ //检查列表模式0:正常模式 + public static final String MODE = DATA1;//电话号码 + + public static final int MODE_CHECK_LIST = 1;//note中内容的类型 + + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";//定义内容类型 + //vnd.android.cursor.item是表示访问单个资源的URI,比如更新表中某一个自定的记录,查询某一条指定的信息,就是相当SQL中的where条件语句。 + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";//内容项目的类型 + //vnd.android.cursor.item是表示访问单个资源的URI,比如更新表中某一个自定的记录,查询某一条指定的信息,就是相当SQL中的where条件语句。 + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");//.content 的索引标识符 + }//电话内容的数据结构 + + public static final class CallNote implements DataColumns {//记录通话数据的表头 + /** + * Call date for this record 通话记录 + *Type: INTEGER (long)
+ */ + public static final String CALL_DATE = DATA1;//在DATA1中存放的是通话时间信息 + + /** + * Phone number for this record + *Type: TEXT
+ */ + public static final String PHONE_NUMBER = DATA3;// 在DATA3中放的是通话号码信息 + + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";//定义内容类型 + + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";//内容项目类型 + + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");//内容标识符 + }//电话内容的数据结构 +} diff --git a/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java b/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java new file mode 100644 index 0000000..680f4db --- /dev/null +++ b/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java @@ -0,0 +1,362 @@ +/* + * 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. + */ //用于存储Notes的数据,以及根据数据更改Notes结构体的变量 +//数据库操作引用 +package net.micode.notes.data;//数据库操作,SQLOpenhelper,对一些note和文件进行数据库的操作。比如删除文件后,将文件里的note也相应删除 + +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;//数据库操作,用SQLOpenhelper,对一些note和文件进行数据库的操作,比如删除文件后,将文件里的note也相应删除 + + +public class NotesDatabaseHelper extends SQLiteOpenHelper {//新建一个自定义的类继承SQLiiteOpenHelper,实现对数据库的各种操作,如创建、增添、删减、修改等。是一个辅助类 + private static final String DB_NAME = "note.db";//定义部分常量 + + private static final int DB_VERSION = 4;//数据库版本号为4 + + public interface TABLE {//接口,分成note和data,在后面的程序里分别使用过 + public static final String NOTE = "note";//以下为表格项目内容 + + public static final String DATA = "data";//数据库中需要存储的项目的名称,就类似创建一个表格的表头的内容。 + } + + private static final String TAG = "NotesDatabaseHelper";//存储便签编号的一个数据表格 + + private static NotesDatabaseHelper mInstance;//实例化一个databaseHelper; 创建NotesDatabaseHelper对象mInstance + + private static final String CREATE_NOTE_TABLE_SQL =//SQL的触发器是一个能由系统自动执行对数据库修改的语句,由文件的增加事件触发。文件夹中移入一个Note之后需要更改的数据的表格。 + "CREATE TABLE " + TABLE.NOTE + "(" +//SQL的触发器是一个能由系统自动执行对数据库修改的语句,由文件的减少事件触发。 + NoteColumns.ID + " INTEGER PRIMARY KEY," +//文件夹插入Note后需要更改的数据的表格 + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +//文件夹删除Note后需要更改的数据的表格 + NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," +//应用界面颜色选择 + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +//创建时间数据 + NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," +//文件夹中便签数据初始化为0 + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," +//SQL的触发器是一个能由系统自动执行对数据库修改的语句,由文件的插入事件触发 + NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + + NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" +//数据库中需要存储的项目的名称,就相当于创建一个表格的表头的内容 + ")";//QL的触发器是一个能由系统自动执行对数据库修改的语句,由新导入数据事件触发。 + + private static final String CREATE_DATA_TABLE_SQL =//.SQL的触发器是一个能由系统自动执行对数据库修改的语句,由文件的删除事件触发。 + "CREATE TABLE " + TABLE.DATA + "(" +//note删除数据触发 + DataColumns.ID + " INTEGER PRIMARY KEY," + + DataColumns.MIME_TYPE + " TEXT NOT NULL," + + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 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 ''" + + ")";//和上面的功能一样,主要是存储的项目不同 + + private static final String CREATE_DATA_NOTE_ID_INDEX_SQL =//将便签的ID作为数据库的ID + "CREATE INDEX IF NOT EXISTS note_id_index ON " + + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";//存储便签编号的一个数据表格 +//以下几个都是在创建触发器(trigger)。触发器是一些在特定的数据库事件(database-event) 发生时自动进行的数据库操作(trigger-action). + /** + * Increase folder's note count when move note to the folder//Increase增加文件,Decrease减少文件 + */ + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =//将新的note移入该文件夹时,更新该文件夹note的数量 + "CREATE TRIGGER increase_folder_count_on_update "+ + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END";//在文件夹中移入一个Note之后需要更改的数据的表格 +//将新的note移入该文件夹时,更新该文件夹note的数量 + /** + * Decrease folder's note count when move note from folder + */ + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =//从文件夹中移出一个note时,更新数量 + "CREATE TRIGGER decrease_folder_count_on_update " + + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" +//在文件夹中移出一个Note之后需要更改的数据的表格 + " END"; + + /** + * Increase folder's note count when insert new note to the folder 当在文件夹中插入一个新的note时增加note数量 + */ + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER =//文件夹中创建新便签,文件夹便签数量+1,启动自定义的数据库insert触发器,附带相关的一系列操作 + "CREATE TRIGGER increase_folder_count_on_insert " + + " AFTER INSERT ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END";// 在文件夹中插入一个Note之后需要更改的数据的表格 + + /** + * Decrease folder's note count when delete note from the folder 在文件夹中删除文件 + */ + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER =//文件夹中删除便签,文件夹便签数量-1 + "CREATE TRIGGER decrease_folder_count_on_delete " +//定义一个更新文件夹中便签数目的SQL语句。当有便签从该文件夹中删除时使用 + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0;" + + " END";//在文件夹中删除一个Note之后需要更改的数据的表格 + + /** SQL语句:当note插入新data时修改状态 + * Update note's content when insert data with type {@link DataConstants#NOTE}//在数据库中新增note或插入内容 + */ //构建一条SQL语句,用于实现在note中输入data后,进行当前状态的更新 + private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER =//当note插入新的数据时,更新note的内容,并更改表格 + "CREATE TRIGGER update_note_content_on_insert " + + " AFTER INSERT ON " + TABLE.DATA + + " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " 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//note发生变化时触发update + */ //实现在note中改变data后,进行当前状态的更新 + private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER =//便签数据更新时,启动数据库update触发器 + "CREATE TRIGGER update_note_content_on_update " + + " AFTER UPDATE ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + + " END";//Note数据被修改后需要更改的数据的表格 + + /** + * Update note's content when data with {@link DataConstants#NOTE} type has deleted + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER =//便签数据更新时,启动数据库delete触发器 + "CREATE TRIGGER update_note_content_on_delete " +//构建一条SQL语句,用于实现在note中删除data后,进行当前状态的更新 + " AFTER delete ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=''" + + " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + + " END"; + + /** + * Delete datas belong to note which has been deleted 删除数据库中的数据,当这些数据在本地被删除 + */ + private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER = + "CREATE TRIGGER delete_data_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.DATA + + " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + + " END"; + + /** + * Delete notes belong to folder which has been deleted 删除文件夹中已被删除的便签 + */ + private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = + "CREATE TRIGGER folder_delete_notes_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + " END";//删除已删除的文件夹的便签后需要更改的数据的表格 + + /** + * Move notes belong to folder which has been moved to trash folder + */ + private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER = + "CREATE TRIGGER folder_move_notes_on_trash " + + " AFTER UPDATE ON " + TABLE.NOTE + + " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + " END";//还原垃圾桶中便签后需要更改的数据的表格 + + public NotesDatabaseHelper(Context context) {///继承父类构造方法 + super(context, DB_NAME, null, DB_VERSION);//构造函数,传入数据库的名称和版本 + } + + public void createNoteTable(SQLiteDatabase db) {//当创建SQLiteOpenHelper时,自动执行onCreate()方法;即自动创建一个数据库 + db.execSQL(CREATE_NOTE_TABLE_SQL);//.执行有更改行为的sql语句 + reCreateNoteTableTriggers(db); + createSystemFolder(db); + Log.d(TAG, "note table has been created");//调用系统输出调试信息,Log.d()是debug的意思。 + }//创建表格,存储标签属性 + + private void reCreateNoteTableTriggers(SQLiteDatabase db) {//xecSQL是数据库操作的API,主要是更改行为的SQL语句。在这里主要是用来重新创建上述定义的表格用的,先删除原来有的数据库的触发器再重新创建新的数据库 + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update");//创建增加文件夹的触发器 + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update");//创建减少文件夹的触发器 + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_delete");//创建删除减少文件夹的触发器 + db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete");//创建删除数据的触发器 + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert");//创建插入文件夹的触发器 + db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete");//创建删除note的触发器 + db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash");//.创建移除note的触发器 + + db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER);//创建自己的数据库操作 + db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER);//创建更新减少文件夹的触发器 + db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER);//创建删除减少文件夹的触发器 + db.execSQL(NOTE_DELETE_DATA_ON_DELETE_TRIGGER);//创建删除标记已删除数据的触发器 + db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER);//创建插入文件夹的触发器 + db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER);// 创建删除notes的触发器 + db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER);//创建将回收站中的notes还原的触发器 + }//execSQL通过添加sql语句可以执行sql操作 + + private void createSystemFolder(SQLiteDatabase db) {//创建几个系统文件夹 + ContentValues values = new ContentValues();//向数据库中插入数据,就要新建一个contentValues的对象。但只能存储基本类型数据 + + /** + * call record foler for call notes 储存呼叫记录的文件夹: + */ + values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER);//放入数据(NoteColumns的id,呼叫记录文件夹的ld) + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);//将note的文件夹类型,与要放入数据库记录的格式类型映射,形成values的键-值 + db.insert(TABLE.NOTE, null, values);// 在对数据库进行操作时,要有一个contentValues的对象,具体方法是:db.insert(database_name,null,initialValues),插入成功就返回记录的id否则返回-1; + + /** + * root folder which is default folder 根文件夹是默认文件夹 + */ + values.clear();// 代码段:对根目录进行修改,将ID与数据库ID进行映射 + values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER);//将数据库ID与通话记录文件夹ID形成映射 + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);//将数据库中数据类型与通话记录文件夹类型形成映射 + db.insert(TABLE.NOTE, null, values);//插入ContantValues对象 + + /** + * temporary folder which is used for moving note 设置临时文件夹作为文件移动的有效目标 + */ //移动note的临时文件夹 + values.clear();//临时文件夹的修改操作 + values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER);//将数据库ID与通话记录文件夹ID形成映射 + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);//将数据库中数据类型与通话记录文件夹类型形成映射 + db.insert(TABLE.NOTE, null, values);// 插入ContantValues对象 + + /** + * create trash folder 创建回收站 + *///垃圾文件夹 + values.clear();//创建垃圾文件夹的操作 + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);//将数据库ID与通话记录文件夹ID形成映射 + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);//将数据库中数据类型与通话记录文件夹类型形成映射 + db.insert(TABLE.NOTE, null, values);// 插入ContantValues对象 + } + + public void createDataTable(SQLiteDatabase db) {//创建表格(用来存储标签内容) + db.execSQL(CREATE_DATA_TABLE_SQL);// 用来重新创建note对应的data的表格,用来重新创建上述定义的表格用的,先删除原来有的数据库的触发器再重新创建新的数据库,输入是一个SQLiteDatabase类的对象 + reCreateDataTableTriggers(db);//重新建立数据表的触发器 + db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); + Log.d(TAG, "data table has been created"); + } + + private void reCreateDataTableTriggers(SQLiteDatabase db) {//删除重建表格 + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert");//往表中增加一行 + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete"); + + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER);//同上面的execSQL + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); + } + + static synchronized NotesDatabaseHelper getInstance(Context context) {//如果NotesDatabaseHelper的实例创建失败,那就重新建一个,重新分配内从空间 + if (mInstance == null) { + mInstance = new NotesDatabaseHelper(context); + } + return mInstance;//为解决同一时刻只能有一个线程执行,在写程序库代码时,有时有一个类需要被所有的其它类使用 + } + + @Override // @Override 伪代码,表示方法重写 + public void onCreate(SQLiteDatabase db) {//在NotesDatabaseHelper对象生命周期开始时创建Note table和Datatable + createNoteTable(db);//函数:生命周期开始的时候oncreate 被调用,这里对其进行重写,加入notes表单和数据表单 + createDataTable(db); + }//实现两个表格(上面创建的两个表格) + + @Override + public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {//.数据库版本的更新,包括数据库内容的更改 + boolean reCreateTriggers = false;// 是否重建的信号 + boolean skipV2 = false;//是否从V2升级到V3 + + if (oldVersion == 1) {//旧版本为1 + upgradeToV2(db);//更新到V2 + skipV2 = true; // this upgrade including the upgrade from v2 to v3 + oldVersion++; + }//旧版本为V2,并且支持V2 + + if (oldVersion == 2 && !skipV2) {//判断当前版本是不是二代 + upgradeToV3(db); + reCreateTriggers = true; + oldVersion++;//旧版本为3 + } + + if (oldVersion == 3) {//从V3升级到V4 + upgradeToV4(db); + oldVersion++; + } + + if (reCreateTriggers) {//重新创建的同时,创建新的note table和datatable + reCreateNoteTableTriggers(db);//重新创建数据表头;前面一个应该为创建便签表头 + reCreateDataTableTriggers(db); + } + + if (oldVersion != newVersion) {//判断当前版本是不是最新的 + throw new IllegalStateException("Upgrade notes database to version " + newVersion + + "fails"); + } + }//数据库版本的更新(数据库内容的更改) + + private void upgradeToV2(SQLiteDatabase db) { + db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); + db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); + createNoteTable(db); + createDataTable(db); + }//更新到版本2 + + private void upgradeToV3(SQLiteDatabase db) {//数据库版本升级到V3 + // drop unused triggers + 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("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID//为 Gtask id在数据库中增加一列 + + " TEXT NOT NULL DEFAULT ''"); + // add a trash system folder + ContentValues values = new ContentValues();//添加垃圾系统文件夹 + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);//为变量赋值 + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values);//插入到表中 + }//更新到V3版本 + + private void upgradeToV4(SQLiteDatabase db) {//数据库版本升级到V4 + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + + " INTEGER NOT NULL DEFAULT 0"); + } +} diff --git a/src/main/java/net/micode/notes/data/NotesProvider.java b/src/main/java/net/micode/notes/data/NotesProvider.java new file mode 100644 index 0000000..7b47b87 --- /dev/null +++ b/src/main/java/net/micode/notes/data/NotesProvider.java @@ -0,0 +1,314 @@ +/* + * 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. + */ //标记该文件遵循 Apache 2.0 开源许可 +package net.micode.notes.data; //标注该文件所属的软件包 + +//引入 +import android.app.SearchManager;//显示该类需要调用的其他类 +import android.content.ContentProvider;//ContentProvider是Android 四大组件之一,用于进程间进行数据交互与共享,即跨进程通信,可以通过ContentProvider把应用中的数据共享给其他应用访问,其他应用可以通过ContentProvider对你应用中的数据进行添删改查。 +import android.content.ContentUris;//ContentUris是一个工具类,主要是用来处理使用 "content" 约束的Uri对象 +import android.content.ContentValues;//导入contentvalues +import android.content.Intent;//Intent 是 一个用于组件间互相通信的信息对象,常用于启动组件和传递数据 +import android.content.UriMatcher;// 类:UriMatcher是Android提供的用来操作Uri的工具类 +import android.database.Cursor;//查询数据库所需的游标 +import android.database.sqlite.SQLiteDatabase;// 引入SQLite数据库 +import android.net.Uri; +import android.text.TextUtils;//文本识别处理工具 +import android.util.Log; + +import net.micode.notes.R;//访问、删除、插入、更新、扩展Notes的数据库 +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.NotesDatabaseHelper.TABLE; +/* +为存储和获取数据提供接口。可以在不同的应用程序之间共享数据 + ContentProvider提供的方法 + query:查询 + insert:插入 + update:更新 + delete:删除 + getType:得到数据类型*/ +public class NotesProvider extends ContentProvider { + private static final UriMatcher mMatcher;//.UriMatcher用于匹配Uri + + private NotesDatabaseHelper mHelper;//数据库辅助类的实例化 + + private static final String TAG = "NotesProvider";//TAG用来做输出日志的log函数的第一个实参 + + private static final int URI_NOTE = 1;//.1-6全部是Uri资源的id + private static final int URI_NOTE_ITEM = 2;//这是一个注册Uri路径的过程 + 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; + + static {//我们在使用uriMatcher时,先把需要匹配Uri路径全部给注册上 + mMatcher = new UriMatcher(UriMatcher.NO_MATCH);//创建UriMatcher时,调用UriMatcher(UriMatcher.NO_MATCH)表示不匹配任何路径的返回码 + mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE);//把需要匹配Uri路径全部给注册上 + mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM);//.有关note的路径注册 + mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA);//有关数据的路径注册 + mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); + mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST);// SUGGEST_URI_PATH_QUERY 并不属于URI的一部分,而应是用于指向此路径的常量。 + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST); + }//注册完需要匹配的Uri后,就可以使用sMatcher.match(uri)方法对输入的Uri进行匹配 + + /** + * 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. + *///trim()函数是去掉字符串头尾空格的函数,注意:不去掉字符串里面的空格,而仅仅是头尾空格! + private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + ","//声明 NOTES_SEARCH_PROJECTION + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + ","//设置表明额外数据、推荐显示的文本、图标、操作、数据 + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + ","// SearchManager.SUGGEST_COLUMN_TEXT_1是将该字段作为安卓搜索框中建议显示的文本。如果每个建议想显示两行数据,还有SearchManager.SUGGEST_COLUMN_TEXT_2 + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + ","//AS语句在这里是:把数据库中NoteColumn.SNIPPET字符串用TRIM函数去掉头部和尾部的空格,然后将处理过后的字符串设置为安卓搜索框中推荐显示的一行字符(column_text_1),如果想显示第二行搜索框则是(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; + + private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION//声明NOTES_SNIPPET_SEARCH_QUERY,便签搜索查询 + + " FROM " + TABLE.NOTE// 在特定表中某一字段检索特定子串 + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?"//数据库中LIKE语句的用法:select * from 表名 where 字段名 like 对应值(子串),它主要是针对字符型字段的,它的作用是在一个字符型字段列中检索包含对应子串的。 + //在这里‘?’就是通配符,对应功能是单字模糊匹配 + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; + + @Override//重定义的标志 + public boolean onCreate() { + mHelper = NotesDatabaseHelper.getInstance(getContext());//对mHelper进行实例化 + return true; + } + + @Override + public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,//查询uri在数据库中对应的位置 + String sortOrder) { + Cursor c = null;//声明游标cursor,待会儿会通过query函数的返回值赋值 + SQLiteDatabase db = mHelper.getReadableDatabase();//获取可读数据库 + String id = null; + switch (mMatcher.match(uri)) {//匹配查找uri + case URI_NOTE://对于不同的匹配值,在数据库中查找相应的条目 + c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, + sortOrder); + break; + case URI_NOTE_ITEM://查询便签条目 + id = uri.getPathSegments().get(1);//获取uri中1号描述符 + c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id + + parseSelection(selection), selectionArgs, null, null, sortOrder); + break; + case URI_DATA://根据日期进行查询 + c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, + sortOrder); + break; + case URI_DATA_ITEM://查询id对应的具体数据 + id = uri.getPathSegments().get(1);//根据日期条目进行查询 + c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs, null, null, sortOrder); + break; + case URI_SEARCH://搜索的uri + case URI_SEARCH_SUGGEST://对于特定Uri的搜索: + if (sortOrder != null || projection != null) {//不合法的参数异常 + throw new IllegalArgumentException(// throw用于异常处理 + "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); + } + + String searchString = null;//搜索所得的内容 + if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {//与搜索相关的ur + if (uri.getPathSegments().size() > 1) {//得到string的list + searchString = uri.getPathSegments().get(1);//得到第二个参数 + } + } else {//语句:利用URI的getQueryParameter方法可以获取字符串参数 + searchString = uri.getQueryParameter("pattern"); + } + + if (TextUtils.isEmpty(searchString)) {//如果字符串为空,返回null。TextUtils.isEmpty()进行字符串的非null判断 + return null;//格式化搜索的字符串 + } + + try {//抛出异常 + searchString = String.format("%%%s%%", searchString);//出错检测,如果正常运行,则根据搜索字符串在数据库中查询, + c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY,//语句:执行本地SQL语句查询 + new String[] { searchString });//.如果rawquery语句无法执行,抛出异常 + } catch (IllegalStateException ex) {//如果出错,抛出异常 + Log.e(TAG, "got exception: " + ex.toString()); + } + break; + default:// 如果以上多个case均不命中,则抛出未知uri的异常 + throw new IllegalArgumentException("Unknown URI " + uri);//抛出异常 + } + if (c != null) {// 若getContentResolver发生变化,就接收通知 + c.setNotificationUri(getContext().getContentResolver(), uri); + } + return c;//将地址作为结果返回 + } + + @Override + public Uri insert(Uri uri, ContentValues values) {//.插入一个uri,uri是一个用于标识某一互联网资源名称的字符串 + SQLiteDatabase db = mHelper.getWritableDatabase();//获得可写的数据库 + long dataId = 0, noteId = 0, insertedId = 0; + switch (mMatcher.match(uri)) {//数据库的插入,用来存放数据 + case URI_NOTE://.新增一个条目 + insertedId = noteId = db.insert(TABLE.NOTE, null, values);//向note中插入新的条目 + break; + case URI_DATA://通过Data查找 + if (values.containsKey(DataColumns.NOTE_ID)) {//.检查便签id + noteId = values.getAsLong(DataColumns.NOTE_ID);//得到value的值并转换成long类型的 + } else {//错误的数据格式,没有note的id + Log.d(TAG, "Wrong data format without note id:" + values.toString());//数据格式错误 + } + insertedId = dataId = db.insert(TABLE.DATA, null, values);//.插入便签数据 + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri);//.抛出异常:未知的URI + } + // Notify the note uri + if (noteId > 0) {//更新内容 + getContext().getContentResolver().notifyChange(/*getContext()是获得一个上下文对象(Context) + getContentResolver() 获得ContentResolver对 象 + notifyChange更新ContextResolver对象里面的内容 + 我们在ContentProvider的insert,update,delete等改变之后调用getContext().getContentResolver().notifyChange(uri, null);这样就通知那些监测databases变化的observer了*/ + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null);//withAppendedId(Uri contentUri, long id)负责把id和contentUri连接成一个新的Uri + } + + // Notify the data uri + if (dataId > 0) {//更新日期 + getContext().getContentResolver().notifyChange(//同上,监听对象变化时,对观察者进行通知 + ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null);//返回插入的uri的路径 + } + + return ContentUris.withAppendedId(uri, insertedId);//最后返回插入uri的路径 + } + + @Override//删除一个uri + public int delete(Uri uri, String selection, String[] selectionArgs) { + int count = 0;//Uri代表要操作的数据,Android上可用的每种资源 -包括 图像、视频片段、音频资源等都可以用Uri来表示。 + String id = null; + SQLiteDatabase db = mHelper.getWritableDatabase();//获得可写的数据库 + boolean deleteData = false;//bool类型的常量,标志是否删除数据 + switch (mMatcher.match(uri)) {//查找匹配的uri + case URI_NOTE://查找到不同类型的相应的uri后在数据库中删除 + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";//根据uri的类型有不同的selection格式,下同 + count = db.delete(TABLE.NOTE, selection, selectionArgs);// 对该notes的uri进行删除 + break; + case URI_NOTE_ITEM://通过条目查找得到 + id = uri.getPathSegments().get(1);//取得要删除的Note项目的id + /** + * ID that smaller than 0 is system folder which is not allowed to + * trash + */ + long noteId = Long.valueOf(id);//Long.valueOf(id)将string类型的字符串变为long类型 + if (noteId <= 0) {//. ID小于0表示是系统文件夹,不能删除 + break; + } + count = db.delete(TABLE.NOTE,//删除项目 + NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + break; + case URI_DATA://通过数据查找到uri + count = db.delete(TABLE.DATA, selection, selectionArgs);//删除数据 + deleteData = true; + break; + case URI_DATA_ITEM://删除uri标识的指定数据 + id = uri.getPathSegments().get(1);//通过数据条目查找到 + count = db.delete(TABLE.DATA,//删除 + DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + deleteData = true; + break; + default://匹配失败,则报错 + throw new IllegalArgumentException("Unknown URI " + uri);//未查找到相应的uri + } + if (count > 0) {//以上若进行了一次成功的修改,则count>0 + if (deleteData) {//如果真的删除了数据,则要求监听器对观察者发送通知 + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);//所有修改要对观察者进行提醒 + } + getContext().getContentResolver().notifyChange(uri, null);//对所有修改进行通知 + } + return count; + } +// 更新一个uri + @Override + public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { + int count = 0; + String id = null; + SQLiteDatabase db = mHelper.getWritableDatabase();//获取可写数据库 + boolean updateData = false; + switch (mMatcher.match(uri)) {//.根据不同的uri,更新数据库 + case URI_NOTE://如果是便签类型,先升级,然后更新数据库 + increaseNoteVersion(-1, selection, selectionArgs);//这个函数下文有定义,升级note版本 + count = db.update(TABLE.NOTE, values, selection, selectionArgs);//数据更新 + break; + case URI_NOTE_ITEM://便签条目类型,则先获取对应便签id,然后升级,更新数据库 + id = uri.getPathSegments().get(1);//获取该item的id + increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); + count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id//对notes item uri进行更新 + + parseSelection(selection), selectionArgs);//将字符串解析成规定格式 + break;//增加一个noteVersion + case URI_DATA:// 多个数据进行了修改 + count = db.update(TABLE.DATA, values, selection, selectionArgs);//对该data的uri进行更新 + updateData = true; + break; + case URI_DATA_ITEM://指定数据进行了修改 + id = uri.getPathSegments().get(1);//获取该项目id并将其uri更新 + count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs); + updateData = true; + break; + default://.匹配失败,则报错 + throw new IllegalArgumentException("Unknown URI " + uri);//抛出错误:未知uri + } + + if (count > 0) {//note更新 + if (updateData) {//data更新 + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);//如果更新数据,所有修改要对观察者进行提醒 + } + getContext().getContentResolver().notifyChange(uri, null); + } + return count; + } + + private String parseSelection(String selection) {//将字符串解析成规定格式 + return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : "");//更新便签版本 + } + + private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {//增加NoteVersion + StringBuilder sql = new StringBuilder(120);//创建Stringbuilder对象 + sql.append("UPDATE ");//在数据库中添加内容 + sql.append(TABLE.NOTE); + sql.append(" SET "); + sql.append(NoteColumns.VERSION); + sql.append("=" + NoteColumns.VERSION + "+1 "); + + if (id > 0 || !TextUtils.isEmpty(selection)) {//操作条件selection不为空或者ID>0,增加WHERE语句 + sql.append(" WHERE ");//sql添加where表明选取的范围 + } + if (id > 0) {//.id>0:更新ID + sql.append(NoteColumns.ID + "=" + String.valueOf(id)); + } + if (!TextUtils.isEmpty(selection)) {//输入的文本非空的条件下输入到数据库中 + String selectString = id > 0 ? parseSelection(selection) : selection;// 根据id,判断selection的格式, + for (String args : selectionArgs) { + selectString = selectString.replaceFirst("\\?", args);//用args替换掉?的占位符 + } + sql.append(selectString);//语句:增加selectString语句 + } + + mHelper.getWritableDatabase().execSQL(sql.toString());//execSQL()方法可以执行insert、delete、update和CREATE TABLE之类有更改行为的SQL语句 + } + + @Override + public String getType(Uri uri) {//仅仅只是声明gettype,并无其他操作 + // TODO Auto-generated method stub + return null;//初始化,返回一个空指针 + } + +} diff --git a/src/main/java/net/micode/notes/gtask/data/MetaData.java b/src/main/java/net/micode/notes/gtask/data/MetaData.java new file mode 100644 index 0000000..8625cfd --- /dev/null +++ b/src/main/java/net/micode/notes/gtask/data/MetaData.java @@ -0,0 +1,115 @@ +/* + * 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.gtask.data; + +import android.database.Cursor; +import android.database.Cursor; +import android.util.Log; + +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONException; //存储json对象的属性名(string类型)和属性值 +import org.json.JSONObject; + +/** + * 新建一个继承Task类的MetaData类,用于记录数据的变化,作为元数据类描述数据属性的信息 + */ +public class MetaData extends Task { + private final static String TAG = MetaData.class.getSimpleName(); + + private String mRelatedGid = null; + + /** + * 调用JSONObject库函数put (),Task类中的setNotes ()和setName ()函数,实现设置数据,即生成元数据库 + * @param gid + * @param metaInfo + */ + public void setMeta(String gid, JSONObject metaInfo) { + try { + metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); + } catch (JSONException e) { + Log.e(TAG, "failed to put related gid"); + } + setNotes(metaInfo.toString()); + setName(GTaskStringUtils.META_NOTE_NAME); + } + + /** + * 获取相关联的Gid + * @return + */ + public String getRelatedGid() { + return mRelatedGid; + } + + /** + * 判断是否值得存放,即当前数据是否有效,若数据非空则返回真值 + * @return + */ + @Override + public boolean isWorthSaving() { + return getNotes() != null; + } + + /** + * 使用本地json数据对象设置元数据内容,一般不会用到,若用到,则抛出异常 + * @param js + */ + @Override + public void setContentByRemoteJSON(JSONObject js) { + super.setContentByRemoteJSON(js); + if (getNotes() != null) { + try { + JSONObject metaInfo = new JSONObject(getNotes().trim()); + mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); + } catch (JSONException e) { + Log.w(TAG, "failed to get related gid"); + mRelatedGid = null; + } + } + } + + /** + * 以本地json设置元数据内容,并抛出错误 + * @param js + */ + @Override + public void setContentByLocalJSON(JSONObject js) { + // this function should not be called + throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + } + + /** + * 从元数据内容中获取本地json对象,并抛出异常 + * @return + */ + @Override + public JSONObject getLocalJSONFromContent() { + throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + } + + /** + * 获取同步动作状态,一般不会用到,若用到,则抛出异常 + * @param c + * @return + */ + @Override + public int getSyncAction(Cursor c) { + throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + } + +} diff --git a/src/main/java/net/micode/notes/gtask/data/Node.java b/src/main/java/net/micode/notes/gtask/data/Node.java new file mode 100644 index 0000000..4b28dc4 --- /dev/null +++ b/src/main/java/net/micode/notes/gtask/data/Node.java @@ -0,0 +1,123 @@ +/* + * 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.gtask.data; + +import android.database.Cursor;//引用cursor,此公用接口提供对数据库查询返回的结果集的随机读写访问。 + +import org.json.JSONObject; + +/** + * 同步操作的基础数据类型,定义了相关指示同步操作的常量 + */ +public abstract class Node { + public static final int SYNC_ACTION_NONE = 0;//本地云端无更新 + + public static final int SYNC_ACTION_ADD_REMOTE = 1;//需要在远程云端增加内容 + + public static final int SYNC_ACTION_ADD_LOCAL = 2;//需要在云端本地删除内容 + + public static final int SYNC_ACTION_DEL_REMOTE = 3;//需要在远程云端删除内容 + + public static final int SYNC_ACTION_DEL_LOCAL = 4;//需要在本地删除内容 + + public static final int SYNC_ACTION_UPDATE_REMOTE = 5; + + public static final int SYNC_ACTION_UPDATE_LOCAL = 6; + + public static final int SYNC_ACTION_UPDATE_CONFLICT = 7;//同步出现冲突 + + public static final int SYNC_ACTION_ERROR = 8;//同步出现错误 + + private String mGid;//记录最后一次修改时间 + + private String mName; + + private long mLastModified;//long类型 表明最后一次的修改的时间 + + private boolean mDeleted;//判断 表征是否被删除 + + /** + *.构造函数,进行初始化,界面没有,名字为空,最后一次修改时间为0(没有修改),表征是否删除。 + */ + public Node() { + mGid = null; + mName = ""; + mLastModified = 0; + mDeleted = false; + } + + public abstract JSONObject getCreateAction(int actionId); + + public abstract JSONObject getUpdateAction(int actionId); + + public abstract void setContentByRemoteJSON(JSONObject js); + + public abstract void setContentByLocalJSON(JSONObject js); + + public abstract JSONObject getLocalJSONFromContent(); + + public abstract int getSyncAction(Cursor c); + + /** + * 设置 gid + * @param gid + */ + public void setGid(String gid) { + this.mGid = gid; + } + + /** + * 设置名称 + * @param name + */ + public void setName(String name) { + this.mName = name; + } + + public void setLastModified(long lastModified) { + this.mLastModified = lastModified; + } + + public void setDeleted(boolean deleted) { + this.mDeleted = deleted; + } + + public String getGid() { + return this.mGid; + } + + public String getName() { + return this.mName; + } + + /** + * 获取最近创建时间标识 + * @return + */ + public long getLastModified() { + return this.mLastModified; + } + + /** + * 获取删除标识 + * @return + */ + public boolean getDeleted() { + return this.mDeleted; + } + +} diff --git a/src/main/java/net/micode/notes/gtask/data/SqlData.java b/src/main/java/net/micode/notes/gtask/data/SqlData.java new file mode 100644 index 0000000..a93ecfd --- /dev/null +++ b/src/main/java/net/micode/notes/gtask/data/SqlData.java @@ -0,0 +1,230 @@ +/* + * 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.gtask.data; + +import android.content.ContentResolver; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +import net.micode.notes.data.Notes; +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.NotesDatabaseHelper.TABLE; +import net.micode.notes.gtask.exception.ActionFailureException; + +import org.json.JSONException; +import org.json.JSONObject; + +/** + * 数据库中的基本数据 + */ +public class SqlData { + private static final String TAG = SqlData.class.getSimpleName();//调用getSimpleName ()函数来得到类的简写名称存入字符串TAG中 + + private static final int INVALID_ID = -99999; + /** + * 新建一个字符串数组,集合了 interface DataColumns 中所有SF常量 + */ + public static final String[] PROJECTION_DATA = new String[] { + DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, + DataColumns.DATA3 + }; + //以下五个变量作为sql表中5列的编号 + public static final int DATA_ID_COLUMN = 0; + + public static final int DATA_MIME_TYPE_COLUMN = 1; + + public static final int DATA_CONTENT_COLUMN = 2; + + public static final int DATA_CONTENT_DATA_1_COLUMN = 3; + + public static final int DATA_CONTENT_DATA_3_COLUMN = 4; + + private ContentResolver mContentResolver; + + private boolean mIsCreate;// 判断是否直接用Content生成,是为true,否则为false + //以下五个变量分别对应上述5列类型,用于构造SqlData,声明为private类型,以防止被恶意篡改。 + private long mDataId; + + private String mDataMimeType; + + private String mDataContent; + + private long mDataContentData1; + + private String mDataContentData3; + + private ContentValues mDiffDataValues;//定义mDiffDataValues用于构造SqiData,操作数据库 + + /** + * QLData的构造方式,只从上下文获取,初始化其中的变量 + * @param context + */ + public SqlData(Context context) { + mContentResolver = context.getContentResolver(); + mIsCreate = true; + mDataId = INVALID_ID; + mDataMimeType = DataConstants.NOTE; + mDataContent = ""; + mDataContentData1 = 0; + mDataContentData3 = ""; + mDiffDataValues = new ContentValues(); + } + + /** + * 构造函数,初始化数据,参数类型分别为 Context 和 Cursor + * @param context + * @param c + */ + public SqlData(Context context, Cursor c) { + mContentResolver = context.getContentResolver(); + mIsCreate = false; + loadFromCursor(c); + mDiffDataValues = new ContentValues(); + } + + /** + * 当前的光标处将五列的数据加载到该类的对象 + * @param c + */ + private void loadFromCursor(Cursor c) { + mDataId = c.getLong(DATA_ID_COLUMN); + mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); + mDataContent = c.getString(DATA_CONTENT_COLUMN); + mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); + mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); + } + + /** + *设置共享数据并提供异常抛出与处理机制 + * @param js + * @throws JSONException + */ + public void setContent(JSONObject js) throws JSONException { + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID;//如果传入的JSONObject对象有DataColumns.ID这一项,则设置dataID为这个ID, + if (mIsCreate || mDataId != dataId) { + mDiffDataValues.put(DataColumns.ID, dataId); + } + mDataId = dataId; + + String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) + : DataConstants.NOTE; + /** + * 如果采用的是第一种SqlData构造方式,或者这个对象的MimeType不和共享数据一样,则将共享数据.MIME_TYPE加入数据库中 + */ + if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { + mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); + } + mDataMimeType = dataMimeType; + + String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; + if (mIsCreate || !mDataContent.equals(dataContent)) { + mDiffDataValues.put(DataColumns.CONTENT, dataContent); + } + mDataContent = dataContent; + + long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0;//如果传入的JSONObject对象有DataColumn.DATA1一项,那么将其获取,否则。将其设置为0。 + if (mIsCreate || mDataContentData1 != dataContentData1) { + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); + } + mDataContentData1 = dataContentData1; + + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : "";// 如果传入的JSONObject对象有DataColumn.DATA3一项,那么将其获取,否则。将其设置为""。 + if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); + } + mDataContentData3 = dataContentData3; + } + + /** + * 获取共享的数据内容,并提供异常抛出与处理机制 + * @return + * @throws JSONException + */ + public JSONObject getContent() throws JSONException { + if (mIsCreate) { + Log.e(TAG, "it seems that we haven't created this in database yet"); + return null; + } + JSONObject js = new JSONObject(); + js.put(DataColumns.ID, mDataId); + js.put(DataColumns.MIME_TYPE, mDataMimeType); + js.put(DataColumns.CONTENT, mDataContent); + js.put(DataColumns.DATA1, mDataContentData1); + js.put(DataColumns.DATA3, mDataContentData3); + return js; + } + + /** + * commit 函数用于把当前所做的修改保存到数据库 + * @param noteId + * @param validateVersion + * @param version + */ + public void commit(long noteId, boolean validateVersion, long version) { + /** + * 分两种构造方式进行不同的操作,之后进行异常处理并反馈错误信息 + */ + if (mIsCreate) { + if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { + mDiffDataValues.remove(DataColumns.ID); + } + + mDiffDataValues.put(DataColumns.NOTE_ID, noteId);//更新共享数据,键为NOTE_ID,值为noteId + Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); + try { + mDataId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); + throw new ActionFailureException("create note failed"); + } + } else { + /** + * 若共享数据存在,则通过内容解析器更新关于新URI的共享数据 + */ + if (mDiffDataValues.size() > 0) { + int result = 0; + if (!validateVersion) { + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); + } else { + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, + " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.VERSION + "=?)", new String[] { + String.valueOf(noteId), String.valueOf(version) + }); + } + if (result == 0) { + Log.w(TAG, "there is no update. maybe user updates note when syncing"); + } + } + } + + mDiffDataValues.clear(); + mIsCreate = false; + } + + public long getId() { + return mDataId; + } +} diff --git a/src/main/java/net/micode/notes/gtask/data/SqlNote.java b/src/main/java/net/micode/notes/gtask/data/SqlNote.java new file mode 100644 index 0000000..890e9fc --- /dev/null +++ b/src/main/java/net/micode/notes/gtask/data/SqlNote.java @@ -0,0 +1,567 @@ +/* + * 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.gtask.data; + +import android.appwidget.AppWidgetManager; +import android.content.ContentResolver; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; +import net.micode.notes.tool.ResourceParser; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.ArrayList; + +/** + * 用于支持小米便签最底层的数据库相关操作,和sqldata的关系上是父集关系 + */ +public class SqlNote { + private static final String TAG = SqlNote.class.getSimpleName(); + + private static final int INVALID_ID = -99999; + /** + * .集合了interface NoteColumns中所有SF常量 + */ + public static final String[] PROJECTION_NOTE = new String[] { + NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, + NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE, + NoteColumns.NOTES_COUNT, NoteColumns.PARENT_ID, NoteColumns.SNIPPET, NoteColumns.TYPE, + NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE, NoteColumns.SYNC_ID, + NoteColumns.LOCAL_MODIFIED, NoteColumns.ORIGIN_PARENT_ID, NoteColumns.GTASK_ID, + NoteColumns.VERSION + }; + //设置了17个列的序号 + public static final int ID_COLUMN = 0; + + public static final int ALERTED_DATE_COLUMN = 1; + + public static final int BG_COLOR_ID_COLUMN = 2; + + public static final int CREATED_DATE_COLUMN = 3; + + public static final int HAS_ATTACHMENT_COLUMN = 4; + + public static final int MODIFIED_DATE_COLUMN = 5; + + public static final int NOTES_COUNT_COLUMN = 6; + + public static final int PARENT_ID_COLUMN = 7; + + public static final int SNIPPET_COLUMN = 8; + + public static final int TYPE_COLUMN = 9; + + public static final int WIDGET_ID_COLUMN = 10; + + public static final int WIDGET_TYPE_COLUMN = 11; + + public static final int SYNC_ID_COLUMN = 12; + + public static final int LOCAL_MODIFIED_COLUMN = 13; + + public static final int ORIGIN_PARENT_ID_COLUMN = 14; + + public static final int GTASK_ID_COLUMN = 15; + + public static final int VERSION_COLUMN = 16; + /** + * 定义对应上述17个内部变量,帮助构造sqlnote + */ + private Context mContext; + + private ContentResolver mContentResolver; + + private boolean mIsCreate; + + private long mId; + + private long mAlertDate; + + private int mBgColorId; + + private long mCreatedDate; + + private int mHasAttachment; + + private long mModifiedDate; + + private long mParentId; + + private String mSnippet; + + private int mType; + + private int mWidgetId; + + private int mWidgetType; + + private long mOriginParent; + + private long mVersion; + + private ContentValues mDiffNoteValues; + + private ArrayList`))jlv3Kr#7T8rx>Okb$?!JU{~mfU(lm15P=nCu-=n