RapidDataAndPredictionXMLLoader.java

  1. /* Copyright 2002-2016 CS Systèmes d'Information
  2.  * Licensed to CS Systèmes d'Information (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;

  18. import java.io.IOException;
  19. import java.io.InputStream;
  20. import java.io.InputStreamReader;
  21. import java.util.ArrayList;
  22. import java.util.List;
  23. import java.util.SortedSet;

  24. import javax.xml.parsers.ParserConfigurationException;
  25. import javax.xml.parsers.SAXParserFactory;

  26. import org.apache.commons.math3.exception.util.LocalizedFormats;
  27. import org.orekit.data.DataLoader;
  28. import org.orekit.data.DataProvidersManager;
  29. import org.orekit.errors.OrekitException;
  30. import org.orekit.errors.OrekitMessages;
  31. import org.orekit.time.AbsoluteDate;
  32. import org.orekit.time.DateComponents;
  33. import org.orekit.time.TimeScalesFactory;
  34. import org.orekit.utils.Constants;
  35. import org.orekit.utils.IERSConventions;
  36. import org.xml.sax.Attributes;
  37. import org.xml.sax.InputSource;
  38. import org.xml.sax.SAXException;
  39. import org.xml.sax.XMLReader;
  40. import org.xml.sax.helpers.DefaultHandler;

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

  58.     /** Conversion factor for milli-arc seconds entries. */
  59.     private static final double MILLI_ARC_SECONDS_TO_RADIANS = Constants.ARC_SECONDS_TO_RADIANS / 1000.0;

  60.     /** Conversion factor for milli seconds entries. */
  61.     private static final double MILLI_SECONDS_TO_SECONDS = 1.0 / 1000.0;

  62.     /** Regular expression for supported files names. */
  63.     private final String supportedNames;

  64.     /** Build a loader for IERS XML EOP files.
  65.      * @param supportedNames regular expression for supported files names
  66.      */
  67.     RapidDataAndPredictionXMLLoader(final String supportedNames) {
  68.         this.supportedNames = supportedNames;
  69.     }

  70.     /** {@inheritDoc} */
  71.     public void fillHistory(final IERSConventions.NutationCorrectionConverter converter,
  72.                             final SortedSet<EOPEntry> history)
  73.         throws OrekitException {
  74.         final Parser parser = new Parser(converter);
  75.         DataProvidersManager.getInstance().feed(supportedNames, parser);
  76.         history.addAll(parser.history);
  77.     }

  78.     /** Internal class performing the parsing. */
  79.     private static class Parser implements DataLoader {

  80.         /** Converter for nutation corrections. */
  81.         private final IERSConventions.NutationCorrectionConverter converter;

  82.         /** History entries. */
  83.         private final List<EOPEntry> history;

  84.         /** Simple constructor.
  85.          * @param converter converter to use
  86.          */
  87.         Parser(final IERSConventions.NutationCorrectionConverter converter) {
  88.             this.converter = converter;
  89.             this.history   = new ArrayList<EOPEntry>();
  90.         }

  91.         /** {@inheritDoc} */
  92.         public boolean stillAcceptsData() {
  93.             return true;
  94.         }

  95.         /** {@inheritDoc} */
  96.         public void loadData(final InputStream input, final String name)
  97.             throws IOException, OrekitException {
  98.             try {
  99.                 // set up a reader for line-oriented bulletin B files
  100.                 final XMLReader reader = SAXParserFactory.newInstance().newSAXParser().getXMLReader();
  101.                 reader.setContentHandler(new EOPContentHandler(name));

  102.                 // read all file, ignoring header
  103.                 reader.parse(new InputSource(new InputStreamReader(input, "UTF-8")));

  104.             } catch (SAXException se) {
  105.                 if ((se.getCause() != null) && (se.getCause() instanceof OrekitException)) {
  106.                     throw (OrekitException) se.getCause();
  107.                 }
  108.                 throw new OrekitException(se, LocalizedFormats.SIMPLE_MESSAGE, se.getMessage());
  109.             } catch (ParserConfigurationException pce) {
  110.                 throw new OrekitException(pce, LocalizedFormats.SIMPLE_MESSAGE, pce.getMessage());
  111.             }
  112.         }

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

  115.             // CHECKSTYLE: stop JavadocVariable check

  116.             // elements and attributes used in both daily and finals data files
  117.             private static final String MJD_ELT           = "MJD";
  118.             private static final String LOD_ELT           = "LOD";
  119.             private static final String X_ELT             = "X";
  120.             private static final String Y_ELT             = "Y";
  121.             private static final String DPSI_ELT          = "dPsi";
  122.             private static final String DEPSILON_ELT      = "dEpsilon";
  123.             private static final String DX_ELT            = "dX";
  124.             private static final String DY_ELT            = "dY";

  125.             // elements and attributes specific to daily data files
  126.             private static final String DATA_EOP_ELT      = "dataEOP";
  127.             private static final String TIME_SERIES_ELT   = "timeSeries";
  128.             private static final String DATE_YEAR_ELT     = "dateYear";
  129.             private static final String DATE_MONTH_ELT    = "dateMonth";
  130.             private static final String DATE_DAY_ELT      = "dateDay";
  131.             private static final String POLE_ELT          = "pole";
  132.             private static final String UT_ELT            = "UT";
  133.             private static final String UT1_U_UTC_ELT     = "UT1_UTC";
  134.             private static final String NUTATION_ELT      = "nutation";
  135.             private static final String SOURCE_ATTR       = "source";
  136.             private static final String BULLETIN_A_SOURCE = "BulletinA";

  137.             // elements and attributes specific to finals data files
  138.             private static final String FINALS_ELT        = "Finals";
  139.             private static final String DATE_ELT          = "date";
  140.             private static final String EOP_SET_ELT       = "EOPSet";
  141.             private static final String BULLETIN_A_ELT    = "bulletinA";
  142.             private static final String UT1_M_UTC_ELT     = "UT1-UTC";

  143.             private boolean inBulletinA;
  144.             private int     year;
  145.             private int     month;
  146.             private int     day;
  147.             private int     mjd;
  148.             private AbsoluteDate mjdDate;
  149.             private double  dtu1;
  150.             private double  lod;
  151.             private double  x;
  152.             private double  y;
  153.             private double  dpsi;
  154.             private double  deps;
  155.             private double  dx;
  156.             private double  dy;

  157.             // CHECKSTYLE: resume JavadocVariable check

  158.             /** File name. */
  159.             private final String name;

  160.             /** Buffer for read characters. */
  161.             private final StringBuffer buffer;

  162.             /** Indicator for daily data XML format or final data XML format. */
  163.             private DataFileContent content;

  164.             /** Simple constructor.
  165.              * @param name file name
  166.              */
  167.             EOPContentHandler(final String name) {
  168.                 this.name = name;
  169.                 buffer  = new StringBuffer();
  170.             }

  171.             /** {@inheritDoc} */
  172.             @Override
  173.             public void startDocument() {
  174.                 content = DataFileContent.UNKNOWN;
  175.             }

  176.             /** {@inheritDoc} */
  177.             @Override
  178.             public void characters(final char[] ch, final int start, final int length) {
  179.                 buffer.append(ch, start, length);
  180.             }

  181.             /** {@inheritDoc} */
  182.             @Override
  183.             public void startElement(final String uri, final String localName,
  184.                                      final String qName, final Attributes atts) {

  185.                 // reset the buffer to empty
  186.                 buffer.delete(0, buffer.length());

  187.                 if (content == DataFileContent.UNKNOWN) {
  188.                     // try to identify file content
  189.                     if (qName.equals(TIME_SERIES_ELT)) {
  190.                         // the file contains final data
  191.                         content = DataFileContent.DAILY;
  192.                     } else if (qName.equals(FINALS_ELT)) {
  193.                         // the file contains final data
  194.                         content = DataFileContent.FINAL;
  195.                     }
  196.                 }

  197.                 if (content == DataFileContent.DAILY) {
  198.                     startDailyElement(qName, atts);
  199.                 } else if (content == DataFileContent.FINAL) {
  200.                     startFinalElement(qName, atts);
  201.                 }

  202.             }

  203.             /** Handle end of an element in a daily data file.
  204.              * @param qName name of the element
  205.              * @param atts element attributes
  206.              */
  207.             private void startDailyElement(final String qName, final Attributes atts) {
  208.                 if (qName.equals(TIME_SERIES_ELT)) {
  209.                     // reset EOP data
  210.                     resetEOPData();
  211.                 } else if (qName.equals(POLE_ELT) || qName.equals(UT_ELT) || qName.equals(NUTATION_ELT)) {
  212.                     final String source = atts.getValue(SOURCE_ATTR);
  213.                     if (source != null) {
  214.                         inBulletinA = source.equals(BULLETIN_A_SOURCE);
  215.                     }
  216.                 }
  217.             }

  218.             /** Handle end of an element in a final data file.
  219.              * @param qName name of the element
  220.              * @param atts element attributes
  221.              */
  222.             private void startFinalElement(final String qName, final Attributes atts) {
  223.                 if (qName.equals(EOP_SET_ELT)) {
  224.                     // reset EOP data
  225.                     resetEOPData();
  226.                 } else if (qName.equals(BULLETIN_A_ELT)) {
  227.                     inBulletinA = true;
  228.                 }
  229.             }

  230.             /** Reset EOP data.
  231.              */
  232.             private void resetEOPData() {
  233.                 inBulletinA = false;
  234.                 year        = -1;
  235.                 month       = -1;
  236.                 day         = -1;
  237.                 mjd         = -1;
  238.                 mjdDate     = null;
  239.                 dtu1        = Double.NaN;
  240.                 lod         = Double.NaN;
  241.                 x           = Double.NaN;
  242.                 y           = Double.NaN;
  243.                 dpsi        = Double.NaN;
  244.                 deps        = Double.NaN;
  245.                 dx          = Double.NaN;
  246.                 dy          = Double.NaN;
  247.             }

  248.             /** {@inheritDoc} */
  249.             @Override
  250.             public void endElement(final String uri, final String localName, final String qName)
  251.                 throws SAXException {
  252.                 try {
  253.                     if (content == DataFileContent.DAILY) {
  254.                         endDailyElement(qName);
  255.                     } else if (content == DataFileContent.FINAL) {
  256.                         endFinalElement(qName);
  257.                     }
  258.                 } catch (OrekitException oe) {
  259.                     throw new SAXException(oe);
  260.                 }
  261.             }

  262.             /** Handle end of an element in a daily data file.
  263.              * @param qName name of the element
  264.              * @exception OrekitException if an EOP element cannot be built
  265.              */
  266.             private void endDailyElement(final String qName) throws OrekitException {
  267.                 if (qName.equals(DATE_YEAR_ELT) && (buffer.length() > 0)) {
  268.                     year = Integer.parseInt(buffer.toString());
  269.                 } else if (qName.equals(DATE_MONTH_ELT) && (buffer.length() > 0)) {
  270.                     month = Integer.parseInt(buffer.toString());
  271.                 } else if (qName.equals(DATE_DAY_ELT) && (buffer.length() > 0)) {
  272.                     day = Integer.parseInt(buffer.toString());
  273.                 } else if (qName.equals(MJD_ELT) && (buffer.length() > 0)) {
  274.                     mjd     = Integer.parseInt(buffer.toString());
  275.                     mjdDate = new AbsoluteDate(new DateComponents(DateComponents.MODIFIED_JULIAN_EPOCH, mjd),
  276.                                                TimeScalesFactory.getUTC());
  277.                 } else if (qName.equals(UT1_M_UTC_ELT)) {
  278.                     dtu1 = overwrite(dtu1, 1.0);
  279.                 } else if (qName.equals(LOD_ELT)) {
  280.                     lod = overwrite(lod, MILLI_SECONDS_TO_SECONDS);
  281.                 } else if (qName.equals(X_ELT)) {
  282.                     x = overwrite(x, Constants.ARC_SECONDS_TO_RADIANS);
  283.                 } else if (qName.equals(Y_ELT)) {
  284.                     y = overwrite(y, Constants.ARC_SECONDS_TO_RADIANS);
  285.                 } else if (qName.equals(DPSI_ELT)) {
  286.                     dpsi = overwrite(dpsi, MILLI_ARC_SECONDS_TO_RADIANS);
  287.                 } else if (qName.equals(DEPSILON_ELT)) {
  288.                     deps = overwrite(deps, MILLI_ARC_SECONDS_TO_RADIANS);
  289.                 } else if (qName.equals(DX_ELT)) {
  290.                     dx   = overwrite(dx, MILLI_ARC_SECONDS_TO_RADIANS);
  291.                 } else if (qName.equals(DY_ELT)) {
  292.                     dy   = overwrite(dy, MILLI_ARC_SECONDS_TO_RADIANS);
  293.                 } else if (qName.equals(POLE_ELT) || qName.equals(UT_ELT) || qName.equals(NUTATION_ELT)) {
  294.                     inBulletinA = false;
  295.                 } else if (qName.equals(DATA_EOP_ELT)) {
  296.                     checkDates();
  297.                     if ((!Double.isNaN(dtu1)) && (!Double.isNaN(lod)) && (!Double.isNaN(x)) && (!Double.isNaN(y))) {
  298.                         final double[] equinox;
  299.                         final double[] nro;
  300.                         if (Double.isNaN(dpsi)) {
  301.                             nro = new double[] {
  302.                                 dx, dy
  303.                             };
  304.                             equinox = converter.toEquinox(mjdDate, nro[0], nro[1]);
  305.                         } else {
  306.                             equinox = new double[] {
  307.                                 dpsi, deps
  308.                             };
  309.                             nro = converter.toNonRotating(mjdDate, equinox[0], equinox[1]);
  310.                         }
  311.                         history.add(new EOPEntry(mjd, dtu1, lod, x, y, equinox[0], equinox[1], nro[0], nro[1]));
  312.                     }
  313.                 }
  314.             }

  315.             /** Handle end of an element in a final data file.
  316.              * @param qName name of the element
  317.              * @exception OrekitException if an EOP element cannot be built
  318.              */
  319.             private void endFinalElement(final String qName) throws OrekitException {
  320.                 if (qName.equals(DATE_ELT) && (buffer.length() > 0)) {
  321.                     final String[] fields = buffer.toString().split("-");
  322.                     if (fields.length == 3) {
  323.                         year  = Integer.parseInt(fields[0]);
  324.                         month = Integer.parseInt(fields[1]);
  325.                         day   = Integer.parseInt(fields[2]);
  326.                     }
  327.                 } else if (qName.equals(MJD_ELT) && (buffer.length() > 0)) {
  328.                     mjd     = Integer.parseInt(buffer.toString());
  329.                     mjdDate = new AbsoluteDate(new DateComponents(DateComponents.MODIFIED_JULIAN_EPOCH, mjd),
  330.                                                TimeScalesFactory.getUTC());
  331.                 } else if (qName.equals(UT1_U_UTC_ELT)) {
  332.                     dtu1 = overwrite(dtu1, 1.0);
  333.                 } else if (qName.equals(LOD_ELT)) {
  334.                     lod = overwrite(lod, MILLI_SECONDS_TO_SECONDS);
  335.                 } else if (qName.equals(X_ELT)) {
  336.                     x = overwrite(x, Constants.ARC_SECONDS_TO_RADIANS);
  337.                 } else if (qName.equals(Y_ELT)) {
  338.                     y = overwrite(y, Constants.ARC_SECONDS_TO_RADIANS);
  339.                 } else if (qName.equals(DPSI_ELT)) {
  340.                     dpsi = overwrite(dpsi, MILLI_ARC_SECONDS_TO_RADIANS);
  341.                 } else if (qName.equals(DEPSILON_ELT)) {
  342.                     deps = overwrite(deps, MILLI_ARC_SECONDS_TO_RADIANS);
  343.                 } else if (qName.equals(DX_ELT)) {
  344.                     dx   = overwrite(dx, MILLI_ARC_SECONDS_TO_RADIANS);
  345.                 } else if (qName.equals(DY_ELT)) {
  346.                     dy   = overwrite(dy, MILLI_ARC_SECONDS_TO_RADIANS);
  347.                 } else if (qName.equals(BULLETIN_A_ELT)) {
  348.                     inBulletinA = false;
  349.                 } else if (qName.equals(EOP_SET_ELT)) {
  350.                     checkDates();
  351.                     if ((!Double.isNaN(dtu1)) && (!Double.isNaN(lod)) && (!Double.isNaN(x)) && (!Double.isNaN(y))) {
  352.                         final double[] equinox;
  353.                         final double[] nro;
  354.                         if (Double.isNaN(dpsi)) {
  355.                             nro = new double[] {
  356.                                 dx, dy
  357.                             };
  358.                             equinox = converter.toEquinox(mjdDate, nro[0], nro[1]);
  359.                         } else {
  360.                             equinox = new double[] {
  361.                                 dpsi, deps
  362.                             };
  363.                             nro = converter.toNonRotating(mjdDate, equinox[0], equinox[1]);
  364.                         }
  365.                         history.add(new EOPEntry(mjd, dtu1, lod, x, y, equinox[0], equinox[1], nro[0], nro[1]));
  366.                     }
  367.                 }
  368.             }

  369.             /** Overwrite a value if it is not set or if we are in a bulletinB.
  370.              * @param oldValue old value to overwrite (may be NaN)
  371.              * @param factor multiplicative factor to apply to raw read data
  372.              * @return a new value
  373.              */
  374.             private double overwrite(final double oldValue, final double factor) {
  375.                 if (buffer.length() == 0) {
  376.                     // there is nothing to overwrite with
  377.                     return oldValue;
  378.                 } else if (inBulletinA && (!Double.isNaN(oldValue))) {
  379.                     // the value is already set and bulletin A values have a low priority
  380.                     return oldValue;
  381.                 } else {
  382.                     // either the value is not set or it is a high priority bulletin B value
  383.                     return Double.parseDouble(buffer.toString()) * factor;
  384.                 }
  385.             }

  386.             /** Check if the year, month, day date and MJD date are consistent.
  387.              * @exception OrekitException if dates are not consistent
  388.              */
  389.             private void checkDates() throws OrekitException {
  390.                 if (new DateComponents(year, month, day).getMJD() != mjd) {
  391.                     throw new OrekitException(OrekitMessages.INCONSISTENT_DATES_IN_IERS_FILE,
  392.                                               name, year, month, day, mjd);
  393.                 }
  394.             }

  395.         }

  396.         /** Enumerate for data file content. */
  397.         private enum DataFileContent {

  398.             /** Unknown content. */
  399.             UNKNOWN,

  400.             /** Daily data. */
  401.             DAILY,

  402.             /** Final data. */
  403.             FINAL;

  404.         }

  405.     }

  406. }