src/com/android/ondevicepersonalization/services/data/user/UserDataTables.java

/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * 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 com.android.ondevicepersonalization.services.data.user;

import android.provider.BaseColumns;

/** Container class for definitions and constants of user data tables. */
public final class UserDataTables implements BaseColumns {
    public static final String USER_TABLE_PREFIX = "user_";
    public static final String INDEX_PREFIX = "index_";

    /** Location history table. */
    public static class LocationHistory implements BaseColumns {
        /** The name of location history table. */
        public static final String TABLE_NAME = USER_TABLE_PREFIX + "location_history";

        /** The name of location history index. */
        public static final String INDEX_NAME = INDEX_PREFIX + TABLE_NAME;

        /** The time that the location is retrieved in seconds. */
        public static final String TIME_SEC = "time_sec";

        /** The latitude of the location in the format of "[+-]DDD.DDDDD". */
        public static final String LATITUDE = "latitude";

        /** The Longitude of the location in the format of "[+-]DDD.DDDDD". */
        public static final String LONGITUDE = "longitude";

        /** The source of location signal. */
        public static final String SOURCE = "source";

        /** Is the location accuracy precise or coarse. */
        public static final String IS_PRECISE = "is_precise";

        public static final String CREATE_TABLE_STATEMENT = "CREATE TABLE IF NOT EXISTS "
                + TABLE_NAME + " ("
                + _ID + " INTEGER PRIMARY KEY, "
                + TIME_SEC + " INTEGER NOT NULL, "
                + LATITUDE + " TEXT NOT NULL, "
                + LONGITUDE + " TEXT NOT NULL, "
                + SOURCE + " INTEGER NOT NULL, "
                + IS_PRECISE + " INTEGER NOT NULL)";

        public static final String CREATE_INDEXES_STATEMENT = "CREATE INDEX IF NOT EXISTS "
                + INDEX_NAME + " ON "
                + TABLE_NAME + "("
                + TIME_SEC + ")";
    }

    /** App usage stats history table. */
    public static class AppUsageHistory implements BaseColumns {
        /** The name of app usage stats table. */
        public static final String TABLE_NAME = USER_TABLE_PREFIX + "app_usage_history";

        /** The package/app name of a usage activity. */
        public static final String PACKAGE_NAME = "package_name";

        /** Activity starting time of the app in seconds. */
        public static final String STARTING_TIME_SEC = "starting_time_sec";

        /** Activity ending time of the app in seconds. */
        public static final String ENDING_TIME_SEC = "ending_time_sec";

        /** Total activity time (on the foreground) of the app in seconds. */
        public static final String TOTAL_TIME_USED_SEC = "total_time_used_sec";

        /** The index name of app usage stats table based on starting timestamp. */
        public static final String STARTING_TIME_SEC_INDEX_NAME = INDEX_PREFIX
                + TABLE_NAME + STARTING_TIME_SEC;

        /** The index name of app usage stats table based on ending timestamp. */
        public static final String ENDING_TIME_SEC_INDEX_NAME = INDEX_PREFIX
                + TABLE_NAME + ENDING_TIME_SEC;

        /** The index name of app usage stats table based on total time spent. */
        public static final String TOTAL_TIME_USED_SEC_INDEX_NAME = INDEX_PREFIX
                + TABLE_NAME + TOTAL_TIME_USED_SEC;

        public static final String CREATE_TABLE_STATEMENT = "CREATE TABLE IF NOT EXISTS "
                + TABLE_NAME + " ("
                + _ID + " INTEGER PRIMARY KEY, "
                + PACKAGE_NAME + " TEXT NOT NULL, "
                + STARTING_TIME_SEC + " INTEGER NOT NULL, "
                + ENDING_TIME_SEC + " INTEGER NOT NULL, "
                + TOTAL_TIME_USED_SEC + " INTEGER NOT NULL)";

        // All timestamp-related fields could be of interests of FA queries.
        public static final String CREATE_STARTING_TIME_SEC_INDEX_STATEMENT =
                "CREATE INDEX IF NOT EXISTS "
                + STARTING_TIME_SEC_INDEX_NAME + " ON "
                + TABLE_NAME + "("
                + STARTING_TIME_SEC + ")";

        public static final String CREATE_ENDING_TIME_SEC_INDEX_STATEMENT =
                "CREATE INDEX IF NOT EXISTS "
                + ENDING_TIME_SEC_INDEX_NAME + " ON "
                + TABLE_NAME + "("
                + ENDING_TIME_SEC + ")";

        public static final String CREATE_TOTAL_TIME_USED_SEC_INDEX_STATEMENT =
                "CREATE INDEX IF NOT EXISTS "
                + TOTAL_TIME_USED_SEC_INDEX_NAME + " ON "
                + TABLE_NAME + "("
                + TOTAL_TIME_USED_SEC + ")";
    }

    // Private constructor to prevent instantiation.
    private UserDataTables() {}
}