android-34/android/health/connect/datatypes/BasalMetabolicRateRecord.java

/*
 * Copyright (C) 2023 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.health.connect.datatypes;

import static android.health.connect.datatypes.RecordTypeIdentifier.RECORD_TYPE_BASAL_METABOLIC_RATE;

import android.annotation.NonNull;
import android.health.connect.HealthConnectManager;
import android.health.connect.datatypes.units.Energy;
import android.health.connect.datatypes.units.Power;
import android.health.connect.datatypes.validation.ValidationUtils;
import android.health.connect.internal.datatypes.BasalMetabolicRateRecordInternal;

import java.time.Instant;
import java.time.ZoneOffset;
import java.util.Objects;

/**
 * Captures the BMR of a user. Each record represents the energy a user would burn if at rest all
 * day, based on their height and weight.
 */
@Identifier(recordIdentifier = RecordTypeIdentifier.RECORD_TYPE_BASAL_METABOLIC_RATE)
public final class BasalMetabolicRateRecord extends InstantRecord {
    private final Power mBasalMetabolicRate;

    /**
     * @param metadata Metadata to be associated with the record. See {@link Metadata}.
     * @param time Start time of this activity
     * @param zoneOffset Zone offset of the user when the activity started
     * @param basalMetabolicRate BasalMetabolicRate of this activity
     * @param skipValidation Boolean flag to skip validation of record values.
     */
    private BasalMetabolicRateRecord(
            @NonNull Metadata metadata,
            @NonNull Instant time,
            @NonNull ZoneOffset zoneOffset,
            @NonNull Power basalMetabolicRate,
            boolean skipValidation) {
        super(metadata, time, zoneOffset, skipValidation);
        Objects.requireNonNull(metadata);
        Objects.requireNonNull(time);
        Objects.requireNonNull(zoneOffset);
        Objects.requireNonNull(basalMetabolicRate);
        if (!skipValidation) {
            ValidationUtils.requireInRange(
                    basalMetabolicRate.getInWatts(), 0.0, 484.259, "basalMetabolicRate");
        }
        mBasalMetabolicRate = basalMetabolicRate;
    }

    /**
     * @return basalMetabolicRate
     */
    @NonNull
    public Power getBasalMetabolicRate() {
        return mBasalMetabolicRate;
    }

    /**
     * Indicates whether some other object is "equal to" this one.
     *
     * @param o the reference object with which to compare.
     * @return {@code true} if this object is the same as the obj
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!super.equals(o)) return false;
        BasalMetabolicRateRecord that = (BasalMetabolicRateRecord) o;
        return getBasalMetabolicRate().equals(that.getBasalMetabolicRate());
    }

    /** Returns a hash code value for the object. */
    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), getBasalMetabolicRate());
    }

    /** Builder class for {@link BasalMetabolicRateRecord} */
    public static final class Builder {
        private final Metadata mMetadata;
        private final Instant mTime;
        private ZoneOffset mZoneOffset;
        private final Power mBasalMetabolicRate;

        /**
         * @param metadata Metadata to be associated with the record. See {@link Metadata}.
         * @param time Start time of this activity
         * @param basalMetabolicRate Basal metabolic rate, in {@link Power} unit. Required field.
         *     Valid range: 0-10000 kcal/day.
         */
        public Builder(
                @NonNull Metadata metadata,
                @NonNull Instant time,
                @NonNull Power basalMetabolicRate) {
            Objects.requireNonNull(metadata);
            Objects.requireNonNull(time);
            Objects.requireNonNull(basalMetabolicRate);
            mMetadata = metadata;
            mTime = time;
            mBasalMetabolicRate = basalMetabolicRate;
            mZoneOffset = ZoneOffset.systemDefault().getRules().getOffset(time);
        }

        /** Sets the zone offset of the user when the activity happened */
        @NonNull
        public Builder setZoneOffset(@NonNull ZoneOffset zoneOffset) {
            Objects.requireNonNull(zoneOffset);
            mZoneOffset = zoneOffset;
            return this;
        }

        /** Sets the zone offset of this record to system default. */
        @NonNull
        public Builder clearZoneOffset() {
            mZoneOffset = RecordUtils.getDefaultZoneOffset();
            return this;
        }

        /**
         * @return Object of {@link BasalMetabolicRateRecord} without validating the values.
         * @hide
         */
        @NonNull
        public BasalMetabolicRateRecord buildWithoutValidation() {
            return new BasalMetabolicRateRecord(
                    mMetadata, mTime, mZoneOffset, mBasalMetabolicRate, true);
        }

        /**
         * @return Object of {@link BasalMetabolicRateRecord}
         */
        @NonNull
        public BasalMetabolicRateRecord build() {
            return new BasalMetabolicRateRecord(
                    mMetadata, mTime, mZoneOffset, mBasalMetabolicRate, false);
        }
    }

    /**
     * Metric identifier get total basal calories burnt using aggregate APIs in {@link
     * HealthConnectManager}
     */
    @NonNull
    public static final AggregationType<Energy> BASAL_CALORIES_TOTAL =
            new AggregationType<>(
                    AggregationType.AggregationTypeIdentifier.BMR_RECORD_BASAL_CALORIES_TOTAL,
                    AggregationType.SUM,
                    RECORD_TYPE_BASAL_METABOLIC_RATE,
                    Energy.class);

    /** @hide */
    @Override
    public BasalMetabolicRateRecordInternal toRecordInternal() {
        BasalMetabolicRateRecordInternal recordInternal =
                (BasalMetabolicRateRecordInternal)
                        new BasalMetabolicRateRecordInternal()
                                .setUuid(getMetadata().getId())
                                .setPackageName(getMetadata().getDataOrigin().getPackageName())
                                .setLastModifiedTime(
                                        getMetadata().getLastModifiedTime().toEpochMilli())
                                .setClientRecordId(getMetadata().getClientRecordId())
                                .setClientRecordVersion(getMetadata().getClientRecordVersion())
                                .setManufacturer(getMetadata().getDevice().getManufacturer())
                                .setModel(getMetadata().getDevice().getModel())
                                .setDeviceType(getMetadata().getDevice().getType())
                                .setRecordingMethod(getMetadata().getRecordingMethod());
        recordInternal.setTime(getTime().toEpochMilli());
        recordInternal.setZoneOffset(getZoneOffset().getTotalSeconds());
        recordInternal.setBasalMetabolicRate(mBasalMetabolicRate.getInWatts());
        return recordInternal;
    }
}