Type: INTEGER (long)
+ */ + public static final String ID = "_id"; + + /** + * The parent's id for note or folder + *Type: INTEGER (long)
+ */ + public static final String PARENT_ID = "parent_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"; + + + /** + * 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 + *Type: INTEGER (long)
+ */ + public static final String WIDGET_ID = "widget_id"; + + /** + * Note's widget type + *Type: INTEGER (long)
+ */ + public static final String WIDGET_TYPE = "widget_type"; + + /** + * Note's background color's id + *Type: INTEGER (long)
+ */ + 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 + *Type: INTEGER
+ */ + public static final String HAS_ATTACHMENT = "has_attachment"; + + /** + * Folder's count of notes + *Type: INTEGER (long)
+ */ + public static final String NOTES_COUNT = "notes_count"; + + /** + * The file type: folder or note + *Type: INTEGER
+ */ + public static final String TYPE = "type"; + + /** + * The last sync id + *Type: INTEGER (long)
+ */ + public static final String SYNC_ID = "sync_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 + *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"; + + /** + * The version code + *Type : INTEGER (long)
+ */ + public static final String VERSION = "version"; + } + + public interface DataColumns { + /** + * The unique ID for a row + *Type: INTEGER (long)
+ */ + public static final String ID = "_id"; + + /** + * The MIME type of the item represented by this row. + *Type: Text
+ */ + public static final String MIME_TYPE = "mime_type"; + + /** + * The reference id to note that this data belongs to + *Type: INTEGER (long)
+ */ + public static final String NOTE_ID = "note_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 + * 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
+ */ + public static final String DATA4 = "data4"; + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *Type: TEXT
+ */ + public static final String DATA5 = "data5"; + } + + public static final class TextNote implements DataColumns { + /** + * Mode to indicate the text in check list mode or not + *Type: Integer 1:check list mode 0: normal mode
+ */ + public static final String MODE = DATA1; + + public static final int MODE_CHECK_LIST = 1; + + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; + + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; + + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note"); + } + + public static final class CallNote implements DataColumns { + /** + * Call date for this record + *Type: INTEGER (long)
+ */ + public static final String CALL_DATE = DATA1; + + /** + * Phone number for this record + *Type: TEXT
+ */ + public static final String PHONE_NUMBER = 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/java/net/micode/notes/data/NotesDatabaseHelper.java b/src/java/net/micode/notes/data/NotesDatabaseHelper.java new file mode 100644 index 0000000..259a42d --- /dev/null +++ b/src/java/net/micode/notes/data/NotesDatabaseHelper.java @@ -0,0 +1,401 @@ +/* + * 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. + * 总体分析 +这段 Java 代码定义了NotesDatabaseHelper类,它继承自SQLiteOpenHelper,是用于管理和操作笔记应用相关数据库的核心辅助类。主要负责数据库的创建(包括创建表结构、索引以及各类触发器等)、数据库版本升级等功能,通过一系列预定义的 SQL 语句来构建数据库环境,同时在版本升级时按照不同版本间的差异进行相应的表结构修改、新增列以及触发器重建等操作,以保证数据库能适配应用的不同版本需求,整体为笔记应用的数据持久化存储与管理提供了可靠的数据库层面支持。 +函数分析 +NotesDatabaseHelper类构造函数 +所属类:NotesDatabaseHelper +功能:调用父类(SQLiteOpenHelper)的构造函数,传入应用上下文、数据库名称(固定为"note.db")、游标工厂(这里传null)以及数据库版本号(固定为4),用于初始化数据库帮助类对象,为后续操作数据库做准备。 +createNoteTable方法 +所属类:NotesDatabaseHelper +功能:在传入的SQLiteDatabase对象上执行创建笔记表(note表)的 SQL 语句(CREATE_NOTE_TABLE_SQL),接着调用reCreateNoteTableTriggers方法重建与笔记表相关的触发器,再调用createSystemFolder方法创建系统文件夹相关记录插入到笔记表中,最后记录日志表示笔记表已创建,用于完成创建笔记表以及相关初始化操作的功能。 +reCreateNoteTableTriggers方法 +所属类:NotesDatabaseHelper +功能:先通过execSQL方法依次删除一系列已存在的与笔记表相关的触发器(如文件夹计数增减触发器、数据删除关联触发器等),然后再按照定义好的创建触发器的 SQL 语句(如NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER等)重新创建这些触发器,用于在需要时重新构建笔记表相关的触发器逻辑,确保数据库操作时对应的触发机制正确生效。 +createSystemFolder方法 +所属类:NotesDatabaseHelper +功能:通过ContentValues对象来设置不同系统文件夹(通话记录文件夹、根文件夹、临时文件夹、回收站文件夹)的相关属性(如ID、TYPE等),然后使用SQLiteDatabase的insert方法将这些系统文件夹记录插入到笔记表中,用于初始化创建系统文件夹相关的数据记录,完善笔记表初始数据结构。 +createDataTable方法 +所属类:NotesDatabaseHelper +功能:在给定的SQLiteDatabase对象上执行创建数据表(data表)的 SQL 语句(CREATE_DATA_TABLE_SQL),接着调用reCreateDataTableTriggers方法重建与数据表相关的触发器,再执行创建数据表中note_id索引的 SQL 语句(CREATE_DATA_NOTE_ID_INDEX_SQL),最后记录日志表示数据表已创建,用于完成创建数据表以及相关初始化操作的功能。 +reCreateDataTableTriggers方法 +所属类:NotesDatabaseHelper +功能:先删除已存在的与数据表中笔记内容更新相关的触发器(插入、更新、删除操作对应的触发器),然后再按照定义好的创建这些触发器的 SQL 语句(如DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER等)重新创建它们,用于在数据表操作时正确触发相应的笔记内容更新逻辑,保证数据一致性。 +getInstance方法 +所属类:NotesDatabaseHelper +功能:采用单例模式,通过同步锁机制判断类的实例(mInstance)是否为null,若为null则创建一个新的NotesDatabaseHelper对象并赋值给mInstance,最后返回该实例,用于保证整个应用中只有一个数据库帮助类实例,方便在不同地方统一操作数据库,避免多次创建数据库连接等资源浪费。 +onCreate方法 +所属类:NotesDatabaseHelper +功能:重写了父类(SQLiteOpenHelper)的onCreate方法,在数据库首次创建时被调用,内部调用createNoteTable和createDataTable方法分别创建笔记表和数据表,用于初始化数据库的基础表结构等相关内容。 +onUpgrade方法 +所属类:NotesDatabaseHelper +功能:重写了父类的onUpgrade方法,用于处理数据库版本升级的逻辑。根据旧版本号(oldVersion)与新版本号(newVersion)的对比情况,执行不同的升级操作,比如从版本1升级到版本2时调用upgradeToV2方法,从版本2升级到版本3时调用upgradeToV3方法等,同时根据需要决定是否重建相关的触发器,若最终旧版本号和新版本号不一致则抛出异常,表示升级失败,整体实现了按照应用不同版本需求对数据库结构进行相应调整的功能。 +upgradeToV2方法 +所属类:NotesDatabaseHelper +功能:在数据库从版本1升级到版本2时被调用,先删除已存在的笔记表和数据表,然后重新调用createNoteTable和createDataTable方法创建新的表结构,用于完成特定版本间数据库表结构的重建升级操作。 +upgradeToV3方法 +所属类:NotesDatabaseHelper +功能:在数据库从版本2升级到版本3时被调用,执行以下操作:先删除一些不再使用的触发器,接着通过ALTER TABLE语句为笔记表添加一个用于存储Gtask ID的新列,最后创建回收站系统文件夹相关记录插入到笔记表中,用于实现版本2到版本3对应的数据库结构和功能调整。 +upgradeToV4方法 +所属类:NotesDatabaseHelper +功能:在数据库从版本3升级到版本4时被调用,通过ALTER TABLE语句为笔记表添加一个版本号(VERSION)列,并设置默认值为0,用于完成版本3到版本4的数据库结构升级,满足对应版本应用对数据库的要求。 + */ + +package net.micode.notes.data; + +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; + + +public class NotesDatabaseHelper extends SQLiteOpenHelper { + private static final String DB_NAME = "note.db"; + + private static final int DB_VERSION = 4; + + public interface TABLE { + public static final String NOTE = "note"; + + public static final String DATA = "data"; + } + + private static final String TAG = "NotesDatabaseHelper"; + + private static NotesDatabaseHelper mInstance; + + private static final String CREATE_NOTE_TABLE_SQL = + "CREATE TABLE " + TABLE.NOTE + "(" + + NoteColumns.ID + " INTEGER PRIMARY KEY," + + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + 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," + + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + + 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" + + ")"; + + private static final String CREATE_DATA_TABLE_SQL = + "CREATE TABLE " + TABLE.DATA + "(" + + 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 = + "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 + */ + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = + "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"; + + /** + * Decrease folder's note count when move note from folder + */ + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = + "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" + ";" + + " END"; + + /** + * Increase folder's note count when insert new note to the folder + */ + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER = + "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"; + + /** + * Decrease folder's note count when delete note from the folder + */ + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER = + "CREATE TRIGGER decrease_folder_count_on_delete " + + " 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"; + + /** + * Update note's content when insert data with type {@link DataConstants#NOTE} + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = + "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 + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = + "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"; + + /** + * Update note's content when data with {@link DataConstants#NOTE} type has deleted + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = + "CREATE TRIGGER update_note_content_on_delete " + + " 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) { + db.execSQL(CREATE_NOTE_TABLE_SQL); + reCreateNoteTableTriggers(db); + createSystemFolder(db); + Log.d(TAG, "note table has been created"); + } + + private void reCreateNoteTableTriggers(SQLiteDatabase db) { + 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"); + db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash"); + + 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); + db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER); + } + + private void createSystemFolder(SQLiteDatabase db) { + ContentValues values = new ContentValues(); + + /** + * call record foler for call notes + */ + values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * root folder which is default folder + */ + values.clear(); + values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * temporary folder which is used for moving note + */ + values.clear(); + values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * create trash folder + */ + values.clear(); + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + } + + public void createDataTable(SQLiteDatabase db) { + db.execSQL(CREATE_DATA_TABLE_SQL); + 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); + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); + } + + static synchronized NotesDatabaseHelper getInstance(Context context) { + if (mInstance == null) { + mInstance = new NotesDatabaseHelper(context); + } + return mInstance; + } + + @Override + public void onCreate(SQLiteDatabase db) { + createNoteTable(db); + createDataTable(db); + } + + @Override + public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { + boolean reCreateTriggers = false; + boolean skipV2 = false; + + if (oldVersion == 1) { + upgradeToV2(db); + skipV2 = true; // this upgrade including the upgrade from v2 to v3 + oldVersion++; + } + + if (oldVersion == 2 && !skipV2) { + upgradeToV3(db); + reCreateTriggers = true; + oldVersion++; + } + + if (oldVersion == 3) { + upgradeToV4(db); + oldVersion++; + } + + if (reCreateTriggers) { + 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); + } + + private void upgradeToV3(SQLiteDatabase db) { + // 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 + + " 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); + } + + private void upgradeToV4(SQLiteDatabase db) { + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + + " INTEGER NOT NULL DEFAULT 0"); + } +} diff --git a/src/java/net/micode/notes/data/NotesProvider.java b/src/java/net/micode/notes/data/NotesProvider.java new file mode 100644 index 0000000..85dd5f6 --- /dev/null +++ b/src/java/net/micode/notes/data/NotesProvider.java @@ -0,0 +1,346 @@ +/* + * 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. + * 总体分析 +这段 Java 代码定义了NotesProvider类,它继承自ContentProvider,是安卓应用中用于在不同组件间共享数据的重要组件,在笔记应用里充当数据提供者的角色。通过UriMatcher对不同的Uri进行匹配,以此来区分是对笔记表(note表)、数据表(data表)进行查询、插入、删除、更新等操作,还是处理搜索及搜索建议相关的逻辑,并且在操作数据后会根据情况发送数据变更通知,以保证相关组件能及时知晓数据的变化,整体实现了数据在应用内的统一管理与共享交互功能。 +函数分析 +NotesProvider类构造函数相关(静态代码块部分) +所属类:NotesProvider +功能:在静态代码块中初始化UriMatcher对象(mMatcher),向其中添加不同的Uri匹配规则,涵盖了笔记表、数据表、搜索以及搜索建议对应的Uri模式,例如匹配笔记表的Uri("note")对应URI_NOTE,匹配笔记表中单个记录的Uri("note/#")对应URI_NOTE_ITEM等,用于后续根据传入的Uri准确判断操作类型及对应的表。 +onCreate方法 +所属类:NotesProvider +功能:重写了父类(ContentProvider)的onCreate方法,在内容提供者被创建时调用,通过NotesDatabaseHelper的单例模式获取数据库帮助类实例(mHelper),并返回true表示创建成功,用于初始化与数据库相关的操作对象,为后续数据库操作做准备。 +query方法 +所属类:NotesProvider +功能:重写了父类的query方法,用于处理数据查询操作。首先获取可读数据库对象,然后根据UriMatcher对传入Uri的匹配结果分情况处理: +若匹配到URI_NOTE,则对笔记表执行查询操作;若匹配到URI_NOTE_ITEM,则先获取Uri路径中的记录ID,再对笔记表中指定ID的记录进行查询。 +对于URI_DATA和URI_DATA_ITEM,类似地分别对数据表进行全表查询以及对数据表中指定ID的记录查询,查询时会结合传入的投影(projection)、选择条件(selection)等参数构建查询语句。 +当匹配到URI_SEARCH或URI_SEARCH_SUGGEST时,先获取搜索字符串,若为空则返回null,否则格式化搜索字符串后执行自定义的搜索查询语句(NOTES_SNIPPET_SEARCH_QUERY)获取搜索结果游标。最后若游标不为null,设置其通知Uri以便数据变化时能收到通知,最终返回游标用于获取查询到的数据,整体实现了根据不同Uri进行对应数据查询的功能。 +insert方法 +所属类:NotesProvider +功能:重写了父类的insert方法,用于处理数据插入操作。获取可写数据库对象后,根据UriMatcher对传入Uri的匹配结果分情况插入数据: +若匹配到URI_NOTE,则向笔记表插入数据并记录插入的记录ID(noteId)。 +若匹配到URI_DATA,先获取所属笔记ID(若不存在则记录日志提示错误数据格式),再向数据表插入数据并记录插入的记录ID(dataId)。插入成功后,根据插入的ID是否大于0,分别向笔记表对应的ContentUri(Notes.CONTENT_NOTE_URI)和数据表对应的ContentUri(Notes.CONTENT_DATA_URI)发送数据变更通知,最后返回插入数据后对应Uri(通过ContentUris.withAppendedId构建),整体实现了向不同表插入数据并发送相应通知的功能。 +delete方法 +所属类:NotesProvider +功能:重写了父类的delete方法,用于处理数据删除操作。获取可写数据库对象后,按照UriMatcher对传入Uri的匹配结果分情况删除数据: +对于URI_NOTE,添加额外条件确保ID大于0(避免删除系统文件夹等情况)后删除笔记表中的记录。 +对于URI_NOTE_ITEM,获取Uri路径中的记录ID,判断ID合法(大于0)后删除对应笔记记录。 +对于URI_DATA和URI_DATA_ITEM,分别删除数据表中的记录以及数据表中指定ID的记录,同时标记是否删除的数据表相关(deleteData变量)。若删除的记录数大于0,根据是否与数据表相关向相应的Uri(笔记表Uri或操作对应的Uri)发送数据变更通知,最后返回删除的记录数量,整体实现了按不同Uri删除对应数据并发送通知的功能。 +update方法 +所属类:NotesProvider +功能:重写了父类的update方法,用于处理数据更新操作。获取可写数据库对象后,依据UriMatcher对传入Uri的匹配结果分情况更新数据: +对于URI_NOTE和URI_NOTE_ITEM,分别更新笔记表中的记录以及笔记表中指定ID的记录,更新前会调用increaseNoteVersion方法增加笔记版本号,然后执行更新操作并根据更新的记录数判断是否发送数据变更通知(向笔记表Uri或操作对应的Uri)。 +对于URI_DATA和URI_DATA_ITEM,类似地更新数据表中的记录以及数据表中指定ID的记录,并标记是否更新的数据表相关(updateData变量),根据更新记录数情况发送相应的通知,最后返回更新的记录数量,整体实现了按不同Uri更新对应数据并发送通知的功能。 +parseSelection方法 +所属类:NotesProvider +功能:接收一个选择条件字符串(selection),判断其不为空时,在其前后添加" AND ("和")",用于将传入的选择条件和已有的查询条件进行合理拼接,辅助其他数据库操作方法构建完整准确的查询、删除、更新等操作的条件语句。 +increaseNoteVersion方法 +所属类:NotesProvider +功能:构建一个用于更新笔记表中版本号(NoteColumns.VERSION)的SQL语句,根据传入的笔记ID(id)以及选择条件(selection)、选择条件参数(selectionArgs)来确定WHERE子句的内容,然后通过数据库帮助类获取可写数据库对象并执行该SQL语句,用于在更新笔记相关数据时增加笔记的版本号,保证数据版本管理的一致性。 +getType方法 +所属类:NotesProvider +功能:重写了父类的getType方法,目前方法体为空,按照ContentProvider规范,该方法应该返回对应Uri所代表的数据的MIME类型,不过此处尚未实现具体逻辑,可能需要根据实际需求补充代码来准确返回不同Uri对应的数据类型信息。 + + */ + +package net.micode.notes.data; + + +import android.app.SearchManager; +import android.content.ContentProvider; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Intent; +import android.content.UriMatcher; +import android.database.Cursor; +import android.database.sqlite.SQLiteDatabase; +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; + + +public class NotesProvider extends ContentProvider { + private static final UriMatcher mMatcher; + + private NotesDatabaseHelper mHelper; + + private static final String TAG = "NotesProvider"; + + 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; + + static { + mMatcher = new UriMatcher(UriMatcher.NO_MATCH); + mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); + mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); + 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); + 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. + */ + private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," + + "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; + + private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION + + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; + + @Override + public boolean onCreate() { + mHelper = NotesDatabaseHelper.getInstance(getContext()); + return true; + } + + @Override + public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, + String sortOrder) { + Cursor c = null; + SQLiteDatabase db = mHelper.getReadableDatabase(); + String id = null; + switch (mMatcher.match(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); + 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 = uri.getPathSegments().get(1); + c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs, null, null, sortOrder); + break; + case URI_SEARCH: + case URI_SEARCH_SUGGEST: + if (sortOrder != null || projection != null) { + throw new IllegalArgumentException( + "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); + } + + String searchString = null; + if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { + if (uri.getPathSegments().size() > 1) { + searchString = uri.getPathSegments().get(1); + } + } else { + searchString = uri.getQueryParameter("pattern"); + } + + if (TextUtils.isEmpty(searchString)) { + return null; + } + + try { + searchString = String.format("%%%s%%", searchString); + c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, + new String[] { searchString }); + } catch (IllegalStateException ex) { + Log.e(TAG, "got exception: " + ex.toString()); + } + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + if (c != null) { + c.setNotificationUri(getContext().getContentResolver(), uri); + } + return c; + } + + @Override + public Uri insert(Uri uri, ContentValues values) { + 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); + break; + case URI_DATA: + if (values.containsKey(DataColumns.NOTE_ID)) { + noteId = values.getAsLong(DataColumns.NOTE_ID); + } else { + 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); + } + // Notify the note uri + if (noteId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); + } + + // Notify the data uri + if (dataId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); + } + + return ContentUris.withAppendedId(uri, insertedId); + } + + @Override + public int delete(Uri uri, String selection, String[] selectionArgs) { + int count = 0; + String id = null; + SQLiteDatabase db = mHelper.getWritableDatabase(); + boolean deleteData = false; + switch (mMatcher.match(uri)) { + case URI_NOTE: + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; + count = db.delete(TABLE.NOTE, selection, selectionArgs); + break; + case URI_NOTE_ITEM: + id = uri.getPathSegments().get(1); + /** + * ID that smaller than 0 is system folder which is not allowed to + * trash + */ + long noteId = Long.valueOf(id); + if (noteId <= 0) { + break; + } + count = db.delete(TABLE.NOTE, + NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + break; + case URI_DATA: + count = db.delete(TABLE.DATA, selection, selectionArgs); + deleteData = true; + break; + case URI_DATA_ITEM: + 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); + } + if (count > 0) { + if (deleteData) { + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); + } + getContext().getContentResolver().notifyChange(uri, null); + } + return count; + } + + @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)) { + case URI_NOTE: + increaseNoteVersion(-1, selection, selectionArgs); + count = db.update(TABLE.NOTE, values, selection, selectionArgs); + break; + case URI_NOTE_ITEM: + id = uri.getPathSegments().get(1); + increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); + count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id + + parseSelection(selection), selectionArgs); + break; + case URI_DATA: + count = db.update(TABLE.DATA, values, selection, selectionArgs); + updateData = true; + break; + case URI_DATA_ITEM: + id = uri.getPathSegments().get(1); + count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs); + updateData = true; + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + + if (count > 0) { + if (updateData) { + 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) { + StringBuilder sql = new StringBuilder(120); + 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)) { + sql.append(" WHERE "); + } + if (id > 0) { + sql.append(NoteColumns.ID + "=" + String.valueOf(id)); + } + if (!TextUtils.isEmpty(selection)) { + String selectString = id > 0 ? parseSelection(selection) : selection; + for (String args : selectionArgs) { + selectString = selectString.replaceFirst("\\?", args); + } + sql.append(selectString); + } + + mHelper.getWritableDatabase().execSQL(sql.toString()); + } + + @Override + public String getType(Uri uri) { + // TODO Auto-generated method stub + return null; + } + +} diff --git a/src/java/net/micode/notes/gtask/data/MetaData.java b/src/java/net/micode/notes/gtask/data/MetaData.java new file mode 100644 index 0000000..db13c76 --- /dev/null +++ b/src/java/net/micode/notes/gtask/data/MetaData.java @@ -0,0 +1,106 @@ +/* + * 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. + * 总体分析 +这段 Java 代码定义了MetaData类,它继承自Task类,主要用于处理与元数据相关的特定逻辑,聚焦在关联 GTask 的相关标识(通过mRelatedGid)以及对元数据信息的存储、获取和相关操作的控制上。类中提供了设置元数据的方法,同时重写了父类的一些方法,像判断是否值得保存以及根据远程 JSON 数据设置内容等方法,不过也限制了部分方法(如设置本地 JSON 内容、获取本地 JSON 内容以及获取同步操作等方法)不能被调用,整体体现了对元数据这种特定数据在应用特定业务场景下的特殊处理逻辑。 +函数分析 +setMeta方法 +所属类:MetaData +功能:尝试将传入的gid(关联的 GTask 标识)添加到给定的JSONObject(元数据信息)中指定的键(GTaskStringUtils.META_HEAD_GTASK_ID)下,若添加过程出现JSONException则记录错误日志,最后通过调用父类的setNotes方法将处理后的JSONObject转换为字符串进行存储,并设置名称为特定的元数据名称(GTaskStringUtils.META_NOTE_NAME),用于设置元数据相关信息并关联对应的 GTask 标识。 +getRelatedGid方法 +所属类:MetaData +功能:返回记录的关联 GTask 的标识(mRelatedGid),用于获取元数据所关联的 GTask 相关标识信息。 +isWorthSaving方法 +所属类:MetaData +功能:重写了父类的该方法,通过判断通过getNotes方法获取到的元数据内容是否为null,返回表示是否值得保存的布尔值,用于确定当前元数据对象是否有需要保存的数据内容。 +setContentByRemoteJSON方法 +所属类:MetaData +功能:首先调用父类的setContentByRemoteJSON方法,然后在确保获取到的元数据内容不为null的情况下,尝试将其转换为JSONObject并从中获取关联 GTask 的标识(mRelatedGid),若获取过程出现JSONException则记录警告日志并将mRelatedGid设为null,用于根据远程传来的 JSON 数据设置元数据内容并解析出关联的 GTask 标识。 +setContentByLocalJSON方法 +所属类:MetaData +功能:明确抛出IllegalAccessError异常,表示该方法不应被调用,用于限制该方法在当前类中的使用情况,体现特定业务逻辑下对本地 JSON 设置元数据内容操作的禁止。 +getLocalJSONFromContent方法 +所属类:MetaData +功能:抛出IllegalAccessError异常,表明该方法不应被调用,用于阻止在当前类中执行从内容获取本地 JSON 的操作,同样是基于特定业务逻辑对该功能的限制。 +getSyncAction方法 +所属类:MetaData +功能:抛出IllegalAccessError异常,意味着该方法不应被调用,用于限定在该类中不能进行获取同步操作相关的调用,体现对元数据在同步操作方面的特定处理规则。 + */ + +package net.micode.notes.gtask.data; + +import android.database.Cursor; +import android.util.Log; + +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONException; +import org.json.JSONObject; + + +public class MetaData extends Task { + private final static String TAG = MetaData.class.getSimpleName(); + + private String mRelatedGid = null; + + 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); + } + + public String getRelatedGid() { + return mRelatedGid; + } + + @Override + public boolean isWorthSaving() { + return getNotes() != null; + } + + @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; + } + } + } + + @Override + public void setContentByLocalJSON(JSONObject js) { + // this function should not be called + throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + } + + @Override + public JSONObject getLocalJSONFromContent() { + throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + } + + @Override + public int getSyncAction(Cursor c) { + throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + } + +} diff --git a/src/java/net/micode/notes/gtask/data/Node.java b/src/java/net/micode/notes/gtask/data/Node.java new file mode 100644 index 0000000..986bfd5 --- /dev/null +++ b/src/java/net/micode/notes/gtask/data/Node.java @@ -0,0 +1,102 @@ +/* + * 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. + * 这段 Java 代码定义了抽象类Node,它为后续相关具体数据类构建了一个基础框架,规定了一系列与数据同步操作以及数据内容设置、获取相关的抽象方法,同时定义了表示不同同步动作类型的常量。这些常量涵盖了从无操作、远程或本地添加、删除、更新,到更新冲突以及出现错误等多种同步情况,类中的属性则记录了如唯一标识(mGid)、名称(mName)、最后修改时间(mLastModified)和删除状态(mDeleted)等基础数据信息,整体为处理具有同步需求的数据对象提供了统一的结构和行为规范。 + */ + +package net.micode.notes.gtask.data; + +import android.database.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; + + private boolean mDeleted; + + 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); + + public void setGid(String gid) { + this.mGid = gid; + } + + 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; + } + + public long getLastModified() { + return this.mLastModified; + } + + public boolean getDeleted() { + return this.mDeleted; + } + +} diff --git a/src/java/net/micode/notes/gtask/data/SqlData.java b/src/java/net/micode/notes/gtask/data/SqlData.java new file mode 100644 index 0000000..1649b36 --- /dev/null +++ b/src/java/net/micode/notes/gtask/data/SqlData.java @@ -0,0 +1,242 @@ +/* + * 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. + * 这段 Java 代码定义了Task类,它继承自抽象类Node,是用于处理任务相关数据及操作的核心类,围绕任务在与 GTask 数据交互(如创建、更新动作对应的 JSON 构建,以及从 JSON 解析数据等)、同步操作判断、数据完整性判断(是否值得保存)以及各类属性设置与获取等方面构建功能逻辑。类中通过对抽象方法的实现,规范了任务数据在不同场景下的序列化与反序列化操作,同时结合自身属性(如完成状态、备注信息、关联的前置任务和父任务列表等),全方位地对任务对象进行管理与操作,在涉及任务数据的同步、展示与持久化存储等业务场景中起着关键作用。 +函数分析 +Task类构造函数 +所属类:Task +功能:调用父类构造函数进行初始化后,对自身特有的属性进行初始化,将完成状态设为false,备注信息设为null,前置任务设为null,父任务列表设为null,元数据信息设为null,为后续根据业务需求设置这些属性值准备初始状态。 +getCreateAction方法 +所属类:Task +功能:创建一个新的JSONObject对象,按照 GTask 相关的数据格式要求,向其中添加如动作类型(创建)、动作ID、任务在父任务列表中的索引、任务实体相关数据(名称、创建者ID、类型、备注等)、父任务ID、目标父任务类型、列表ID以及前置任务ID(若存在)等信息,若添加过程出现JSONException则记录错误日志、打印堆栈信息并抛出异常,最终返回构建好的用于创建任务的JSONObject,用于生成创建任务操作对应的 JSON 数据结构。 +getUpdateAction方法 +所属类:Task +功能:同样先创建一个JSONObject对象,然后依据 GTask 格式规范,向其中添加动作类型(更新)、动作ID、任务ID以及任务实体更新相关的数据(名称、备注、删除状态等),若出现JSONException则记录错误日志、打印堆栈信息并抛出异常,最后返回该JSONObject,用于构建任务更新操作对应的 JSON 数据内容。 +setContentByRemoteJSON方法 +所属类:Task +功能:在传入的JSONObject不为null的前提下,尝试从其中获取并设置任务的相关属性信息,包括ID、最后修改时间、名称、备注、删除状态以及完成状态等,若获取过程出现JSONException则记录错误日志、打印堆栈信息并抛出异常,用于根据远程传来的 JSON 数据更新任务对象的属性内容。 +setContentByLocalJSON方法 +所属类:Task +功能:先对传入的JSONObject进行有效性判断,若不符合要求则记录警告日志,若符合则尝试从中解析出笔记相关信息,进一步判断笔记类型是否合法,然后遍历数据数组,找到类型为普通笔记的数据项,将其内容设置为任务的名称,用于依据本地 JSON 数据设置任务的名称等相关属性。 +getLocalJSONFromContent方法 +所属类:Task +功能:根据元数据信息(mMetaInfo)是否为null分情况处理,若为null且任务名称也为null则记录警告日志并返回null,否则构建一个新的JSONObject,按照特定格式填充任务相关数据(如笔记内容、类型等)并返回;若mMetaInfo不为null,则从其中获取并更新对应的数据(如将任务名称更新到相关数据项中),最后返回处理后的JSONObject,用于生成基于任务当前内容的本地 JSON 数据表示形式。 +setMetaInfo方法 +所属类:Task +功能:在传入的MetaData对象不为null且其备注信息不为null的情况下,尝试将备注信息转换为JSONObject并赋值给mMetaInfo属性,若转换出现JSONException则记录警告日志并将mMetaInfo设为null,用于设置任务的元数据信息,方便后续基于元数据进行相关操作与判断。 +getSyncAction方法 +所属类:Task +功能:通过一系列复杂的条件判断来确定任务的同步操作类型,首先尝试获取元数据中的笔记相关信息,基于其是否存在以及笔记ID等信息与游标数据的对比,结合本地是否有更新、同步ID与最后修改时间是否匹配、GTask ID是否一致等多方面因素,按照不同情况返回对应的同步操作类型常量(如无操作、本地更新、远程更新、更新冲突、出现错误等),若过程中出现异常则记录错误日志并打印堆栈信息,用于判断任务在数据同步过程中的操作类型。 +isWorthSaving方法 +所属类:Task +功能:通过判断元数据信息是否为null,以及任务名称和备注信息去除空白字符后长度是否大于0等条件,返回表示任务是否值得保存的布尔值,用于确定任务对象当前的数据状态是否有保存的必要。 +setCompleted方法 +所属类:Task +功能:接收一个布尔型参数completed,将其赋值给mCompleted属性,用于设置任务的完成状态,满足业务场景中对任务完成与否的标记需求。 +setNotes方法 +所属类:Task +功能:传入一个字符串参数notes,将其赋值给mNotes属性,用于更新任务的备注信息,方便在不同阶段修改任务的相关说明内容。 +setPriorSibling方法 +所属类:Task +功能:接受一个Task类型的参数priorSibling,将其赋值给mPriorSibling属性,用于设置任务的前置任务,构建任务之间的先后顺序关联关系。 +setParent方法 +所属类:Task +功能:接收一个TaskList类型的参数parent,将其赋值给mParent属性,用于设置任务所属的父任务列表,确立任务在任务层级结构中的归属关系。 +getCompleted方法 +所属类:Task +功能:返回mCompleted属性的值,也就是任务的完成状态,用于获取任务是否已完成的相关信息,便于展示、筛选等业务操作。 +getNotes方法 +所属类:Task +功能:返回mNotes属性的值,即任务的备注信息,用于获取任务的相关说明内容,在查看、编辑任务详情等场景下会用到。 +getPriorSibling方法 +所属类:Task +功能:返回mPriorSibling属性的值,也就是任务的前置任务对象,方便在处理任务顺序、依赖关系等业务逻辑中获取前置任务相关信息。 +getParent方法 +所属类:Task +功能:返回mParent属性的值,即任务所属的父任务列表对象,用于获取任务在任务层级结构中的上层归属信息,有助于进行任务分组、层级展示等操作。 + */ + +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(); + + private static final int INVALID_ID = -99999; + + public static final String[] PROJECTION_DATA = new String[] { + DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, + DataColumns.DATA3 + }; + + 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; + + private long mDataId; + + private String mDataMimeType; + + private String mDataContent; + + private long mDataContentData1; + + private String mDataContentData3; + + private ContentValues mDiffDataValues; + + public SqlData(Context context) { + mContentResolver = context.getContentResolver(); + mIsCreate = true; + mDataId = INVALID_ID; + mDataMimeType = DataConstants.NOTE; + mDataContent = ""; + mDataContentData1 = 0; + mDataContentData3 = ""; + mDiffDataValues = new ContentValues(); + } + + public SqlData(Context context, Cursor c) { + mContentResolver = context.getContentResolver(); + mIsCreate = false; + loadFromCursor(c); + mDiffDataValues = new ContentValues(); + } + + 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); + } + + public void setContent(JSONObject js) throws JSONException { + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_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; + 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; + if (mIsCreate || mDataContentData1 != dataContentData1) { + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); + } + mDataContentData1 = dataContentData1; + + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; + if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); + } + mDataContentData3 = dataContentData3; + } + + 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; + } + + 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); + 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 { + 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/java/net/micode/notes/gtask/data/SqlNote.java b/src/java/net/micode/notes/gtask/data/SqlNote.java new file mode 100644 index 0000000..79a4095 --- /dev/null +++ b/src/java/net/micode/notes/gtask/data/SqlNote.java @@ -0,0 +1,505 @@ +/* + * 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; + + +public class SqlNote { + private static final String TAG = SqlNote.class.getSimpleName(); + + private static final int INVALID_ID = -99999; + + 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 + }; + + 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; + + 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