public class DataProvidersManager extends Object
This class is the primary point of access for all data loading features. It is used for example to load Earth Orientation Parameters used by IERS frames, to load UTC leap seconds used by time scales, to load planetary ephemerides...
It is user-customizable: users can add their own data providers at will. This allows them for example to use a database or an existing data loading library in order to embed an Orekit enabled application in a global system with its own data handling mechanisms. There is no upper limitation on the number of providers, but often each application will use only a few.
If the list of providers is empty when attempting to
feed a file loader, the
addDefaultProviders() method is called
automatically to set up a default configuration. This default configuration
data provider for each component of the
path-like list specified by the java property
feed method documentation for further
details. The default providers configuration is not set up if the list
is not empty. If users want to have both the default providers and additional
providers, they must call explicitly the
The default configuration uses a predefined set of
that already handled gzip-compressed files (recognized by the
Unix-compressed files (recognized by the
.Z suffix) and Hatanaka compressed
RINEX files. Users can access the
filters manager to
set up custom filters for handling specific types of filters (decompression,
|Modifier and Type||Field and Description|
Name of the property defining the root directories or zip/jar files path for default configuration.
|Constructor and Description|
Build an instance with default configuration.
|Modifier and Type||Method and Description|
Add the default providers configuration.
Add a data provider to the supported list.
Clear the set of data file names that have been loaded.
Remove all data providers.
Feed a data file loader by browsing all data providers.
Get the manager for filters.
Get an unmodifiable view of the set of data file names that have been loaded.
Get an unmodifiable view of the list of supported providers.
Check if some provider is supported.
Remove one provider.
Reset all filters to default.
public FiltersManager getFiltersManager()
public void resetFiltersToDefault()
public void addDefaultProviders()
The default configuration contains one
for each component of the path-like list specified by the java property
If the property is not set or is null, no data will be available to the library (for example no pole corrections will be applied and only predefined UTC steps will be taken into account). No errors will be triggered in this case.
If the property is set, it must contains a list of existing directories or zip/jar
DirectoryCrawler instance will be set up for each
directory and one
ZipJarCrawler instance (configured to look for the
archive in the filesystem) will be set up for each zip/jar archive. The list
elements in the java property are separated using the standard path separator for
the operating system as returned by
System.getProperty("path.separator"). This standard path separator is ":" on
Linux and Unix type systems and ";" on Windows types systems.
public void addProvider(DataProvider provider)
public DataProvider removeProvider(DataProvider provider)
public void clearProviders()
public boolean isSupported(DataProvider provider)
public List<DataProvider> getProviders()
The names returned are exactly the ones that were given to the
public void clearLoadedDataNames()
public boolean feed(String supportedNames, DataLoader loader)
If this method is called with an empty list of providers, a default
providers configuration is set up. This default configuration contains
data provider: a
instance that loads data from files located somewhere in a directory hierarchy.
This default provider is not added if the list is not empty. If users
want to have both the default provider and other providers, they must add it
The providers are used in the order in which they were
added. As soon as one provider is able to feed the data loader, the loop is
stopped. If no provider is able to feed the data loader, then the last error
triggered is thrown.
supportedNames- regular expression for file names supported by the visitor
loader- data loader to use
Copyright © 2002-2022 CS GROUP. All rights reserved.