diff --git a/src/net/micode/notes/tool/BackupUtils.java b/src/net/micode/notes/tool/BackupUtils.java index 39f6ec4..1b49494 100644 --- a/src/net/micode/notes/tool/BackupUtils.java +++ b/src/net/micode/notes/tool/BackupUtils.java @@ -35,12 +35,21 @@ import java.io.FileOutputStream; import java.io.IOException; import java.io.PrintStream; - +/** + * 该类主要负责笔记的备份操作，将笔记数据导出为文本文件。 + * 提供了单例模式获取实例，以及导出笔记到文本文件的功能。 + */ public class BackupUtils { private static final String TAG = "BackupUtils"; - // Singleton stuff + // 单例模式相关变量 private static BackupUtils sInstance; + /** + * 获取BackupUtils的单例实例。 + * + * @param context 上下文对象 + * @return BackupUtils的单例实例 + */ public static synchronized BackupUtils getInstance(Context context) { if (sInstance == null) { sInstance = new BackupUtils(context); @@ -49,43 +58,72 @@ public class BackupUtils { } /** - * Following states are signs to represents backup or restore - * status + * 以下状态码用于表示备份或恢复操作的状态。 */ - // Currently, the sdcard is not mounted + // 当前SD卡未挂载 public static final int STATE_SD_CARD_UNMOUONTED = 0; - // The backup file not exist + // 备份文件不存在 public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; - // The data is not well formated, may be changed by other programs + // 数据格式不正确，可能被其他程序修改 public static final int STATE_DATA_DESTROIED = 2; - // Some run-time exception which causes restore or backup fails + // 运行时异常导致备份或恢复失败 public static final int STATE_SYSTEM_ERROR = 3; - // Backup or restore success + // 备份或恢复成功 public static final int STATE_SUCCESS = 4; + // 文本导出工具实例 private TextExport mTextExport; + /** + * 构造函数，初始化文本导出工具。 + * + * @param context 上下文对象 + */ private BackupUtils(Context context) { mTextExport = new TextExport(context); } + /** + * 检查外部存储是否可用。 + * + * @return 如果外部存储已挂载返回true，否则返回false + */ private static boolean externalStorageAvailable() { return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); } + /** + * 将笔记导出为文本文件。 + * + * @return 导出操作的状态码 + */ public int exportToText() { return mTextExport.exportToText(); } + /** + * 获取导出的文本文件的文件名。 + * + * @return 导出的文本文件的文件名 + */ public String getExportedTextFileName() { return mTextExport.mFileName; } + /** + * 获取导出的文本文件的目录。 + * + * @return 导出的文本文件的目录 + */ public String getExportedTextFileDir() { return mTextExport.mFileDirectory; } + /** + * 内部类，负责将笔记导出为文本文件的具体操作。 + */ private static class TextExport { + // 笔记查询的投影列 private static final String[] NOTE_PROJECTION = { NoteColumns.ID, NoteColumns.MODIFIED_DATE, @@ -93,12 +131,14 @@ public class BackupUtils { NoteColumns.TYPE }; + // 笔记ID列的索引 private static final int NOTE_COLUMN_ID = 0; - + // 笔记修改日期列的索引 private static final int NOTE_COLUMN_MODIFIED_DATE = 1; - + // 笔记摘要列的索引 private static final int NOTE_COLUMN_SNIPPET = 2; + // 数据查询的投影列 private static final String[] DATA_PROJECTION = { DataColumns.CONTENT, DataColumns.MIME_TYPE, @@ -108,23 +148,36 @@ public class BackupUtils { DataColumns.DATA4, }; + // 数据内容列的索引 private static final int DATA_COLUMN_CONTENT = 0; - + // 数据MIME类型列的索引 private static final int DATA_COLUMN_MIME_TYPE = 1; - + // 数据通话日期列的索引 private static final int DATA_COLUMN_CALL_DATE = 2; - + // 数据电话号码列的索引 private static final int DATA_COLUMN_PHONE_NUMBER = 4; + // 文本格式数组 private final String [] TEXT_FORMAT; + // 文件夹名称的文本格式索引 private static final int FORMAT_FOLDER_NAME = 0; + // 笔记日期的文本格式索引 private static final int FORMAT_NOTE_DATE = 1; + // 笔记内容的文本格式索引 private static final int FORMAT_NOTE_CONTENT = 2; + // 上下文对象 private Context mContext; + // 导出文件的文件名 private String mFileName; + // 导出文件的目录 private String mFileDirectory; + /** + * 构造函数，初始化文本格式、上下文、文件名和目录。 + * + * @param context 上下文对象 + */ public TextExport(Context context) { TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); mContext = context; @@ -132,15 +185,24 @@ public class BackupUtils { mFileDirectory = ""; } + /** + * 获取指定索引的文本格式。 + * + * @param id 文本格式的索引 + * @return 指定索引的文本格式字符串 + */ private String getFormat(int id) { return TEXT_FORMAT[id]; } /** - * Export the folder identified by folder id to text + * 将指定文件夹下的笔记导出为文本。 + * + * @param folderId 文件夹ID + * @param ps 打印流，用于输出文本 */ private void exportFolderToText(String folderId, PrintStream ps) { - // Query notes belong to this folder + // 查询属于该文件夹的笔记 Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] { folderId @@ -149,11 +211,11 @@ public class BackupUtils { if (notesCursor != null) { if (notesCursor.moveToFirst()) { do { - // Print note's last modified date + // 打印笔记的最后修改日期 ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( mContext.getString(R.string.format_datetime_mdhm), notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); - // Query data belong to this note + // 查询属于该笔记的数据 String noteId = notesCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (notesCursor.moveToNext()); @@ -163,7 +225,10 @@ public class BackupUtils { } /** - * Export note identified by id to a print stream + * 将指定ID的笔记导出到打印流。 + * + * @param noteId 笔记ID + * @param ps 打印流，用于输出文本 */ private void exportNoteToText(String noteId, PrintStream ps) { Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, @@ -176,7 +241,7 @@ public class BackupUtils { do { String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); if (DataConstants.CALL_NOTE.equals(mimeType)) { - // Print phone number + // 打印电话号码 String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER); long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE); String location = dataCursor.getString(DATA_COLUMN_CONTENT); @@ -185,11 +250,11 @@ public class BackupUtils { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), phoneNumber)); } - // Print call date + // 打印通话日期 ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat .format(mContext.getString(R.string.format_datetime_mdhm), callDate))); - // Print call attachment location + // 打印通话附件位置 if (!TextUtils.isEmpty(location)) { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), location)); @@ -205,7 +270,7 @@ public class BackupUtils { } dataCursor.close(); } - // print a line separator between note + // 在笔记之间打印换行符 try { ps.write(new byte[] { Character.LINE_SEPARATOR, Character.LETTER_NUMBER @@ -216,7 +281,9 @@ public class BackupUtils { } /** - * Note will be exported as text which is user readable + * 将笔记导出为用户可读的文本。 + * + * @return 导出操作的状态码 */ public int exportToText() { if (!externalStorageAvailable()) { @@ -229,7 +296,7 @@ public class BackupUtils { Log.e(TAG, "get print stream error"); return STATE_SYSTEM_ERROR; } - // First export folder and its notes + // 首先导出文件夹及其笔记 Cursor folderCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -240,7 +307,7 @@ public class BackupUtils { if (folderCursor != null) { if (folderCursor.moveToFirst()) { do { - // Print folder's name + // 打印文件夹名称 String folderName = ""; if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) { folderName = mContext.getString(R.string.call_record_folder_name); @@ -257,7 +324,7 @@ public class BackupUtils { folderCursor.close(); } - // Export notes in root's folder + // 导出根文件夹中的笔记 Cursor noteCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -270,7 +337,7 @@ public class BackupUtils { ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( mContext.getString(R.string.format_datetime_mdhm), noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); - // Query data belong to this note + // 查询属于该笔记的数据 String noteId = noteCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (noteCursor.moveToNext()); @@ -283,7 +350,9 @@ public class BackupUtils { } /** - * Get a print stream pointed to the file {@generateExportedTextFile} + * 获取指向导出文本文件的打印流。 + * + * @return 打印流对象，如果创建失败返回null */ private PrintStream getExportToTextPrintStream() { File file = generateFileMountedOnSDcard(mContext, R.string.file_path, @@ -310,7 +379,12 @@ public class BackupUtils { } /** - * Generate the text file to store imported data + * 生成用于存储导入数据的文本文件。 + * + * @param context 上下文对象 + * @param filePathResId 文件路径的资源ID + * @param fileNameFormatResId 文件名格式的资源ID + * @return 生成的文件对象，如果创建失败返回null */ private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { StringBuilder sb = new StringBuilder(); @@ -339,6 +413,4 @@ public class BackupUtils { return null; } -} - - +} \ No newline at end of file