DataUtils部分注释

xdx_branch
dingxuXie 1 year ago
parent 87a684cf13
commit 21c15bc24c

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