/*
 * 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;


public class SqlData {
    private static final String TAG = SqlData.class.getSimpleName();

    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
    };
/*这是一个Java类，名称为SqlData，其中定义了一些静态变量和常量，用于在类内和类外引用。

第一行定义了一个名为TAG的静态常量字符串，用于在日志中标识该类。这个字符串的值是SqlData类的简单名称。

第二行定义了一个名为INVALID_ID的私有静态常量整数，用于表示无效的ID。该值被设置为-99999。

第三行定义了一个名为PROJECTION_DATA的公共静态常量字符串数组，用于定义一个查询所需返回的列。这些列包括DataColumns类中定义的ID、MIME_TYPE、CONTENT、DATA1和DATA3。

这些变量和常量都被声明为静态的，这意味着它们属于类本身，而不是类的实例。因此，它们可以在类的所有实例之间共享和访问。这些变量和常量的使用可以提高代码的可读性和可维护性，并避免在代码中多次重复相同的值。*/
    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;

    private long mDataId;

    private String mDataMimeType;

    private String mDataContent;

    private long mDataContentData1;

    private String mDataContentData3;

    private ContentValues mDiffDataValues;
/*这是一个Java类，名称为SqlData，其中定义了一些成员变量和常量，用于在类内存储和操作数据。

第一行定义了一个名为DATA_ID_COLUMN的公共静态常量整数，用于表示列索引中的数据ID列。

第二行定义了一个名为DATA_MIME_TYPE_COLUMN的公共静态常量整数，用于表示列索引中的MIME类型列。

第三行定义了一个名为DATA_CONTENT_COLUMN的公共静态常量整数，用于表示列索引中的内容列。

第四行定义了一个名为DATA_CONTENT_DATA_1_COLUMN的公共静态常量整数，用于表示列索引中的DATA1列。

第五行定义了一个名为DATA_CONTENT_DATA_3_COLUMN的公共静态常量整数，用于表示列索引中的DATA3列。

接下来的几行定义了该类的一些成员变量，包括ContentResolver类型的mContentResolver、boolean类型的mIsCreate、long类型的mDataId、String类型的mDataMimeType、String类型的mDataContent、long类型的mDataContentData1、String类型的mDataContentData3和ContentValues类型的mDiffDataValues。这些变量表示了该类的不同数据属性。

其中，ContentValues是一个键值对的集合，用于在Android应用中存储和操作数据。在该类中，mDiffDataValues被用于存储该对象的数据属性的差异，即该对象已更改但尚未提交到数据库中的值。*/
    // 构造函数用于初始化一个SqlData对象的实例
    public SqlData(Context context) {
        mContentResolver = context.getContentResolver();// 获取ContentResolver对象，用于访问ContentProvider中的数据
        mIsCreate = true;// 初始化数据的创建状态
        mDataId = INVALID_ID; // 初始化数据的ID值
        mDataMimeType = DataConstants.NOTE;// 初始化数据的MIME类型为NOTE
        mDataContent = ""; // 初始化数据的内容为空字符串
        mDataContentData1 = 0;  // 初始化数据的数据内容Data1为0
        mDataContentData3 = "";// 初始化数据的数据内容Data3为空字符串
        mDiffDataValues = new ContentValues();// 初始化差异数据的ContentValues对象，用于保存数据的不同之处
    }

    // 定义SqlData类，该类用于处理数据库中的数据
    public SqlData(Context context, Cursor c) {
        // 获取ContentResolver对象
        mContentResolver = context.getContentResolver();
        // 设置初始状态为非创建状态
        mIsCreate = false;
        // 从Cursor对象中读取数据，并将数据加载到
        loadFromCursor(c);
        // 创建一个新的ContentValues对象，用于存储数据的差异
        mDiffDataValues = new ContentValues();
    }
/*该构造函数主要是用于初始化SqlData对象，并且在初始化过程中从Cursor对象中读取数据，同时创建一个新的ContentValues对象，以备后续存储数据的差异。*/
/*定义了一个私有方法loadFromCursor，该方法接收一个Cursor对象作为参数，并且在该方法中从Cursor对象中读取数据，将这些数据加载到SqlData对象中。*/
// 从Cursor对象中读取数据，并将数据加载到SqlData对象中
    private void loadFromCursor(Cursor c) {
        // 从Cursor对象中读取数据id
        mDataId = c.getLong(DATA_ID_COLUMN);
        // 从Cursor对象中读取数据类型
        mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN);
        // 从Cursor对象中读取数据内容
        mDataContent = c.getString(DATA_CONTENT_COLUMN);
        // 从Cursor对象中读取数据内容的第一个数据项
        mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN);
        // 从Cursor对象中读取数据内容的第三个数据项
        mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN);
    }
/*该方法主要是用于从Cursor对象中读取数据，并将这些数据加载到SqlData对象的相关成员变量中。其中，数据的读取顺序和类型需要与Cursor对象中的列名一一对应。*/
    public void setContent(JSONObject js) throws JSONException {// 设置SqlData对象的内容
        long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID;// 从JSONObject对象中获取数据id
        if (mIsCreate || mDataId != dataId) {
            mDiffDataValues.put(DataColumns.ID, dataId);
        }
        mDataId = dataId; // 如果当前SqlData对象是创建状态，或者数据id与当前对象的数据id不同，将数据id加入到差异数据值对象中

//setContent方法的主要部分，用于设置SqlData对象的各个成员变量值，并且在设置过程中检查差异数据。
        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;
       // 从JSONObject对象中获取数据类型，并将其设置为SqlData对象的数据类型
        String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : "";
        if (mIsCreate || !mDataContent.equals(dataContent)) {
            mDiffDataValues.put(DataColumns.CONTENT, dataContent);
        }
        mDataContent = dataContent;
        // 从JSONObject对象中获取数据内容的第一个数据项，并将其设置为SqlData对象的数据内容的第一个数据项
        long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0;
        if (mIsCreate || mDataContentData1 != dataContentData1) {
            mDiffDataValues.put(DataColumns.DATA1, dataContentData1);
        }
        mDataContentData1 = dataContentData1;
        // 从JSONObject对象中获取数据内容的第三个数据项，并将其设置为SqlData对象的数据内容的第三个数据项
        String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : "";
        if (mIsCreate || !mDataContentData3.equals(dataContentData3)) {
            mDiffDataValues.put(DataColumns.DATA3, dataContentData3);
        }
        mDataContentData3 = dataContentData3;
    }
/*该代码段主要是根据JSONObject对象中的数据，设置SqlData对象的相应成员变量，并且在设置过程中检查差异数据。
   其中，如果当前SqlData对象是创建状态，或者相应成员变量的值与JSONObject对象中的值不同，就将相应的数据加入到差异数据值对象中。
   这些差异数据值将在后续的操作中被用于更新数据库中的数据。*/
    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;
    }
/*这段代码定义了一个名为getContent()的方法，它返回一个JSONObject对象。
该方法可能会抛出一个JSONException异常，因此在调用该方法时需要处理该异常。
方法体内的第一条语句检查一个名为mIsCreate的 boolean 类型的成员变量是否为 true，如果是，则输出一个错误日志并返回 null。否则，方法会创建一个新的JSONObject对象，并向它添加一些键值对，这些键值对是由mDataId、mDataMimeType、mDataContent、mDataContentData1和mDataContentData3这些成员变量组成的。
最后，该方法返回一个JSONObject对象，其中包含了这些成员变量的值。*/


    public void commit(long noteId, boolean validateVersion, long version) {

        if (mIsCreate) {
            if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) {
                mDiffDataValues.remove(DataColumns.ID);
            }

            mDiffDataValues.put(DataColumns.NOTE_ID, noteId);
            Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues);
            try {
                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;
    }
/*这段代码定义了一个名为commit()的方法，用于将已经修改的数据保存到数据库中。
方法接受三个参数：noteId为 long 类型，表示当前笔记的 ID;
validateVersion为 boolean 类型，表示是否需要验证版本;
version为 long 类型，表示当前笔记的版本。
方法体内的第一条语句检查一个名为mIsCreate的boolean类型的成员变量是否为true，如果是，则表示当前是创建一个新的数据，需要将数据插入到数据库中。
如果mDiffDataValues中包含 DataColumns.ID 这个键值对，表明该成员变量的值已经被赋值，需要将其移除，因为它是自增的主键，不应该由用户指定。
接下来，将 DataColumns.NOTE_ID 对应的值设置为noteId，并将mDiffDataValues插入到Notes.CONTENT_DATA_URI中获取Uri对象，然后Uri对象中获取新的数据的 ID 并设置给成员变量mDataId。
如果获取 ID 失败，则记录错误日志并抛出一个ActionFailureException异常。
如果mIsCreate的值为 false，则表示需要更新数据库中的数据。
如果mDiffDataValues中有数据，则调用mContentResolver.update()方法对数据库进行更新。
如果validateVersion的值为 false，则直接更新数据，否则需要先验证版本。验证版本的过程是通过查询NoteColumns.VERSION等于version且NoteColumns.ID等于的noteId
无论是插入数据还是更新数据，都需要清空mDiffDataValues的内容并将mIsCreate设为 false，表示数据已经提交保存到数据库中。*/
    public long getId() {
        return mDataId;
    }//定义了一个名为getId()的方法，返回一个long类型的值，表示当前笔记的ID。
     //直接返回成员变量mDataId，因此不会引发任何异常。
}
6