Merge "Add support to index ShortcutInfo as GenericDocument"

/*

 * Copyright (C) 2021 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 android.content.pm;

import android.annotation.NonNull;

import android.annotation.Nullable;

import android.app.Person;

import android.app.appsearch.AppSearchSchema;

import android.app.appsearch.GenericDocument;

import android.net.UriCodec;

import com.android.internal.annotations.VisibleForTesting;

import java.nio.charset.StandardCharsets;

import java.util.Objects;

import java.util.UUID;

/**

 * @hide

 */

public class AppSearchPerson extends GenericDocument {

    /** The name of the schema type for {@link Person} documents.*/

    public static final String SCHEMA_TYPE = "Person";

    public static final String KEY_NAME = "name";

    public static final String KEY_KEY = "key";

    public static final String KEY_IS_BOT = "isBot";

    public static final String KEY_IS_IMPORTANT = "isImportant";

    private AppSearchPerson(@NonNull GenericDocument document) {

        super(document);

    }

    public static final AppSearchSchema SCHEMA = new AppSearchSchema.Builder(SCHEMA_TYPE)

            .addProperty(new AppSearchSchema.PropertyConfig.Builder(KEY_NAME)

                    .setDataType(AppSearchSchema.PropertyConfig.DATA_TYPE_STRING)

                    .setCardinality(AppSearchSchema.PropertyConfig.CARDINALITY_OPTIONAL)

                    .setTokenizerType(AppSearchSchema.PropertyConfig.TOKENIZER_TYPE_NONE)

                    .setIndexingType(AppSearchSchema.PropertyConfig.INDEXING_TYPE_NONE)

                    .build()

            ).addProperty(new AppSearchSchema.PropertyConfig.Builder(KEY_KEY)

                    .setDataType(AppSearchSchema.PropertyConfig.DATA_TYPE_STRING)

                    .setCardinality(AppSearchSchema.PropertyConfig.CARDINALITY_OPTIONAL)

                    .setTokenizerType(AppSearchSchema.PropertyConfig.TOKENIZER_TYPE_NONE)

                    .setIndexingType(AppSearchSchema.PropertyConfig.INDEXING_TYPE_NONE)

                    .build()

            ).addProperty(new AppSearchSchema.PropertyConfig.Builder(KEY_IS_BOT)

                    .setDataType(AppSearchSchema.PropertyConfig.DATA_TYPE_BOOLEAN)

                    .setCardinality(AppSearchSchema.PropertyConfig.CARDINALITY_REQUIRED)

                    .setTokenizerType(AppSearchSchema.PropertyConfig.TOKENIZER_TYPE_NONE)

                    .setIndexingType(AppSearchSchema.PropertyConfig.INDEXING_TYPE_NONE)

                    .build()

            ).addProperty(new AppSearchSchema.PropertyConfig.Builder(KEY_IS_IMPORTANT)

                    .setDataType(AppSearchSchema.PropertyConfig.DATA_TYPE_BOOLEAN)

                    .setCardinality(AppSearchSchema.PropertyConfig.CARDINALITY_REQUIRED)

                    .setTokenizerType(AppSearchSchema.PropertyConfig.TOKENIZER_TYPE_NONE)

                    .setIndexingType(AppSearchSchema.PropertyConfig.INDEXING_TYPE_NONE)

                    .build()

            ).build();

    /** hide */

    @NonNull

    public static AppSearchPerson instance(@NonNull final Person person) {

        Objects.requireNonNull(person);

        final String id;

        if (person.getUri() != null) {

            id = person.getUri();

        } else {

            // NOTE: an identifier is required even when uri is null.

            id = UUID.randomUUID().toString();

        }

        return new Builder(id).setName(person.getName())

                .setKey(person.getKey()).setIsBot(person.isBot())

                .setIsImportant(person.isImportant()).build();

    }

    /** hide */

    @NonNull

    public Person toPerson() {

        String uri;

        try {

            uri = UriCodec.decode(

                    getUri(), false /* convertPlus */, StandardCharsets.UTF_8,

                    true /* throwOnFailure */);

        } catch (IllegalArgumentException e) {

            uri = null;

        }

        return new Person.Builder().setName(getPropertyString(KEY_NAME))

                .setUri(uri).setKey(getPropertyString(KEY_KEY))

                .setBot(getPropertyBoolean(KEY_IS_BOT))

                .setImportant(getPropertyBoolean(KEY_IS_IMPORTANT)).build();

    }

    /** @hide */

    @VisibleForTesting

    public static class Builder extends GenericDocument.Builder<Builder> {

        public Builder(@NonNull final String id) {

            super(id, SCHEMA_TYPE);

        }

        /** @hide */

        @NonNull

        public Builder setName(@Nullable final CharSequence name) {

            if (name != null) {

                setPropertyString(KEY_NAME, name.toString());

            }

            return this;

        }

        /** @hide */

        @NonNull

        public Builder setKey(@Nullable final String key) {

            if (key != null) {

                setPropertyString(KEY_KEY, key);

            }

            return this;

        }

        /** @hide */

        @NonNull

        public Builder setIsBot(final boolean isBot) {

            setPropertyBoolean(KEY_IS_BOT, isBot);

            return this;

        }

        /** @hide */

        @NonNull

        public Builder setIsImportant(final boolean isImportant) {

            setPropertyBoolean(KEY_IS_IMPORTANT, isImportant);

            return this;

        }

        @NonNull

        @Override

        public AppSearchPerson build() {

            return new AppSearchPerson(super.build());

        }

    }

}