fr.cnes.sirius.patrius.time

Class UTCTAIHistoryFilesLoader

java.lang.Object

fr.cnes.sirius.patrius.time.UTCTAIHistoryFilesLoader

All Implemented Interfaces:

DataLoader, UTCTAILoader

public class UTCTAIHistoryFilesLoader
extends Object
implements UTCTAILoader

Loader for UTC versus TAI history files.

UTC versus TAI history files contain leap seconds data since.

The UTC versus TAI history files are recognized thanks to their base names, which must match the pattern UTC-TAI.history (or UTC-TAI.history.gz for gzip-compressed files)

Only one history file must be present in the IERS directories hierarchy.

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor and Description
UTCTAIHistoryFilesLoader() Build a loader for UTC-TAI history file.

Method Summary

Modifier and Type	Method and Description
String	getSupportedNames() Get the regular expression for supported files names.
void	loadData(InputStream input, String name) Load UTC-TAI offsets entries read from some file.
SortedMap<DateComponents,Integer>	loadTimeSteps() Load stored UTC-TAI offsets entries.
boolean	stillAcceptsData() Check if the loader still accepts new data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UTCTAIHistoryFilesLoader

public UTCTAIHistoryFilesLoader()

Build a loader for UTC-TAI history file.

Method Detail

getSupportedNames

public String getSupportedNames()

Get the regular expression for supported files names.

Specified by:

getSupportedNames in interface UTCTAILoader

Returns:

regular expression for supported files names

loadTimeSteps

public SortedMap<DateComponents,Integer> loadTimeSteps()

Load stored UTC-TAI offsets entries.

Specified by:

loadTimeSteps in interface UTCTAILoader

Returns:

sorted UTC-TAI offsets entries (may be empty if no data file is available)

stillAcceptsData

public boolean stillAcceptsData()

Check if the loader still accepts new data.

This method is used to speed up data loading by interrupting crawling the data sets as soon as a loader has found the data it was waiting for. For loaders that can merge data from any number of sources (for example JPL ephemerides or Earth Orientation Parameters that are split among several files), this method should always return true to make sure no data is left over.

Specified by:

stillAcceptsData in interface DataLoader

Returns:

true while the loader still accepts new data

loadData

public void loadData(InputStream input,
                     String name)
              throws PatriusException,
                     IOException,
                     ParseException

Load UTC-TAI offsets entries read from some file.

The time steps are extracted from some UTC-TAI.history[.gz] file. Since entries are stored in a SortedMap, they are chronologically sorted and only one entry remains for a given date.

Specified by:

loadData in interface DataLoader

Parameters:

input - data input stream

name - name of the file (or zip entry)

Throws:

IOException - if data can't be read

ParseException - if data can't be parsed

PatriusException - if some data is missing or if some loader specific error occurs