ParameterDriversList.java

  1. /* Copyright 2002-2024 CS GROUP
  2.  * Licensed to CS GROUP (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *   http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.orekit.utils;

  19. import java.util.ArrayList;
  20. import java.util.Collections;
  21. import java.util.Comparator;
  22. import java.util.Iterator;
  23. import java.util.List;

  25. import org.orekit.time.AbsoluteDate;
  26. import org.orekit.utils.TimeSpanMap.Span;


  29. /** Class managing several {@link ParameterDriver parameter drivers},
  30.  * taking care of duplicated names.
  31.  * <p>
  32.  * Once parameter drivers sharing the same name have been added to
  33.  * an instance of this class, they are permanently bound together and
  34.  * also bound to the {@link #getDrivers() delegating driver} that
  35.  * manages them. This means that if drivers {@code d1}, {@code d2}...
  36.  * {@code dn} are added to the list and both correspond to parameter
  37.  * name "P", then {@link #getDrivers()} will return a list containing
  38.  * a delegating driver {@code delegateD} for the same name "P".
  39.  * Afterwards, whenever either {@link ParameterDriver#setValue(double)}
  40.  * or {@link ParameterDriver#setReferenceDate(AbsoluteDate)} is called
  41.  * on any of the {@code n+1} instances {@code d1}, {@code d2}... {@code dn}
  42.  * or {@code delegateD}, the call will be automatically forwarded to the
  43.  * {@code n} remaining instances, hence ensuring they remain consistent
  44.  * with each other.
  45.  * </p>
  46.  * @author Luc Maisonobe
  47.  * @author Mélina Vanel
  48.  * @since 8.0
  49.  */
  50. public class ParameterDriversList {

  52.     /** Managed drivers. */
  53.     private final List<DelegatingDriver> delegating;

  55.     /** Creates an empty list.
  56.      */
  57.     public ParameterDriversList() {
  58.         this.delegating = new ArrayList<>();
  59.     }

  61.     /** Add a driver.
  62.      * <p>
  63.      * If the driver is already present, it will not be added.
  64.      * If another driver managing the same parameter is present,
  65.      * both drivers will be managed together, existing drivers
  66.      * being set to the value of the last driver added (i.e.
  67.      * each addition overrides the parameter value).
  68.      * </p>
  69.      * <p>
  70.      * Warning if a driver is added and a driver with the same name
  71.      * was already added before, they should have the same validity
  72.      * Period to avoid surprises. Whatever, all driver having
  73.      * same name will have their valueSpanMap, nameSpanMap and validity period
  74.      * overwritten with the last driver added attributes.
  75.      * </p>
  76.      * @param driver driver to add
  77.      */
  78.     public void add(final ParameterDriver driver) {

  80.         final DelegatingDriver existingHere = findByName(driver.getName());
  81.         final DelegatingDriver alreadyBound = getAssociatedDelegatingDriver(driver);

  83.         if (existingHere != null) {
  84.             if (alreadyBound != null) {
  85.                 // merge the two delegating drivers
  86.                 existingHere.merge(alreadyBound);
  87.             } else {
  88.                 // this is a new driver for an already managed parameter
  89.                 existingHere.add(driver);
  90.             }
  91.         } else {
  92.             if (alreadyBound != null) {
  93.                 // the driver is new here, but already bound to other drivers in other lists
  94.                 delegating.add(alreadyBound);
  95.                 alreadyBound.addOwner(this);
  96.             } else {
  97.                 // this is the first driver we have for this parameter name
  98.                 delegating.add(new DelegatingDriver(this, driver));
  99.             }
  100.         }

  102.     }

  104.     /** Get a {@link DelegatingDriver delegating driver} bound to a driver.
  105.      * @param driver driver to check
  106.      * @return a {@link DelegatingDriver delegating driver} bound to a driver, or
  107.      * null if this driver is not associated with any {@link DelegatingDriver delegating driver}
  108.      * @since 9.1
  109.      */
  110.     private DelegatingDriver getAssociatedDelegatingDriver(final ParameterDriver driver) {
  111.         for (final ParameterObserver observer : driver.getObservers()) {
  112.             if (observer instanceof ChangesForwarder) {
  113.                 return ((ChangesForwarder) observer).getDelegatingDriver();
  114.             }
  115.         }
  116.         return null;
  117.     }

  119.     /** Replace a {@link DelegatingDriver delegating driver}.
  120.      * @param oldDelegating delegating driver to replace
  121.      * @param newDelegating new delegating driver to use
  122.      * @since 10.1
  123.      */
  124.     private void replaceDelegating(final DelegatingDriver oldDelegating, final DelegatingDriver newDelegating) {
  125.         for (int i = 0; i < delegating.size(); ++i) {
  126.             if (delegating.get(i) == oldDelegating) {
  127.                 delegating.set(i, newDelegating);
  128.             }
  129.         }
  130.     }

  132.     /** Find  a {@link DelegatingDriver delegating driver} by name.
  133.      * @param name name to check
  134.      * @return a {@link DelegatingDriver delegating driver} managing this parameter name
  135.      * @since 9.1
  136.      */
  137.     public DelegatingDriver findByName(final String name) {
  138.         for (final DelegatingDriver d : delegating) {
  139.             if (d.getName().equals(name)) {
  140.                 return d;
  141.             }
  142.         }
  143.         return null;
  144.     }

  146.     /** Find  a {@link DelegatingDriver delegating driver} by name.
  147.      * @param name name to check
  148.      * @return a {@link DelegatingDriver delegating driver} managing this parameter name
  149.      * @since 9.1
  150.      */
  151.     public String findDelegatingSpanNameBySpanName(final String name) {
  152.         for (final DelegatingDriver d : delegating) {
  153.             for (Span<String> span = d.getNamesSpanMap().getFirstSpan(); span != null; span = span.next()) {
  154.                 if (span.getData().equals(name)) {
  155.                     return span.getData();
  156.                 }
  157.             }
  158.         }
  159.         return null;
  160.     }


  163.     /** Sort the parameters lexicographically.
  164.      */
  165.     public void sort() {
  166.         Collections.sort(delegating, new Comparator<DelegatingDriver>() {
  167.             /** {@inheritDoc} */
  168.             @Override
  169.             public int compare(final DelegatingDriver d1, final DelegatingDriver d2) {
  170.                 return d1.getName().compareTo(d2.getName());
  171.             }
  172.         });
  173.     }

  175.     /** Filter parameters to keep only one type of selection status.
  176.      * @param selected if true, only {@link ParameterDriver#isSelected()
  177.      * selected} parameters will be kept, the other ones will be removed
  178.      */
  179.     public void filter(final boolean selected) {
  180.         for (final Iterator<DelegatingDriver> iterator = delegating.iterator(); iterator.hasNext();) {
  181.             final DelegatingDriver delegatingDriver = iterator.next();
  182.             if (delegatingDriver.isSelected() != selected) {
  183.                 iterator.remove();
  184.                 delegatingDriver.removeOwner(this);
  185.             }
  186.         }
  187.     }

  189.     /** Get the number of parameters with different names.
  190.      * @return number of parameters with different names
  191.      */
  192.     public int getNbParams() {
  193.         return delegating.size();
  194.     }

  196.     /** Get the number of values to estimate for parameters with different names.
  197.      * @return number of values to estimate for parameters with different names
  198.      */
  199.     public int getNbValuesToEstimate() {
  200.         int nbValuesToEstimate = 0;
  201.         for (DelegatingDriver driver : delegating) {
  202.             nbValuesToEstimate += driver.getNbOfValues();
  203.         }
  204.         return nbValuesToEstimate;
  205.     }

  207.     /** Get delegating drivers for all parameters.
  208.      * <p>
  209.      * The delegating drivers are <em>not</em> the same as
  210.      * the drivers added to the list, but they delegate to them.
  211.      * </p>
  212.      * <p>
  213.      * All delegating drivers manage parameters with different names.
  214.      * </p>
  215.      * @return unmodifiable view of the list of delegating drivers
  216.      */
  217.     public List<DelegatingDriver> getDrivers() {
  218.         return Collections.unmodifiableList(delegating);
  219.     }

  221.     /** Specialized driver delegating to several other managing
  222.      * the same parameter name.
  223.      */
  224.     public static class DelegatingDriver extends ParameterDriver {

  226.         /** Lists owning this delegating driver. */
  227.         private final List<ParameterDriversList> owners;

  229.         /** Observer for propagating changes between all drivers. */
  230.         private ChangesForwarder forwarder;

  232.         /** Simple constructor.
  233.          * @param owner list owning this delegating driver
  234.          * @param driver first driver in the series
  235.          */
  236.         DelegatingDriver(final ParameterDriversList owner, final ParameterDriver driver) {
  237.             super(driver.getName(), driver.getNamesSpanMap(),
  238.                   driver.getValueSpanMap(), driver.getReferenceValue(),
  239.                   driver.getScale(), driver.getMinValue(), driver.getMaxValue());

  241.             owners = new ArrayList<>();
  242.             addOwner(owner);

  244.             setValueSpanMap(driver);
  245.             setReferenceDate(driver.getReferenceDate());
  246.             setSelected(driver.isSelected());

  248.             // set up a change forwarder observing both the raw driver and the delegating driver
  249.             this.forwarder = new ChangesForwarder(this, driver);
  250.             addObserver(forwarder);
  251.             driver.addObserver(forwarder);

  253.         }

  255.         /** Add an owner for this delegating driver.
  256.          * @param owner owner to add
  257.          */
  258.         void addOwner(final ParameterDriversList owner) {
  259.             owners.add(owner);
  260.         }

  262.         /** Remove one owner of this driver.
  263.          * @param owner owner to remove delegating driver from
  264.          * @since 10.1
  265.          */
  266.         private void removeOwner(final ParameterDriversList owner) {
  267.             for (final Iterator<ParameterDriversList> iterator = owners.iterator(); iterator.hasNext();) {
  268.                 if (iterator.next() == owner) {
  269.                     iterator.remove();
  270.                 }
  271.             }
  272.         }

  274.         /** Add a driver. Warning, by doing this operation
  275.          * all the delegated drivers present in the parameterDriverList
  276.          * will be overwritten with the attributes of the driver given
  277.          * in argument.
  278.          * <p>
  279.          * </p>
  280.          * Warning if a driver is added and a driver with the same name
  281.          * was already added before, they should have the same validity
  282.          * Period (that is to say that the {@link ParameterDriver#setPeriods}
  283.          * method should have been called with same arguments for all drivers
  284.          * having the same name) to avoid surprises. Whatever, all driver having
  285.          * same name will have their valueSpanMap, nameSpanMap and validity period
  286.          * overwritten with the last driver added attributes.
  287.          * @param driver driver to add
  288.          */
  289.         private void add(final ParameterDriver driver) {

  291.             setValueSpanMap(driver);
  292.             setReferenceDate(driver.getReferenceDate());

  294.             // if any of the drivers is selected, all must be selected
  295.             if (isSelected()) {
  296.                 driver.setSelected(true);
  297.             } else {
  298.                 setSelected(driver.isSelected());
  299.             }

  301.             driver.addObserver(forwarder);
  302.             forwarder.add(driver);

  304.         }

  306.         /** Merge another instance.
  307.          * <p>
  308.          * After merging, the other instance is merely empty and preserved
  309.          * only as a child of the current instance. Changes are therefore
  310.          * still forwarded to it, but it is itself not responsible anymore
  311.          * for forwarding change.
  312.          * <p>
  313.          * </p>
  314.          * Warning if a driver is added and a driver with the same name
  315.          * was already added before, they should have the same validity
  316.          * Period (that is to say that the {@link ParameterDriver#setPeriods}
  317.          * method should have been called with same arguments for all drivers
  318.          * having the same name) to avoid surprises. Whatever, all driver having
  319.          * same name will have their valueSpanMap, nameSpanMap and validity period
  320.          * overwritten with the last driver added attributes.
  321.          * </p>
  322.          * @param other instance to merge
  323.          */
  324.         private void merge(final DelegatingDriver other) {

  326.             if (other.forwarder == forwarder) {
  327.                 // we are attempting to merge an instance with either itself
  328.                 // or an already embedded one, just ignore the request
  329.                 return;
  330.             }

  332.             // synchronize parameter
  333.             setValueSpanMap(other);
  334.             //setValue(other.getValue());
  335.             setReferenceDate(other.getReferenceDate());
  336.             if (isSelected()) {
  337.                 other.setSelected(true);
  338.             } else {
  339.                 setSelected(other.isSelected());
  340.             }

  342.             // move around drivers
  343.             for (final ParameterDriver otherDriver : other.forwarder.getDrivers()) {
  344.                 // as drivers are added one at a time and always refer back to a single
  345.                 // DelegatingDriver (through the ChangesForwarder), they cannot be
  346.                 // referenced by two different DelegatingDriver. We can blindly move
  347.                 // around all drivers, there cannot be any duplicates
  348.                 forwarder.add(otherDriver);
  349.                 otherDriver.replaceObserver(other.forwarder, forwarder);
  350.             }

  352.             // forwarding is now delegated to current instance
  353.             other.replaceObserver(other.forwarder, forwarder);
  354.             other.forwarder = forwarder;

  356.             // replace merged instance with current instance in former owners
  357.             for (final ParameterDriversList otherOwner : other.owners) {
  358.                 owners.add(otherOwner);
  359.                 otherOwner.replaceDelegating(other, this);
  360.             }

  362.         }

  364.         /** Get the raw drivers to which this one delegates.
  365.          * <p>
  366.          * These raw drivers all manage the same parameter name.
  367.          * </p>
  368.          * @return raw drivers to which this one delegates
  369.          */
  370.         public List<ParameterDriver> getRawDrivers() {
  371.             return Collections.unmodifiableList(forwarder.getDrivers());
  372.         }

  374.     }

  376.     /** Local observer for propagating changes, avoiding infinite recursion. */
  377.     private static class ChangesForwarder implements ParameterObserver {

  379.         /** DelegatingDriver we are associated with. */
  380.         private final DelegatingDriver delegating;

  382.         /** Drivers synchronized together by the instance. */
  383.         private final List<ParameterDriver> drivers;

  385.         /** Root of the current update chain. */
  386.         private ParameterDriver root;

  388.         /** Depth of the current update chain. */
  389.         private int depth;

  391.         /** Simple constructor.
  392.          * @param delegating delegatingDriver we are associated with
  393.          * @param driver first driver in the series
  394.          */
  395.         ChangesForwarder(final DelegatingDriver delegating, final ParameterDriver driver) {
  396.             this.delegating = delegating;
  397.             this.drivers    = new ArrayList<>();
  398.             drivers.add(driver);
  399.         }

  401.         /** Get the {@link DelegatingDriver} associated with this instance.
  402.          * @return {@link DelegatingDriver} associated with this instance
  403.          * @since 9.1
  404.          */
  405.         DelegatingDriver getDelegatingDriver() {
  406.             return delegating;
  407.         }

  409.         /** Add a driver to the list synchronized together by the instance.
  410.          * @param driver driver to add
  411.          * @since 10.1
  412.          */
  413.         void add(final ParameterDriver driver) {
  414.             drivers.add(driver);
  415.         }

  417.         /** Get the drivers synchronized together by the instance.
  418.          * @return drivers synchronized together by the instance.
  419.          * @since 10.1
  420.          */
  421.         public List<ParameterDriver> getDrivers() {
  422.             return drivers;
  423.         }

  425.         /** {@inheritDoc} */
  426.         @Override
  427.         public void valueSpanMapChanged(final TimeSpanMap<Double> previousValueSpanMap, final ParameterDriver driver) {
  428.             updateAll(driver, d -> d.setValueSpanMap(driver));
  429.         }

  431.         /** {@inheritDoc} */
  432.         @Override
  433.         public void valueChanged(final double previousValue, final ParameterDriver driver, final AbsoluteDate date) {
  434.             updateAll(driver, d -> d.setValue(driver.getValue(date), date));
  435.         }

  437.         /** {@inheritDoc} */
  438.         @Override
  439.         public void referenceDateChanged(final AbsoluteDate previousReferenceDate, final ParameterDriver driver) {
  440.             updateAll(driver, d -> d.setReferenceDate(driver.getReferenceDate()));
  441.         }

  443.         /** {@inheritDoc} */
  444.         @Override
  445.         public void nameChanged(final String previousName, final ParameterDriver driver) {
  446.             updateAll(driver, d -> d.setName(driver.getName()));
  447.         }

  449.         /** {@inheritDoc} */
  450.         @Override
  451.         public void selectionChanged(final boolean previousSelection, final ParameterDriver driver) {
  452.             updateAll(driver, d -> d.setSelected(driver.isSelected()));
  453.         }

  455.         /** {@inheritDoc} */
  456.         @Override
  457.         public void estimationTypeChanged(final boolean previousSelection, final ParameterDriver driver) {
  458.             updateAll(driver, d -> d.setContinuousEstimation(driver.isContinuousEstimation()));
  459.         }

  461.         /** {@inheritDoc} */
  462.         @Override
  463.         public void referenceValueChanged(final double previousReferenceValue, final ParameterDriver driver) {
  464.             updateAll(driver, d -> d.setReferenceValue(driver.getReferenceValue()));
  465.         }

  467.         /** {@inheritDoc} */
  468.         @Override
  469.         public void minValueChanged(final double previousMinValue, final ParameterDriver driver) {
  470.             updateAll(driver, d -> d.setMinValue(driver.getMinValue()));
  471.         }

  473.         /** {@inheritDoc} */
  474.         @Override
  475.         public void maxValueChanged(final double previousMaxValue, final ParameterDriver driver) {
  476.             updateAll(driver, d -> d.setMaxValue(driver.getMaxValue()));
  477.         }

  479.         /** {@inheritDoc} */
  480.         @Override
  481.         public void scaleChanged(final double previousScale, final ParameterDriver driver) {
  482.             updateAll(driver, d -> d.setScale(driver.getScale()));
  483.         }

  485.         /** Update all bound parameters.
  486.          * @param driver driver triggering the update
  487.          * @param updater updater to use
  488.          */
  489.         private void updateAll(final ParameterDriver driver, final Updater updater) {

  491.             final boolean firstCall = depth++ == 0;
  492.             if (firstCall) {
  493.                 root = driver;
  494.             }

  496.             if (driver == getDelegatingDriver()) {
  497.                 // propagate change downwards, which will trigger recursive calls
  498.                 for (final ParameterDriver d : drivers) {
  499.                     if (d != root) {
  500.                         updater.update(d);
  501.                     }
  502.                 }
  503.             } else if (firstCall) {
  504.                 // first call started from an underlying driver, propagate change upwards
  505.                 updater.update(getDelegatingDriver());
  506.             }

  508.             if (--depth == 0) {
  509.                 // this is the end of the root call
  510.                 root = null;
  511.             }

  513.         }

  515.     }

  517.     /** Interface for updating parameters. */
  518.     @FunctionalInterface
  519.     private interface Updater {
  520.         /** Update a driver.
  521.          * @param driver driver to update
  522.          */
  523.         void update(ParameterDriver driver);
  524.     }

  526. }
Created with JaCoCo 0.8.12.202403310830