/*
 * 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;  // 导入Android URI类，用于定义内容提供者的URI

/**
 * 笔记数据相关的常量定义类
 * 包含笔记的URI、类型、列名等常量
 */
public class Notes {
    // 内容提供者的授权标识，用于ContentProvider的authority属性
    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} 用于存储通话记录
     */
    public static final int ID_ROOT_FOLDER = 0;  // 根文件夹ID
    public static final int ID_TEMPARAY_FOLDER = -1;  // 临时文件夹ID
    public static final int ID_CALL_RECORD_FOLDER = -2;  // 通话记录文件夹ID
    public static final int ID_TRASH_FOLER = -3;  // 回收站文件夹ID

    // Intent额外数据键名常量，用于在不同组件间传递数据
    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大小的小部件

    /**
     * 数据常量类
     * 定义MIME类型常量
     */
    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
     * 通过这个URI可以访问所有笔记和文件夹
     */
    public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");

    /**
     * 查询数据的URI
     * 通过这个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字段名

        /**
         * 笔记或文件夹的父ID
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String PARENT_ID = "parent_id";  // 父文件夹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";  // 小部件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";  // 背景颜色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";  // 同步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";  // 原始父文件夹ID字段名

        /**
         * Google任务ID
         * <P> 类型 : TEXT </P>
         */
        public static final String GTASK_ID = "gtask_id";  // Google任务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";  // 主键ID字段名

        /**
         * 该行所代表项目的MIME类型
         * <P> 类型: Text </P>
         */
        public static final String MIME_TYPE = "mime_type";  // MIME类型字段名

        /**
         * 该数据所属笔记的引用ID
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String NOTE_ID = "note_id";  // 笔记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";  // 通用数据字段1

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

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

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

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

    /**
     * 文本笔记数据列定义
     * 定义了文本笔记特定的数据列
     */
    public static final class TextNote implements DataColumns {
        /**
         * 模式：指示文本是否为清单模式
         * <P> 类型: Integer 1:清单模式 0: 普通模式 </P>
         */
        public static final String MODE = DATA1;  // 模式字段，使用DATA1列

        public static final int MODE_CHECK_LIST = 1;  // 清单模式常量

        // 内容类型常量，用于ContentProvider
        public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";  // 多项目类型
        public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";  // 单项目类型

        // 文本笔记的URI
        public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");
    }

    /**
     * 通话笔记数据列定义
     * 定义了通话笔记特定的数据列
     */
    public static final class CallNote implements DataColumns {
        /**
         * 该记录的通话日期
         * <P> 类型: INTEGER (long) </P>
         */
        public static final String CALL_DATE = DATA1;  // 通话日期字段，使用DATA1列

        /**
         * 该记录的电话号码
         * <P> 类型: TEXT </P>
         */
        public static final String PHONE_NUMBER = DATA3;  // 电话号码字段，使用DATA3列

        // 内容类型常量，用于ContentProvider
        public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";  // 多项目类型
        public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";  // 单项目类型

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