/* * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * * Licensed under the Apache License, Version 2.0 (the "License"); * 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.model; import android.content.ContentProviderOperation; import android.content.ContentProviderResult; import android.content.ContentUris; import android.content.ContentValues; import android.content.Context; import android.content.OperationApplicationException; import android.net.Uri; 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.DataColumns; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.Notes.TextNote; import java.util.ArrayList; public class Note { private ContentValues mNoteDiffValues;//ContentValues是用于给其他应用调用小米便签的内容的共享数据 private NoteData mNoteData; private static final String TAG = "Note"; /** * Create a new note id for adding a new note to databases */ public static synchronized long getNewNoteId(Context context, long folderId) { // Create a new note in the database//获取新建便签的编号 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); Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values); //外部应用对ContentProvider中的数据进行添加、删除、修改和查询操作 long noteId = 0;//实现外部应用对数据的插入删除等操作 try { noteId = Long.valueOf(uri.getPathSegments().get(1)); } catch (NumberFormatException e) { Log.e(TAG, "Get note id error :" + e.toString()); noteId = 0; } if (noteId == -1) { throw new IllegalStateException("Wrong note id:" + noteId); } return noteId; } public Note() {//定义两个变量用来存储便签的数据,一个是存储便签属性、一个是存储便签内容 mNoteDiffValues = new ContentValues(); mNoteData = new NoteData(); } public void setNoteValue(String key, String value) {//设置数据库表格的标签属性数据 mNoteDiffValues.put(key, value); mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); } public void setTextData(String key, String value) { mNoteData.setTextData(key, value); } //设置数据库表格的标签文本内容的数据 public void setTextDataId(long id) { mNoteData.setTextDataId(id); } //设置文本数据的ID public long getTextDataId() { return mNoteData.mTextDataId; } //获取文本数据的id public void setCallDataId(long id) { mNoteData.setCallDataId(id); } //设置电话号码数据的ID public void setCallData(String key, String value) { mNoteData.setCallData(key, value); } //得到电话号码数据的ID public boolean isLocalModified() {//判断是否是本地修改 return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); } public boolean syncNote(Context context, long noteId) {//判断便签是否同步 if (noteId <= 0) { throw new IllegalArgumentException("Wrong note id:" + noteId); } if (!isLocalModified()) {//如果本地没有发现修改,直接返回1,指示已经同步到数据库中 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 */ 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.clear();//初始化便签特征值 if (mNoteData.isLocalModified()//判断未同步 && (mNoteData.pushIntoContentResolver(context, noteId) == null)) { return false; } return true; } private class NoteData {//定义一个基本的便签内容的数据类,主要包含文本数据和电话号码数据 private long mTextDataId; private ContentValues mTextDataValues; private long mCallDataId; private ContentValues mCallDataValues; private static final String TAG = "NoteData"; public NoteData() {//NoteData的构造函数,初始化四个变量 mTextDataValues = new ContentValues(); mCallDataValues = new ContentValues(); mTextDataId = 0; mCallDataId = 0; } boolean isLocalModified() {//下面是上述几个函数的具体实现 return mTextDataValues.size() > 0 || mCallDataValues.size() > 0; } void setTextDataId(long id) { if(id <= 0) { throw new IllegalArgumentException("Text data id should larger than 0"); } mTextDataId = id; } void setCallDataId(long id) {//判断ID是否合法 if (id <= 0) { throw new IllegalArgumentException("Call data id should larger than 0"); } mCallDataId = id; } void setCallData(String key, String value) {//设置电话号码数据内容,并且保存修改时间 mCallDataValues.put(key, value); mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); } void setTextData(String key, String value) {//设置文本数据 mTextDataValues.put(key, value); mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); } Uri pushIntoContentResolver(Context context, long noteId) {//下面函数的作用是将新的数据通过Uri的操作存储到数据库 /** * Check for safety */ if (noteId <= 0) { throw new IllegalArgumentException("Wrong note id:" + noteId); } ArrayList operationList = new ArrayList();//数据库操作链表 ContentProviderOperation.Builder builder = null; if(mTextDataValues.size() > 0) {//把文本数据存入DataColumns mTextDataValues.put(DataColumns.NOTE_ID, noteId); if (mTextDataId == 0) {//uri插入文本数据 mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, mTextDataValues); try { setTextDataId(Long.valueOf(uri.getPathSegments().get(1)));//尝试重新给它设置id } catch (NumberFormatException e) { Log.e(TAG, "Insert new text data fail with noteId" + noteId);//插入数据失败 mTextDataValues.clear(); return null; } } else { builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(//更新builder对象,追加uri数据和文本ID Notes.CONTENT_DATA_URI, mTextDataId)); builder.withValues(mTextDataValues); operationList.add(builder.build()); } mTextDataValues.clear(); } if(mCallDataValues.size() > 0) {//对于电话号码的数据也是和文本数据一样的同步处理 mCallDataValues.put(DataColumns.NOTE_ID, noteId); if (mCallDataId == 0) {//将电话号码的id设定为uri提供的id mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE); Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, mCallDataValues); try {/异常处理 setCallDataId(Long.valueOf(uri.getPathSegments().get(1))); } catch (NumberFormatException e) { Log.e(TAG, "Insert new call data fail with noteId" + noteId); mCallDataValues.clear(); return null; } } else {// 当电话号码不为新建时,更新电话号码ID builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mCallDataId)); builder.withValues(mCallDataValues); operationList.add(builder.build()); } mCallDataValues.clear(); } //把电话号码数据存入DataColumns if (operationList.size() > 0) {//存储过程中如果遇到异常,通过如下进行处理 try { ContentProviderResult[] results = context.getContentResolver().applyBatch( Notes.AUTHORITY, operationList); 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; } } return null; } } }