add comment

app/src/main/java/net/micode/notes/gtask/data/SqlNote.java

@@ -13,6 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/*
+ * Description：用于支持小米便签最底层的数据库相关操作，和sqldata的关系上是父集关系，即note是data的子父集。
+ * 和SqlData相比，SqlNote算是真正意义上的数据了。
+ */
 
 package net.micode.notes.gtask.data;
 
@@ -39,10 +43,11 @@ import java.util.ArrayList;
 
 
 public class SqlNote {
+    //调用getSimpleName()函数，得到类的简写名称存入字符串TAG中
     private static final String TAG = SqlNote.class.getSimpleName();
 
     private static final int INVALID_ID = -99999;
-
+    // 集合了interface NoteColumns中所有SF常量（17个）
     public static final String[] PROJECTION_NOTE = new String[] {
             NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID,
             NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE,
@@ -52,6 +57,7 @@ public class SqlNote {
             NoteColumns.VERSION
     };
 
+    //以下设置17个列的编号
     public static final int ID_COLUMN = 0;
 
     public static final int ALERTED_DATE_COLUMN = 1;
@@ -86,6 +92,7 @@ public class SqlNote {
 
     public static final int VERSION_COLUMN = 16;
 
+    //一下定义了17个内部的变量，其中12个可以由content中获得，5个需要初始化为0或者new
     private Context mContext;
 
     private ContentResolver mContentResolver;
@@ -122,6 +129,7 @@ public class SqlNote {
 
     private ArrayList<SqlData> mDataList;
 
+    //mIsCreate用于标示构造函数，并且进行构造函数，同时构造函数只有context，对所有变量进行初始化
     public SqlNote(Context context) {
         mContext = context;
         mContentResolver = context.getContentResolver();
@@ -143,6 +151,8 @@ public class SqlNote {
         mDataList = new ArrayList<SqlData>();
     }
 
+    //mIsCreate用于标示构造方式
+    //构造函数有context和一个数据库的cursor，多数变量通过cursor指向的一条记录直接进行初始化
     public SqlNote(Context context, Cursor c) {
         mContext = context;
         mContentResolver = context.getContentResolver();
@@ -154,6 +164,7 @@ public class SqlNote {
         mDiffNoteValues = new ContentValues();
     }
 
+    //mIsCreate用于标示构造方式
     public SqlNote(Context context, long id) {
         mContext = context;
         mContentResolver = context.getContentResolver();
@@ -166,16 +177,20 @@ public class SqlNote {
 
     }
 
+    //通过id从光标处加载数据
     private void loadFromCursor(long id) {
         Cursor c = null;
         try {
             c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)",
                     new String[] {
                         String.valueOf(id)
-                    }, null);
+                    }, null);//通过id获得对应的ContentResolver中的cursor
             if (c != null) {
                 c.moveToNext();
-                loadFromCursor(c);
+                loadFromCursor(c);/*然后加载数据进行初始化，这样函数SqlNote(Context context, long id)
+                                   *与SqlNote(Context context, long id)的实现方式基本相同
+                                   */
+
             } else {
                 Log.w(TAG, "loadFromCursor: cursor = null");
             }
@@ -185,7 +200,9 @@ public class SqlNote {
         }
     }
 
+    //通过游标从光标处加载数据
     private void loadFromCursor(Cursor c) {
+        //直接从一条记录中的获得以下变量的初始值
         mId = c.getLong(ID_COLUMN);
         mAlertDate = c.getLong(ALERTED_DATE_COLUMN);
         mBgColorId = c.getInt(BG_COLOR_ID_COLUMN);
@@ -200,6 +217,7 @@ public class SqlNote {
         mVersion = c.getLong(VERSION_COLUMN);
     }
 
+    //通过content机制获取共享数据并加载到数据库当前游标处
     private void loadDataContent() {
         Cursor c = null;
         mDataList.clear();
@@ -226,6 +244,7 @@ public class SqlNote {
         }
     }
 
+    //设置通过content机制用于共享的数据信息
     public boolean setContent(JSONObject js) {
         try {
             JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
@@ -359,6 +378,7 @@ public class SqlNote {
         return true;
     }
 
+    //获取content机制提供的数据并加载到note中
     public JSONObject getContent() {
         try {
             JSONObject js = new JSONObject();
@@ -370,6 +390,7 @@ public class SqlNote {
 
             JSONObject note = new JSONObject();
             if (mType == Notes.TYPE_NOTE) {
+                //类型为note时
                 note.put(NoteColumns.ID, mId);
                 note.put(NoteColumns.ALERTED_DATE, mAlertDate);
                 note.put(NoteColumns.BG_COLOR_ID, mBgColorId);
@@ -393,6 +414,7 @@ public class SqlNote {
                 }
                 js.put(GTaskStringUtils.META_HEAD_DATA, dataArray);
             } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) {
+                //类型为文件夹或者
                 note.put(NoteColumns.ID, mId);
                 note.put(NoteColumns.TYPE, mType);
                 note.put(NoteColumns.SNIPPET, mSnippet);
@@ -407,39 +429,48 @@ public class SqlNote {
         return null;
     }
 
+    //给当前id设置父id
     public void setParentId(long id) {
         mParentId = id;
         mDiffNoteValues.put(NoteColumns.PARENT_ID, id);
     }
 
+    //给当前id设置Gtaskid
     public void setGtaskId(String gid) {
         mDiffNoteValues.put(NoteColumns.GTASK_ID, gid);
     }
 
+    //给当前id设置同步id
     public void setSyncId(long syncId) {
         mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId);
     }
 
+    //初始化本地修改，即撤销所有当前修改
     public void resetLocalModified() {
         mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0);
     }
 
+    //获得当前id
     public long getId() {
         return mId;
     }
 
+    //获得当前id的父id
     public long getParentId() {
         return mParentId;
     }
 
+    //获取小片段即用于显示的部分便签内容
     public String getSnippet() {
         return mSnippet;
     }
 
+    //判断是否为便签类型
     public boolean isNoteType() {
         return mType == Notes.TYPE_NOTE;
     }
 
+    //commit函数用于把当前造作所做的修改保存到数据库
     public void commit(boolean validateVersion) {
         if (mIsCreate) {
             if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) {
@@ -458,6 +489,7 @@ public class SqlNote {
             }
 
             if (mType == Notes.TYPE_NOTE) {
+                //直接使用sqldata中的实现
                 for (SqlData sqlData : mDataList) {
                     sqlData.commit(mId, false, -1);
                 }
@@ -471,6 +503,7 @@ public class SqlNote {
                 mVersion ++;
                 int result = 0;
                 if (!validateVersion) {
+                    //构造字符串
                     result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "("
                             + NoteColumns.ID + "=?)", new String[] {
                         String.valueOf(mId)

app/src/main/java/net/micode/notes/gtask/data/Task.java

@@ -35,22 +35,22 @@ import org.json.JSONObject;
 public class Task extends Node {
     private static final String TAG = Task.class.getSimpleName();
 
-    private boolean mCompleted;
+    private boolean mCompleted;//是否完成
 
     private String mNotes;
 
-    private JSONObject mMetaInfo;
+    private JSONObject mMetaInfo;//将在实例中存储数据的类型
 
-    private Task mPriorSibling;
+    private Task mPriorSibling;//对应的优先兄弟Task的指针
 
-    private TaskList mParent;
+    private TaskList mParent;//所在的任务列表的指针
 
     public Task() {
         super();
         mCompleted = false;
         mNotes = null;
-        mPriorSibling = null;
+        mPriorSibling = null;//TaskList中当前Task前面的Task的指针
-        mParent = null;
+        mParent = null;//当前Task所在的TaskList
         mMetaInfo = null;
     }
 

app/src/main/java/net/micode/notes/gtask/data/TaskList.java

@@ -31,11 +31,11 @@ import java.util.ArrayList;
 
 
 public class TaskList extends Node {
-    private static final String TAG = TaskList.class.getSimpleName();
+    private static final String TAG = TaskList.class.getSimpleName();//tag标记
 
-    private int mIndex;
+    private int mIndex;//当前TaskList的指针
 
-    private ArrayList<Task> mChildren;
+    private ArrayList<Task> mChildren;//类中主要的保存数据的单元，用来实现一个以Task为元素的ArrayList
 
     public TaskList() {
         super();
@@ -43,6 +43,7 @@ public class TaskList extends Node {
         mIndex = 1;
     }
 
+    //生成并返回一个包含了一定数据的JSONObject实体
     public JSONObject getCreateAction(int actionId) {
         JSONObject js = new JSONObject();
 
@@ -74,6 +75,7 @@ public class TaskList extends Node {
         return js;
     }
 
+    //生成并返回一个包含了一定数据的JSONObject实体
     public JSONObject getUpdateAction(int actionId) {
         JSONObject js = new JSONObject();
 
@@ -216,10 +218,13 @@ public class TaskList extends Node {
         return SYNC_ACTION_ERROR;
     }
 
+    //获得TaskList的大小，即mChildren的大小
     public int getChildTaskCount() {
         return mChildren.size();
     }
 
+    //返回值为是否成功添加任务
+    //在当前任务表末尾添加新的任务
     public boolean addChildTask(Task task) {
         boolean ret = false;
         if (task != null && !mChildren.contains(task)) {
@@ -229,11 +234,13 @@ public class TaskList extends Node {
                 task.setPriorSibling(mChildren.isEmpty() ? null : mChildren
                         .get(mChildren.size() - 1));
                 task.setParent(this);
+                //每一次ArrayList的变化都要紧跟相关Task中PriorSibling的更改，接下来几个函数都有相关操作
             }
         }
         return ret;
     }
 
+    //在当前任务表的指定位置添加新的任务
     public boolean addChildTask(Task task, int index) {
         if (index < 0 || index > mChildren.size()) {
             Log.e(TAG, "add child task: invalid index");
@@ -260,6 +267,7 @@ public class TaskList extends Node {
         return true;
     }
 
+    //删除TaskList中的一个Task
     public boolean removeChildTask(Task task) {
         boolean ret = false;
         int index = mChildren.indexOf(task);
@@ -281,6 +289,7 @@ public class TaskList extends Node {
         return ret;
     }
 
+    //将当前TaskList中含有的某个Task移到index位置
     public boolean moveChildTask(Task task, int index) {
 
         if (index < 0 || index >= mChildren.size()) {
@@ -297,8 +306,10 @@ public class TaskList extends Node {
         if (pos == index)
             return true;
         return (removeChildTask(task) && addChildTask(task, index));
+        //利用已实现好的功能完成当下功能
     }
 
+    //返回寻找结果，按gid寻找task
     public Task findChildTaskByGid(String gid) {
         for (int i = 0; i < mChildren.size(); i++) {
             Task t = mChildren.get(i);
@@ -309,10 +320,11 @@ public class TaskList extends Node {
         return null;
     }
 
+    //返回指定task的index
     public int getChildTaskIndex(Task task) {
         return mChildren.indexOf(task);
     }
-
+    //返回指定index的Task
     public Task getChildTaskByIndex(int index) {
         if (index < 0 || index >= mChildren.size()) {
             Log.e(TAG, "getTaskByIndex: invalid index");
@@ -321,8 +333,9 @@ public class TaskList extends Node {
         return mChildren.get(index);
     }
 
+    //返回指定gid的Task
     public Task getChilTaskByGid(String gid) {
-        for (Task task : mChildren) {
+        for (Task task : mChildren) {//常见的ArrayList的遍历方法
             if (task.getGid().equals(gid))
                 return task;
         }