/*
 * 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 类，表示一个任务的元数据。
 * 它包含了与任务相关的附加信息，如任务的 GID 等元数据。
 */
public class MetaData extends Task {
    private final static String TAG = MetaData.class.getSimpleName();  // 用于日志记录的 TAG

    private String mRelatedGid = null;  // 用于存储与该任务关联的 GID（Google Task ID）

    /**
     * 设置 Meta 数据，包含任务的 GID 和其他元数据。
     * 
     * @param gid 任务的 GID
     * @param metaInfo 任务的元数据，以 JSON 对象的形式传递
     */
    public void setMeta(String gid, JSONObject metaInfo) {
        try {
            // 将 GID 添加到 metaInfo 中
            metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
        } catch (JSONException e) {
            // 如果发生异常，记录错误日志
            Log.e(TAG, "failed to put related gid");
        }
        // 设置当前任务的备注信息为 metaInfo 的字符串表示
        setNotes(metaInfo.toString());
        // 设置任务名称为默认的 Meta 任务名称
        setName(GTaskStringUtils.META_NOTE_NAME);
    }

    /**
     * 获取当前任务所关联的 GID。
     * 
     * @return 返回与任务关联的 GID
     */
    public String getRelatedGid() {
        return mRelatedGid;
    }

    /**
     * 判断当前任务是否值得保存。
     * 只有当备注信息（notes）不为 null 时，任务才值得保存。
     * 
     * @return 如果备注信息不为空，则返回 true，否则返回 false
     */
    @Override
    public boolean isWorthSaving() {
        return getNotes() != null;
    }

    /**
     * 通过远程 JSON 数据设置任务内容。
     * 如果备注（notes）不为空，它将尝试从中提取与任务关联的 GID。
     * 
     * @param js 传入的远程 JSON 数据
     */
    @Override
    public void setContentByRemoteJSON(JSONObject js) {
        // 调用父类的相应方法，设置基本的任务内容
        super.setContentByRemoteJSON(js);
        
        // 如果备注不为空，尝试解析其中的 GID 信息
        if (getNotes() != null) {
            try {
                // 将备注内容转换为 JSON 对象
                JSONObject metaInfo = new JSONObject(getNotes().trim());
                // 从 metaInfo 中获取 GID 并存储
                mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
            } catch (JSONException e) {
                // 如果解析失败，记录警告日志，并将 GID 设置为 null
                Log.w(TAG, "failed to get related gid");
                mRelatedGid = null;
            }
        }
    }

    /**
     * 本方法不应被调用。该方法会抛出 IllegalAccessError。
     * 
     * @param js 传入的本地 JSON 数据
     * @throws IllegalAccessError 如果调用此方法，将抛出异常
     */
    @Override
    public void setContentByLocalJSON(JSONObject js) {
        throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
    }

    /**
     * 本方法不应被调用。该方法会抛出 IllegalAccessError。
     * 
     * @return 返回值永远不会被调用
     * @throws IllegalAccessError 如果调用此方法，将抛出异常
     */
    @Override
    public JSONObject getLocalJSONFromContent() {
        throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
    }

    /**
     * 本方法不应被调用。该方法会抛出 IllegalAccessError。
     * 
     * @param c 数据库游标
     * @return 返回值永远不会被调用
     * @throws IllegalAccessError 如果调用此方法，将抛出异常
     */
    @Override
    public int getSyncAction(Cursor c) {
        throw new IllegalAccessError("MetaData:getSyncAction should not be called");
    }

}
