fr.cnes.sirius.patrius.tools.ephemerisComparator
Class EphemerisComparator

java.lang.Object
  fr.cnes.sirius.patrius.tools.ephemerisComparator.EphemerisComparator

public class EphemerisComparator
extends Object

This class provides the global usage of the ephemeris comparator library.

Since:

1.0

Version:

$Id: EphemerisComparator.java 17581 2017-05-10 12:47:31Z bignon $

Author:

Philippe Pavero

Concurrency :

not thread-safe

Concurrency comment :

it uses non thread-safe objects

Constructor Summary

EphemerisComparator()
Simple constructor

Method Summary

void	clean() clean the output directory
boolean	compareFiles(URI setupFileURI, URI firstDataFileURI, URI secondDataFileURI) Uses the ephemeris comparison library to load the data contained in the file, compute the comparisons between the two files and with thresholds
boolean	compareFilesWithReport(URI setupFileURI, URI firstDataFileURI, URI secondDataFileURI, URI outputDirURI, URI xslFileURI) Uses the ephemeris comparison library to load the data contained in the file, compute the comparisons between the two files and with thresholds, and produce a report of the comparison.
ComparisonData	getAbsoluteComparisonData()
Data<Double>	getloadedData1()
Data<Double>	getloadedData2()
ComparisonData	getRawComparisonData()
ComparisonData	getRelativeComparisonData()
ThresholdsData	getThresholdsData()
void	initSetup(URI setupFileURI) create a Setup object to handle the setup information
void	produceReport(URI setupFileURI, URI firstDataFileURI, URI secondDataFileURI, URI outputDirURI, URI xslFileURI) Produce the report if all the data have been computed above

Methods inherited from class java.lang.Object

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

Constructor Detail

EphemerisComparator

public EphemerisComparator()

Simple constructor

Since:

1.0

Method Detail

clean

public final void clean()
                 throws IOException

clean the output directory

Throws:

IOException - if there is any problem with the loading, reading, saving of the files

Since:

1.0

initSetup

public final void initSetup(URI setupFileURI)
                     throws IOException

create a Setup object to handle the setup information

Parameters:

setupFileURI - the address to the setup information file

Throws:

IOException - if there is any problem with the loading, reading, saving of the files

Since:

1.0

See Also:

for more information about the properties that can be set up

compareFilesWithReport

public final boolean compareFilesWithReport(URI setupFileURI,
                                            URI firstDataFileURI,
                                            URI secondDataFileURI,
                                            URI outputDirURI,
                                            URI xslFileURI)
                                     throws IOException,
                                            EphemerisComparatorException

Uses the ephemeris comparison library to load the data contained in the file, compute the comparisons between the two files and with thresholds, and produce a report of the comparison.

Parameters:

setupFileURI - the address to the setup information file

firstDataFileURI - the address of the file that contains the first data set

secondDataFileURI - the address of the file that contains the second data set

outputDirURI - the address to put the reports

xslFileURI - the address of the XSL file

Returns:

noThresholdExceeded is true if no deviation exceeded the associated threshold

Throws:

IOException - if there is any problem with the loading, reading, saving of the files

EphemerisComparatorException - if one of the data files can not be found

Since:

1.0

See Also:

for more information about the properties that can be set up

produceReport

public final void produceReport(URI setupFileURI,
                                URI firstDataFileURI,
                                URI secondDataFileURI,
                                URI outputDirURI,
                                URI xslFileURI)
                         throws IOException,
                                EphemerisComparatorException

Produce the report if all the data have been computed above

Parameters:

setupFileURI - the address to the setup information file

firstDataFileURI - the address of the file that contains the first data set

secondDataFileURI - the address of the file that contains the second data set

outputDirURI - the address to put the reports

xslFileURI - the address of the XSL file

Throws:

IOException - if there is any problem with the loading, reading, saving of the files

EphemerisComparatorException - if one of the data files can not be found

Since:

1.0

compareFiles

public final boolean compareFiles(URI setupFileURI,
                                  URI firstDataFileURI,
                                  URI secondDataFileURI)
                           throws IOException,
                                  EphemerisComparatorException

Uses the ephemeris comparison library to load the data contained in the file, compute the comparisons between the two files and with thresholds

Parameters:

setupFileURI - the address to the setup information file

firstDataFileURI - the address of the file that contains the first data set

secondDataFileURI - the address of the file that contains the second data set

Returns:

noThresholdExceeded is true if no deviation exceeded the associated threshold

Throws:

IOException - if there is any problem with the loading, reading, saving of the files

EphemerisComparatorException - if one of the data files can not be found

Since:

1.0

See Also:

for more information about the properties that can be set up

getloadedData1

public final Data<Double> getloadedData1()

Returns:

the absoluteComparisonData

getloadedData2

public final Data<Double> getloadedData2()

Returns:

the absoluteComparisonData

getAbsoluteComparisonData

public final ComparisonData getAbsoluteComparisonData()

Returns:

the absoluteComparisonData

getRelativeComparisonData

public final ComparisonData getRelativeComparisonData()

Returns:

the relativeComparisonData

getRawComparisonData

public final ComparisonData getRawComparisonData()

Returns:

the rawComparisonData

getThresholdsData

public final ThresholdsData getThresholdsData()

Returns:

the thresholdsData