model/Note.java

Notes-master/src/net/micode/notes/model/Note.java

@@ -33,16 +33,23 @@ import net.micode.notes.data.Notes.TextNote;
 
 import java.util.ArrayList;
 
-
+/**
+ * 笔记模型类，负责笔记数据的创建、管理和同步
+ * 提供了创建新笔记ID、设置笔记属性、设置文本内容、设置通话记录内容等功能
+ */
 public class Note {
-    private ContentValues mNoteDiffValues;
+    private ContentValues mNoteDiffValues; // 存储笔记属性的变更值
-    private NoteData mNoteData;
+    private NoteData mNoteData; // 存储笔记的文本内容和通话记录内容
     private static final String TAG = "Note";
+    
     /**
-     * Create a new note id for adding a new note to databases
+     * 静态方法，用于创建新的笔记ID并添加到数据库
+     * @param context 上下文对象
+     * @param folderId 父文件夹ID
+     * @return 新创建的笔记ID
      */
     public static synchronized long getNewNoteId(Context context, long folderId) {
-        // Create a new note in the database
+        // 创建一个新笔记并设置初始属性：创建时间、修改时间、类型、本地修改标记和父文件夹ID
         ContentValues values = new ContentValues();
         long createdTime = System.currentTimeMillis();
         values.put(NoteColumns.CREATED_DATE, createdTime);
@@ -52,6 +59,7 @@ public class Note {
         values.put(NoteColumns.PARENT_ID, folderId);
         Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values);
 
+        // 从返回的URI中解析出笔记ID
         long noteId = 0;
         try {
             noteId = Long.valueOf(uri.getPathSegments().get(1));
@@ -59,69 +67,114 @@ public class Note {
             Log.e(TAG, "Get note id error :" + e.toString());
             noteId = 0;
         }
+        // 验证笔记ID的有效性
         if (noteId == -1) {
             throw new IllegalStateException("Wrong note id:" + noteId);
         }
         return noteId;
     }
 
+    /**
+     * 构造函数，初始化笔记属性变更值和笔记数据
+     */
     public Note() {
         mNoteDiffValues = new ContentValues();
         mNoteData = new NoteData();
     }
 
+    /**
+     * 设置笔记的属性值
+     * @param key 属性名
+     * @param value 属性值
+     */
     public void setNoteValue(String key, String value) {
         mNoteDiffValues.put(key, value);
+        // 设置本地修改标记和修改时间
         mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
         mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
     }
 
+    /**
+     * 设置笔记的文本内容属性
+     * @param key 属性名
+     * @param value 属性值
+     */
     public void setTextData(String key, String value) {
         mNoteData.setTextData(key, value);
     }
 
+    /**
+     * 设置笔记的文本内容ID
+     * @param id 文本内容ID
+     */
     public void setTextDataId(long id) {
         mNoteData.setTextDataId(id);
     }
 
+    /**
+     * 获取笔记的文本内容ID
+     * @return 文本内容ID
+     */
     public long getTextDataId() {
         return mNoteData.mTextDataId;
     }
 
+    /**
+     * 设置笔记的通话记录内容ID
+     * @param id 通话记录内容ID
+     */
     public void setCallDataId(long id) {
         mNoteData.setCallDataId(id);
     }
 
+    /**
+     * 设置笔记的通话记录内容属性
+     * @param key 属性名
+     * @param value 属性值
+     */
     public void setCallData(String key, String value) {
         mNoteData.setCallData(key, value);
     }
 
+    /**
+     * 检查笔记是否有本地修改
+     * @return 如果有修改返回true，否则返回false
+     */
     public boolean isLocalModified() {
         return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified();
     }
 
+    /**
+     * 将笔记同步到内容提供者
+     * @param context 上下文对象
+     * @param noteId 笔记ID
+     * @return 同步成功返回true，失败返回false
+     */
     public boolean syncNote(Context context, long noteId) {
+        // 验证笔记ID的有效性
         if (noteId <= 0) {
             throw new IllegalArgumentException("Wrong note id:" + noteId);
         }
 
+        // 如果没有修改，直接返回成功
         if (!isLocalModified()) {
             return true;
         }
 
         /**
-         * In theory, once data changed, the note should be updated on {@link NoteColumns#LOCAL_MODIFIED} and
+         * 理论上，一旦数据发生变化，笔记应该在NoteColumns.LOCAL_MODIFIED和
-         * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the
+         * NoteColumns.MODIFIED_DATE上更新。为了数据安全，即使笔记更新失败，
-         * note data info
+         * 我们仍然更新笔记数据信息
          */
         if (context.getContentResolver().update(
                 ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null,
                 null) == 0) {
             Log.e(TAG, "Update note error, should not happen");
-            // Do not return, fall through
+            // 不返回，继续执行
         }
         mNoteDiffValues.clear();
 
+        // 同步笔记数据，如果失败则返回false
         if (mNoteData.isLocalModified()
                 && (mNoteData.pushIntoContentResolver(context, noteId) == null)) {
             return false;
@@ -130,17 +183,19 @@ public class Note {
         return true;
     }
 
+    /**
+     * 内部类，负责管理笔记的文本内容和通话记录内容
+     */
     private class NoteData {
-        private long mTextDataId;
+        private long mTextDataId; // 文本内容ID
-
+        private ContentValues mTextDataValues; // 文本内容属性值
-        private ContentValues mTextDataValues;
+        private long mCallDataId; // 通话记录内容ID
-
+        private ContentValues mCallDataValues; // 通话记录内容属性值
-        private long mCallDataId;
-
-        private ContentValues mCallDataValues;
-
         private static final String TAG = "NoteData";
 
+        /**
+         * 构造函数，初始化文本内容和通话记录内容的属性值和ID
+         */
         public NoteData() {
             mTextDataValues = new ContentValues();
             mCallDataValues = new ContentValues();
@@ -148,10 +203,18 @@ public class Note {
             mCallDataId = 0;
         }
 
+        /**
+         * 检查笔记数据是否有本地修改
+         * @return 如果有修改返回true，否则返回false
+         */
         boolean isLocalModified() {
             return mTextDataValues.size() > 0 || mCallDataValues.size() > 0;
         }
 
+        /**
+         * 设置文本内容ID
+         * @param id 文本内容ID
+         */
         void setTextDataId(long id) {
             if(id <= 0) {
                 throw new IllegalArgumentException("Text data id should larger than 0");
@@ -159,6 +222,10 @@ public class Note {
             mTextDataId = id;
         }
 
+        /**
+         * 设置通话记录内容ID
+         * @param id 通话记录内容ID
+         */
         void setCallDataId(long id) {
             if (id <= 0) {
                 throw new IllegalArgumentException("Call data id should larger than 0");
@@ -166,32 +233,53 @@ public class Note {
             mCallDataId = id;
         }
 
+        /**
+         * 设置通话记录内容属性
+         * @param key 属性名
+         * @param value 属性值
+         */
         void setCallData(String key, String value) {
             mCallDataValues.put(key, value);
+            // 更新外部类的本地修改标记和修改时间
             mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
             mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
         }
 
+        /**
+         * 设置文本内容属性
+         * @param key 属性名
+         * @param value 属性值
+         */
         void setTextData(String key, String value) {
             mTextDataValues.put(key, value);
+            // 更新外部类的本地修改标记和修改时间
             mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
             mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
         }
 
+        /**
+         * 将笔记数据推送到内容提供者
+         * @param context 上下文对象
+         * @param noteId 笔记ID
+         * @return 操作成功返回笔记URI，失败返回null
+         */
         Uri pushIntoContentResolver(Context context, long noteId) {
             /**
-             * Check for safety
+             * 安全检查
              */
             if (noteId <= 0) {
                 throw new IllegalArgumentException("Wrong note id:" + noteId);
             }
 
+            // 创建操作列表，用于批量操作
             ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
             ContentProviderOperation.Builder builder = null;
 
+            // 处理文本内容更新或插入
             if(mTextDataValues.size() > 0) {
                 mTextDataValues.put(DataColumns.NOTE_ID, noteId);
                 if (mTextDataId == 0) {
+                    // 如果没有文本内容ID，创建新的文本内容
                     mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE);
                     Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
                             mTextDataValues);
@@ -203,6 +291,7 @@ public class Note {
                         return null;
                     }
                 } else {
+                    // 如果已有文本内容ID，更新现有文本内容
                     builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
                             Notes.CONTENT_DATA_URI, mTextDataId));
                     builder.withValues(mTextDataValues);
@@ -211,9 +300,11 @@ public class Note {
                 mTextDataValues.clear();
             }
 
+            // 处理通话记录内容更新或插入
             if(mCallDataValues.size() > 0) {
                 mCallDataValues.put(DataColumns.NOTE_ID, noteId);
                 if (mCallDataId == 0) {
+                    // 如果没有通话记录内容ID，创建新的通话记录内容
                     mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE);
                     Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
                             mCallDataValues);
@@ -225,6 +316,7 @@ public class Note {
                         return null;
                     }
                 } else {
+                    // 如果已有通话记录内容ID，更新现有通话记录内容
                     builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
                             Notes.CONTENT_DATA_URI, mCallDataId));
                     builder.withValues(mCallDataValues);
@@ -233,6 +325,7 @@ public class Note {
                 mCallDataValues.clear();
             }
 
+            // 批量执行操作
             if (operationList.size() > 0) {
                 try {
                     ContentProviderResult[] results = context.getContentResolver().applyBatch(