/*
 * 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;
public class Notes {//Notes类，定义一些基本标识符。该类不对标识符进行任何操作，仅仅只是定义，供其他类调用
    public static final String AUTHORITY = "micode_notes";//定义一个权限名
    public static final String TAG = "Notes";//设置标签，表示APP的名称是Notes
    public static final int TYPE_NOTE     = 0;//以下三个常量对NoteColumns.TYPE的值进行设置时会用到
    public static final int TYPE_FOLDER   = 1;
    public static final int TYPE_SYSTEM   = 2;

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

    //系统文件标识：根目录0，临时文件夹-1，通话记录-2，垃圾文件夹-3
    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";//定义了通知日期的ID
    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";//定义桌面插件的名称
    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";//定义Note，标识text_note的存放地址
    public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date";//定义Call_note，标识call_note的存放地址

    public static final int TYPE_WIDGET_INVALIDE      = -1;//小部件标识：无效小部件-1，2*2大小小部件0，4*4大小小部件1
    public static final int TYPE_WIDGET_2X            = 0;
    public static final int TYPE_WIDGET_4X            = 1;

    public static class DataConstants {//DataContants类：存放textnotes和callnotes地址
        public static final String NOTE = TextNote.CONTENT_ITEM_TYPE;//定义变量NOTE，用来识别text_note的存放地址
        public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE;//定义变量CALL_NOTE，用来标志call_note的存放地址
    }

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

    public interface NoteColumns {//定义NoteColumns的常量,用于后面创建数据库的表头
        /**
         * The unique ID for a row
         * <P> Type: INTEGER (long) </P>
         */
        public static final String ID = "_id";//定义每一行id

        /**
         * The parent's id for note or folder
         * <P> Type: INTEGER (long) </P>
         */
        public static final String PARENT_ID = "parent_id";//父节点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的布局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";//便签背景颜色的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";//文件夹类型还是note类型

        /**
         * The last sync id
         * <P> Type: INTEGER (long) </P>
         */
        public static final String SYNC_ID = "sync_id";//最后一次同步的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";//移动到临时文件夹之前的父节点的ID

        /**
         * The gtask id
         * <P> Type : TEXT </P>
         */
        public static final String GTASK_ID = "gtask_id";//后台任务的ID

        /**
         * The version code
         * <P> Type : INTEGER (long) </P>
         */
        public static final String VERSION = "version";//定义版本号
    }//定义便签属性的常量

    public interface DataColumns {// 定义DataColumns的常量,用于后面创建数据库的表头
        /**
         * The unique ID for a row
         * <P> Type: INTEGER (long) </P>
         */
        public static final String ID = "_id";//定义DataColumns的部分常量

        /**
         * 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";//设置标签的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 {@link #MIME_TYPE} specific, used for
         * integer data type
         * <P> Type: INTEGER </P>
         */
        public static final String DATA1 = "data1";//文本内容的数据结构

        /**
         * Generic data column, the meaning is {@link #MIME_TYPE} specific, used for
         * integer data type
         * <P> Type: INTEGER </P>
         */
        public static final String DATA2 = "data2";//定义文本内容的类型

        /**
         * Generic data column, the meaning is {@link #MIME_TYPE} specific, used for
         * TEXT data type
         * <P> Type: TEXT </P>
         */
        public static final String DATA3 = "data3";//用于文本类型

        /**
         * Generic data column, the meaning is {@link #MIME_TYPE} specific, used for
         * TEXT data type
         * <P> Type: TEXT </P>
         */
        public static final String DATA4 = "data4";//定义常量

        /**
         * Generic data column, the meaning is {@link #MIME_TYPE} specific, used for
         * TEXT data type
         * <P> Type: TEXT </P>
         */
        public static final String DATA5 = "data5";//文本内容的数据结构
    }//主要定义存储便签内容数据

    public static final class TextNote implements DataColumns {//创建文本数据TextNote，继承上面的DataColumns接口
        /**
         * Mode to indicate the text in check list mode or not
         * <P> Type: Integer 1:check list mode 0: normal mode </P>
         */
        public static final String MODE = DATA1;//继承了DataColumns中的DATA1

        public static final int MODE_CHECK_LIST = 1;//note中内容的类型

        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";//内容项目的类型

        public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");//文本内容的数据结构
    }

    public static final class CallNote implements DataColumns {//通话数据（CallNote）继承了接口类，而后进行了格式适配
        /**
         * Call date for this record
         * <P> Type: INTEGER (long) </P>
         */
        public static final String CALL_DATE = DATA1;//存放通话时间

        /**
         * Phone number for this record
         * <P> Type: TEXT </P>
         */
        public static final String PHONE_NUMBER = DATA3;//放通话号码信息

        public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";//修改CONTENT_TYPE属性

        public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";//定义内容项目类型

        public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");//内容标识符
    }//电话内容的数据结构
}