agi.foundation.stk

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

Class StkFacilityDatabaseQuery

java.lang.Object

agi.foundation.stk.StkFacilityDatabaseQuery

public class StkFacilityDatabaseQuery
extends Object

A query to be run against a StkFacilityDatabase.

The following example shows how to query the facility database for facilities matching certain criteria:

StkFacilityDatabase db = new StkFacilityDatabase(dbDirectory, "stkFacility");

// Create a query object and then populate it with the properties to query on.
// Regular expressions are used to query on strings.
StkFacilityDatabaseQuery query = new StkFacilityDatabaseQuery();
query.setFacilityName(Pattern.compile("^Diyarbak"));

// Get the database entries matching the query and print out the Longitude and Latitude of each.
for (StkFacilityDatabaseEntry entry : db.getEntries(query)) {
    System.out.format("%s: Longitude %f, Latitude %f%n", entry.getFacilityName(), entry.getLongitude(), entry.getLatitude());
}

Constructor Summary

Constructors

Constructor and Description
StkFacilityDatabaseQuery()

Method Summary

Modifier and Type	Method and Description
Pattern	getCentralBodyName() Gets a regular expression that the CentralBodyName (get / set) must match in order to be included in the query.
Pattern	getFacilityName() Gets a regular expression that the FacilityName (get / set) must match in order to be included in the query.
Double	getMaximumAltitude() Gets the maximum value of Altitude (get / set) in meters that is allowed in order for the entry to be included in the query.
Double	getMaximumLatitude() Gets the maximum value of Latitude (get / set) in radians that is allowed in order for the entry to be included in the query.
Double	getMaximumLongitude() Gets the maximum value of Longitude (get / set) in radians that is allowed in order for the entry to be included in the query.
Double	getMinimumAltitude() Gets the minimum value of Altitude (get / set) in meters that is allowed in order for the entry to be included in the query.
Double	getMinimumLatitude() Gets the minimum value of Latitude (get / set) in radians that is allowed in order for the entry to be included in the query.
Double	getMinimumLongitude() Gets the minimum value of Longitude (get / set) in radians that is allowed in order for the entry to be included in the query.
Pattern	getNetworkName() Gets a regular expression that the NetworkName (get / set) must match in order to be included in the query.
boolean	matches(StkFacilityDatabaseEntry entry) Determines if an entry matches this query.
void	setCentralBodyName(Pattern value) Sets a regular expression that the CentralBodyName (get / set) must match in order to be included in the query.
void	setFacilityName(Pattern value) Sets a regular expression that the FacilityName (get / set) must match in order to be included in the query.
void	setMaximumAltitude(Double value) Sets the maximum value of Altitude (get / set) in meters that is allowed in order for the entry to be included in the query.
void	setMaximumLatitude(Double value) Sets the maximum value of Latitude (get / set) in radians that is allowed in order for the entry to be included in the query.
void	setMaximumLongitude(Double value) Sets the maximum value of Longitude (get / set) in radians that is allowed in order for the entry to be included in the query.
void	setMinimumAltitude(Double value) Sets the minimum value of Altitude (get / set) in meters that is allowed in order for the entry to be included in the query.
void	setMinimumLatitude(Double value) Sets the minimum value of Latitude (get / set) in radians that is allowed in order for the entry to be included in the query.
void	setMinimumLongitude(Double value) Sets the minimum value of Longitude (get / set) in radians that is allowed in order for the entry to be included in the query.
void	setNetworkName(Pattern value) Sets a regular expression that the NetworkName (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

StkFacilityDatabaseQuery

public StkFacilityDatabaseQuery()

Method Detail

getFacilityName

public final Pattern getFacilityName()

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

setFacilityName

public final void setFacilityName(Pattern value)

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

getNetworkName

public final Pattern getNetworkName()

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

setNetworkName

public final void setNetworkName(Pattern value)

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

getMinimumLatitude

@Nullable
public final Double getMinimumLatitude()

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

setMinimumLatitude

public final void setMinimumLatitude(@Nullable
                                     Double value)

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

getMaximumLatitude

@Nullable
public final Double getMaximumLatitude()

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

setMaximumLatitude

public final void setMaximumLatitude(@Nullable
                                     Double value)

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

getMinimumLongitude

@Nullable
public final Double getMinimumLongitude()

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

setMinimumLongitude

public final void setMinimumLongitude(@Nullable
                                      Double value)

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

getMaximumLongitude

@Nullable
public final Double getMaximumLongitude()

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

setMaximumLongitude

public final void setMaximumLongitude(@Nullable
                                      Double value)

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

getMinimumAltitude

@Nullable
public final Double getMinimumAltitude()

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

setMinimumAltitude

public final void setMinimumAltitude(@Nullable
                                     Double value)

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

getMaximumAltitude

@Nullable
public final Double getMaximumAltitude()

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

setMaximumAltitude

public final void setMaximumAltitude(@Nullable
                                     Double value)

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

getCentralBodyName

public final Pattern getCentralBodyName()

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

setCentralBodyName

public final void setCentralBodyName(Pattern value)

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

matches

public final boolean matches(@Nonnull
                             StkFacilityDatabaseEntry 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.