You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
xiaomi/DataUtils.java

398 lines
17 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* 遵循 Apache 许可证 2.0 版(“许可证”);
* 除非遵守许可证,否则不得使用此文件。
* 你可以在以下网址获取许可证副本:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 除非适用法律要求或书面同意,
* 根据许可证分发的软件按“原样”分发,
* 不附带任何明示或暗示的保证或条件。
* 请参阅许可证,了解具体的权限和限制。
*/
package net.micode.notes.tool;
import android.content.ContentProviderOperation;
import android.content.ContentProviderResult;
import android.content.ContentResolver;
import android.content.ContentUris;
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;
import java.util.ArrayList;
import java.util.HashSet;
// DataUtils 类提供了一系列与数据操作相关的实用方法,主要用于处理笔记数据在数据库中的操作,如删除、移动、查询等
public class DataUtils {
// 用于日志记录的标签,使用类的简单名称
public static final String TAG = "DataUtils";
// 批量删除笔记的方法,接收内容解析器和要删除的笔记 ID 集合作为参数
public static boolean batchDeleteNotes(ContentResolver resolver, HashSet<Long> ids) {
// 如果传入的 ID 集合为 null记录日志并返回 true表示无需删除操作
if (ids == null) {
Log.d(TAG, "the ids is null");
return true;
}
// 如果 ID 集合为空,记录日志并返回 true表示没有要删除的笔记
if (ids.size() == 0) {
Log.d(TAG, "no id is in the hashset");
return true;
}
// 创建一个用于存储内容提供者操作的列表
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;
}
// 创建一个用于删除指定笔记的内容提供者操作构建器
ContentProviderOperation.Builder builder = ContentProviderOperation
.newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id));
// 将构建好的操作添加到操作列表中
operationList.add(builder.build());
}
try {
// 执行批量操作,并获取操作结果
ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);
// 如果操作结果为空或第一个结果为 null表示删除失败记录日志并返回 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;
}
// 将指定笔记移动到目标文件夹的方法,接收内容解析器、笔记 ID、源文件夹 ID 和目标文件夹 ID 作为参数
public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) {
// 创建一个用于存储要更新的内容值的对象
ContentValues values = new ContentValues();
// 设置目标文件夹 ID
values.put(NoteColumns.PARENT_ID, desFolderId);
// 设置源文件夹 ID
values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId);
// 标记笔记在本地已修改
values.put(NoteColumns.LOCAL_MODIFIED, 1);
// 使用内容解析器更新指定笔记的信息
resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null);
}
// 批量将笔记移动到指定文件夹的方法,接收内容解析器、要移动的笔记 ID 集合和目标文件夹 ID 作为参数
public static boolean batchMoveToFolder(ContentResolver resolver, HashSet<Long> ids,
long folderId) {
// 如果传入的 ID 集合为 null记录日志并返回 true表示无需移动操作
if (ids == null) {
Log.d(TAG, "the ids is null");
return true;
}
// 创建一个用于存储内容提供者操作的列表
ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
// 遍历要移动的笔记 ID 集合
for (long id : ids) {
// 创建一个用于更新指定笔记的内容提供者操作构建器
ContentProviderOperation.Builder builder = ContentProviderOperation
.newUpdate(ContentU.withAppendedId(Notes.CONTENT_NOTE_URI, id));
// 设置目标文件夹 ID
builder.withValue(NoteColumns.PARENT_ID, folderId);
// 标记笔记在本地已修改
builder.withValue(NoteColumns.LOCAL_MODIFIED, 1);
// 将构建好的操作添加到操作列表中
operationList.add(builder.build());
}
try {
// 执行批量操作,并获取操作结果
ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);
// 如果操作结果为空或第一个结果为 null表示移动失败记录日志并返回 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;
}
/**
* 获取除系统文件夹({@link Notes#TYPE_SYSTEM}})之外的所有文件夹数量的方法
*/
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;
// 如果游标不为 null
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;
}
// 检查指定笔记是否在非回收站且指定类型的笔记数据库中可见的方法,接收内容解析器、笔记 ID 和类型作为参数
public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) {
// 查询数据库,检查是否存在符合条件的笔记
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;
// 如果游标不为 null
if (cursor!= null) {
// 如果查询结果数量大于 0表示笔记存在设置 exist 为 true
if (cursor.getCount() > 0) {
exist = true;
}
// 关闭游标
cursor.close();
}
// 返回检查结果
return exist;
}
// 检查指定笔记是否存在于笔记数据库中的方法,接收内容解析器和笔记 ID 作为参数
public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) {
// 查询数据库,检查是否存在指定笔记
Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
null, null, null, null);
boolean exist = false;
// 如果游标不为 null
if (cursor!= null) {
// 如果查询结果数量大于 0表示笔记存在设置 exist 为 true
if (cursor.getCount() > 0) {
exist = true;
}
// 关闭游标
cursor.close();
}
// 返回检查结果
return exist;
}
// 检查指定数据是否存在于数据数据库中的方法,接收内容解析器和数据 ID 作为参数
public static boolean existInDataDatabase(ContentResolver resolver, long dataId) {
// 查询数据库,检查是否存在指定数据
Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId),
null, null, null, null);
boolean exist = false;
// 如果游标不为 null
if (cursor!= null) {
// 如果查询结果数量大于 0表示数据存在设置 exist 为 true
if (cursor.getCount() > 0) {
exist = true;
}
// 关闭游标
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;
// 如果游标不为 null
if (cursor!= null) {
// 如果查询结果数量大于 0表示文件夹存在设置 exist 为 true
if (cursor.getCount() > 0) {
exist = true;
}
// 关闭游标
cursor.close();
}
// 返回检查结果
return exist;
}
// 获取指定文件夹中笔记的小部件属性集合的方法,接收内容解析器和文件夹 ID 作为参数
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 },
NoteColumns.PARENT_ID + "=?",
new String[] { String.valueOf(folderId) },
null);
HashSet<AppWidgetAttribute> set = null;
// 如果游标不为 null
if (c!= null) {
// 如果游标可以移动到第一条记录
if (c.moveToFirst()) {
// 创建一个用于存储小部件属性的集合
set = new HashSet<AppWidgetAttribute>();
do {
try {
// 创建一个小部件属性对象
AppWidgetAttribute widget = new AppWidgetAttribute();
// 设置小部件 ID
widget.widgetId = c.getInt(0);
// 设置小部件类型
widget.widgetType = c.getInt(1);
// 将小部件属性对象添加到集合中
set.add(widget);
} catch (IndexOutOfBoundsException e) {
// 捕获索引越界异常,记录错误日志
Log.e(TAG, e.toString());
}
} while (c.moveToNext());
}
// 关闭游标
c.close();
}
// 返回小部件属性集合
return set;
}
// 根据笔记 ID 获取通话号码的方法,接收内容解析器和笔记 ID 作为参数
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 的方法,接收内容解析器、通话号码和通话日期作为参数
public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) {
// 查询数据库,获取符合条件的笔记 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("
+ CallNote.PHONE_NUMBER + ",?)",
new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber },
null);
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();
}
// 如果未找到笔记 ID返回 0
return 0;
}
// 根据笔记 ID 获取片段信息的方法,接收内容解析器和笔记 ID 作为参数
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);
}
// 格式化片段信息的方法,接收片段信息字符串作为参数
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;
}
}