便签数据模型类注释

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

@@ -15,6 +15,7 @@
  */
 
 package net.micode.notes.model;
+
 import android.content.ContentProviderOperation;
 import android.content.ContentProviderResult;
 import android.content.ContentUris;
@@ -33,16 +34,23 @@ import net.micode.notes.data.Notes.TextNote;
 
 import java.util.ArrayList;
 
-
+/**
+ * 便签数据模型类，负责便签的创建、更新和管理
+ * 封装了便签及其关联数据（文本内容、通话记录等）的操作逻辑
+ */
 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
+        // 在数据库中创建新便签
         ContentValues values = new ContentValues();
         long createdTime = System.currentTimeMillis();
         values.put(NoteColumns.CREATED_DATE, createdTime);
@@ -65,41 +73,81 @@ public class Note {
         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) {
         if (noteId <= 0) {
             throw new IllegalArgumentException("Wrong note id:" + noteId);
@@ -110,15 +158,15 @@ public class Note {
         }
 
         /**
-         * In theory, once data changed, the note should be updated on {@link NoteColumns#LOCAL_MODIFIED} and
+         * 理论上，一旦数据发生变化，便签应该在{@link NoteColumns#LOCAL_MODIFIED}和
-         * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the
+         * {@link 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();
 
@@ -130,17 +178,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";
 
+        /**
+         * 构造函数，初始化便签数据对象
+         */
         public NoteData() {
             mTextDataValues = new ContentValues();
             mCallDataValues = new ContentValues();
@@ -148,10 +198,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 +217,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,21 +228,37 @@ 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);
@@ -189,9 +267,11 @@ public class Note {
             ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
             ContentProviderOperation.Builder builder = null;
 
+            // 处理文本数据
             if(mTextDataValues.size() > 0) {
                 mTextDataValues.put(DataColumns.NOTE_ID, noteId);
                 if (mTextDataId == 0) {
+                    // 插入新文本数据
                     mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE);
                     Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
                             mTextDataValues);
@@ -203,6 +283,7 @@ public class Note {
                         return null;
                     }
                 } else {
+                    // 更新现有文本数据
                     builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
                             Notes.CONTENT_DATA_URI, mTextDataId));
                     builder.withValues(mTextDataValues);
@@ -211,9 +292,11 @@ public class Note {
                 mTextDataValues.clear();
             }
 
+            // 处理通话记录数据
             if(mCallDataValues.size() > 0) {
                 mCallDataValues.put(DataColumns.NOTE_ID, noteId);
                 if (mCallDataId == 0) {
+                    // 插入新通话记录数据
                     mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE);
                     Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
                             mCallDataValues);
@@ -225,6 +308,7 @@ public class Note {
                         return null;
                     }
                 } else {
+                    // 更新现有通话记录数据
                     builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
                             Notes.CONTENT_DATA_URI, mCallDataId));
                     builder.withValues(mCallDataValues);
@@ -233,6 +317,7 @@ public class Note {
                 mCallDataValues.clear();
             }
 
+            // 批量执行ContentProvider操作
             if (operationList.size() > 0) {
                 try {
                     ContentProviderResult[] results = context.getContentResolver().applyBatch(
@@ -250,4 +335,4 @@ public class Note {
             return null;
         }
     }
-}
+}