agi.foundation.navigation.datareaders

(agi.foundation.navigation-2024r2.jar)

Class PredictionSupportFile

java.lang.Object

agi.foundation.compatibility.BaseCollection<PredictionSupportRecord>

agi.foundation.navigation.datareaders.PredictionSupportFile

All Implemented Interfaces:

Iterable<PredictionSupportRecord>, Collection<PredictionSupportRecord>, List<PredictionSupportRecord>

public class PredictionSupportFile
extends BaseCollection<PredictionSupportRecord>

A Prediction Support File (PSF) containing statistical data necessary to predict navigation accuracy.

Constructor Summary

Constructors

Constructor and Description
PredictionSupportFile() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
static PredictionSupportFile	downloadPredictionSupportFile(JulianDate dateOfPsf) Downloads the Prediction Support File from an AGI server and returns the contents of the file as a PredictionSupportFile.
static PredictionSupportFile	downloadPredictionSupportFile(JulianDate dateOfPsf, Proxy proxy) Downloads the Prediction Support File from an AGI server and returns the contents of the file as a PredictionSupportFile.
static String	downloadRawPredictionSupportFile(JulianDate dateOfPsf) Downloads the Prediction Support File from an AGI server and returns the contents of the file as a string.
static String	downloadRawPredictionSupportFile(JulianDate dateOfPsf, Proxy proxy) Downloads the Prediction Support File from an AGI server and returns the contents of the file as a string.
PredictionSupportRecord	findRecordByPrn(int prn) Finds the prediction support record corresponding to a specified pseudo-random number (PRN).
ZonedDateTime	getCreationDate() Gets the creation date of the PSF file.
JulianDate	getCreationJulianDate() Gets the creation date of the PSF file express as a JulianDate.
String	getFileId() Gets the FILEID of the PSF file.
ZonedDateTime	getReferenceDate() Gets the reference date of the PSF file.
JulianDate	getReferenceJulianDate() Gets the reference date of the PSF file expressed as a JulianDate.
String	getSource() Gets the SOURCE of the PSF file.
String	getSystemId() Gets the SYSID of the PSF file.
static PredictionSupportFile	readFrom(BufferedReader reader) Reads a PredictionSupportFile in version 1 format from a reader.
static PredictionSupportFile	readFrom(InputStream stream) Reads a PredictionSupportFile in version 1 format from a stream.
static PredictionSupportFile	readFrom(String fileName) Reads a PredictionSupportFile in version 1 format.
void	setCreationDate(ZonedDateTime value) Sets the creation date of the PSF file.
void	setFileId(String value) Sets the FILEID of the PSF file.
void	setReferenceDate(ZonedDateTime value) Sets the reference date of the PSF file.
void	setSource(String value) Sets the SOURCE of the PSF file.
void	setSystemId(String value) Sets the SYSID of the PSF file.
void	writeToPsfVersion1(Writer writer) Write a PSF file in version 1 format.

Methods inherited from class agi.foundation.compatibility.BaseCollection

add, add, addAll, addAll, clear, clearItems, contains, containsAll, get, getItems, indexOf, insertItem, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeItem, retainAll, set, setItem, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

PredictionSupportFile

public PredictionSupportFile()

Initializes a new instance.

Method Detail

readFrom

@Nonnull
public static PredictionSupportFile readFrom(@Nonnull
                                                       String fileName)

Reads a PredictionSupportFile in version 1 format.

Parameters:

fileName - The name of the PredictionSupportFile from which to read.

Returns:

A PredictionSupportFile instance containing the data read from the file.

Throws:

ArgumentNullException - Thrown when fileName is null.

readFrom

@Nonnull
public static PredictionSupportFile readFrom(@Nonnull
                                                       InputStream stream)

Reads a PredictionSupportFile in version 1 format from a stream.

Parameters:

stream - A stream from which to read the PredictionSupportFile.

Returns:

A PredictionSupportFile instance containing the data read from the stream.

Throws:

ArgumentNullException - Thrown when stream is null.

readFrom

@Nonnull
public static PredictionSupportFile readFrom(@Nonnull
                                                       BufferedReader reader)

Reads a PredictionSupportFile in version 1 format from a reader.

Parameters:

reader - The reader from which to read the PredictionSupportFile.

Returns:

A PredictionSupportFile instance containing the data read from the reader.

Throws:

ArgumentNullException - Thrown when reader is null.

downloadPredictionSupportFile

@Nonnull
public static PredictionSupportFile downloadPredictionSupportFile(@Nonnull
                                                                            JulianDate dateOfPsf)

Downloads the Prediction Support File from an AGI server and returns the contents of the file as a PredictionSupportFile. This method connects via HTTPS to ftp.agi.com.

Parameters:

dateOfPsf - Date for which the PredictionSupportFile is needed.

Returns:

A PredictionSupportFile populated with the data returned from the server.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadPredictionSupportFile

@Nonnull
public static PredictionSupportFile downloadPredictionSupportFile(@Nonnull
                                                                            JulianDate dateOfPsf,
                                                                            Proxy proxy)

Downloads the Prediction Support File from an AGI server and returns the contents of the file as a PredictionSupportFile. This method connects via HTTPS to ftp.agi.com.

Parameters:

dateOfPsf - Date for which the PredictionSupportFile is needed.

proxy - Proxy to use when connecting.

Returns:

A PredictionSupportFile populated with the data returned from the server.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadRawPredictionSupportFile

@Nonnull
public static String downloadRawPredictionSupportFile(@Nonnull
                                                                JulianDate dateOfPsf)

Downloads the Prediction Support File from an AGI server and returns the contents of the file as a string. This method connects via HTTPS to ftp.agi.com.

Parameters:

dateOfPsf - Date for which the PredictionSupportFile is needed.

Returns:

A string containing the contents of the Prediction Support File returned from the server.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadRawPredictionSupportFile

@Nonnull
public static String downloadRawPredictionSupportFile(@Nonnull
                                                                JulianDate dateOfPsf,
                                                                @Nullable
                                                                Proxy proxy)

Downloads the Prediction Support File from an AGI server and returns the contents of the file as a string. This method connects via HTTPS to ftp.agi.com.

Parameters:

dateOfPsf - Date for which the PredictionSupportFile is needed.

proxy - Proxy to use when connecting.

Returns:

>A string containing the contents of the Prediction Support File returned from the server.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

getFileId

public final String getFileId()

Gets the FILEID of the PSF file.

setFileId

public final void setFileId(String value)

Sets the FILEID of the PSF file.

getSystemId

public final String getSystemId()

Gets the SYSID of the PSF file.

setSystemId

public final void setSystemId(String value)

Sets the SYSID of the PSF file.

getSource

public final String getSource()

Gets the SOURCE of the PSF file.

setSource

public final void setSource(String value)

Sets the SOURCE of the PSF file.

getReferenceDate

@Nonnull
public final ZonedDateTime getReferenceDate()

Gets the reference date of the PSF file.

setReferenceDate

public final void setReferenceDate(@Nonnull
                                   ZonedDateTime value)

Sets the reference date of the PSF file.

getReferenceJulianDate

@Nonnull
public final JulianDate getReferenceJulianDate()

Gets the reference date of the PSF file expressed as a JulianDate.

getCreationDate

@Nonnull
public final ZonedDateTime getCreationDate()

Gets the creation date of the PSF file.

setCreationDate

public final void setCreationDate(@Nonnull
                                  ZonedDateTime value)

Sets the creation date of the PSF file.

getCreationJulianDate

@Nonnull
public final JulianDate getCreationJulianDate()

Gets the creation date of the PSF file express as a JulianDate.

findRecordByPrn

public final PredictionSupportRecord findRecordByPrn(int prn)

Finds the prediction support record corresponding to a specified pseudo-random number (PRN).

Parameters:

prn - The PRN for which to obtain a record.

Returns:

The prediction support record for the specified PRN, or null if a record does not exist for the PRN.

writeToPsfVersion1

public final void writeToPsfVersion1(@Nonnull
                                     Writer writer)

Write a PSF file in version 1 format.

Parameters:

writer - The writer to write the file to.