MoneyWiseXAnalysisAccountAttr.java

/*
 * MoneyWise: Finance Application
 * Copyright 2012-2026. Tony Washer
 *
 * 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 io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.values;

import io.github.tonywasher.joceanus.metis.data.MetisDataType;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.base.MoneyWiseXAnalysisAttribute;
import io.github.tonywasher.joceanus.oceanus.resource.OceanusBundleId;

/**
 * AccountAttribute enumeration.
 */
public enum MoneyWiseXAnalysisAccountAttr
        implements MoneyWiseXAnalysisAttribute {
    /**
     * Local Currency Balance.
     */
    BALANCE,

    /**
     * Exchange Rate.
     */
    EXCHANGERATE,

    /**
     * Reported Valuation.
     */
    VALUATION,

    /**
     * Valuation Delta.
     */
    VALUEDELTA,

    /**
     * Deposit Rate.
     */
    DEPOSITRATE,

    /**
     * Maturity.
     */
    MATURITY;

    /**
     * The String name.
     */
    private String theName;

    @Override
    public String toString() {
        /* If we have not yet loaded the name */
        if (theName == null) {
            /* Load the name */
            theName = bundleIdForAttribute(this).getValue();
        }

        /* return the name */
        return theName;
    }

    @Override
    public boolean isPreserved() {
        return switch (this) {
            case BALANCE, MATURITY, DEPOSITRATE, EXCHANGERATE, VALUATION -> true;
            default -> false;
        };
    }

    @Override
    public MetisDataType getDataType() {
        return switch (this) {
            case DEPOSITRATE -> MetisDataType.RATE;
            case EXCHANGERATE -> MetisDataType.RATIO;
            case MATURITY -> MetisDataType.DATE;
            default -> MetisDataType.MONEY;
        };
    }

    /**
     * Obtain the resource bundleId for the attribute.
     *
     * @param pAttr the attribute
     * @return the resource bundleId
     */
    private static OceanusBundleId bundleIdForAttribute(final MoneyWiseXAnalysisAccountAttr pAttr) {
        return switch (pAttr) {
            case BALANCE -> MoneyWiseXAnalysisValuesResource.ACCOUNTATTR_BALANCE;
            case VALUATION -> MoneyWiseXAnalysisValuesResource.ACCOUNTATTR_VALUATION;
            case VALUEDELTA -> MoneyWiseXAnalysisValuesResource.ACCOUNTATTR_VALUEDELTA;
            case DEPOSITRATE -> MoneyWiseXAnalysisValuesResource.ACCOUNTATTR_DEPOSITRATE;
            case EXCHANGERATE -> MoneyWiseXAnalysisValuesResource.ACCOUNTATTR_EXCHANGERATE;
            case MATURITY -> MoneyWiseXAnalysisValuesResource.ACCOUNTATTR_MATURITY;
            default -> throw new IllegalArgumentException();
        };
    }
}