[file name]: DataUtils.java
[file content begin]
/*
 * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
 * 版权声明：2010-2011年，MiCode开源社区
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 基于Apache License 2.0许可证授权
 * you may not use this file except in compliance with the License.
 * 除非遵守许可证，否则不得使用此文件
 * You may obtain a copy of the License at
 * 可以在以下地址获取许可证副本
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * 除非适用法律要求或书面同意
 * distributed under the License is distributed on an "AS IS" BASIS,
 * 按"原样"分发软件
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * 没有任何明示或暗示的担保或条件
 * See the License for the specific language governing permissions and
 * 请参阅许可证了解具体语言权限
 * limitations under the License.
 * 和限制
 */

// 包声明：工具类包
package net.micode.notes.tool;

// 导入Android相关类
import android.content.ContentProviderOperation;        // 内容提供器操作类
import android.content.ContentProviderResult;          // 内容提供器结果类
import android.content.ContentResolver;                // 内容解析器类
import android.content.ContentUris;                    // 内容URI工具类
import android.content.ContentValues;                  // 内容值类
import android.content.OperationApplicationException;  // 操作应用异常类
import android.database.Cursor;                        // 数据库游标类
import android.os.RemoteException;                     // 远程异常类
import android.util.Log;                               // 日志工具类

// 导入应用内部类
import net.micode.notes.data.Notes;                    // 笔记数据类
import net.micode.notes.data.Notes.CallNote;           // 通话笔记类
import net.micode.notes.data.Notes.NoteColumns;        // 笔记列定义
import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; // 小部件属性类

// 导入Java集合类
import java.util.ArrayList;                            // 动态数组类
import java.util.HashSet;                              // 哈希集合类

// 数据库工具类，提供对笔记数据的各种操作
public class DataUtils {
    public static final String TAG = "DataUtils";      // 日志标签
    
    // 批量删除笔记的方法
    // 参数：resolver - 内容解析器，ids - 要删除的笔记ID集合
    // 返回值：boolean - 删除是否成功
    public static boolean batchDeleteNotes(ContentResolver resolver, HashSet<Long> ids) {
        if (ids == null) {                             // 如果ID集合为空
            Log.d(TAG, "the ids is null");             // 记录调试日志
            return true;                               // 返回成功（无需删除）
        }
        if (ids.size() == 0) {                         // 如果ID集合大小为0
            Log.d(TAG, "no id is in the hashset");     // 记录调试日志
            return true;                               // 返回成功（无需删除）
        }

        // 创建内容提供器操作列表
        ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
        for (long id : ids) {                          // 遍历ID集合
            if(id == Notes.ID_ROOT_FOLDER) {           // 如果是根文件夹ID
                Log.e(TAG, "Don't delete system folder root"); // 记录错误日志
                continue;                              // 跳过，不删除系统根文件夹
            }
            // 创建删除操作
            ContentProviderOperation.Builder builder = ContentProviderOperation
                    .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id));
            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 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;                                  // 返回失败
    }

    // 将笔记移动到其他文件夹的方法
    // 参数：resolver - 内容解析器，id - 笔记ID，srcFolderId - 源文件夹ID，desFolderId - 目标文件夹ID
    public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) {
        ContentValues values = new ContentValues();    // 创建内容值对象
        values.put(NoteColumns.PARENT_ID, desFolderId); // 设置父文件夹ID为目标文件夹ID
        values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId); // 设置原始父文件夹ID
        values.put(NoteColumns.LOCAL_MODIFIED, 1);     // 设置本地修改标志为1（已修改）
        // 更新笔记
        resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null);
    }

    // 批量移动笔记到指定文件夹的方法
    // 参数：resolver - 内容解析器，ids - 笔记ID集合，folderId - 目标文件夹ID
    // 返回值：boolean - 移动是否成功
    public static boolean batchMoveToFolder(ContentResolver resolver, HashSet<Long> ids,
            long folderId) {
        if (ids == null) {                             // 如果ID集合为空
            Log.d(TAG, "the ids is null");             // 记录调试日志
            return true;                               // 返回成功（无需移动）
        }

        // 创建内容提供器操作列表
        ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
        for (long id : ids) {                          // 遍历ID集合
            // 创建更新操作
            ContentProviderOperation.Builder builder = ContentProviderOperation
                    .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id));
            builder.withValue(NoteColumns.PARENT_ID, folderId); // 设置父文件夹ID
            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 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;                                  // 返回失败
    }

    /**
     * 获取用户文件夹数量（排除系统文件夹）
     * 参数：resolver - 内容解析器
     * 返回值：int - 用户文件夹数量
     */
    public static int getUserFolderCount(ContentResolver resolver) {
        // 查询用户文件夹数量
        Cursor cursor =resolver.query(Notes.CONTENT_NOTE_URI,
                new String[] { "COUNT(*)" },           // 查询计数
                NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?", // 查询条件
                new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER)}, // 参数
                null);                                 // 排序方式

        int count = 0;                                 // 初始化计数
        if(cursor != null) {                           // 如果游标不为空
            if(cursor.moveToFirst()) {                 // 如果游标移动到第一行
                try {
                    count = cursor.getInt(0);          // 获取计数值
                } catch (IndexOutOfBoundsException e) { // 捕获索引越界异常
                    Log.e(TAG, "get folder count failed:" + e.toString()); // 记录错误日志
                } finally {
                    cursor.close();                    // 关闭游标
                }
            }
        }
        return count;                                  // 返回计数
    }

    // 检查指定类型的笔记是否在数据库中可见（不在垃圾箱中）
    // 参数：resolver - 内容解析器，noteId - 笔记ID，type - 笔记类型
    // 返回值：boolean - 是否可见
    public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) {
        // 查询指定ID和类型的笔记
        Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
                null,                                   // 所有列
                NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER, // 条件
                new String [] {String.valueOf(type)},   // 参数
                null);                                  // 排序

        boolean exist = false;                          // 初始化存在标志
        if (cursor != null) {                           // 如果游标不为空
            if (cursor.getCount() > 0) {                // 如果结果数大于0
                exist = true;                           // 设置存在标志为true
            }
            cursor.close();                             // 关闭游标
        }
        return exist;                                   // 返回存在标志
    }

    // 检查笔记是否存在于笔记数据库中
    // 参数：resolver - 内容解析器，noteId - 笔记ID
    // 返回值：boolean - 是否存在
    public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) {
        // 查询指定ID的笔记
        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) {                // 如果结果数大于0
                exist = true;                           // 设置存在标志为true
            }
            cursor.close();                             // 关闭游标
        }
        return exist;                                   // 返回存在标志
    }

    // 检查数据是否存在于数据数据库中
    // 参数：resolver - 内容解析器，dataId - 数据ID
    // 返回值：boolean - 是否存在
    public static boolean existInDataDatabase(ContentResolver resolver, long dataId) {
        // 查询指定ID的数据
        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) {                // 如果结果数大于0
                exist = true;                           // 设置存在标志为true
            }
            cursor.close();                             // 关闭游标
        }
        return exist;                                   // 返回存在标志
    }

    // 检查可见文件夹名称是否已存在
    // 参数：resolver - 内容解析器，name - 文件夹名称
    // 返回值：boolean - 是否存在
    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) {                // 如果结果数大于0
                exist = true;                           // 设置存在标志为true
            }
            cursor.close();                             // 关闭游标
        }
        return exist;                                   // 返回存在标志
    }

    // 获取文件夹中的笔记小部件属性
    // 参数：resolver - 内容解析器，folderId - 文件夹ID
    // 返回值：HashSet<AppWidgetAttribute> - 小部件属性集合
    public static HashSet<AppWidgetAttribute> getFolderNoteWidget(ContentResolver resolver, long folderId) {
        // 查询文件夹中的笔记小部件信息
        Cursor c = resolver.query(Notes.CONTENT_NOTE_URI,
                new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, // 查询小部件ID和类型
                NoteColumns.PARENT_ID + "=?",          // 父文件夹ID条件
                new String[] { String.valueOf(folderId) }, // 参数
                null);                                  // 排序

        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); // 获取小部件ID
                        widget.widgetType = c.getInt(1); // 获取小部件类型
                        set.add(widget);               // 添加到集合
                    } catch (IndexOutOfBoundsException e) { // 捕获索引越界异常
                        Log.e(TAG, e.toString());      // 记录错误日志
                    }
                } while (c.moveToNext());              // 移动到下一行
            }
            c.close();                                 // 关闭游标
        }
        return set;                                    // 返回集合
    }

    // 根据笔记ID获取通话号码
    // 参数：resolver - 内容解析器，noteId - 笔记ID
    // 返回值：String - 电话号码，如果不存在返回空字符串
    public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) {
        // 查询通话笔记的电话号码
        Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,
                new String [] { CallNote.PHONE_NUMBER }, // 查询电话号码列
                CallNote.NOTE_ID + "=? AND " + CallNote.MIME_TYPE + "=?", // 条件
                new String [] { String.valueOf(noteId), CallNote.CONTENT_ITEM_TYPE }, // 参数
                null);                                  // 排序

        if (cursor != null && cursor.moveToFirst()) {  // 如果游标不为空且移动到第一行
            try {
                return cursor.getString(0);            // 返回电话号码
            } catch (IndexOutOfBoundsException e) {    // 捕获索引越界异常
                Log.e(TAG, "Get call number fails " + e.toString()); // 记录错误日志
            } finally {
                cursor.close();                        // 关闭游标
            }
        }
        return "";                                     // 返回空字符串
    }

    // 根据电话号码和通话日期获取笔记ID
    // 参数：resolver - 内容解析器，phoneNumber - 电话号码，callDate - 通话日期
    // 返回值：long - 笔记ID，如果不存在返回0
    public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) {
        // 查询通话笔记的笔记ID
        Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,
                new String [] { CallNote.NOTE_ID },    // 查询笔记ID列
                CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL("
                + CallNote.PHONE_NUMBER + ",?)",       // 条件（包含电话号码相等函数）
                new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber }, // 参数
                null);                                  // 排序

        if (cursor != null) {                           // 如果游标不为空
            if (cursor.moveToFirst()) {                 // 如果游标移动到第一行
                try {
                    return cursor.getLong(0);           // 返回笔记ID
                } catch (IndexOutOfBoundsException e) { // 捕获索引越界异常
                    Log.e(TAG, "Get call note id fails " + e.toString()); // 记录错误日志
                }
            }
            cursor.close();                             // 关闭游标
        }
        return 0;                                       // 返回0（表示不存在）
    }

    // 根据笔记ID获取内容摘要
    // 参数：resolver - 内容解析器，noteId - 笔记ID
    // 返回值：String - 内容摘要，如果不存在抛出异常
    public static String getSnippetById(ContentResolver resolver, long noteId) {
        // 查询笔记的内容摘要
        Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI,
                new String [] { NoteColumns.SNIPPET },  // 查询内容摘要列
                NoteColumns.ID + "=?",                  // 条件
                new String [] { String.valueOf(noteId)}, // 参数
                null);                                  // 排序

        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); // 抛出异常
    }

    // 格式化内容摘要（去除换行符和多余空格）
    // 参数：snippet - 原始内容摘要
    // 返回值：String - 格式化后的内容摘要
    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;                                 // 返回格式化后的内容摘要
    }
}
[file content end]