注释 module.Note

pull/13/head
chenqy 3 years ago
parent 9269e48a97
commit 5fae0011ce

@ -39,23 +39,30 @@ public class Note {
private NoteData mNoteData;
private static final String TAG = "Note";
/**
* Create a new note id for adding a new note to databases
*
* @param context
* @param folderId id
* @return
*/
public static synchronized long getNewNoteId(Context context, long folderId) {
// Create a new note in the database
// 创建一个新的ContentValues对象并设置相关键值对
ContentValues values = new ContentValues();
long createdTime = System.currentTimeMillis();
values.put(NoteColumns.CREATED_DATE, createdTime);
values.put(NoteColumns.MODIFIED_DATE, createdTime);
values.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
values.put(NoteColumns.LOCAL_MODIFIED, 1);
values.put(NoteColumns.PARENT_ID, folderId);
long createdTime = System.currentTimeMillis(); // 获取当前时间作为创建时间
values.put(NoteColumns.CREATED_DATE, createdTime); // 存入创建时间
values.put(NoteColumns.MODIFIED_DATE, createdTime); // 存入修改时间(初始与创建时间相同)
values.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 存入笔记类型
values.put(NoteColumns.LOCAL_MODIFIED, 1); // 存入本地修改状态
values.put(NoteColumns.PARENT_ID, folderId); // 存入所属文件夹id
// 向数据库中插入新笔记数据并获取包含新建笔记Uri的对象uri
Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values);
long noteId = 0;
try {
// 从uri中获得新建笔记的id即路径segments的第二个元素并将其转换为long类型返回
noteId = Long.valueOf(uri.getPathSegments().get(1));
} catch (NumberFormatException e) {
// 如果获取不到这个id或者它等于-1则会抛出相应的异常
Log.e(TAG, "Get note id error :" + e.toString());
noteId = 0;
}
@ -65,71 +72,169 @@ public class Note {
return noteId;
}
/**
* Note
* "Note"
*/
public Note() {
// 创建一个ContentValues对象用于保存笔记中改变的值即笔记已经被修改但还没同步到数据库
mNoteDiffValues = new ContentValues();
// 创建一个NoteData对象用于保存笔记的所有数据包括标题、正文、颜色等
mNoteData = new NoteData();
}
/**
* key-value
* @param key
* @param value
*
* ContentValuesmNoteDiffValuesNoteDatamNoteData
*
*
*/
public void setNoteValue(String key, String value) {
// 向ContentValues对象中添加键值对
mNoteDiffValues.put(key, value);
// 将本地修改状态设置为1表示笔记已经被修改但还没同步到数据库
mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
// 将修改时间设置为当前时间
mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
}
/**
*
*
* @param key "title""content"
* @param value
*
* ContentValuesmNoteDiffValuesNoteDatamNoteData
*/
public void setTextData(String key, String value) {
// 调用mNoteData对象的setTextData方法将指定键key和值value添加到笔记的文本数据中
mNoteData.setTextData(key, value);
}
/**
* id
*
* @param id id
*
* id
* mNoteDataNoteDatasetTextDataIdid
*/
public void setTextDataId(long id) {
// 调用mNoteData对象的setTextDataId方法将指定的长整型数值作为笔记文本数据的id进行设置
mNoteData.setTextDataId(id);
}
/**
* id
*
* @return id
*
* Noteid
* mNoteDataNoteDatamTextDataIdNoteDataid
*/
public long getTextDataId() {
// 返回mNoteData对象中保存的笔记文本数据的id
return mNoteData.mTextDataId;
}
/**
* id
*
* @param id id
*
* id
* mNoteDataNoteDatasetCallDataIdid
*/
public void setCallDataId(long id) {
// 调用mNoteData对象的setCallDataId方法将指定的长整型数值作为笔记的通话记录id进行设置
mNoteData.setCallDataId(id);
}
/**
*
*
* @param key "name""number"
* @param value
*
* Note
* mNoteDataNoteDatasetCallData/
*/
public void setCallData(String key, String value) {
// 调用mNoteData对象的setCallData方法将指定键key和值value添加到笔记的通话记录数据中
mNoteData.setCallData(key, value);
}
/**
*
*
* @return
*
* NotemNoteDiffValuesmNoteData
* truefalse
*/
public boolean isLocalModified() {
// 判断mNoteDiffValues对象是否包含数据或者mNoteData对象中是否有数据被本地修改。
return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified();
}
/**
*
*
* @param context Context访
* @param noteId ID
*
* @return
*
* NoteNotetrue
* 使ContentResolvermNoteDiffValuesNoteColumns.LOCAL_MODIFIEDNoteColumns.MODIFIED_DATE
* falsemNoteDiffValuesmNoteData
* falsetrue
*/
public boolean syncNote(Context context, long noteId) {
// 检查noteId参数是否合法如果小于等于0则抛出IllegalArgumentException异常
if (noteId <= 0) {
throw new IllegalArgumentException("Wrong note id:" + noteId);
}
// 如果当前Note对象没有被本地修改则直接返回true
if (!isLocalModified()) {
return true;
}
/**
* In theory, once data changed, the note should be updated on {@link NoteColumns#LOCAL_MODIFIED} and
* {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the
* note data info
*/
// 使用ContentResolver对象将mNoteDiffValues中保存的数值更新到NoteColumns.LOCAL_MODIFIED和NoteColumns.MODIFIED_DATE字段上
if (context.getContentResolver().update(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null,
null) == 0) {
// 如果更新失败,则在日志中记录错误信息
Log.e(TAG, "Update note error, should not happen");
// Do not return, fall through
}
// 清空mNoteDiffValues中的数据
mNoteDiffValues.clear();
// 将mNoteData中的数据保存到本地数据库中
if (mNoteData.isLocalModified()
&& (mNoteData.pushIntoContentResolver(context, noteId) == null)) {
// 如果保存失败则返回false
return false;
}
// 如果保存成功则返回true
return true;
}
private class NoteData {
private long mTextDataId;
@ -141,113 +246,211 @@ public class Note {
private static final String TAG = "NoteData";
/**
*
*
* NoteDatamTextDataValuesmCallDataValuesmTextDataIdmCallDataId
* mTextDataValuesmCallDataValues
* mTextDataIdmCallDataIdIDID0
*/
public NoteData() {
// 创建一个新的ContentValues对象mTextDataValues用于保存笔记的文本数据
mTextDataValues = new ContentValues();
// 创建一个新的ContentValues对象mCallDataValues用于保存笔记的通话记录数据
mCallDataValues = new ContentValues();
// 将mTextDataId和mCallDataId的初始值设置为0
mTextDataId = 0;
mCallDataId = 0;
}
/**
*
*
* @return
*
* NoteDatamTextDataValuesmCallDataValues
* truefalse
*/
boolean isLocalModified() {
// 判断mTextDataValues和mCallDataValues对象是否包含数据如果有数据被本地修改过则返回true
return mTextDataValues.size() > 0 || mCallDataValues.size() > 0;
}
/**
* id
*
* @param id id
*
* idid0IllegalArgumentException
* mTextDataIdNoteDataID
*/
void setTextDataId(long id) {
// 如果指定的id小于等于0则抛出IllegalArgumentException异常
if(id <= 0) {
throw new IllegalArgumentException("Text data id should larger than 0");
}
// 将指定的长整型数值作为笔记的文本数据id进行设置
mTextDataId = id;
}
/**
* id
*
* @param id id
*
* idid0
* IllegalArgumentException
* mCallDataIdNoteDataID
*/
void setCallDataId(long id) {
// 如果指定的id小于等于0则抛出IllegalArgumentException异常
if (id <= 0) {
throw new IllegalArgumentException("Call data id should larger than 0");
}
// 将指定的长整型数值作为笔记的通话记录数据id进行设置
mCallDataId = id;
}
/**
*
*
* @param key
* @param value
*
* mCallDataValuesNoteColumns.LOCAL_MODIFIEDNoteColumns.MODIFIED_DATE1
*
*/
void setCallData(String key, String value) {
// 将键值对保存到mCallDataValues对象中
mCallDataValues.put(key, value);
// 将NoteColumns.LOCAL_MODIFIED字段的值设置为1表示笔记已被本地修改过
mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
// 将NoteColumns.MODIFIED_DATE字段的值更新为当前时间戳表示笔记最近一次被修改的时间
mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
}
/**
*
*
* @param key
* @param value
*
* mTextDataValuesNoteColumns.LOCAL_MODIFIEDNoteColumns.MODIFIED_DATE1
*
*/
void setTextData(String key, String value) {
// 将键值对保存到mTextDataValues对象中
mTextDataValues.put(key, value);
// 将NoteColumns.LOCAL_MODIFIED字段的值设置为1表示笔记已被本地修改过
mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
// 将NoteColumns.MODIFIED_DATE字段的值更新为当前时间戳表示笔记最近一次被修改的时间
mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
}
/**
* ContentResolver
*
* @param context Context
* @param noteId id
*
* @return Urinull
*
* NoteDataContentResolvermTextDataValuesmCallDataValuesContentResolverNoteColumns.LOCAL_MODIFIEDNoteColumns.MODIFIED_DATE0
*
*/
Uri pushIntoContentResolver(Context context, long noteId) {
/**
* Check for safety
* noteId
*/
if (noteId <= 0) {
throw new IllegalArgumentException("Wrong note id:" + noteId);
}
// 初始化operationList列表和builder对象
ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
ContentProviderOperation.Builder builder = null;
// 如果mTextDataValues对象不为空则将其中的数据保存到ContentResolver中
if(mTextDataValues.size() > 0) {
// 为mTextDataValues对象添加笔记id
mTextDataValues.put(DataColumns.NOTE_ID, noteId);
if (mTextDataId == 0) {
// 如果mTextDataId为0则表明当前笔记没有文本数据需要进行插入操作
mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE);
// 通过ContentResolver插入数据并获取插入的Uri对象
Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
mTextDataValues);
try {
// 解析Uri中的id值并将其设置为mTextDataId
setTextDataId(Long.valueOf(uri.getPathSegments().get(1)));
} catch (NumberFormatException e) {
Log.e(TAG, "Insert new text data fail with noteId" + noteId);
// 插入失败清空mTextDataValues并返回null
mTextDataValues.clear();
return null;
}
} else {
// 如果mTextDataId不为0则表明当前笔记已经有文本数据需要进行更新操作
builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mTextDataId));
builder.withValues(mTextDataValues);
operationList.add(builder.build());
}
// 清空mTextDataValues对象
mTextDataValues.clear();
}
// 如果mCallDataValues对象不为空则将其中的数据保存到ContentResolver中
if(mCallDataValues.size() > 0) {
// 为mCallDataValues对象添加笔记id
mCallDataValues.put(DataColumns.NOTE_ID, noteId);
if (mCallDataId == 0) {
// 如果mCallDataId为0则表明当前笔记没有通话记录数据需要进行插入操作
mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE);
// 通过ContentResolver插入数据并获取插入的Uri对象
Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
mCallDataValues);
try {
// 解析Uri中的id值并将其设置为mCallDataId
setCallDataId(Long.valueOf(uri.getPathSegments().get(1)));
} catch (NumberFormatException e) {
Log.e(TAG, "Insert new call data fail with noteId" + noteId);
// 插入失败清空mCallDataValues并返回null
mCallDataValues.clear();
return null;
}
} else {
// 如果mCallDataId不为0则表明当前笔记已经有通话记录数据需要进行更新操作
builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mCallDataId));
builder.withValues(mCallDataValues);
operationList.add(builder.build());
}
// 清空mCallDataValues对象
mCallDataValues.clear();
}
if (operationList.size() > 0) {
if (operationList.size() > 0) { // 如果操作列表中有操作
try {
// 调用 ContentResolver 的 applyBatch 方法执行操作
ContentProviderResult[] results = context.getContentResolver().applyBatch(
Notes.AUTHORITY, operationList);
// 判断操作是否成功,并返回对应的 Uri
return (results == null || results.length == 0 || results[0] == null) ? null
: ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId);
} catch (RemoteException e) {
Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
return null;
} catch (OperationApplicationException e) {
Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
return null;
} catch (RemoteException e) { // 捕获 RemoteException 异常
Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); // 记录异常信息到日志
return null; // 返回 null
} catch (OperationApplicationException e) { // 捕获 OperationApplicationException 异常
Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); // 记录异常信息到日志
return null; // 返回 null
}
}
return null;
return null; // 如果操作列表为空,则返回 null
}
}
}

Loading…
Cancel
Save