MoneyWiseAnalysisSecurityPriceCursor.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.lethe.data.analysis.data;

import io.github.tonywasher.joceanus.oceanus.date.OceanusDate;
import io.github.tonywasher.joceanus.oceanus.decimal.OceanusPrice;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseDataSet;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseSecurity;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseSecurityPrice;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseSecurityPrice.MoneyWiseSecurityPriceDataMap;
import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataInstanceMap;

import java.util.Currency;
import java.util.HashMap;
import java.util.ListIterator;
import java.util.Map;

/**
 * Quick access to dated security Prices on an analysis pass.
 */
public class MoneyWiseAnalysisSecurityPriceCursor {
    /**
     * SecurityPrice data map.
     */
    private final MoneyWiseSecurityPriceDataMap theDataMap;

    /**
     * Cursor map.
     */
    private final Map<MoneyWiseSecurity, MoneyWiseSecurityCursor> theCursorMap;

    /**
     * Constructor.
     *
     * @param pData the dataSet
     */
    protected MoneyWiseAnalysisSecurityPriceCursor(final MoneyWiseDataSet pData) {
        /* Obtain the data map */
        theDataMap = pData.getSecurityPriceDataMap();

        /* Create the cursor map */
        theCursorMap = new HashMap<>();
    }

    /**
     * Obtain price for security and date.
     *
     * @param pSecurity the security
     * @param pDate     the date
     * @return the security price
     */
    public OceanusPrice getSecurityPrice(final MoneyWiseSecurity pSecurity,
                                         final OceanusDate pDate) {
        /* Access cursor and return rate */
        final MoneyWiseSecurityCursor myCursor = getCursor(pSecurity);
        return myCursor.getSecurityPrice(pDate);
    }

    /**
     * Obtain security cursor.
     *
     * @param pSecurity the security
     * @return the cursor
     */
    private MoneyWiseSecurityCursor getCursor(final MoneyWiseSecurity pSecurity) {
        /* Look for existing cursor */
        MoneyWiseSecurityCursor myCursor = theCursorMap.get(pSecurity);

        /* If we do not have a cursor */
        if (myCursor == null) {
            /* Allocate new cursor */
            myCursor = new MoneyWiseSecurityCursor(pSecurity);
            theCursorMap.put(pSecurity, myCursor);
        }

        /* return the cursor */
        return myCursor;
    }

    /**
     * Security Cursor class.
     */
    private final class MoneyWiseSecurityCursor {
        /**
         * SecurityPrice iterator.
         */
        private final ListIterator<MoneyWiseSecurityPrice> theIterator;

        /**
         * The current price.
         */
        private OceanusPrice theCurrent;

        /**
         * The next date.
         */
        private OceanusDate theNextDate;

        /**
         * The next price.
         */
        private OceanusPrice theNextPrice;

        /**
         * Constructor.
         *
         * @param pSecurity the security
         */
        private MoneyWiseSecurityCursor(final MoneyWiseSecurity pSecurity) {
            /* Create the default price */
            final Currency myCurrency = pSecurity.getCurrency();
            theCurrent = OceanusPrice.getWholeUnits(PrometheusDataInstanceMap.ONE, myCurrency);

            /* Access the Price list */
            theIterator = theDataMap.priceIterator(pSecurity);

            /* If we have an iterator */
            if (theIterator != null) {
                /* move the cursor */
                moveCursor();
            }
        }

        /**
         * Move the cursor.
         */
        private void moveCursor() {
            /* If we have an iterator */
            if (theIterator.hasPrevious()) {
                /* access next rate and record */
                final MoneyWiseSecurityPrice myPrice = theIterator.previous();
                theNextPrice = myPrice.getPrice();
                theNextDate = myPrice.getDate();
            } else {
                theNextDate = null;
                theNextPrice = null;
            }
        }

        /**
         * Obtain security price for date.
         *
         * @param pDate the date
         * @return the security price
         */
        private OceanusPrice getSecurityPrice(final OceanusDate pDate) {
            /* if we have a later price */
            if (theNextDate != null) {
                /* while we need to move the cursor */
                while (pDate.compareTo(theNextDate) >= 0) {
                    /* store price */
                    theCurrent = theNextPrice;

                    /* move the cursor */
                    moveCursor();
                }
            }

            /* Return the price */
            return theCurrent;
        }
    }
}