/*
 * 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;//引用url
public class Notes {//Notes类，在类中定义了了许多常量
    public static final String AUTHORITY = "micode_notes";
    public static final String TAG = "Notes";//APP名称
    public static final int TYPE_NOTE     = 0;
    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
     */
    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";//背景颜色
    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";//创建text note的存放地址
    public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date";//定义call_data的ID

    public static final int TYPE_WIDGET_INVALIDE      = -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;
        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常量，方便进行系统查询

    /**
     * Uri to query data
     */
    public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");//通过uri查询数据

    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";

        /**
         * Created data for note or folder//创建一个属于note或者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// note小物件id
         * <P> Type: INTEGER (long) </P>
         */
        public static final String WIDGET_ID = "widget_id";//小部件ID

        /**
         * Note's widget type//便签页数
         * <P> Type: INTEGER (long) </P>//note小物件类型
         */
        public static final String WIDGET_TYPE = "widget_type";//小部件类型

        /**
         * Note's background color's id//便签背景颜色
         * <P> Type: INTEGER (long) </P>//note背景颜色id
         */
        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>//对于文字note，它没有附件，对于多个Note，它至少有一个附件
         */
        public static final String HAS_ATTACHMENT = "has_attachment";//是否有附件

        /**
         * Folder's count of notes
         * <P> Type: INTEGER (long) </P>//文件夹内有多少个note
         */
        public static final String NOTES_COUNT = "notes_count";//文件夹中的便签数量

        /**
         * The file type: folder or note//文件类型:folder 或者 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";//后台任务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";//定义文件类型

        /**
         * 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 #MIMETYPE} specific, used for//根据MIME类型的不同，对应下面5个不同属性
         * integer data type
         * <P> Type: INTEGER </P>
         */
        public static final String DATA1 = "data1";//文本内容的数据结构

        /**
         * Generic data column, the meaning is {@link #MIMETYPE} specific, used for
         * integer data type
         * <P> Type: INTEGER </P>
         */
        public static final String DATA2 = "data2";//文本模式

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

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

        /**
         * Generic data column, the meaning is {@link #MIMETYPE} specific, used for
         * TEXT data type
         * <P> Type: TEXT </P>
         */
        public static final String DATA5 = "data5";
    }

    public static final class TextNote implements DataColumns {// 对DataColumns的实现，建立一个新的类，textNote用于保存相关的信息。
        /**
         * Mode to indicate the text in check list mode or not// 清单模式的MODE=0，正常模式的MODE=1
         * <P> Type: Integer 1:check list mode 0: normal mode </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";//内容的类型

        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 {//记录通话数据的表头
        /**
         * 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";

        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");//内容标识符
    }
}
