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

import android.net.Uri;

/**
 * Notes类定义了小米便签应用的数据模型和常量，包括：
 * - 内容提供者的URI结构
 * - 数据库表结构和列定义
 * - 便签类型、文件夹类型和系统特殊文件夹ID
 * - 意图传递的额外数据键名
 */
public class Notes {
    // 内容提供者的权限标识
    public static final String AUTHORITY = "micode_notes";
    public static final String TAG = "Notes";
    
    // 便签类型常量
    public static final int TYPE_NOTE     = 0;  // 普通便签
    public static final int TYPE_FOLDER   = 1;  // 文件夹
    public static final int TYPE_SYSTEM   = 2;  // 系统便签

    /**
     * 系统文件夹标识符：
     * {@link Notes#ID_ROOT_FOLDER } 是默认根文件夹
     * {@link Notes#ID_TEMPARAY_FOLDER } 用于存放未分类便签
     * {@link Notes#ID_CALL_RECORD_FOLDER} 用于存储通话记录便签
     * {@link Notes#ID_TRASH_FOLER} 是废纸篓文件夹
     */
    public static final int ID_ROOT_FOLDER = 0;
    public static final int ID_TEMPARAY_FOLDER = -1;
    public static final int ID_CALL_RECORD_FOLDER = -2;
    public static final int ID_TRASH_FOLER = -3;

    // 意图传递的额外数据键名
    public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date";           // 提醒日期
    public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; // 便签背景色ID
    public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id";               // 桌面小部件ID
    public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type";           // 桌面小部件类型
    public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id";               // 文件夹ID
    public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date";               // 通话日期

    // 桌面小部件类型常量
    public static final int TYPE_WIDGET_INVALIDE      = -1;  // 无效小部件
    public static final int TYPE_WIDGET_2X            = 0;   // 2x尺寸小部件
    public static final int TYPE_WIDGET_4X            = 1;   // 4x尺寸小部件

    /**
     * 数据类型常量
     */
    public static class DataConstants {
        public static final String NOTE = TextNote.CONTENT_ITEM_TYPE;       // 文本便签MIME类型
        public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE;   // 通话记录便签MIME类型
    }

    /**
     * 用于查询所有便签和文件夹的URI
     */
    public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");

    /**
     * 用于查询便签关联数据的URI
     */
    public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");

    /**
     * 便签表的列定义
     */
    public interface NoteColumns {
        /**
         * 行的唯一ID
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String ID = "_id";

        /**
         * 便签或文件夹的父ID
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String PARENT_ID = "parent_id";

        /**
         * 便签或文件夹的创建日期
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String CREATED_DATE = "created_date";

        /**
         * 最新修改日期
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String MODIFIED_DATE = "modified_date";

        /**
         * 提醒日期
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String ALERTED_DATE = "alert_date";

        /**
         * 文件夹名称或便签的摘要内容
         * <P> 类型: TEXT </P>
         */
        public static final String SNIPPET = "snippet";

        /**
         * 便签关联的桌面小部件ID
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String WIDGET_ID = "widget_id";

        /**
         * 便签关联的桌面小部件类型
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String WIDGET_TYPE = "widget_type";

        /**
         * 便签的背景色ID
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String BG_COLOR_ID = "bg_color_id";

        /**
         * 标识便签是否有附件
         * 对于文本便签，没有附件；对于多媒体便签，至少有一个附件
         * <P> 类型: INTEGER </P>
         */
        public static final String HAS_ATTACHMENT = "has_attachment";

        /**
         * 文件夹下便签的数量
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String NOTES_COUNT = "notes_count";

        /**
         * 文件类型：文件夹或便签
         * <P> 类型: INTEGER </P>
         */
        public static final String TYPE = "type";

        /**
         * 最后同步ID
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String SYNC_ID = "sync_id";

        /**
         * 标识本地是否有修改
         * <P> 类型: INTEGER </P>
         */
        public static final String LOCAL_MODIFIED = "local_modified";

        /**
         * 移动到临时文件夹前的原始父ID
         * <P> 类型 : INTEGER </P>
         */
        public static final String ORIGIN_PARENT_ID = "origin_parent_id";

        /**
         * Google任务ID（用于与Google任务同步）
         * <P> 类型 : TEXT </P>
         */
        public static final String GTASK_ID = "gtask_id";

        /**
         * 版本代码
         * <P> 类型 : INTEGER (long) </P>
         */
        public static final String VERSION = "version";
    }

    /**
     * 数据表的列定义
     */
    public interface DataColumns {
        /**
         * 行的唯一ID
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String ID = "_id";

        /**
         * 此行表示的数据项的MIME类型
         * <P> 类型: Text </P>
         */
        public static final String MIME_TYPE = "mime_type";

        /**
         * 此数据所属便签的引用ID
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String NOTE_ID = "note_id";

        /**
         * 创建日期
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String CREATED_DATE = "created_date";

        /**
         * 最新修改日期
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String MODIFIED_DATE = "modified_date";

        /**
         * 数据内容
         * <P> 类型: TEXT </P>
         */
        public static final String CONTENT = "content";

        /**
         * 通用数据列，含义由{@link #MIMETYPE}指定，用于整数类型数据
         * <P> 类型: INTEGER </P>
         */
        public static final String DATA1 = "data1";

        /**
         * 通用数据列，含义由{@link #MIMETYPE}指定，用于整数类型数据
         * <P> 类型: INTEGER </P>
         */
        public static final String DATA2 = "data2";

        /**
         * 通用数据列，含义由{@link #MIMETYPE}指定，用于文本类型数据
         * <P> 类型: TEXT </P>
         */
        public static final String DATA3 = "data3";

        /**
         * 通用数据列，含义由{@link #MIMETYPE}指定，用于文本类型数据
         * <P> 类型: TEXT </P>
         */
        public static final String DATA4 = "data4";

        /**
         * 通用数据列，含义由{@link #MIMETYPE}指定，用于文本类型数据
         * <P> 类型: TEXT </P>
         */
        public static final String DATA5 = "data5";
    }

    /**
     * 文本便签类型定义
     */
    public static final class TextNote implements DataColumns {
        /**
         * 标识文本是否处于待办清单模式
         * <P> 类型: Integer 1:待办清单模式 0:普通文本模式 </P>
         */
        public static final String MODE = DATA1;

        public static final int MODE_CHECK_LIST = 1;  // 待办清单模式值

        public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";    // 文本便签集合的MIME类型
        public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";  // 单个文本便签的MIME类型

        public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");  // 文本便签的内容URI
    }

    /**
     * 通话记录便签类型定义
     */
    public static final class CallNote implements DataColumns {
        /**
         * 此记录的通话日期
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String CALL_DATE = DATA1;

        /**
         * 此记录的电话号码
         * <P> 类型: TEXT </P>
         */
        public static final String PHONE_NUMBER = DATA3;

        public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";    // 通话记录集合的MIME类型
        public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";  // 单个通话记录的MIME类型

        public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");  // 通话记录的内容URI
    }
}