Note.java注释

src/model/Note.java

@@ -33,27 +33,36 @@ import net.micode.notes.data.Notes.TextNote;
 
 import java.util.ArrayList;
 
-
+// Note类表示一个便签，包含便签的数据和与数据库交互的方法
 public class Note {
+    // 存储便签变化的ContentValues对象
     private ContentValues mNoteDiffValues;
+    // 存储便签数据的NoteData对象
     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对象，用于存储便签数据
         ContentValues values = new ContentValues();
         long createdTime = System.currentTimeMillis();
-        values.put(NoteColumns.CREATED_DATE, createdTime);
+        values.put(NoteColumns.CREATED_DATE, createdTime); // 创建时间
-        values.put(NoteColumns.MODIFIED_DATE, createdTime);
+        values.put(NoteColumns.MODIFIED_DATE, createdTime); // 修改时间
-        values.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
+        values.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 便签类型
-        values.put(NoteColumns.LOCAL_MODIFIED, 1);
+        values.put(NoteColumns.LOCAL_MODIFIED, 1); // 本地修改标志
-        values.put(NoteColumns.PARENT_ID, folderId);
+        values.put(NoteColumns.PARENT_ID, folderId); // 父ID，即文件夹ID
+        // 将新便签插入数据库
         Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values);
 
         long noteId = 0;
         try {
+            // 从URI中获取新创建的便签ID
             noteId = Long.valueOf(uri.getPathSegments().get(1));
         } catch (NumberFormatException e) {
             Log.e(TAG, "Get note id error :" + e.toString());
@@ -65,41 +74,50 @@ public class Note {
         return noteId;
     }
 
+    // Note类的构造函数
     public Note() {
         mNoteDiffValues = new ContentValues();
         mNoteData = new NoteData();
     }
 
+    // 设置便签的值
     public void setNoteValue(String key, String value) {
         mNoteDiffValues.put(key, value);
-        mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
+        mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); // 设置本地修改标志
-        mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
+        mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); // 设置修改时间
     }
 
+    // 设置文本数据
     public void setTextData(String key, String value) {
         mNoteData.setTextData(key, value);
     }
 
+    // 设置文本数据ID
     public void setTextDataId(long id) {
         mNoteData.setTextDataId(id);
     }
 
+    // 获取文本数据ID
     public long getTextDataId() {
         return mNoteData.mTextDataId;
     }
 
+    // 设置通话数据ID
     public void setCallDataId(long id) {
         mNoteData.setCallDataId(id);
     }
 
+    // 设置通话数据
     public void setCallData(String key, String value) {
         mNoteData.setCallData(key, value);
     }
 
+    // 检查便签是否本地修改过
     public boolean isLocalModified() {
         return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified();
     }
 
+    // 同步便签到数据库
     public boolean syncNote(Context context, long noteId) {
         if (noteId <= 0) {
             throw new IllegalArgumentException("Wrong note id:" + noteId);
@@ -110,15 +128,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,15 +148,12 @@ public class Note {
         return true;
     }
 
+    // NoteData内部类，存储便签的数据
     private class NoteData {
         private long mTextDataId;
-
         private ContentValues mTextDataValues;
-
         private long mCallDataId;
-
         private ContentValues mCallDataValues;
-
         private static final String TAG = "NoteData";
 
         public NoteData() {
@@ -148,10 +163,12 @@ public class Note {
             mCallDataId = 0;
         }
 
+        // 检查便签数据是否本地修改过
         boolean isLocalModified() {
             return mTextDataValues.size() > 0 || mCallDataValues.size() > 0;
         }
 
+        // 设置文本数据ID
         void setTextDataId(long id) {
             if(id <= 0) {
                 throw new IllegalArgumentException("Text data id should larger than 0");
@@ -159,6 +176,7 @@ public class Note {
             mTextDataId = id;
         }
 
+        // 设置通话数据ID
         void setCallDataId(long id) {
             if (id <= 0) {
                 throw new IllegalArgumentException("Call data id should larger than 0");
@@ -166,21 +184,24 @@ public class Note {
             mCallDataId = id;
         }
 
+        // 设置通话数据
         void setCallData(String key, String value) {
             mCallDataValues.put(key, value);
             mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
             mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
         }
 
+        // 设置文本数据
         void setTextData(String key, String value) {
             mTextDataValues.put(key, value);
             mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
             mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
         }
 
+        // 将便签数据推送到内容解析器
         Uri pushIntoContentResolver(Context context, long noteId) {
             /**
-             * Check for safety
+             * 安全检查
              */
             if (noteId <= 0) {
                 throw new IllegalArgumentException("Wrong note id:" + noteId);
@@ -221,33 +242,3 @@ public class Note {
                         setCallDataId(Long.valueOf(uri.getPathSegments().get(1)));
                     } catch (NumberFormatException e) {
                         Log.e(TAG, "Insert new call data fail with noteId" + noteId);
-                        mCallDataValues.clear();
-                        return null;
-                    }
-                } else {
-                    builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
-                            Notes.CONTENT_DATA_URI, mCallDataId));
-                    builder.withValues(mCallDataValues);
-                    operationList.add(builder.build());
-                }
-                mCallDataValues.clear();
-            }
-
-            if (operationList.size() > 0) {
-                try {
-                    ContentProviderResult[] results = context.getContentResolver().applyBatch(
-                            Notes.AUTHORITY, operationList);
-                    return (results == null || results.length == 0 || results[0] == null) ? null
-                            : ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId);
-                } catch (RemoteException e) {
-                    Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
-                    return null;
-                } catch (OperationApplicationException e) {
-                    Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
-                    return null;
-                }
-            }
-            return null;
-        }
-    }
-}