TDMParser.java
/* Copyright 2002-2020 CS GROUP
* Licensed to CS GROUP (CS) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* CS licenses this file to You 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 org.orekit.files.ccsds;
import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.regex.Pattern;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.hipparchus.exception.DummyLocalizable;
import org.orekit.annotation.DefaultDataContext;
import org.orekit.data.DataContext;
import org.orekit.errors.OrekitException;
import org.orekit.errors.OrekitMessages;
import org.orekit.time.AbsoluteDate;
import org.orekit.utils.IERSConventions;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
/**
* Class for CCSDS Tracking Data Message parsers.
*
* <p> This base class is immutable, and hence thread safe. When parts must be
* changed, such as reference date for Mission Elapsed Time or Mission Relative
* Time time systems, or the gravitational coefficient or the IERS conventions,
* the various {@code withXxx} methods must be called, which create a new
* immutable instance with the new parameters. This is a combination of the <a
* href="https://en.wikipedia.org/wiki/Builder_pattern">builder design
* pattern</a> and a <a href="http://en.wikipedia.org/wiki/Fluent_interface">fluent
* interface</a>.
*
* <p> This class allow the handling of both "keyvalue" and "xml" TDM file formats.
* Format can be inferred if file names ends respectively with ".txt" or ".xml".
* Otherwise it must be explicitely set using {@link #withFileFormat(TDMFileFormat)}
*
* <p>ParseInfo subclass regroups common parsing functions; and specific handlers were added
* for both file formats.
*
* <p>References:<p>
* - <a href="https://public.ccsds.org/Pubs/503x0b1c1.pdf">CCSDS 503.0-B-1 recommended standard</a> ("Tracking Data Message", Blue Book, Issue 1, November 2007).<p>
* - <a href="https://public.ccsds.org/Pubs/505x0b1.pdf">CCSDS 505.0-B-1 recommended standard</a> ("XML Specification for Navigation Data Message", Blue Book, Issue 1, December 2010).<p>
*
* @author Maxime Journot
* @since 9.0
*/
public class TDMParser extends DefaultHandler {
/** Pattern for dash. */
private static final Pattern DASH = Pattern.compile("-");
/** Pattern for delimiting regular expressions. */
private static final Pattern SEPARATOR = Pattern.compile("\\s+");
/** Enumerate for the format. */
public enum TDMFileFormat {
/** Keyvalue (text file with Key = Value lines). */
KEYVALUE,
/** XML format. */
XML,
/** UKNOWN file format, default format, throw an Orekit Exception if kept this way. */
UNKNOWN;
}
/** Format of the file to parse: KEYVALUE or XML. */
private TDMFileFormat fileFormat;
/** Reference date for Mission Elapsed Time or Mission Relative Time time systems. */
private final AbsoluteDate missionReferenceDate;
/** IERS Conventions. */
private final IERSConventions conventions;
/** Indicator for simple or accurate EOP interpolation. */
private final boolean simpleEOP;
/** Data context for frames, time scales, etc. */
private final DataContext dataContext;
/** Simple constructor.
* <p>
* This class is immutable, and hence thread safe. When parts
* must be changed, such fiel format or reference date for Mission Elapsed Time or
* Mission Relative Time time systems, or the IERS conventions,
* the various {@code withXxx} methods must be called,
* which create a new immutable instance with the new parameters. This
* is a combination of the
* <a href="https://en.wikipedia.org/wiki/Builder_pattern">builder design
* pattern</a> and a
* <a href="http://en.wikipedia.org/wiki/Fluent_interface">fluent
* interface</a>.
* </p>
* <p>
* The initial date for Mission Elapsed Time and Mission Relative Time time systems is not set here.
* If such time systems are used, it must be initialized before parsing by calling {@link
* #withMissionReferenceDate(AbsoluteDate)}.
* </p>
* <p>
* The IERS conventions to use is not set here. If it is needed in order to
* parse some reference frames or UT1 time scale, it must be initialized before
* parsing by calling {@link #withConventions(IERSConventions)}.
* </p>
* <p>
* The TDM file format to use is not set here. It may be automatically inferred while parsing
* if the name of the file to parse ends with ".txt" or ".xml".
* Otherwise it must be initialized before parsing by calling {@link #withFileFormat(TDMFileFormat)}
* </p>
*
* <p>This method uses the {@link DataContext#getDefault() default data context}. See
* {@link #withDataContext(DataContext)}.
*/
@DefaultDataContext
public TDMParser() {
this(TDMFileFormat.UNKNOWN, AbsoluteDate.FUTURE_INFINITY, null, true,
DataContext.getDefault());
}
/** Complete constructor.
* @param fileFormat The format of the file: KEYVALUE or XML
* @param missionReferenceDate reference date for Mission Elapsed Time or Mission Relative Time time systems
* @param conventions IERS Conventions
* @param simpleEOP if true, tidal effects are ignored when interpolating EOP
* @param dataContext used to retrieve frames, time scales, etc.
*/
private TDMParser(final TDMFileFormat fileFormat,
final AbsoluteDate missionReferenceDate,
final IERSConventions conventions,
final boolean simpleEOP,
final DataContext dataContext) {
this.fileFormat = fileFormat;
this.missionReferenceDate = missionReferenceDate;
this.conventions = conventions;
this.simpleEOP = simpleEOP;
this.dataContext = dataContext;
}
/** Set file format.
* @param newFileFormat The format of the file: KEYVALUE or XML
* @return a new instance, with file format set to newFileFormat
* @see #getFileFormat()
*/
public TDMParser withFileFormat(final TDMFileFormat newFileFormat) {
return new TDMParser(newFileFormat, getMissionReferenceDate(), getConventions(),
isSimpleEOP(), getDataContext());
}
/** Get file format.
* @return the file format
* @see #withFileFormat(TDMFileFormat)
*/
public TDMFileFormat getFileFormat() {
return fileFormat;
}
/** Set initial date.
* @param newMissionReferenceDate mission reference date to use while parsing
* @return a new instance, with mission reference date replaced
* @see #getMissionReferenceDate()
*/
public TDMParser withMissionReferenceDate(final AbsoluteDate newMissionReferenceDate) {
return new TDMParser(getFileFormat(), newMissionReferenceDate, getConventions(),
isSimpleEOP(), getDataContext());
}
/** Get initial date.
* @return mission reference date to use while parsing
* @see #withMissionReferenceDate(AbsoluteDate)
*/
public AbsoluteDate getMissionReferenceDate() {
return missionReferenceDate;
}
/** Set IERS conventions.
* @param newConventions IERS conventions to use while parsing
* @return a new instance, with IERS conventions replaced
* @see #getConventions()
*/
public TDMParser withConventions(final IERSConventions newConventions) {
return new TDMParser(getFileFormat(), getMissionReferenceDate(), newConventions,
isSimpleEOP(), getDataContext());
}
/** Get IERS conventions.
* @return IERS conventions to use while parsing
* @see #withConventions(IERSConventions)
*/
public IERSConventions getConventions() {
return conventions;
}
/** Set EOP interpolation method.
* @param newSimpleEOP if true, tidal effects are ignored when interpolating EOP
* @return a new instance, with EOP interpolation method replaced
* @see #isSimpleEOP()
*/
public TDMParser withSimpleEOP(final boolean newSimpleEOP) {
return new TDMParser(getFileFormat(), getMissionReferenceDate(), getConventions(),
newSimpleEOP, getDataContext());
}
/** Get EOP interpolation method.
* @return true if tidal effects are ignored when interpolating EOP
* @see #withSimpleEOP(boolean)
*/
public boolean isSimpleEOP() {
return simpleEOP;
}
/**
* Get the data context.
*
* @return the data context used for retrieving frames, time scales, etc.
*/
public DataContext getDataContext() {
return dataContext;
}
/**
* Set the data context.
*
* @param newDataContext used for retrieving frames, time scales, etc.
* @return a new instance with the data context replaced.
*/
public TDMParser withDataContext(final DataContext newDataContext) {
return new TDMParser(getFileFormat(), getMissionReferenceDate(), getConventions(),
isSimpleEOP(), newDataContext);
}
/** Parse a CCSDS Tracking Data Message.
* @param fileName name of the file containing the message
* @return parsed file content in a TDMFile object
*/
public TDMFile parse(final String fileName) {
try (InputStream stream = new FileInputStream(fileName)) {
return parse(stream, fileName);
} catch (IOException ioe) {
throw new OrekitException(OrekitMessages.UNABLE_TO_FIND_FILE, fileName);
}
}
/** Parse a CCSDS Tracking Data Message.
* @param stream stream containing message
* @return parsed file content in a TDMFile object
*/
public TDMFile parse(final InputStream stream) {
return parse(stream, "<unknown>");
}
/** Parse a CCSDS Tracking Data Message.
* @param stream stream containing message
* @param fileName name of the file containing the message (for error messages)
* @return parsed file content in a TDMFile object
*/
public TDMFile parse(final InputStream stream, final String fileName) {
// Set the format of the file automatically
// If it is obvious and was not formerly specified
// Then, use a different parsing method for each file format
if (TDMFileFormat.UNKNOWN.equals(fileFormat)) {
if (fileName.toLowerCase(Locale.US).endsWith(".txt")) {
// Keyvalue format case
return this.withFileFormat(TDMFileFormat.KEYVALUE).parse(stream, fileName);
} else if (fileName.toLowerCase(Locale.US).endsWith(".xml")) {
// XML format case
return this.withFileFormat(TDMFileFormat.XML).parse(stream, fileName);
} else {
throw new OrekitException(OrekitMessages.CCSDS_TDM_UNKNOWN_FORMAT, fileName);
}
} else if (this.fileFormat.equals(TDMFileFormat.KEYVALUE)) {
return parseKeyValue(stream, fileName);
} else if (this.fileFormat.equals(TDMFileFormat.XML)) {
return parseXml(stream, fileName);
} else {
throw new OrekitException(OrekitMessages.CCSDS_TDM_UNKNOWN_FORMAT, fileName);
}
}
/** Parse a CCSDS Tracking Data Message with KEYVALUE format.
* @param stream stream containing message
* @param fileName name of the file containing the message (for error messages)
* @return parsed file content in a TDMFile object
*/
public TDMFile parseKeyValue(final InputStream stream, final String fileName) {
final KeyValueHandler handler = new KeyValueHandler(new ParseInfo(this.getMissionReferenceDate(),
this.getConventions(),
this.isSimpleEOP(),
fileName,
getDataContext()));
return handler.parse(stream, fileName);
}
/** Parse a CCSDS Tracking Data Message with XML format.
* @param stream stream containing message
* @param fileName name of the file containing the message (for error messages)
* @return parsed file content in a TDMFile object
*/
public TDMFile parseXml(final InputStream stream, final String fileName) {
try {
// Create the handler
final XMLHandler handler = new XMLHandler(new ParseInfo(this.getMissionReferenceDate(),
this.getConventions(),
this.isSimpleEOP(),
fileName,
getDataContext()));
// Create the XML SAX parser factory
final SAXParserFactory factory = SAXParserFactory.newInstance();
// Build the parser and read the xml file
final SAXParser parser = factory.newSAXParser();
parser.parse(stream, handler);
// Get the content of the file
final TDMFile tdmFile = handler.parseInfo.tdmFile;
// Check time systems consistency
tdmFile.checkTimeSystems();
return tdmFile;
} catch (SAXException se) {
final OrekitException oe;
if (se.getException() != null && se.getException() instanceof OrekitException) {
oe = (OrekitException) se.getException();
} else {
oe = new OrekitException(se, new DummyLocalizable(se.getMessage()));
}
throw oe;
} catch (ParserConfigurationException | IOException e) {
// throw caught exception as an OrekitException
throw new OrekitException(e, new DummyLocalizable(e.getMessage()));
}
}
/** Private class used to stock TDM parsing info.
* @author sports
*/
private static class ParseInfo {
/** Reference date for Mission Elapsed Time or Mission Relative Time time systems. */
private final AbsoluteDate missionReferenceDate;
/** IERS Conventions. */
private final IERSConventions conventions;
/** Indicator for simple or accurate EOP interpolation. */
private final boolean simpleEOP;
/** Data context. */
private final DataContext dataContext;
/** Name of the file. */
private String fileName;
/** Current Observation Block being parsed. */
private TDMFile.ObservationsBlock currentObservationsBlock;
/** Current line number. */
private int lineNumber;
/** Current parsed line. */
private String line;
/** TDMFile object being filled. */
private TDMFile tdmFile;
/** Key value of the current line being read. */
private KeyValue keyValue;
/** Temporary stored comments. */
private List<String> commentTmp;
/** Boolean indicating if the parser is currently parsing a meta-data block. */
private boolean parsingMetaData;
/** Boolean indicating if the parser is currently parsing a data block. */
private boolean parsingData;
/** Complete constructor.
* @param missionReferenceDate reference date for Mission Elapsed Time or Mission Relative Time time systems
* @param conventions IERS Conventions
* @param simpleEOP if true, tidal effects are ignored when interpolating EOP
* @param fileName the name of the file being parsed
* @param dataContext used to retrieve frames, time scales, etc.
*/
private ParseInfo(final AbsoluteDate missionReferenceDate,
final IERSConventions conventions,
final boolean simpleEOP,
final String fileName,
final DataContext dataContext) {
this.missionReferenceDate = missionReferenceDate;
this.conventions = conventions;
this.simpleEOP = simpleEOP;
this.fileName = fileName;
this.dataContext = dataContext;
this.lineNumber = 0;
this.line = "";
this.tdmFile = new TDMFile();
this.commentTmp = new ArrayList<String>();
this.currentObservationsBlock = null;
this.parsingMetaData = false;
this.parsingData = false;
}
/** Parse a meta-data entry.<p>
* key = value (KEYVALUE file format)<p>
* <<key>value</key> (XML file format)
*/
private void parseMetaDataEntry() {
final TDMFile.TDMMetaData metaData = this.currentObservationsBlock.getMetaData();
try {
switch (keyValue.getKeyword()) {
case TIME_SYSTEM:
// Read the time system and ensure that it is supported by Orekit
if (!CcsdsTimeScale.contains(keyValue.getValue())) {
throw new OrekitException(OrekitMessages.CCSDS_TIME_SYSTEM_NOT_IMPLEMENTED,
keyValue.getValue());
}
final CcsdsTimeScale timeSystem =
CcsdsTimeScale.valueOf(keyValue.getValue());
metaData.setTimeSystem(timeSystem);
// Convert start/stop time to AbsoluteDate if they have been read already
if (metaData.getStartTimeString() != null) {
metaData.setStartTime(parseDate(metaData.getStartTimeString(), timeSystem));
}
if (metaData.getStopTimeString() != null) {
metaData.setStopTime(parseDate(metaData.getStopTimeString(), timeSystem));
}
break;
case START_TIME:
// Set the start time as a String first
metaData.setStartTimeString(keyValue.getValue());
// If time system has already been defined, convert the start time to an AbsoluteDate
if (metaData.getTimeSystem() != null) {
metaData.setStartTime(parseDate(keyValue.getValue(), metaData.getTimeSystem()));
}
break;
case STOP_TIME:
// Set the stop time as a String first
metaData.setStopTimeString(keyValue.getValue());
// If time system has already been defined, convert the start time to an AbsoluteDate
if (metaData.getTimeSystem() != null) {
metaData.setStopTime(parseDate(keyValue.getValue(), metaData.getTimeSystem()));
}
break;
case PARTICIPANT_1: case PARTICIPANT_2: case PARTICIPANT_3:
case PARTICIPANT_4: case PARTICIPANT_5:
// Get the participant number
String key = keyValue.getKey();
int participantNumber = Integer.parseInt(key.substring(key.length() - 1));
// Add the tuple to the map
metaData.addParticipant(participantNumber, keyValue.getValue());
break;
case MODE:
metaData.setMode(keyValue.getValue());
break;
case PATH:
metaData.setPath(keyValue.getValue());
break;
case PATH_1:
metaData.setPath1(keyValue.getValue());
break;
case PATH_2:
metaData.setPath2(keyValue.getValue());
break;
case TRANSMIT_BAND:
metaData.setTransmitBand(keyValue.getValue());
break;
case RECEIVE_BAND:
metaData.setReceiveBand(keyValue.getValue());
break;
case TURNAROUND_NUMERATOR:
metaData.setTurnaroundNumerator(keyValue.getIntegerValue());
break;
case TURNAROUND_DENOMINATOR:
metaData.setTurnaroundDenominator(keyValue.getIntegerValue());
break;
case TIMETAG_REF:
metaData.setTimetagRef(keyValue.getValue());
break;
case INTEGRATION_INTERVAL:
metaData.setIntegrationInterval(keyValue.getDoubleValue());
break;
case INTEGRATION_REF:
metaData.setIntegrationRef(keyValue.getValue());
break;
case FREQ_OFFSET:
metaData.setFreqOffset(keyValue.getDoubleValue());
break;
case RANGE_MODE:
metaData.setRangeMode(keyValue.getValue());
break;
case RANGE_MODULUS:
metaData.setRangeModulus(keyValue.getDoubleValue());
break;
case RANGE_UNITS:
metaData.setRangeUnits(keyValue.getValue());
break;
case ANGLE_TYPE:
metaData.setAngleType(keyValue.getValue());
break;
case REFERENCE_FRAME:
metaData.setReferenceFrameString(keyValue.getValue());
metaData.setReferenceFrame(parseCCSDSFrame(keyValue.getValue())
.getFrame(this.conventions, this.simpleEOP, dataContext));
break;
case TRANSMIT_DELAY_1: case TRANSMIT_DELAY_2: case TRANSMIT_DELAY_3:
case TRANSMIT_DELAY_4: case TRANSMIT_DELAY_5:
// Get the participant number
key = keyValue.getKey();
participantNumber = Integer.parseInt(key.substring(key.length() - 1));
// Add the tuple to the map
metaData.addTransmitDelay(participantNumber, keyValue.getDoubleValue());
break;
case RECEIVE_DELAY_1: case RECEIVE_DELAY_2: case RECEIVE_DELAY_3:
case RECEIVE_DELAY_4: case RECEIVE_DELAY_5:
// Get the participant number
key = keyValue.getKey();
participantNumber = Integer.parseInt(key.substring(key.length() - 1));
// Add the tuple to the map
metaData.addReceiveDelay(participantNumber, keyValue.getDoubleValue());
break;
case DATA_QUALITY:
metaData.setDataQuality(keyValue.getValue());
break;
case CORRECTION_ANGLE_1:
metaData.setCorrectionAngle1(keyValue.getDoubleValue());
break;
case CORRECTION_ANGLE_2:
metaData.setCorrectionAngle2(keyValue.getDoubleValue());
break;
case CORRECTION_DOPPLER:
metaData.setCorrectionDoppler(keyValue.getDoubleValue());
break;
case CORRECTION_RANGE:
metaData.setCorrectionRange(keyValue.getDoubleValue());
break;
case CORRECTION_RECEIVE:
metaData.setCorrectionReceive(keyValue.getDoubleValue());
break;
case CORRECTION_TRANSMIT:
metaData.setCorrectionTransmit(keyValue.getDoubleValue());
break;
case CORRECTIONS_APPLIED:
metaData.setCorrectionsApplied(keyValue.getValue());
break;
default:
throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD, lineNumber, fileName, line);
}
} catch (NumberFormatException nfe) {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
lineNumber, fileName, line);
}
}
/** Parse a CCSDS frame.
* @param frameName name of the frame, as the value of a CCSDS key=value line
* @return CCSDS frame corresponding to the name
*/
private CCSDSFrame parseCCSDSFrame(final String frameName) {
return CCSDSFrame.valueOf(DASH.matcher(frameName).replaceAll(""));
}
/** Parse a date.
* @param date date to parse, as the value of a CCSDS key=value line
* @param timeSystem time system to use
* @return parsed date
*/
private AbsoluteDate parseDate(final String date, final CcsdsTimeScale timeSystem) {
return timeSystem.parseDate(date, conventions, missionReferenceDate,
dataContext.getTimeScales());
}
}
/** Handler for parsing KEYVALUE file formats. */
private static class KeyValueHandler {
/** ParseInfo object. */
private ParseInfo parseInfo;
/** Simple constructor.
* @param parseInfo ParseInfo object
*/
KeyValueHandler(final ParseInfo parseInfo) {
this.parseInfo = parseInfo;
}
/**
* Parse an observation data line and add its content to the Observations Block
* block.
*
*/
private void parseObservationsDataLine() {
// Parse an observation line
// An observation line should consist in the string "keyword = epoch value"
// parseInfo.keyValue.getValue() should return the string "epoch value"
final String[] fields = SEPARATOR.split(parseInfo.keyValue.getValue());
// Check that there are 2 fields in the value of the key
if (fields.length != 2) {
throw new OrekitException(OrekitMessages.CCSDS_TDM_INCONSISTENT_DATA_LINE,
parseInfo.lineNumber, parseInfo.fileName, parseInfo.line);
}
// Convert the date to an AbsoluteDate object (OrekitException if it fails)
final AbsoluteDate epoch = parseInfo.parseDate(fields[0], parseInfo.currentObservationsBlock.getMetaData().getTimeSystem());
final double measurement;
try {
// Convert the value to double (NumberFormatException if it fails)
measurement = Double.parseDouble(fields[1]);
} catch (NumberFormatException nfe) {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
parseInfo.lineNumber, parseInfo.fileName, parseInfo.line);
}
// Adds the observation to current observation block
parseInfo.currentObservationsBlock.addObservation(parseInfo.keyValue.getKeyword().name(),
epoch,
measurement);
}
/** Parse a CCSDS Tracking Data Message with KEYVALUE format.
* @param stream stream containing message
* @param fileName name of the file containing the message (for error messages)
* @return parsed file content in a TDMFile object
*/
public TDMFile parse(final InputStream stream, final String fileName) {
try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream, StandardCharsets.UTF_8))) {
try {
// Initialize internal TDMFile
final TDMFile tdmFile = parseInfo.tdmFile;
// Read the file
for (String line = reader.readLine(); line != null; line = reader.readLine()) {
++parseInfo.lineNumber;
if (line.trim().length() == 0) {
continue;
}
parseInfo.line = line;
parseInfo.keyValue = new KeyValue(parseInfo.line, parseInfo.lineNumber, parseInfo.fileName);
if (parseInfo.keyValue.getKeyword() == null) {
throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD, parseInfo.lineNumber, parseInfo.fileName, parseInfo.line);
}
switch (parseInfo.keyValue.getKeyword()) {
// Header entries
case CCSDS_TDM_VERS:
// Set CCSDS TDM version
tdmFile.setFormatVersion(parseInfo.keyValue.getDoubleValue());
break;
case CREATION_DATE:
// Save current comment in header
tdmFile.setHeaderComment(parseInfo.commentTmp);
parseInfo.commentTmp.clear();
// Set creation date
tdmFile.setCreationDate(new AbsoluteDate(
parseInfo.keyValue.getValue(),
parseInfo.dataContext.getTimeScales().getUTC()));
break;
case ORIGINATOR:
// Set originator
tdmFile.setOriginator(parseInfo.keyValue.getValue());
break;
// Comments
case COMMENT:
parseInfo.commentTmp.add(parseInfo.keyValue.getValue());
break;
// Start/Strop keywords
case META_START:
// Add an observation block and set the last observation block to the current
tdmFile.addObservationsBlock();
parseInfo.currentObservationsBlock = tdmFile.getObservationsBlocks().get(tdmFile.getObservationsBlocks().size() - 1);
// Indicate the start of meta-data parsing for this block
parseInfo.parsingMetaData = true;
break;
case META_STOP:
// Save current comment in current meta-data comment
parseInfo.currentObservationsBlock.getMetaData().setComment(parseInfo.commentTmp);
parseInfo.commentTmp.clear();
// Indicate the end of meta-data parsing for this block
parseInfo.parsingMetaData = false;
break;
case DATA_START:
// Indicate the start of data parsing for this block
parseInfo.parsingData = true;
break;
case DATA_STOP:
// Save current comment in current Observation Block comment
parseInfo.currentObservationsBlock.setObservationsComment(parseInfo.commentTmp);
parseInfo.commentTmp.clear();
// Indicate the end of data parsing for this block
parseInfo.parsingData = false;
break;
default:
// Parse a line that does not display the previous keywords
if ((parseInfo.currentObservationsBlock != null) &&
(parseInfo.parsingData || parseInfo.parsingMetaData)) {
if (parseInfo.parsingMetaData) {
// Parse a meta-data line
parseInfo.parseMetaDataEntry();
} else {
// Parse an observation data line
this.parseObservationsDataLine();
}
} else {
throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD,
parseInfo.lineNumber, parseInfo.fileName, parseInfo.line);
}
break;
}
}
// Check time systems consistency before returning the parsed content
tdmFile.checkTimeSystems();
return tdmFile;
} catch (IOException ioe) {
throw new OrekitException(ioe, new DummyLocalizable(ioe.getMessage()));
}
} catch (IOException ioe) {
throw new OrekitException(ioe, new DummyLocalizable(ioe.getMessage()));
}
}
}
/** Handler for parsing XML file formats. */
private static class XMLHandler extends DefaultHandler {
/** ParseInfo object. */
private ParseInfo parseInfo;
/** Locator used to get current line number. */
private Locator locator;
/** Current keyword being read. */
private Keyword currentKeyword;
/** Current observation keyword being read. */
private Keyword currentObservationKeyword;
/** Current observation epoch being read. */
private AbsoluteDate currentObservationEpoch;
/** Current observation measurement being read. */
private double currentObservationMeasurement;
/** Simple constructor.
* @param parseInfo ParseInfo object
*/
XMLHandler(final ParseInfo parseInfo) {
this.parseInfo = parseInfo;
this.locator = null;
this.currentKeyword = null;
this.currentObservationKeyword = null;
this.currentObservationEpoch = null;
this.currentObservationMeasurement = Double.NaN;
}
@Override
public void setDocumentLocator(final Locator documentLocator) {
this.locator = documentLocator;
}
/**
* Extract the content of an element.
*
* @param ch the characters
* @param start the index of the first character of the desired content
* @param length the length of the content
* @throws SAXException in case of an error.
*
* @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int)
*/
@Override
public void characters(final char[] ch, final int start, final int length) throws SAXException
{
try {
// currentKeyword is set to null in function endElement every time an end tag is parsed.
// Thus only the characters between a start and an end tags are parsed.
if (currentKeyword != null) {
// Store the info in a KeyValue object so that we can use the common functions of parseInfo
// The SAX locator does not allow the retrieving of the line
// So a pseudo-line showing the keyword is reconstructed
final String value = new String(ch, start, length);
parseInfo.line = "<" + currentKeyword.name() + ">" + value + "<" + "/" + currentKeyword.name() + ">";
parseInfo.lineNumber = locator.getLineNumber();
parseInfo.keyValue = new KeyValue(currentKeyword, value, parseInfo.line, parseInfo.lineNumber, parseInfo.fileName);
// Scan the keyword
switch (currentKeyword) {
case CREATION_DATE:
// Set creation date
parseInfo.tdmFile.setCreationDate(new AbsoluteDate(
parseInfo.keyValue.getValue(),
parseInfo.dataContext.getTimeScales().getUTC()));
break;
case ORIGINATOR:
// Set originator
parseInfo.tdmFile.setOriginator(parseInfo.keyValue.getValue());
break;
case COMMENT:
// Comments
parseInfo.commentTmp.add(parseInfo.keyValue.getValue());
break;
case tdm: case header: case body: case segment:
case metadata: case data:case observation:
// Do nothing for this tags
break;
default:
// Parse a line that does not display the previous keywords
if ((parseInfo.currentObservationsBlock != null) &&
(parseInfo.parsingData || parseInfo.parsingMetaData)) {
if (parseInfo.parsingMetaData) {
// Call meta-data parsing
parseInfo.parseMetaDataEntry();
} else if (parseInfo.parsingData) {
// Call data parsing
parseObservationDataLine();
}
} else {
throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD,
parseInfo.lineNumber, parseInfo.fileName, parseInfo.line);
}
break;
}
}
} catch (OrekitException e) {
// Re-throw the exception as a SAXException
throw new SAXException(e);
}
}
/**
* Detect the beginning of an element.
*
* @param uri The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
* @param localName The local name (without prefix), or the empty string if Namespace processing is not being performed.
* @param qName The qualified name (with prefix), or the empty string if qualified names are not available.
* @param attributes The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.
* @throws SAXException in case of an error
*
* @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
*/
@Override
public void startElement(final String uri, final String localName, final String qName, final Attributes attributes) throws SAXException
{
// Check if the start element belongs to the standard keywords
try
{
try {
this.currentKeyword = Keyword.valueOf(qName);
} catch (IllegalArgumentException e) {
throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD,
locator.getLineNumber(),
parseInfo.fileName,
"<" + qName + ">");
}
switch (currentKeyword) {
case tdm:
// Get the version number
parseInfo.tdmFile.setFormatVersion(Double.parseDouble(attributes.getValue("version")));
break;
case observation:
// Re-initialize the stored observation's attributes
this.currentObservationKeyword = null;
this.currentObservationEpoch = null;
this.currentObservationMeasurement = Double.NaN;
break;
case segment:
// Add an observation block and set the last observation block to the current
final TDMFile tdmFile = parseInfo.tdmFile;
tdmFile.addObservationsBlock();
parseInfo.currentObservationsBlock = tdmFile.getObservationsBlocks().get(tdmFile.getObservationsBlocks().size() - 1);
break;
case metadata:
// Indicate the start of meta-data parsing for this block
parseInfo.parsingMetaData = true;
break;
case data:
// Indicate the start of data parsing for this block
parseInfo.parsingData = true;
break;
default:
// Ignore the element.
break;
}
}
catch (IllegalArgumentException | OrekitException e)
{
throw new SAXException(e);
}
}
/**
* Detect the end of an element and remove the stored keyword.
*
* @param uri The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
* @param localName The local name (without prefix), or the empty string if Namespace processing is not being performed.
* @param qName The qualified name (with prefix), or the empty string if qualified names are not available.
* @throws SAXException in case of an error
*
* @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String, java.lang.String)
*/
@Override
public void endElement(final String uri, final String localName, final String qName) throws SAXException
{
// check if the start element belongs to the standard keywords
try
{
// Set the stored keyword to null
currentKeyword = null;
// Ending keyword
final Keyword endKeyword;
try {
endKeyword = Keyword.valueOf(qName);
} catch (IllegalArgumentException e) {
throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD,
locator.getLineNumber(),
parseInfo.fileName,
"</" + qName + ">");
}
switch (endKeyword) {
case header:
// Save header comment
parseInfo.tdmFile.setHeaderComment(parseInfo.commentTmp);
parseInfo.commentTmp.clear();
break;
case observation:
// Check that stored observation's attributes were all found
if (currentObservationKeyword == null ||
currentObservationEpoch == null ||
Double.isNaN(currentObservationMeasurement)) {
throw new OrekitException(OrekitMessages.CCSDS_TDM_XML_INCONSISTENT_DATA_BLOCK,
locator.getLineNumber(),
parseInfo.fileName);
} else {
// Add current observation
parseInfo.currentObservationsBlock.addObservation(currentObservationKeyword.name(),
currentObservationEpoch,
currentObservationMeasurement);
}
break;
case segment:
// Do nothing
break;
case metadata:
// Save current comment in current meta-data comment
parseInfo.currentObservationsBlock.getMetaData().setComment(parseInfo.commentTmp);
parseInfo.commentTmp.clear();
// Indicate the end of meta-data parsing for this block
parseInfo.parsingMetaData = false;
break;
case data:
// Save current comment in current Observation Block comment
parseInfo.currentObservationsBlock.setObservationsComment(parseInfo.commentTmp);
parseInfo.commentTmp.clear();
// Indicate the end of data parsing for this block
parseInfo.parsingData = false;
break;
default:
// Ignore the element.
}
}
catch (IllegalArgumentException | OrekitException e)
{
throw new SAXException(e);
}
}
@Override
public InputSource resolveEntity(final String publicId, final String systemId) {
// disable external entities
return new InputSource();
}
/** Parse a line in an observation data block.
*/
private void parseObservationDataLine() {
// Parse an observation line
// An XML observation line should consist in the string "<KEYWORD>value</KEYWORD>
// Each observation block should display:
// - One line with the keyword EPOCH;
// - One line with a specific data keyword
switch(currentKeyword) {
case EPOCH:
// Convert the date to an AbsoluteDate object (OrekitException if it fails)
currentObservationEpoch = parseInfo.parseDate(parseInfo.keyValue.getValue(),
parseInfo.currentObservationsBlock.getMetaData().getTimeSystem());
break;
default:
try {
// Update current observation keyword
currentObservationKeyword = currentKeyword;
// Convert the value to double (NumberFormatException if it fails)
currentObservationMeasurement = Double.parseDouble(parseInfo.keyValue.getValue());
} catch (NumberFormatException nfe) {
throw new OrekitException(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE,
parseInfo.lineNumber, parseInfo.fileName, parseInfo.line);
}
break;
}
}
}
}