diff --git a/app/src/main/java/net/micode/notes/gtask/data/MetaData.java b/app/src/main/java/net/micode/notes/gtask/data/MetaData.java index 3a2050b..dac87f7 100644 --- a/app/src/main/java/net/micode/notes/gtask/data/MetaData.java +++ b/app/src/main/java/net/micode/notes/gtask/data/MetaData.java @@ -26,29 +26,61 @@ import org.json.JSONObject; public class MetaData extends Task { + /*功能描述：得到类的简写名称并存入字符串TAG中 + *实现过程：调用getSimpleName()函数 + */ private final static String TAG = MetaData.class.getSimpleName(); + /* + * 功能描述：设置数据，即生成元数据库 + * 实现过程：调用JSONObject库函数put ()，Task类中的setNotes ()和setName ()函数 + * 参数注解： + */ + private String mRelatedGid; - private String mRelatedGid = null; - + { + mRelatedGid = null; + } + /* + * 功能描述：设置数据，即生成元数据库 + * 实现过程：调用JSONObject库函数put ()，Task类中的setNotes ()和setName ()函数 + * 参数注解： + */ public void setMeta(String gid, JSONObject metaInfo) { + //对函数块进行注释 try { metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); + /* + * 将这对键值放入metaInfo这个jsonobject对象中 + */ } catch (JSONException e) { Log.e(TAG, "failed to put related gid"); + /* + *输出错误信息 + */ } setNotes(metaInfo.toString()); setName(GTaskStringUtils.META_NOTE_NAME); } - + //获取相关联的Gid + public String getRelatedGid() { + return mRelatedGid; } - + /* + * 功能描述：判断当前数据是否为空，若为空则返回真即值得保存 + * Made By CuiCan + */ @Override public boolean isWorthSaving() { + return getNotes() != null; } - + /* + * 功能描述：使用远程json数据对象设置元数据内容 + * 实现过程：调用父类Task中的setContentByRemoteJSON ()函数，并 + * 参数注解： + */ @Override public void setContentByRemoteJSON(JSONObject js) { super.setContentByRemoteJSON(js); @@ -58,25 +90,42 @@ public class MetaData extends Task { mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); } catch (JSONException e) { Log.w(TAG, "failed to get related gid"); + //输出警告信息 mRelatedGid = null; } } } - + //使用本地json数据对象设置元数据内容，使用时则谁抛出异常 + //Made By CuiCan @Override public void setContentByLocalJSON(JSONObject js) { // this function should not be called throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + //传递非法参数 } - + /* + * 功能描述：从元数据内容中获取本地json对象，一般不会用到，若用到，则抛出异常 + * Made By CuiCan + */ @Override public JSONObject getLocalJSONFromContent() { throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + /* + * 传递非法参数异常 + * Made By Cui Can + */ } - + /* + * 功能描述：获取同步动作状态，一般不会用到，若用到，则抛出异常 + * Made By CuiCan + */ @Override public int getSyncAction(Cursor c) { throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + /* + * 传递非法参数异常 + * Made By Cui Can + */ } } diff --git a/app/src/main/java/net/micode/notes/gtask/data/Node.java b/app/src/main/java/net/micode/notes/gtask/data/Node.java index 63950e0..ee24559 100644 --- a/app/src/main/java/net/micode/notes/gtask/data/Node.java +++ b/app/src/main/java/net/micode/notes/gtask/data/Node.java @@ -20,33 +20,48 @@ import android.database.Cursor; import org.json.JSONObject; +/** + * 应该是同步操作的基础数据类型，定义了相关指示同步操作的常量 + * 关键字：abstract + */ public abstract class Node { + //定义了各种用于表征同步状态的常量 + public static final int SYNC_ACTION_NONE = 0; + // 本地和云端都无可更新内容（即本地和云端内容一致） public static final int SYNC_ACTION_ADD_REMOTE = 1; + // 需要在远程云端增加内容 public static final int SYNC_ACTION_ADD_LOCAL = 2; + // 需要在本地增加内容 public static final int SYNC_ACTION_DEL_REMOTE = 3; + // 需要在远程云端删除内容 public static final int SYNC_ACTION_DEL_LOCAL = 4; + // 需要在本地删除内容 public static final int SYNC_ACTION_UPDATE_REMOTE = 5; + // 需要将本地内容更新到远程云端 public static final int SYNC_ACTION_UPDATE_LOCAL = 6; + // 需要将远程云端内容更新到本地 public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; + // 同步出现冲突 public static final int SYNC_ACTION_ERROR = 8; + // 同步出现错误 private String mGid; private String mName; private long mLastModified; - + //记录最后一次修改时间 private boolean mDeleted; - + //表征是否被删除 public Node() { mGid = null; mName = ""; @@ -67,34 +82,42 @@ public abstract class Node { public abstract int getSyncAction(Cursor c); public void setGid(String gid) { + this.mGid = gid; } public void setName(String name) { + this.mName = name; } public void setLastModified(long lastModified) { + this.mLastModified = lastModified; } public void setDeleted(boolean deleted) { + this.mDeleted = deleted; } public String getGid() { + return this.mGid; } public String getName() { + return this.mName; } public long getLastModified() { + return this.mLastModified; } public boolean getDeleted() { + return this.mDeleted; } diff --git a/app/src/main/java/net/micode/notes/gtask/data/SqlData.java b/app/src/main/java/net/micode/notes/gtask/data/SqlData.java index d3ec3be..c6b59da 100644 --- a/app/src/main/java/net/micode/notes/gtask/data/SqlData.java +++ b/app/src/main/java/net/micode/notes/gtask/data/SqlData.java @@ -13,7 +13,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - +/* + * Description：用于支持小米便签最底层的数据库相关操作，和sqlnote的关系上是子集关系，即data是note的子集（节点）。 + * SqlData其实就是也就是所谓数据中的数据 + */ package net.micode.notes.gtask.data; import android.content.ContentResolver; @@ -36,10 +39,13 @@ import org.json.JSONObject; public class SqlData { + //调用getSimpleName ()函数，得到类的简写名称存入字符串TAG中 private static final String TAG = SqlData.class.getSimpleName(); private static final int INVALID_ID = -99999; + //为mDataId赋初始值-99999 + //集合了interface DataColumns中所有的SF常量 public static final String[] PROJECTION_DATA = new String[] { DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, DataColumns.DATA3 @@ -54,9 +60,9 @@ public class SqlData { public static final int DATA_CONTENT_DATA_1_COLUMN = 3; public static final int DATA_CONTENT_DATA_3_COLUMN = 4; - + //以上五个变量作为sql表中五列的编号 private ContentResolver mContentResolver; - + //用来判断是否直接用content生成，是为true，否则false private boolean mIsCreate; private long mDataId; @@ -70,25 +76,33 @@ public class SqlData { private String mDataContentData3; private ContentValues mDiffDataValues; - + /*mContentResolver用于获取ContentProvider提供的数据 + *mIsCreate表征当前数据是用哪种方式创建（两种构造函数的参数不同） + * 构造函数，并且用于初始化 + */ public SqlData(Context context) { mContentResolver = context.getContentResolver(); mIsCreate = true; mDataId = INVALID_ID; + //mDataId赋予初始值-99999 mDataMimeType = DataConstants.NOTE; mDataContent = ""; mDataContentData1 = 0; mDataContentData3 = ""; mDiffDataValues = new ContentValues(); } - + /*mContentResolver用于获取ContentProvider提供的数据 + * mIsCreate表征当前数据是用哪种方式创建（两种构造函数的参数不同） + * 构造函数，初始化数据 + */ public SqlData(Context context, Cursor c) { mContentResolver = context.getContentResolver(); mIsCreate = false; loadFromCursor(c); mDiffDataValues = new ContentValues(); } - + //从光标处加载数据 + //从当前的光标处将五列的数据加载到该类的对象 private void loadFromCursor(Cursor c) { mDataId = c.getLong(DATA_ID_COLUMN); mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); @@ -96,8 +110,9 @@ public class SqlData { mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); } - + //设置用于共享的数据，并提供异常抛出与处理机制 public void setContent(JSONObject js) throws JSONException { + //如果传入的JSONObject对象中有DataColumns.ID这一项，则设置，否则设为INVALID_ID long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; if (mIsCreate || mDataId != dataId) { mDiffDataValues.put(DataColumns.ID, dataId); @@ -129,12 +144,13 @@ public class SqlData { } mDataContentData3 = dataContentData3; } - + //获取共享的数据内容，并提供异常抛出与处理机制 public JSONObject getContent() throws JSONException { if (mIsCreate) { Log.e(TAG, "it seems that we haven't created this in database yet"); return null; } + //创建JSONObject对象。并将相关数据放入其中，并返回。 JSONObject js = new JSONObject(); js.put(DataColumns.ID, mDataId); js.put(DataColumns.MIME_TYPE, mDataMimeType); @@ -143,7 +159,7 @@ public class SqlData { js.put(DataColumns.DATA3, mDataContentData3); return js; } - + //commit函数用于把当前造作所做的修改保存到数据库 public void commit(long noteId, boolean validateVersion, long version) { if (mIsCreate) { @@ -182,7 +198,7 @@ public class SqlData { mDiffDataValues.clear(); mIsCreate = false; } - + //获取当前的id public long getId() { return mDataId; }