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


/**
 * Google Tasks 元数据类
 * <p>
 * 继承自 Task，用于存储和管理 Google Tasks 同步的元数据信息。
 * 元数据以特殊任务的形式存储在 Google Tasks 中，用于关联本地笔记和远程任务的对应关系。
 * 该类不应通过本地 JSON 或数据库游标进行操作，仅用于远程同步场景。
 * </p>
 */
public class MetaData extends Task {
    /**
     * 日志标签
     */
    private final static String TAG = MetaData.class.getSimpleName();

    /**
     * 关联的 Google Tasks ID
     */
    private String mRelatedGid = null;

    /**
     * 设置元数据信息
     * <p>
     * 将 Google Tasks ID 添加到元信息 JSON 对象中，并设置任务名称为元数据专用名称。
     * 元信息以 JSON 字符串形式存储在任务的 notes 字段中。
     * </p>
     * 
     * @param gid 关联的 Google Tasks ID
     * @param metaInfo 元信息 JSON 对象
     */
    public void setMeta(String gid, JSONObject metaInfo) {
        try {
            // 将关联的 GID 添加到元信息中
            metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
        } catch (JSONException e) {
            Log.e(TAG, "failed to put related gid");
        }
        // 将元信息转换为字符串并设置为任务备注
        setNotes(metaInfo.toString());
        // 设置为元数据专用名称
        setName(GTaskStringUtils.META_NOTE_NAME);
    }

    /**
     * 获取关联的 Google Tasks ID
     * 
     * @return 关联的 Google Tasks ID，如果未设置则返回 null
     */
    public String getRelatedGid() {
        return mRelatedGid;
    }

    /**
     * 判断是否值得保存
     * <p>
     * 只有当 notes 字段不为空时才值得保存，因为元数据信息存储在 notes 中。
     * </p>
     * 
     * @return 如果 notes 不为 null 返回 true，否则返回 false
     */
    @Override
    public boolean isWorthSaving() {
        return getNotes() != null;
    }

    /**
     * 根据远程 JSON 设置内容
     * <p>
     * 从远程服务器返回的 JSON 对象中解析元数据信息，提取关联的 Google Tasks ID。
     * </p>
     * 
     * @param js 远程服务器返回的 JSON 对象
     */
    @Override
    public void setContentByRemoteJSON(JSONObject js) {
        super.setContentByRemoteJSON(js);
        if (getNotes() != null) {
            try {
                // 从 notes 字段中解析元信息 JSON
                JSONObject metaInfo = new JSONObject(getNotes().trim());
                // 提取关联的 GID
                mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
            } catch (JSONException e) {
                Log.w(TAG, "failed to get related gid");
                mRelatedGid = null;
            }
        }
    }

    /**
     * 根据本地 JSON 设置内容
     * <p>
     * 此方法不应被调用，因为元数据不通过本地 JSON 进行操作。
     * </p>
     * 
     * @param js 本地 JSON 对象
     * @throws IllegalAccessError 总是抛出此异常，表示不应调用此方法
     */
    @Override
    public void setContentByLocalJSON(JSONObject js) {
        // this function should not be called
        throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
    }

    /**
     * 从内容生成本地 JSON 对象
     * <p>
     * 此方法不应被调用，因为元数据不通过本地 JSON 进行操作。
     * </p>
     * 
     * @return 无返回值，总是抛出异常
     * @throws IllegalAccessError 总是抛出此异常，表示不应调用此方法
     */
    @Override
    public JSONObject getLocalJSONFromContent() {
        throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
    }

    /**
     * 根据数据库游标获取同步动作
     * <p>
     * 此方法不应被调用，因为元数据不通过数据库游标进行操作。
     * </p>
     * 
     * @param c 数据库游标
     * @return 无返回值，总是抛出异常
     * @throws IllegalAccessError 总是抛出此异常，表示不应调用此方法
     */
    @Override
    public int getSyncAction(Cursor c) {
        throw new IllegalAccessError("MetaData:getSyncAction should not be called");
    }

}
