RapidDataAndPredictionXMLLoader.java

  1. /* Copyright 2002-2022 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.frames;

  19. import java.io.IOException;
  20. import java.io.InputStream;
  21. import java.io.InputStreamReader;
  22. import java.nio.charset.StandardCharsets;
  23. import java.util.ArrayList;
  24. import java.util.Collection;
  25. import java.util.List;
  26. import java.util.SortedSet;
  27. import java.util.function.Supplier;

  29. import javax.xml.parsers.ParserConfigurationException;
  30. import javax.xml.parsers.SAXParser;
  31. import javax.xml.parsers.SAXParserFactory;

  33. import org.hipparchus.exception.LocalizedCoreFormats;
  34. import org.orekit.data.DataProvidersManager;
  35. import org.orekit.errors.OrekitException;
  36. import org.orekit.errors.OrekitMessages;
  37. import org.orekit.time.AbsoluteDate;
  38. import org.orekit.time.DateComponents;
  39. import org.orekit.time.TimeScale;
  40. import org.orekit.utils.IERSConventions;
  41. import org.orekit.utils.units.Unit;
  42. import org.xml.sax.Attributes;
  43. import org.xml.sax.InputSource;
  44. import org.xml.sax.SAXException;
  45. import org.xml.sax.helpers.DefaultHandler;

  47. /** Loader for IERS rapid data and prediction file in XML format (finals file).
  48.  * <p>Rapid data and prediction file contain {@link EOPEntry
  49.  * Earth Orientation Parameters} for several years periods, in one file
  50.  * only that is updated regularly.</p>
  51.  * <p>The XML EOP files are recognized thanks to their base names, which
  52.  * must match one of the the patterns <code>finals.2000A.*.xml</code> or
  53.  * <code>finals.*.xml</code> (or the same ending with <code>.gz</code> for
  54.  * gzip-compressed files) where * stands for a word like "all", "daily",
  55.  * or "data".</p>
  56.  * <p>Files containing data (back to 1973) are available at IERS web site: <a
  57.  * href="http://www.iers.org/IERS/EN/DataProducts/EarthOrientationData/eop.html">Earth orientation data</a>.</p>
  58.  * <p>
  59.  * This class is immutable and hence thread-safe
  60.  * </p>
  61.  * @author Luc Maisonobe
  62.  */
  63. class RapidDataAndPredictionXMLLoader extends AbstractEopLoader
  64.         implements EOPHistoryLoader {

  66.     /** Millisecond unit. */
  67.     private static final Unit MILLI_SECOND = Unit.parse("ms");

  69.     /** Milli arcsecond unit. */
  70.     private static final Unit MILLI_ARC_SECOND = Unit.parse("mas");

  72.     /**
  73.      * Build a loader for IERS XML EOP files.
  74.      *
  75.      * @param supportedNames regular expression for supported files names
  76.      * @param manager        provides access to the XML EOP files.
  77.      * @param utcSupplier    UTC time scale.
  78.      */
  79.     RapidDataAndPredictionXMLLoader(final String supportedNames,
  80.                                     final DataProvidersManager manager,
  81.                                     final Supplier<TimeScale> utcSupplier) {
  82.         super(supportedNames, manager, utcSupplier);
  83.     }

  85.     /** {@inheritDoc} */
  86.     public void fillHistory(final IERSConventions.NutationCorrectionConverter converter,
  87.                             final SortedSet<EOPEntry> history) {
  88.         final ItrfVersionProvider itrfVersionProvider = new ITRFVersionLoader(
  89.                 ITRFVersionLoader.SUPPORTED_NAMES,
  90.                 getDataProvidersManager());
  91.         final Parser parser = new Parser(converter, itrfVersionProvider, getUtc());
  92.         final EopParserLoader loader = new EopParserLoader(parser);
  93.         this.feed(loader);
  94.         history.addAll(loader.getEop());
  95.     }

  97.     /** Internal class performing the parsing. */
  98.     static class Parser extends AbstractEopParser {

  100.         /** History entries. */
  101.         private List<EOPEntry> history;

  103.         /**
  104.          * Simple constructor.
  105.          *
  106.          * @param converter           converter to use
  107.          * @param itrfVersionProvider to use for determining the ITRF version of the EOP.
  108.          * @param utc                 time scale for parsing dates.
  109.          */
  110.         Parser(final IERSConventions.NutationCorrectionConverter converter,
  111.                final ItrfVersionProvider itrfVersionProvider,
  112.                final TimeScale utc) {
  113.             super(converter, itrfVersionProvider, utc);
  114.         }

  116.         /** {@inheritDoc} */
  117.         @Override
  118.         public Collection<EOPEntry> parse(final InputStream input, final String name)
  119.             throws IOException, OrekitException {
  120.             try {
  121.                 this.history = new ArrayList<>();
  122.                 // set up a parser for line-oriented bulletin B files
  123.                 final SAXParser parser = SAXParserFactory.newInstance().newSAXParser();

  125.                 // read all file, ignoring header
  126.                 parser.parse(new InputSource(new InputStreamReader(input, StandardCharsets.UTF_8)),
  127.                              new EOPContentHandler(name));

  129.                 return history;

  131.             } catch (SAXException | ParserConfigurationException e) {
  132.                 throw new OrekitException(e, LocalizedCoreFormats.SIMPLE_MESSAGE, e.getMessage());
  133.             }
  134.         }

  136.         /** Local content handler for XML EOP files. */
  137.         private class EOPContentHandler extends DefaultHandler {

  139.             // CHECKSTYLE: stop JavadocVariable check

  141.             // elements and attributes used in both daily and finals data files
  142.             private static final String MJD_ELT           = "MJD";
  143.             private static final String LOD_ELT           = "LOD";
  144.             private static final String X_ELT             = "X";
  145.             private static final String Y_ELT             = "Y";
  146.             private static final String DPSI_ELT          = "dPsi";
  147.             private static final String DEPSILON_ELT      = "dEpsilon";
  148.             private static final String DX_ELT            = "dX";
  149.             private static final String DY_ELT            = "dY";

  151.             // elements and attributes specific to daily data files
  152.             private static final String DATA_EOP_ELT      = "dataEOP";
  153.             private static final String TIME_SERIES_ELT   = "timeSeries";
  154.             private static final String DATE_YEAR_ELT     = "dateYear";
  155.             private static final String DATE_MONTH_ELT    = "dateMonth";
  156.             private static final String DATE_DAY_ELT      = "dateDay";
  157.             private static final String POLE_ELT          = "pole";
  158.             private static final String UT_ELT            = "UT";
  159.             private static final String UT1_U_UTC_ELT     = "UT1_UTC";
  160.             private static final String NUTATION_ELT      = "nutation";
  161.             private static final String SOURCE_ATTR       = "source";
  162.             private static final String BULLETIN_A_SOURCE = "BulletinA";

  164.             // elements and attributes specific to finals data files
  165.             private static final String FINALS_ELT        = "Finals";
  166.             private static final String DATE_ELT          = "date";
  167.             private static final String EOP_SET_ELT       = "EOPSet";
  168.             private static final String BULLETIN_A_ELT    = "bulletinA";
  169.             private static final String UT1_M_UTC_ELT     = "UT1-UTC";

  171.             private boolean inBulletinA;
  172.             private int     year;
  173.             private int     month;
  174.             private int     day;
  175.             private int     mjd;
  176.             private AbsoluteDate mjdDate;
  177.             private double  dtu1;
  178.             private double  lod;
  179.             private double  x;
  180.             private double  y;
  181.             private double  dpsi;
  182.             private double  deps;
  183.             private double  dx;
  184.             private double  dy;

  186.             // CHECKSTYLE: resume JavadocVariable check

  188.             /** File name. */
  189.             private final String name;

  191.             /** Buffer for read characters. */
  192.             private final StringBuilder buffer;

  194.             /** Indicator for daily data XML format or final data XML format. */
  195.             private DataFileContent content;

  197.             /** ITRF version configuration. */
  198.             private ITRFVersionLoader.ITRFVersionConfiguration configuration;

  200.             /** Simple constructor.
  201.              * @param name file name
  202.              */
  203.             EOPContentHandler(final String name) {
  204.                 this.name   = name;
  205.                 this.buffer = new StringBuilder();
  206.             }

  208.             /** {@inheritDoc} */
  209.             @Override
  210.             public void startDocument() {
  211.                 content       = DataFileContent.UNKNOWN;
  212.                 configuration = null;
  213.             }

  215.             /** {@inheritDoc} */
  216.             @Override
  217.             public void characters(final char[] ch, final int start, final int length) {
  218.                 buffer.append(ch, start, length);
  219.             }

  221.             /** {@inheritDoc} */
  222.             @Override
  223.             public void startElement(final String uri, final String localName,
  224.                                      final String qName, final Attributes atts) {

  226.                 // reset the buffer to empty
  227.                 buffer.delete(0, buffer.length());

  229.                 if (content == DataFileContent.UNKNOWN) {
  230.                     // try to identify file content
  231.                     if (qName.equals(TIME_SERIES_ELT)) {
  232.                         // the file contains final data
  233.                         content = DataFileContent.DAILY;
  234.                     } else if (qName.equals(FINALS_ELT)) {
  235.                         // the file contains final data
  236.                         content = DataFileContent.FINAL;
  237.                     }
  238.                 }

  240.                 if (content == DataFileContent.DAILY) {
  241.                     startDailyElement(qName, atts);
  242.                 } else if (content == DataFileContent.FINAL) {
  243.                     startFinalElement(qName);
  244.                 }

  246.             }

  248.             /** Handle end of an element in a daily data file.
  249.              * @param qName name of the element
  250.              * @param atts element attributes
  251.              */
  252.             private void startDailyElement(final String qName, final Attributes atts) {
  253.                 if (qName.equals(TIME_SERIES_ELT)) {
  254.                     // reset EOP data
  255.                     resetEOPData();
  256.                 } else if (qName.equals(POLE_ELT) || qName.equals(UT_ELT) || qName.equals(NUTATION_ELT)) {
  257.                     final String source = atts.getValue(SOURCE_ATTR);
  258.                     if (source != null) {
  259.                         inBulletinA = source.equals(BULLETIN_A_SOURCE);
  260.                     }
  261.                 }
  262.             }

  264.             /** Handle end of an element in a final data file.
  265.              * @param qName name of the element
  266.              */
  267.             private void startFinalElement(final String qName) {
  268.                 if (qName.equals(EOP_SET_ELT)) {
  269.                     // reset EOP data
  270.                     resetEOPData();
  271.                 } else if (qName.equals(BULLETIN_A_ELT)) {
  272.                     inBulletinA = true;
  273.                 }
  274.             }

  276.             /** Reset EOP data.
  277.              */
  278.             private void resetEOPData() {
  279.                 inBulletinA = false;
  280.                 year        = -1;
  281.                 month       = -1;
  282.                 day         = -1;
  283.                 mjd         = -1;
  284.                 mjdDate     = null;
  285.                 dtu1        = Double.NaN;
  286.                 lod         = Double.NaN;
  287.                 x           = Double.NaN;
  288.                 y           = Double.NaN;
  289.                 dpsi        = Double.NaN;
  290.                 deps        = Double.NaN;
  291.                 dx          = Double.NaN;
  292.                 dy          = Double.NaN;
  293.             }

  295.             /** {@inheritDoc} */
  296.             @Override
  297.             public void endElement(final String uri, final String localName, final String qName) {
  298.                 if (content == DataFileContent.DAILY) {
  299.                     endDailyElement(qName);
  300.                 } else if (content == DataFileContent.FINAL) {
  301.                     endFinalElement(qName);
  302.                 }
  303.             }

  305.             /** Handle end of an element in a daily data file.
  306.              * @param qName name of the element
  307.              */
  308.             private void endDailyElement(final String qName) {
  309.                 if (qName.equals(DATE_YEAR_ELT) && buffer.length() > 0) {
  310.                     year = Integer.parseInt(buffer.toString());
  311.                 } else if (qName.equals(DATE_MONTH_ELT) && buffer.length() > 0) {
  312.                     month = Integer.parseInt(buffer.toString());
  313.                 } else if (qName.equals(DATE_DAY_ELT) && buffer.length() > 0) {
  314.                     day = Integer.parseInt(buffer.toString());
  315.                 } else if (qName.equals(MJD_ELT) && buffer.length() > 0) {
  316.                     mjd     = Integer.parseInt(buffer.toString());
  317.                     mjdDate = new AbsoluteDate(new DateComponents(DateComponents.MODIFIED_JULIAN_EPOCH, mjd),
  318.                                                getUtc());
  319.                 } else if (qName.equals(UT1_M_UTC_ELT)) {
  320.                     dtu1 = overwrite(dtu1, Unit.SECOND);
  321.                 } else if (qName.equals(LOD_ELT)) {
  322.                     lod = overwrite(lod, MILLI_SECOND);
  323.                 } else if (qName.equals(X_ELT)) {
  324.                     x = overwrite(x, Unit.ARC_SECOND);
  325.                 } else if (qName.equals(Y_ELT)) {
  326.                     y = overwrite(y, Unit.ARC_SECOND);
  327.                 } else if (qName.equals(DPSI_ELT)) {
  328.                     dpsi = overwrite(dpsi, MILLI_ARC_SECOND);
  329.                 } else if (qName.equals(DEPSILON_ELT)) {
  330.                     deps = overwrite(deps, MILLI_ARC_SECOND);
  331.                 } else if (qName.equals(DX_ELT)) {
  332.                     dx   = overwrite(dx, MILLI_ARC_SECOND);
  333.                 } else if (qName.equals(DY_ELT)) {
  334.                     dy   = overwrite(dy, MILLI_ARC_SECOND);
  335.                 } else if (qName.equals(POLE_ELT) || qName.equals(UT_ELT) || qName.equals(NUTATION_ELT)) {
  336.                     inBulletinA = false;
  337.                 } else if (qName.equals(DATA_EOP_ELT)) {
  338.                     checkDates();
  339.                     if (!Double.isNaN(dtu1) && !Double.isNaN(lod) && !Double.isNaN(x) && !Double.isNaN(y)) {
  340.                         final double[] equinox;
  341.                         final double[] nro;
  342.                         if (Double.isNaN(dpsi)) {
  343.                             nro = new double[] {
  344.                                 dx, dy
  345.                             };
  346.                             equinox = getConverter().toEquinox(mjdDate, nro[0], nro[1]);
  347.                         } else {
  348.                             equinox = new double[] {
  349.                                 dpsi, deps
  350.                             };
  351.                             nro = getConverter().toNonRotating(mjdDate, equinox[0], equinox[1]);
  352.                         }
  353.                         if (configuration == null || !configuration.isValid(mjd)) {
  354.                             // get a configuration for current name and date range
  355.                             configuration = getItrfVersionProvider().getConfiguration(name, mjd);
  356.                         }
  357.                         history.add(new EOPEntry(mjd, dtu1, lod, x, y, equinox[0], equinox[1], nro[0], nro[1],
  358.                                                  configuration.getVersion(), mjdDate));
  359.                     }
  360.                 }
  361.             }

  363.             /** Handle end of an element in a final data file.
  364.              * @param qName name of the element
  365.              */
  366.             private void endFinalElement(final String qName) {
  367.                 if (qName.equals(DATE_ELT) && buffer.length() > 0) {
  368.                     final String[] fields = buffer.toString().split("-");
  369.                     if (fields.length == 3) {
  370.                         year  = Integer.parseInt(fields[0]);
  371.                         month = Integer.parseInt(fields[1]);
  372.                         day   = Integer.parseInt(fields[2]);
  373.                     }
  374.                 } else if (qName.equals(MJD_ELT) && buffer.length() > 0) {
  375.                     mjd     = Integer.parseInt(buffer.toString());
  376.                     mjdDate = new AbsoluteDate(new DateComponents(DateComponents.MODIFIED_JULIAN_EPOCH, mjd),
  377.                                                getUtc());
  378.                 } else if (qName.equals(UT1_U_UTC_ELT)) {
  379.                     dtu1 = overwrite(dtu1, Unit.SECOND);
  380.                 } else if (qName.equals(LOD_ELT)) {
  381.                     lod = overwrite(lod, MILLI_SECOND);
  382.                 } else if (qName.equals(X_ELT)) {
  383.                     x = overwrite(x, Unit.ARC_SECOND);
  384.                 } else if (qName.equals(Y_ELT)) {
  385.                     y = overwrite(y, Unit.ARC_SECOND);
  386.                 } else if (qName.equals(DPSI_ELT)) {
  387.                     dpsi = overwrite(dpsi, MILLI_ARC_SECOND);
  388.                 } else if (qName.equals(DEPSILON_ELT)) {
  389.                     deps = overwrite(deps, MILLI_ARC_SECOND);
  390.                 } else if (qName.equals(DX_ELT)) {
  391.                     dx   = overwrite(dx, MILLI_ARC_SECOND);
  392.                 } else if (qName.equals(DY_ELT)) {
  393.                     dy   = overwrite(dy, MILLI_ARC_SECOND);
  394.                 } else if (qName.equals(BULLETIN_A_ELT)) {
  395.                     inBulletinA = false;
  396.                 } else if (qName.equals(EOP_SET_ELT)) {
  397.                     checkDates();
  398.                     if (!Double.isNaN(dtu1) && !Double.isNaN(lod) && !Double.isNaN(x) && !Double.isNaN(y)) {
  399.                         final double[] equinox;
  400.                         final double[] nro;
  401.                         if (Double.isNaN(dpsi)) {
  402.                             nro = new double[] {
  403.                                 dx, dy
  404.                             };
  405.                             equinox = getConverter().toEquinox(mjdDate, nro[0], nro[1]);
  406.                         } else {
  407.                             equinox = new double[] {
  408.                                 dpsi, deps
  409.                             };
  410.                             nro = getConverter().toNonRotating(mjdDate, equinox[0], equinox[1]);
  411.                         }
  412.                         if (configuration == null || !configuration.isValid(mjd)) {
  413.                             // get a configuration for current name and date range
  414.                             configuration = getItrfVersionProvider().getConfiguration(name, mjd);
  415.                         }
  416.                         history.add(new EOPEntry(mjd, dtu1, lod, x, y, equinox[0], equinox[1], nro[0], nro[1],
  417.                                                  configuration.getVersion(), mjdDate));
  418.                     }
  419.                 }
  420.             }

  422.             /** Overwrite a value if it is not set or if we are in a bulletinB.
  423.              * @param oldValue old value to overwrite (may be NaN)
  424.              * @param units units of raw data
  425.              * @return a new value
  426.              */
  427.             private double overwrite(final double oldValue, final Unit units) {
  428.                 if (buffer.length() == 0) {
  429.                     // there is nothing to overwrite with
  430.                     return oldValue;
  431.                 } else if (inBulletinA && !Double.isNaN(oldValue)) {
  432.                     // the value is already set and bulletin A values have a low priority
  433.                     return oldValue;
  434.                 } else {
  435.                     // either the value is not set or it is a high priority bulletin B value
  436.                     return units.toSI(Double.parseDouble(buffer.toString()));
  437.                 }
  438.             }

  440.             /** Check if the year, month, day date and MJD date are consistent.
  441.              */
  442.             private void checkDates() {
  443.                 if (new DateComponents(year, month, day).getMJD() != mjd) {
  444.                     throw new OrekitException(OrekitMessages.INCONSISTENT_DATES_IN_IERS_FILE,
  445.                                               name, year, month, day, mjd);
  446.                 }
  447.             }

  449.             /** {@inheritDoc} */
  450.             @Override
  451.             public InputSource resolveEntity(final String publicId, final String systemId) {
  452.                 // disable external entities
  453.                 return new InputSource();
  454.             }

  456.         }

  458.     }

  460.     /** Enumerate for data file content. */
  461.     private enum DataFileContent {

  463.         /** Unknown content. */
  464.         UNKNOWN,

  466.         /** Daily data. */
  467.         DAILY,

  469.         /** Final data. */
  470.         FINAL

  472.     }

  474. }
Created with JaCoCo 0.8.7.202105040129