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

import org.apache.http.client.fluent.Content;

import java.net.URI;

//Notes类是最底层的数据类，它定义了一堆常量，用来表示标签和文件的各种属性，以及Intent的额外数据（如布局、小组件ID）。
// 它还通过接口以及其实现类定义了数据库表的列名（两个表：note表和data表）。
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;
    //类型行的3种取值
    /**
     * Following IDs are system folders' identifiers
     * {@link Notes#ID_ROOT_FOLDER } is default folder
     * {@link Notes#ID_TEMPARAY_FOLDER } is for notes belonging no folder
     * {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records
     */
    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;
    //这里定义了4种文件夹类型：

    //ID_ROOT_FOLDER：默认文件夹
    //ID_TEMPARAY_FOLDER：不属于文件夹的笔记
    //ID_CALL_RECORD_FOLDER：用于存储通话记录，以便返回
    //ID_TRASH_FOLER：垃圾回收站

    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";
    public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_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";
    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;
    public static final int TYPE_WIDGET_4X            = 1;

    //定义一些布局的ID，这部分就是用于设置UI界面的一些布局或小组件的id。

    public static class DataConstants {
        public static final String NOTE = TextNote.CONTENT_ITEM_TYPE;
        public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE;
    }
    //这里定义了两种数据类型：文本便签和通话记录

    /**
     * Uri to query all notes and folders
     */
    public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");

    /**
     * Uri to query data
     */
    public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");

    //Android开发中常见的用于定义内容提供者（
    //Content Provider）URI，内容提供者是一种Android组件，它允许应用程序共享和存储数据。这里定义了一个URI来查询数据

    public interface NoteColumns {
        /**
         * The unique ID for a row
         * <P> Type: INTEGER (long) </P>
         */
        public static final String ID = "_id";

        /**
         * The parent's id for note or folder
         * <P> Type: INTEGER (long) </P>
         */
        public static final String PARENT_ID = "parent_id";

        /**
         * Created data for note or folder
         * <P> Type: INTEGER (long) </P>
         */
        public static final String CREATED_DATE = "created_date";

        /**
         * Latest modified date
         * <P> Type: INTEGER (long) </P>
         */
        public static final String MODIFIED_DATE = "modified_date";


        /**
         * Alert date
         * <P> Type: INTEGER (long) </P>
         */
        public static final String ALERTED_DATE = "alert_date";

        /**
         * Folder's name or text content of note
         * <P> Type: TEXT </P>
         */
        public static final String SNIPPET = "snippet";

        /**
         * Note's widget id
         * <P> Type: INTEGER (long) </P>
         */
        public static final String WIDGET_ID = "widget_id";

        /**
         * Note's widget type
         * <P> Type: INTEGER (long) </P>
         */
        public static final String WIDGET_TYPE = "widget_type";

        /**
         * Note's background color's id
         * <P> Type: INTEGER (long) </P>
         */
        public static final String BG_COLOR_ID = "bg_color_id";

        /**
         * For text note, it doesn't has attachment, for multi-media
         * note, it has at least one attachment
         * <P> Type: INTEGER </P>
         */
        public static final String HAS_ATTACHMENT = "has_attachment";

        /**
         * Folder's count of notes
         * <P> Type: INTEGER (long) </P>
         */
        public static final String NOTES_COUNT = "notes_count";

        /**
         * The file type: folder or note
         * <P> Type: INTEGER </P>
         */
        public static final String TYPE = "type";

        /**
         * The last sync id
         * <P> Type: INTEGER (long) </P>
         */
        public static final String SYNC_ID = "sync_id";

        /**
         * Sign to indicate local modified or not
         * <P> Type: INTEGER </P>
         */
        public static final String LOCAL_MODIFIED = "local_modified";

        /**
         * Original parent id before moving into temporary folder
         * <P> Type : INTEGER </P>
         */
        public static final String ORIGIN_PARENT_ID = "origin_parent_id";

        /**
         * The gtask id
         * <P> Type : TEXT </P>
         */
        public static final String GTASK_ID = "gtask_id";

        /**
         * The version code
         * <P> Type : INTEGER (long) </P>
         */
        public static final String VERSION = "version";
    }

    //这个接口定义了一系列静态的、最终的字符串常量，这些常量代表数据库表中的列名。

    //属性有：ID、父级ID、创建日期、修改日期、提醒日期、文件（标签）名（摘要？）、小部件ID、小部件类型、背景颜色ID、
    // 附件、文件中的标签数量、 文件（标签）类型、最后一个同步ID、本地修改标签、移动前的ID、谷歌任务ID、代码版本信息。

    public interface DataColumns {
        /**
         * The unique ID for a row
         * <P> Type: INTEGER (long) </P>
         */
        public static final String ID = "_id";

        /**
         * The MIME type of the item represented by this row.
         * <P> Type: Text </P>
         */
        public static final String MIME_TYPE = "mime_type";
        //MIME类型是一种标准，用于标识文档、文件或字节流的性质和格式。在数据库中，这个字段可以用来识别不同类型的数据，例如文本、图片、音频或视频等。
        /**
         * The reference id to note that this data belongs to
         * <P> Type: INTEGER (long) </P>
         */
        public static final String NOTE_ID = "note_id";
        //归属的Note的ID
        /**
         * Created data for note or folder
         * <P> Type: INTEGER (long) </P>
         */
        public static final String CREATED_DATE = "created_date";
        //创建日期
        /**
         * Latest modified date
         * <P> Type: INTEGER (long) </P>
         */
        public static final String MODIFIED_DATE = "modified_date";
        //最近修改日期
        /**
         * Data's content
         * <P> Type: TEXT </P>
         */
        public static final String CONTENT = "content";
        //数据内容

        /**
         * Generic data column, the meaning is  specific, used for
         * integer data type
         * <P> Type: INTEGER </P>
         */
        public static final String DATA1 = "data1";

        /**
         * Generic data column, the meaning is  specific, used for
         * integer data type
         * <P> Type: INTEGER </P>
         */
        public static final String DATA2 = "data2";

        /**
         * Generic data column, the meaning is  specific, used for
         * TEXT data type
         * <P> Type: TEXT </P>
         */
        public static final String DATA3 = "data3";

        /**
         * Generic data column, the meaning is  specific, used for
         * TEXT data type
         * <P> Type: TEXT </P>
         */
        public static final String DATA4 = "data4";

        /**
         * Generic data column, the meaning is  specific, used for
         * TEXT data type
         * <P> Type: TEXT </P>
         */
        public static final String DATA5 = "data5";
        // 以上5个是通用数据列，它们的具体意义取决于MIME类型（由MIME_TYPE字段指定）。
        // 不同的MIME类型可能需要存储不同类型的数据，这5个字段提供了灵活性，允许根据MIME类型来存储相应的数据。
    }
    //以下这两个类是上述的DataColumns接口的实现类，分别是文本标签和通话记录实体。
    // 定义了实体之后，应用的其他部分或其他应用可以通过内容提供者访问和操作文本标签和通话记录
    public static final class TextNote implements DataColumns {
        //模式这个被存在DATA1列中
        public static final String MODE = DATA1;
        //所处检查列表模式
        public static final int MODE_CHECK_LIST = 1;
        // 定义了MIME类型，用于标识文本标签的目录
        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";
        //文本标签内容提供者（Content Provider）的URI，用于访问文本标签数据
        public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");}

    public static final class CallNote implements DataColumns {
        //一个字符串常量，表示通话记录的日期
        public static final String CALL_DATE = DATA1;
        //意味着在数据库表中，这个电话号码信息将被存储在DATA3列中
        public static final String PHONE_NUMBER = DATA3;
        // 同样定义了MIME类型，是用于标识通话记录的目录。
        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";
        //定义了通话记录内容提供者的URI，用于访问通话记录数据。
        public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");
    }
}
