DataUtils部分注释

Notes-master/src/net/micode/notes/tool/DataUtils.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
+//与backup部分库类似，不再赘述
 package net.micode.notes.tool;
 
 import android.content.ContentProviderOperation;
@@ -38,83 +38,122 @@ import java.util.HashSet;
 public class DataUtils {
     public static final String TAG = "DataUtils";
     public static boolean batchDeleteNotes(ContentResolver resolver, HashSet<Long> ids) {
+        // 检查提供的ID集合是否为null
         if (ids == null) {
             Log.d(TAG, "the ids is null");
             return true;
         }
+        // 检查ID集合是否为空
         if (ids.size() == 0) {
             Log.d(TAG, "no id is in the hashset");
             return true;
         }
+        // TODO: 实现根据提供的ids批量删除笔记的逻辑
+        return false;
+    }
+}
 
+       public boolean deleteNotes(long[] ids) {
+    // 创建一个内容提供者操作的列表，用于存储删除操作
     ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
+    
+    // 遍历所有给定的ID
     for (long id : ids) {
+        // 检查ID是否为系统根文件夹ID，如果是则跳过删除操作
         if(id == Notes.ID_ROOT_FOLDER) {
             Log.e(TAG, "Don't delete system folder root");
             continue;
         }
+        // 为每个非系统根文件夹ID构建一个删除操作，并添加到操作列表中
         ContentProviderOperation.Builder builder = ContentProviderOperation
                 .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id));
         operationList.add(builder.build());
     }
+    
     try {
+        // 执行内容提供者操作列表中的所有操作
         ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);
+        
+        // 检查删除操作的结果，如果没有成功删除任何笔记，则返回false
         if (results == null || results.length == 0 || results[0] == null) {
             Log.d(TAG, "delete notes failed, ids:" + ids.toString());
             return false;
         }
+        // 所有删除操作执行成功，返回true
         return true;
     } catch (RemoteException e) {
+        // 处理执行删除操作时可能出现的远程异常
         Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
     } catch (OperationApplicationException e) {
+        // 处理执行删除操作时可能出现的操作应用异常
         Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
     }
+    // 如果有任何异常发生，则返回false
     return false;
-    }
+}
 
-    public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) {
+    /**
+ * 将指定的笔记移动到新的文件夹中。
+ * 
+ * @param resolver 内容解析器，用于执行数据库操作。
+ * @param id 笔记的ID，表示要移动的笔记。
+ * @param srcFolderId 源文件夹ID，表示当前笔记所在的文件夹。
+ * @param desFolderId 目标文件夹ID，表示要将笔记移动到的新文件夹。
+ */
+public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) {
     ContentValues values = new ContentValues();
-        values.put(NoteColumns.PARENT_ID, desFolderId);
+    values.put(NoteColumns.PARENT_ID, desFolderId); // 设置新的父文件夹ID
-        values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId);
+    values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId); // 记录原始父文件夹ID
-        values.put(NoteColumns.LOCAL_MODIFIED, 1);
+    values.put(NoteColumns.LOCAL_MODIFIED, 1); // 标记笔记已本地修改
-        resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null);
+    resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null); // 执行更新操作
-    }
+}
 
-    public static boolean batchMoveToFolder(ContentResolver resolver, HashSet<Long> ids,
+/**
+ * 批量将笔记移动到指定的文件夹中。
+ * 
+ * @param resolver 内容解析器，用于执行数据库操作。
+ * @param ids 需要移动的笔记ID集合。
+ * @param folderId 目标文件夹ID，表示要将笔记移动到的新文件夹。
+ * @return 如果移动操作成功执行，则返回true；否则返回false。
+ */
+public static boolean batchMoveToFolder(ContentResolver resolver, HashSet<Long> ids,
         long folderId) {
     if (ids == null) {
         Log.d(TAG, "the ids is null");
-            return true;
+        return true; // 如果ID集为空，视为操作成功
     }
 
+    // 准备批量操作
     ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
     for (long id : ids) {
         ContentProviderOperation.Builder builder = ContentProviderOperation
                 .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id));
-            builder.withValue(NoteColumns.PARENT_ID, folderId);
+        builder.withValue(NoteColumns.PARENT_ID, folderId); // 设置新的父文件夹ID
-            builder.withValue(NoteColumns.LOCAL_MODIFIED, 1);
+        builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); // 标记笔记已本地修改
         operationList.add(builder.build());
     }
 
     try {
         ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);
+        // 检查操作结果
         if (results == null || results.length == 0 || results[0] == null) {
             Log.d(TAG, "delete notes failed, ids:" + ids.toString());
-                return false;
+            return false; // 如果没有成功的结果，返回false
         }
-            return true;
+        return true; // 批量操作成功
     } catch (RemoteException e) {
         Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
     } catch (OperationApplicationException e) {
         Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
     }
-        return false;
+    return false; // 捕获异常，返回失败
-    }
+}
 
     /**
      * Get the all folder count except system folders {@link Notes#TYPE_SYSTEM}}
      */
     public static int getUserFolderCount(ContentResolver resolver) {
+        // 查询数据库中类型为文件夹且父ID不为回收站ID的笔记数量
         Cursor cursor =resolver.query(Notes.CONTENT_NOTE_URI,
                 new String[] { "COUNT(*)" },
                 NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?",
@@ -123,20 +162,24 @@ public class DataUtils {
 
         int count = 0;
         if(cursor != null) {
+            // 如果查询结果不为空，则尝试获取计数结果
             if(cursor.moveToFirst()) {
                 try {
-                    count = cursor.getInt(0);
+                    count = cursor.getInt(0); // 获取查询结果中的计数
                 } catch (IndexOutOfBoundsException e) {
+                    // 处理可能的索引越界异常
                     Log.e(TAG, "get folder count failed:" + e.toString());
                 } finally {
+                    // 无论是否成功，最后都关闭Cursor
                     cursor.close();
                 }
             }
         }
-        return count;
+        return count; // 返回文件夹数量
     }
 
     public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) {
+        // 根据noteId和类型查询数据库，排除父ID为垃圾文件夹的情况
         Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
                 null,
                 NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER,
@@ -145,59 +188,70 @@ public class DataUtils {
 
         boolean exist = false;
         if (cursor != null) {
+            // 检查查询结果是否有记录
             if (cursor.getCount() > 0) {
                 exist = true;
             }
+            // 关闭Cursor
             cursor.close();
         }
         return exist;
     }
-
     public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) {
+    // 使用ContentUris和noteId构建查询URI，并执行查询
     Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
             null, null, null, null);
 
     boolean exist = false;
     if (cursor != null) {
+        // 如果查询结果不为空，检查是否有记录匹配
         if (cursor.getCount() > 0) {
             exist = true;
         }
+        // 关闭Cursor
         cursor.close();
     }
     return exist;
-    }
+}
 
    public static boolean existInDataDatabase(ContentResolver resolver, long dataId) {
+    // 使用ContentUris和dataId构建查询URI，并执行查询
     Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId),
             null, null, null, null);
 
     boolean exist = false;
     if (cursor != null) {
+        // 如果查询结果不为空，检查是否有记录匹配
         if (cursor.getCount() > 0) {
             exist = true;
         }
+        // 关闭Cursor
         cursor.close();
     }
     return exist;
-    }
+}
 
     public static boolean checkVisibleFolderName(ContentResolver resolver, String name) {
+    // 构建查询条件，查询类型为文件夹且非回收站中的记录，并执行查询
     Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null,
             NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER +
             " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER +
             " AND " + NoteColumns.SNIPPET + "=?",
             new String[] { name }, null);
+    
     boolean exist = false;
     if(cursor != null) {
+        // 如果查询结果不为空，检查是否有记录匹配
         if(cursor.getCount() > 0) {
             exist = true;
         }
+        // 关闭Cursor
         cursor.close();
     }
     return exist;
-    }
+}
-
     public static HashSet<AppWidgetAttribute> getFolderNoteWidget(ContentResolver resolver, long folderId) {
+    // 根据指定的文件夹ID查询笔记小部件的ID和类型
     Cursor c = resolver.query(Notes.CONTENT_NOTE_URI,
             new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE },
             NoteColumns.PARENT_ID + "=?",
@@ -206,25 +260,27 @@ public class DataUtils {
 
     HashSet<AppWidgetAttribute> set = null;
     if (c != null) {
+        // 如果查询结果不为空，则遍历结果并填充集合
         if (c.moveToFirst()) {
             set = new HashSet<AppWidgetAttribute>();
             do {
                 try {
                     AppWidgetAttribute widget = new AppWidgetAttribute();
-                        widget.widgetId = c.getInt(0);
+                    widget.widgetId = c.getInt(0); // 获取小部件ID
-                        widget.widgetType = c.getInt(1);
+                    widget.widgetType = c.getInt(1); // 获取小部件类型
                     set.add(widget);
                 } catch (IndexOutOfBoundsException e) {
                     Log.e(TAG, e.toString());
                 }
             } while (c.moveToNext());
         }
-            c.close();
+        c.close(); // 关闭游标
     }
     return set;
-    }
+}
 
    public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) {
+    // 根据笔记ID和MIME类型查询关联的电话号码
     Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,
             new String [] { CallNote.PHONE_NUMBER },
             CallNote.NOTE_ID + "=? AND " + CallNote.MIME_TYPE + "=?",
@@ -233,17 +289,17 @@ public class DataUtils {
 
     if (cursor != null && cursor.moveToFirst()) {
         try {
-                return cursor.getString(0);
+            return cursor.getString(0); // 获取电话号码
         } catch (IndexOutOfBoundsException e) {
             Log.e(TAG, "Get call number fails " + e.toString());
         } finally {
-                cursor.close();
+            cursor.close(); // 关闭游标
         }
     }
-        return "";
+    return ""; // 如果未查询到电话号码，则返回空字符串
-    }
+}
-
     public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) {
+    // 构造查询语句，查询特定电话号码、通话日期和MIME类型的注释ID
     Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,
             new String [] { CallNote.NOTE_ID },
             CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL("
@@ -254,17 +310,23 @@ public class DataUtils {
     if (cursor != null) {
         if (cursor.moveToFirst()) {
             try {
+                // 如果查询结果存在，返回第一行的注释ID
                 return cursor.getLong(0);
             } catch (IndexOutOfBoundsException e) {
+                // 处理索引越界异常
                 Log.e(TAG, "Get call note id fails " + e.toString());
             }
         }
+        // 关闭游标
         cursor.close();
     }
+    // 如果查询无结果，返回0
     return 0;
-    }
+}
+
 
     public static String getSnippetById(ContentResolver resolver, long noteId) {
+    // 构造查询语句，查询特定ID的注释的摘要
     Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI,
             new String [] { NoteColumns.SNIPPET },
             NoteColumns.ID + "=?",
@@ -274,22 +336,28 @@ public class DataUtils {
     if (cursor != null) {
         String snippet = "";
         if (cursor.moveToFirst()) {
+            // 如果查询结果存在，获取摘要
             snippet = cursor.getString(0);
         }
+        // 关闭游标
         cursor.close();
         return snippet;
     }
+    // 如果查询无结果，抛出异常
     throw new IllegalArgumentException("Note is not found with id: " + noteId);
-    }
+}
+
+
 
    public static String getFormattedSnippet(String snippet) {
     if (snippet != null) {
+        // 删除首尾空格
         snippet = snippet.trim();
+        // 如果摘要中包含换行符，截取至第一个换行符前
         int index = snippet.indexOf('\n');
         if (index != -1) {
             snippet = snippet.substring(0, index);
         }
     }
     return snippet;
-    }
 }