diff --git a/app/src/main/java/net/micode/notes/data/Notes.java b/app/src/main/java/net/micode/notes/data/Notes.java index f240604..13c6c88 100644 --- a/app/src/main/java/net/micode/notes/data/Notes.java +++ b/app/src/main/java/net/micode/notes/data/Notes.java @@ -17,263 +17,283 @@ package net.micode.notes.data; import android.net.Uri; + +/** + * Notes类定义了便签应用的数据结构和常量 + * 包含便签类型、系统文件夹ID、内容提供者URI以及数据表结构定义 + */ public class Notes { + // 内容提供者的权限标识 public static final String AUTHORITY = "micode_notes"; + // 日志标签 public static final String TAG = "Notes"; - public static final int TYPE_NOTE = 0; - public static final int TYPE_FOLDER = 1; - public static final int TYPE_SYSTEM = 2; + + // 便签类型常量 + public static final int TYPE_NOTE = 0; // 普通便签 + public static final int TYPE_FOLDER = 1; // 文件夹 + public static final int TYPE_SYSTEM = 2; // 系统便签 /** - * Following IDs are system folders' identifiers - * {@link Notes#ID_ROOT_FOLDER } is default folder - * {@link Notes#ID_TEMPARAY_FOLDER } is for notes belonging no folder - * {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records + * 系统文件夹ID常量 + * {@link Notes#ID_ROOT_FOLDER } 是默认文件夹 + * {@link Notes#ID_TEMPARAY_FOLDER } 用于存放未分类便签 + * {@link Notes#ID_CALL_RECORD_FOLDER} 用于存储通话记录 */ - public static final int ID_ROOT_FOLDER = 0; - public static final int ID_TEMPARAY_FOLDER = -1; - public static final int ID_CALL_RECORD_FOLDER = -2; - public static final int ID_TRASH_FOLER = -3; - - public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; - public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; - public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; - public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; - public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; - public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; - - public static final int TYPE_WIDGET_INVALIDE = -1; - public static final int TYPE_WIDGET_2X = 0; - public static final int TYPE_WIDGET_4X = 1; + public static final int ID_ROOT_FOLDER = 0; // 根文件夹ID + public static final int ID_TEMPARAY_FOLDER = -1; // 临时文件夹ID + public static final int ID_CALL_RECORD_FOLDER = -2; // 通话记录文件夹ID + public static final int ID_TRASH_FOLER = -3; // 回收站文件夹ID + + // Intent传递的额外数据键名 + public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; // 提醒日期 + public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; // 背景颜色ID + public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; // 桌面小部件ID + public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; // 桌面小部件类型 + public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; // 文件夹ID + public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; // 通话日期 + + // 桌面小部件类型常量 + public static final int TYPE_WIDGET_INVALIDE = -1; // 无效小部件 + public static final int TYPE_WIDGET_2X = 0; // 2x大小的小部件 + public static final int TYPE_WIDGET_4X = 1; // 4x大小的小部件 + /** + * 数据常量类 + * 定义不同类型便签的MIME类型 + */ public static class DataConstants { - public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; - public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; + public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; // 文本便签MIME类型 + public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; // 通话记录便签MIME类型 } /** - * Uri to query all notes and folders + * 查询所有便签和文件夹的URI */ public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note"); /** - * Uri to query data + * 查询便签数据的URI */ public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data"); + /** + * 便签表的列定义接口 + * 定义了便签表的所有字段名称和含义 + */ public interface NoteColumns { /** - * The unique ID for a row - *
Type: INTEGER (long)
+ * 行的唯一ID + *类型: INTEGER (long)
*/ public static final String ID = "_id"; /** - * The parent's id for note or folder - *Type: INTEGER (long)
+ * 便签或文件夹的父级ID + *类型: INTEGER (long)
*/ public static final String PARENT_ID = "parent_id"; /** - * Created data for note or folder - *Type: INTEGER (long)
+ * 便签或文件夹的创建日期 + *类型: INTEGER (long)
*/ public static final String CREATED_DATE = "created_date"; /** - * Latest modified date - *Type: INTEGER (long)
+ * 最后修改日期 + *类型: INTEGER (long)
*/ public static final String MODIFIED_DATE = "modified_date"; - /** - * Alert date - *Type: INTEGER (long)
+ * 提醒日期 + *类型: INTEGER (long)
*/ public static final String ALERTED_DATE = "alert_date"; /** - * Folder's name or text content of note - *Type: TEXT
+ * 文件夹名称或便签的摘要内容 + *类型: TEXT
*/ public static final String SNIPPET = "snippet"; /** - * Note's widget id - *Type: INTEGER (long)
+ * 便签关联的桌面小部件ID + *类型: INTEGER (long)
*/ public static final String WIDGET_ID = "widget_id"; /** - * Note's widget type - *Type: INTEGER (long)
+ * 便签关联的桌面小部件类型 + *类型: INTEGER (long)
*/ public static final String WIDGET_TYPE = "widget_type"; /** - * Note's background color's id - *Type: INTEGER (long)
+ * 便签的背景颜色ID + *类型: 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
+ * 标识便签是否有附件 + * 文本便签没有附件,多媒体便签至少有一个附件 + *类型: INTEGER
*/ public static final String HAS_ATTACHMENT = "has_attachment"; /** - * Folder's count of notes - *Type: INTEGER (long)
+ * 文件夹包含的便签数量 + *类型: INTEGER (long)
*/ public static final String NOTES_COUNT = "notes_count"; /** - * The file type: folder or note - *Type: INTEGER
+ * 文件类型:文件夹或便签 + *类型: INTEGER
*/ public static final String TYPE = "type"; /** - * The last sync id - *Type: INTEGER (long)
+ * 最后同步ID + *类型: INTEGER (long)
*/ public static final String SYNC_ID = "sync_id"; /** - * Sign to indicate local modified or not - *Type: INTEGER
+ * 标识本地是否有修改 + *类型: INTEGER
*/ public static final String LOCAL_MODIFIED = "local_modified"; /** - * Original parent id before moving into temporary folder - *Type : INTEGER
+ * 移动到临时文件夹前的原始父级ID + *类型 : INTEGER
*/ public static final String ORIGIN_PARENT_ID = "origin_parent_id"; /** - * The gtask id - *Type : TEXT
+ * Google任务ID + *类型 : TEXT
*/ public static final String GTASK_ID = "gtask_id"; /** - * The version code - *Type : INTEGER (long)
+ * 版本代码 + *类型 : INTEGER (long)
*/ public static final String VERSION = "version"; } + /** + * 数据表的列定义接口 + * 定义了数据表的所有字段名称和含义 + */ public interface DataColumns { /** - * The unique ID for a row - *Type: INTEGER (long)
+ * 行的唯一ID + *类型: INTEGER (long)
*/ public static final String ID = "_id"; /** - * The MIME type of the item represented by this row. - *Type: Text
+ * 此行表示的数据项的MIME类型 + *类型: Text
*/ public static final String MIME_TYPE = "mime_type"; /** - * The reference id to note that this data belongs to - *Type: INTEGER (long)
+ * 此数据所属便签的引用ID + *类型: INTEGER (long)
*/ public static final String NOTE_ID = "note_id"; /** - * Created data for note or folder - *Type: INTEGER (long)
+ * 数据的创建日期 + *类型: INTEGER (long)
*/ public static final String CREATED_DATE = "created_date"; /** - * Latest modified date - *Type: INTEGER (long)
+ * 数据的最后修改日期 + *类型: INTEGER (long)
*/ public static final String MODIFIED_DATE = "modified_date"; /** - * Data's content - *Type: TEXT
+ * 数据内容 + *类型: TEXT
*/ public static final String CONTENT = "content"; - /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * integer data type - *Type: INTEGER
+ * 通用数据列,含义由{@link #MIMETYPE}指定,用于整数类型数据 + *类型: INTEGER
*/ public static final String DATA1 = "data1"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * integer data type - *Type: INTEGER
+ * 通用数据列,含义由{@link #MIMETYPE}指定,用于整数类型数据 + *类型: INTEGER
*/ public static final String DATA2 = "data2"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *Type: TEXT
+ * 通用数据列,含义由{@link #MIMETYPE}指定,用于文本类型数据 + *类型: TEXT
*/ public static final String DATA3 = "data3"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *Type: TEXT
+ * 通用数据列,含义由{@link #MIMETYPE}指定,用于文本类型数据 + *类型: TEXT
*/ public static final String DATA4 = "data4"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *Type: TEXT
+ * 通用数据列,含义由{@link #MIMETYPE}指定,用于文本类型数据 + *类型: TEXT
*/ public static final String DATA5 = "data5"; } + /** + * 文本便签类 + * 继承DataColumns接口,定义文本便签特有的字段和常量 + */ 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
+ * 标识文本是否处于复选列表模式 + *类型: Integer 1:复选列表模式 0:普通模式
*/ 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 int MODE_CHECK_LIST = 1; // 复选列表模式值 - public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note"); + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; // 文本便签集合的MIME类型 + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; // 单条文本便签的MIME类型 + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note"); // 文本便签的内容URI } + /** + * 通话记录便签类 + * 继承DataColumns接口,定义通话记录便签特有的字段和常量 + */ public static final class CallNote implements DataColumns { /** - * Call date for this record - *Type: INTEGER (long)
+ * 通话记录的日期 + *类型: INTEGER (long)
*/ public static final String CALL_DATE = DATA1; /** - * Phone number for this record - *Type: TEXT
+ * 通话记录的电话号码 + *类型: 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"); + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; // 通话记录集合的MIME类型 + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; // 单条通话记录的MIME类型 + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note"); // 通话记录的内容URI } -} +} \ No newline at end of file