agi.foundation.stk

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

Class StkCityDatabaseQuery

java.lang.Object

agi.foundation.stk.StkCityDatabaseQuery

public class StkCityDatabaseQuery
extends Object

A query to be run against a StkCityDatabase.

The following example shows how to query the city database for cities matching certain criteria:

StkCityDatabase db = new StkCityDatabase(dbDirectory, "stkCityDb");

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

// only look in PA, because there's also a New Philadelphia in Ohio
query.setProvinceName(Pattern.compile("Pennsylvania"));

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

Constructor Summary

Constructors

Constructor and Description
StkCityDatabaseQuery()

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	getCityName() Gets a regular expression that the CityName (get / set) must match in order to be included in the query.
Pattern	getCountryName() Gets a regular expression that the CountryName (get / set) must match in order 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	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	getProvinceName() Gets a regular expression that the ProvinceName (get / set) must match in order to be included in the query.
CityType	getTypeOfCity() Gets a value that the TypeOfCity (get / set) must match in order to be included in the query.
boolean	matches(StkCityDatabaseEntry 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	setCityName(Pattern value) Sets a regular expression that the CityName (get / set) must match in order to be included in the query.
void	setCountryName(Pattern value) Sets a regular expression that the CountryName (get / set) must match in order 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	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	setProvinceName(Pattern value) Sets a regular expression that the ProvinceName (get / set) must match in order to be included in the query.
void	setTypeOfCity(CityType value) Sets a value that the TypeOfCity (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

StkCityDatabaseQuery

public StkCityDatabaseQuery()

Method Detail

getCityName

public final Pattern getCityName()

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

setCityName

public final void setCityName(Pattern value)

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

getTypeOfCity

@Nonnull
public final CityType getTypeOfCity()

Gets a value that the TypeOfCity (get / set) must match in order to be included in the query.

setTypeOfCity

public final void setTypeOfCity(@Nonnull
                                CityType value)

Sets a value that the TypeOfCity (get / set) must match in order to be included in the query.

getProvinceName

public final Pattern getProvinceName()

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

setProvinceName

public final void setProvinceName(Pattern value)

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

getCountryName

public final Pattern getCountryName()

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

setCountryName

public final void setCountryName(Pattern value)

Sets a regular expression that the CountryName (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.

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
                             StkCityDatabaseEntry 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.