/* * 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.gtask.data; import android.content.ContentResolver; import android.content.ContentUris; import android.content.ContentValues; import android.content.Context; import android.database.Cursor; import android.net.Uri; import android.util.Log; import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.DataConstants; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.NotesDatabaseHelper.TABLE; import net.micode.notes.gtask.exception.ActionFailureException; import org.json.JSONException; import org.json.JSONObject; /** * SqlData类用于处理与笔记数据相关的数据库操作 * 提供了从数据库加载、保存数据以及与JSON格式互相转换的功能 * 支持增量更新机制,仅提交发生变化的数据字段 */ public class SqlData { private static final String TAG = SqlData.class.getSimpleName(); // 无效ID常量,用于标记未初始化的ID private static final int INVALID_ID = -99999; // 数据查询投影,定义了从数据库查询数据时需要返回的列 public static final String[] PROJECTION_DATA = new String[] { DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, DataColumns.DATA3 }; // 投影列索引常量,方便从Cursor中获取对应列的数据 public static final int DATA_ID_COLUMN = 0; public static final int DATA_MIME_TYPE_COLUMN = 1; public static final int DATA_CONTENT_COLUMN = 2; public static final int DATA_CONTENT_DATA_1_COLUMN = 3; public static final int DATA_CONTENT_DATA_3_COLUMN = 4; // 内容解析器,用于与内容提供者交互 private ContentResolver mContentResolver; // 是否为新创建的数据 private boolean mIsCreate; // 数据ID private long mDataId; // 数据MIME类型 private String mDataMimeType; // 数据内容 private String mDataContent; // 额外数据字段1 private long mDataContentData1; // 额外数据字段3 private String mDataContentData3; // 存储发生变化的数据字段,用于增量更新 private ContentValues mDiffDataValues; /** * 构造函数,创建一个新的SqlData对象 * @param context 应用上下文 */ public SqlData(Context context) { mContentResolver = context.getContentResolver(); mIsCreate = true; mDataId = INVALID_ID; mDataMimeType = DataConstants.NOTE; mDataContent = ""; mDataContentData1 = 0; mDataContentData3 = ""; mDiffDataValues = new ContentValues(); } /** * 构造函数,从数据库游标创建SqlData对象 * @param context 应用上下文 * @param c 包含数据的游标 */ public SqlData(Context context, Cursor c) { mContentResolver = context.getContentResolver(); mIsCreate = false; loadFromCursor(c); mDiffDataValues = new ContentValues(); } /** * 从数据库游标加载数据 * @param c 包含数据的游标 */ private void loadFromCursor(Cursor c) { mDataId = c.getLong(DATA_ID_COLUMN); mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); mDataContent = c.getString(DATA_CONTENT_COLUMN); mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); } /** * 从JSON对象设置数据内容 * 只会将发生变化的字段添加到差异值集合中 * @param js 包含数据的JSON对象 * @throws JSONException JSON解析异常 */ public void setContent(JSONObject js) throws JSONException { // 处理数据ID long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; if (mIsCreate || mDataId != dataId) { mDiffDataValues.put(DataColumns.ID, dataId); } mDataId = dataId; // 处理MIME类型 String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) : DataConstants.NOTE; if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); } mDataMimeType = dataMimeType; // 处理内容字段 String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; if (mIsCreate || !mDataContent.equals(dataContent)) { mDiffDataValues.put(DataColumns.CONTENT, dataContent); } mDataContent = dataContent; // 处理额外数据字段1 long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; if (mIsCreate || mDataContentData1 != dataContentData1) { mDiffDataValues.put(DataColumns.DATA1, dataContentData1); } mDataContentData1 = dataContentData1; // 处理额外数据字段3 String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { mDiffDataValues.put(DataColumns.DATA3, dataContentData3); } mDataContentData3 = dataContentData3; } /** * 将数据内容转换为JSON对象 * @return 包含数据的JSON对象 * @throws JSONException JSON构建异常 */ public JSONObject getContent() throws JSONException { if (mIsCreate) { Log.e(TAG, "it seems that we haven't created this in database yet"); return null; } JSONObject js = new JSONObject(); js.put(DataColumns.ID, mDataId); js.put(DataColumns.MIME_TYPE, mDataMimeType); js.put(DataColumns.CONTENT, mDataContent); js.put(DataColumns.DATA1, mDataContentData1); js.put(DataColumns.DATA3, mDataContentData3); return js; } /** * 将数据提交到数据库 * 支持创建新记录和更新已有记录 * @param noteId 关联的笔记ID * @param validateVersion 是否验证版本 * @param version 版本号 */ public void commit(long noteId, boolean validateVersion, long version) { if (mIsCreate) { // 创建新记录时,如果ID无效且已设置,则移除ID设置 if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { mDiffDataValues.remove(DataColumns.ID); } // 设置关联的笔记ID mDiffDataValues.put(DataColumns.NOTE_ID, noteId); // 插入新记录 Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); try { // 从返回的URI中获取新记录的ID mDataId = Long.valueOf(uri.getPathSegments().get(1)); } catch (NumberFormatException e) { Log.e(TAG, "Get note id error :" + e.toString()); throw new ActionFailureException("create note failed"); } } else { // 更新已有记录 if (mDiffDataValues.size() > 0) { int result = 0; if (!validateVersion) { // 不验证版本时直接更新 result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); } else { // 验证版本时使用更严格的条件更新 result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE + " WHERE " + NoteColumns.VERSION + "=?)", new String[] { String.valueOf(noteId), String.valueOf(version) }); } if (result == 0) { Log.w(TAG, "there is no update. maybe user updates note when syncing"); } } } // 清空差异值集合,重置创建标志 mDiffDataValues.clear(); mIsCreate = false; } /** * 获取数据ID * @return 数据ID */ public long getId() { return mDataId; } }