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


public class MetaData extends Task {
    // 常量标签，用于日志输出，值为当前类的简单名称
    private final static String TAG = MetaData.class.getSimpleName();

    // 相关GID的字符串变量，初始化为null
    private String mRelatedGid = null;

    /**
     * 设置元数据
     *
     * @param gid       任务的GID
     * @param 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) {
            // 如果放入GID失败，输出错误日志
            Log.e(TAG, "failed to put related gid");
        }
        // 将metaInfo转换为字符串并设置为便签的备注
        setNotes(metaInfo.toString());
        // 设置便签的名称为预定义的元数据名称
        setName(GTaskStringUtils.META_NOTE_NAME);
    }

    /**
     * 获取相关GID
     *
     * @return 返回相关GID的字符串，如果未设置则返回null
     */
    public String getRelatedGid() {
        return mRelatedGid;
    }

    /**
     * 判断便签是否值得保存
     *
     * @return 如果便签有备注则返回true，否则返回false
     */
    @Override
    public boolean isWorthSaving() {
        return getNotes() != null;
    }

    /**
     * 通过远程JSON对象设置便签内容
     *
     * @param js 包含便签内容的JSONObject对象
     */
    @Override
    public void setContentByRemoteJSON(JSONObject js) {
        // 调用父类的方法处理JSON对象
        super.setContentByRemoteJSON(js);
        // 如果便签有备注
        if (getNotes() != null) {
            try {
                // 将备注转换为JSONObject对象
                JSONObject metaInfo = new JSONObject(getNotes().trim());
                // 从metaInfo中获取相关GID
                mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
            } catch (JSONException e) {
                // 如果获取GID失败，输出警告日志，并将相关GID设置为null
                Log.w(TAG, "failed to get related gid");
                mRelatedGid = null;
            }
        }
    }

    /**
     * 通过本地JSON对象设置便签内容（不应调用此方法）
     *
     * @param js 包含便签内容的JSONObject对象
     * @throws IllegalAccessError 总是抛出此错误，因为此方法不应被调用
     */
    @Override
    public void setContentByLocalJSON(JSONObject js) {
        // 抛出错误，因为此方法不应被调用
        throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
    }

    /**
     * 从便签内容获取本地JSON对象（不应调用此方法）
     *
     * @return 不返回任何值，因为此方法不应被调用
     * @throws IllegalAccessError 总是抛出此错误，因为此方法不应被调用
     */
    @Override
    public JSONObject getLocalJSONFromContent() {
        // 抛出错误，因为此方法不应被调用
        throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
    }

    /**
     * 获取同步操作（不应调用此方法）
     *
     * @param c 数据库游标
     * @return 不返回任何值，因为此方法不应被调用
     * @throws IllegalAccessError 总是抛出此错误，因为此方法不应被调用
     */
    @Override
    public int getSyncAction(Cursor c) {
        // 抛出错误，因为此方法不应被调用
        throw new IllegalAccessError("MetaData:getSyncAction should not be called");
    }
}
