agi.foundation.stk

(agi.foundation.models-2024r3.jar)

Class StkSatelliteDatabaseQuery

java.lang.Object

agi.foundation.stk.StkSatelliteDatabaseQuery

public class StkSatelliteDatabaseQuery
extends Object

A query to be run against a StkSatelliteDatabase.

The following example shows how to query the satellite database for satellites matching certain criteria:

StkSatelliteDatabase db = new StkSatelliteDatabase(dbDirectory, "stkSatDb");

// Create a query object and then populate it with the properties to query on.
// Regular expressions are used to query on strings.
StkSatelliteDatabaseQuery query = new StkSatelliteDatabaseQuery();
query.setCommonName(Pattern.compile("QUICK"));
query.setMinimumApogee(200000.0);

// Get the database entries matching the query and print out the SSC number of each.
for (StkSatelliteDatabaseEntry entry : db.getEntries(query)) {
    System.out.println(entry.getSatelliteNumber());
}

Constructor Summary

Constructors

Constructor and Description
StkSatelliteDatabaseQuery()

Method Summary

Modifier and Type	Method and Description
Boolean	getActive() Gets the value of Active (get / set) that is required in order for the entry to be included in the query.
Pattern	getCommonName() Gets a regular expression that the CommonName (get / set) must match in order to be included in the query.
Pattern	getInternationalDesignator() Gets a regular expression that the InternationalDesignator (get / set) must match in order to be included in the query.
Double	getMaximumApogee() Gets the maximum value of Apogee (get / set) that is allowed in order for the entry to be included in the query.
Double	getMaximumInclination() Gets the maximum value of Inclination (get / set) that is allowed in order for the entry to be included in the query.
Double	getMaximumPerigee() Gets the maximum value of Perigee (get / set) that is allowed in order for the entry to be included in the query.
Double	getMaximumPeriod() Gets the maximum value of Period (get / set) that is allowed in order for the entry to be included in the query.
Double	getMinimumApogee() Gets the minimum value of Apogee (get / set) that is allowed in order for the entry to be included in the query.
Double	getMinimumInclination() Gets the minimum value of Inclination (get / set) that is allowed in order for the entry to be included in the query.
Double	getMinimumPerigee() Gets the minimum value of Perigee (get / set) that is allowed in order for the entry to be included in the query.
Double	getMinimumPeriod() Gets the minimum value of Period (get / set) that is allowed in order for the entry to be included in the query.
Pattern	getMission() Gets a regular expression that the Mission (get / set) must match in order to be included in the query.
Pattern	getOfficialName() Gets a regular expression that the OfficialName (get / set) must match in order to be included in the query.
Pattern	getOwner() Gets a regular expression that the Owner (get / set) must match in order to be included in the query.
Pattern	getSatelliteNumber() Gets a regular expression that the SatelliteNumber (get / set) must match in order to be included in the query.
boolean	matches(StkSatelliteDatabaseEntry entry) Determines if an entry matches this query.
void	setActive(Boolean value) Sets the value of Active (get / set) that is required in order for the entry to be included in the query.
void	setCommonName(Pattern value) Sets a regular expression that the CommonName (get / set) must match in order to be included in the query.
void	setInternationalDesignator(Pattern value) Sets a regular expression that the InternationalDesignator (get / set) must match in order to be included in the query.
void	setMaximumApogee(Double value) Sets the maximum value of Apogee (get / set) that is allowed in order for the entry to be included in the query.
void	setMaximumInclination(Double value) Sets the maximum value of Inclination (get / set) that is allowed in order for the entry to be included in the query.
void	setMaximumPerigee(Double value) Sets the maximum value of Perigee (get / set) that is allowed in order for the entry to be included in the query.
void	setMaximumPeriod(Double value) Sets the maximum value of Period (get / set) that is allowed in order for the entry to be included in the query.
void	setMinimumApogee(Double value) Sets the minimum value of Apogee (get / set) that is allowed in order for the entry to be included in the query.
void	setMinimumInclination(Double value) Sets the minimum value of Inclination (get / set) that is allowed in order for the entry to be included in the query.
void	setMinimumPerigee(Double value) Sets the minimum value of Perigee (get / set) that is allowed in order for the entry to be included in the query.
void	setMinimumPeriod(Double value) Sets the minimum value of Period (get / set) that is allowed in order for the entry to be included in the query.
void	setMission(Pattern value) Sets a regular expression that the Mission (get / set) must match in order to be included in the query.
void	setOfficialName(Pattern value) Sets a regular expression that the OfficialName (get / set) must match in order to be included in the query.
void	setOwner(Pattern value) Sets a regular expression that the Owner (get / set) must match in order to be included in the query.
void	setSatelliteNumber(Pattern value) Sets a regular expression that the SatelliteNumber (get / set) must match in order to be included in the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

StkSatelliteDatabaseQuery

public StkSatelliteDatabaseQuery()

Method Detail

getSatelliteNumber

public final Pattern getSatelliteNumber()

Gets a regular expression that the SatelliteNumber (get / set) must match in order to be included in the query.

setSatelliteNumber

public final void setSatelliteNumber(Pattern value)

Sets a regular expression that the SatelliteNumber (get / set) must match in order to be included in the query.

getCommonName

public final Pattern getCommonName()

Gets a regular expression that the CommonName (get / set) must match in order to be included in the query.

setCommonName

public final void setCommonName(Pattern value)

Sets a regular expression that the CommonName (get / set) must match in order to be included in the query.

getOfficialName

public final Pattern getOfficialName()

Gets a regular expression that the OfficialName (get / set) must match in order to be included in the query.

setOfficialName

public final void setOfficialName(Pattern value)

Sets a regular expression that the OfficialName (get / set) must match in order to be included in the query.

getInternationalDesignator

public final Pattern getInternationalDesignator()

Gets a regular expression that the InternationalDesignator (get / set) must match in order to be included in the query.

setInternationalDesignator

public final void setInternationalDesignator(Pattern value)

Sets a regular expression that the InternationalDesignator (get / set) must match in order to be included in the query.

getOwner

public final Pattern getOwner()

Gets a regular expression that the Owner (get / set) must match in order to be included in the query.

setOwner

public final void setOwner(Pattern value)

Sets a regular expression that the Owner (get / set) must match in order to be included in the query.

getMission

public final Pattern getMission()

Gets a regular expression that the Mission (get / set) must match in order to be included in the query.

setMission

public final void setMission(Pattern value)

Sets a regular expression that the Mission (get / set) must match in order to be included in the query.

getActive

@Nullable
public final Boolean getActive()

Gets the value of Active (get / set) that is required in order for the entry to be included in the query.

setActive

public final void setActive(@Nullable
                            Boolean value)

Sets the value of Active (get / set) that is required in order for the entry to be included in the query.

getMinimumApogee

@Nullable
public final Double getMinimumApogee()

Gets the minimum value of Apogee (get / set) that is allowed in order for the entry to be included in the query.

setMinimumApogee

public final void setMinimumApogee(@Nullable
                                   Double value)

Sets the minimum value of Apogee (get / set) that is allowed in order for the entry to be included in the query.

getMaximumApogee

@Nullable
public final Double getMaximumApogee()

Gets the maximum value of Apogee (get / set) that is allowed in order for the entry to be included in the query.

setMaximumApogee

public final void setMaximumApogee(@Nullable
                                   Double value)

Sets the maximum value of Apogee (get / set) that is allowed in order for the entry to be included in the query.

getMinimumPerigee

@Nullable
public final Double getMinimumPerigee()

Gets the minimum value of Perigee (get / set) that is allowed in order for the entry to be included in the query.

setMinimumPerigee

public final void setMinimumPerigee(@Nullable
                                    Double value)

Sets the minimum value of Perigee (get / set) that is allowed in order for the entry to be included in the query.

getMaximumPerigee

@Nullable
public final Double getMaximumPerigee()

Gets the maximum value of Perigee (get / set) that is allowed in order for the entry to be included in the query.

setMaximumPerigee

public final void setMaximumPerigee(@Nullable
                                    Double value)

Sets the maximum value of Perigee (get / set) that is allowed in order for the entry to be included in the query.

getMinimumPeriod

@Nullable
public final Double getMinimumPeriod()

Gets the minimum value of Period (get / set) that is allowed in order for the entry to be included in the query.

setMinimumPeriod

public final void setMinimumPeriod(@Nullable
                                   Double value)

Sets the minimum value of Period (get / set) that is allowed in order for the entry to be included in the query.

getMaximumPeriod

@Nullable
public final Double getMaximumPeriod()

Gets the maximum value of Period (get / set) that is allowed in order for the entry to be included in the query.

setMaximumPeriod

public final void setMaximumPeriod(@Nullable
                                   Double value)

Sets the maximum value of Period (get / set) that is allowed in order for the entry to be included in the query.

getMinimumInclination

@Nullable
public final Double getMinimumInclination()

Gets the minimum value of Inclination (get / set) that is allowed in order for the entry to be included in the query.

setMinimumInclination

public final void setMinimumInclination(@Nullable
                                        Double value)

Sets the minimum value of Inclination (get / set) that is allowed in order for the entry to be included in the query.

getMaximumInclination

@Nullable
public final Double getMaximumInclination()

Gets the maximum value of Inclination (get / set) that is allowed in order for the entry to be included in the query.

setMaximumInclination

public final void setMaximumInclination(@Nullable
                                        Double value)

Sets the maximum value of Inclination (get / set) that is allowed in order for the entry to be included in the query.

matches

public final boolean matches(@Nonnull
                             StkSatelliteDatabaseEntry entry)

Determines if an entry matches this query.

Parameters:

entry - The entry to check.

Returns:

true if the entry matches this query; otherwise false.

Throws:

ArgumentNullException - Thrown when entry is null.