/*
 * 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.database.Cursor;
import android.util.Log;

import net.micode.notes.tool.GTaskStringUtils;

import org.json.JSONException;
import org.json.JSONObject;


// 定义一个名为MetaData的类，它继承自Task类
public class MetaData extends Task {
    // 定义一个静态常量TAG，用于日志记录时标识这个类
    private final static String TAG = MetaData.class.getSimpleName();

    // 定义一个私有变量mRelatedGid，用于存储相关的gid（全局唯一标识符）
    private String mRelatedGid = null;

    // 定义一个方法，用于设置元数据
    // 参数gid是全局唯一标识符，metaInfo是包含元数据的JSONObject
    public void setMeta(String gid, JSONObject metaInfo) {
        try {
            // 将gid添加到metaInfo中，键为GTaskStringUtils.META_HEAD_GTASK_ID
            metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
        } catch (JSONException e) {
            // 如果添加失败，则记录错误日志
            Log.e(TAG, "failed to put related gid");
        }
        // 调用setNotes方法，将metaInfo的字符串表示形式设置为任务的备注
        setNotes(metaInfo.toString());
        // 设置任务的名称为预设的元数据名称
        setName(GTaskStringUtils.META_NOTE_NAME);
    }

    // 定义一个方法，用于获取相关的gid
    public String getRelatedGid() {
        return mRelatedGid;
    }

    // 重写isWorthSaving方法，判断这个MetaData对象是否值得保存
    // 如果备注（即元数据）不为null，则认为值得保存
    @Override
    public boolean isWorthSaving() {
        return getNotes() != null;
    }

    // 重写setContentByRemoteJSON方法，用于从远程JSON对象中设置内容
    // 首先调用父类的同名方法，然后从备注中提取JSON对象，并获取gid
    @Override
    public void setContentByRemoteJSON(JSONObject js) {
        super.setContentByRemoteJSON(js);
        if (getNotes() != null) {
            try {
                JSONObject metaInfo = new JSONObject(getNotes().trim());
                mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
            } catch (JSONException e) {
                // 如果获取gid失败，则记录警告日志，并将mRelatedGid设置为null
                Log.w(TAG, "failed to get related gid");
                mRelatedGid = null;
            }
        }
    }

    // 重写setContentByLocalJSON方法，由于这个方法不应该被调用，所以抛出IllegalAccessError异常
    @Override
    public void setContentByLocalJSON(JSONObject js) {
        // this function should not be called
        throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
    }

    // 重写getLocalJSONFromContent方法，同样由于不应该被调用，抛出IllegalAccessError异常
    @Override
    public JSONObject getLocalJSONFromContent() {
        throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
    }

    // 重写getSyncAction方法，由于不应该被调用，抛出IllegalAccessError异常
    // 这个方法通常用于同步操作，但在这个MetaData类中不适用
    @Override
    public int getSyncAction(Cursor c) {
        throw new IllegalAccessError("MetaData:getSyncAction should not be called");
    }
}