Package org.deltava.beans.navdata

Class NavigationDataBean

java.lang.Object

org.deltava.beans.navdata.NavigationDataBean

All Implemented Interfaces:

Serializable, Cloneable, Comparable<NavigationDataBean>, GeoLocation, IconMapEntry, MapEntry, MarkerMapEntry, Cacheable

Direct Known Subclasses:

AirportLocation, Gate, Intersection, NavigationFrequencyBean

public abstract class NavigationDataBean
extends Object
implements Cloneable, Cacheable, Comparable<NavigationDataBean>, MarkerMapEntry, IconMapEntry

A bean to store common properties for Navigation Database objects.

Since:

1.0

Version:

11.0

Author:

Luke

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.deltava.beans.GeoLocation

ALL, DEGREE_FEET, DEGREE_MILES, FEET_MILES, LAT_DIRECTIONS, LATITUDE, LON_DIRECTIONS, LONGITUDE, RADIAN_MILES

Fields inherited from interface org.deltava.beans.MapEntry

BLUE, BROWN, COLORS, GREEN, GREY, LINECOLORS, ORANGE, PURPLE, RED, WHITE, YELLOW

Constructor Summary

Constructors

Constructor	Description
NavigationDataBean(Navaid type, double lat, double lon)	Creates a new Navigation Object.

Method Summary

Modifier and Type	Method	Description
Object	cacheKey()	Returns the cache key for this object.
Object	clone()
int	compareTo(NavigationDataBean nb2)	Compares two objects by comparing their codes.
static NavigationDataBean	create(String id)	Creats a bean from a unique ID that matches the ACARS dispatch client.
static NavigationDataBean	create(Navaid type, double lat, double lng)	Creates a bean from a type, latitude and longitude.
boolean	equals(Object o2)
String	getAirway()	Returns if this waypoint is on an Airway.
String	getCode()	Returns the object's code.
protected String	getHTMLPosition()	Helper method to return the Latitude/Longitude for HTML infoboxes.
protected String	getHTMLTitle()	Helper method to return the item type and code for HTML infoboxes.
final double	getLatitude()	Returns the latitude of this location.
final double	getLongitude()	Returns the longitude of this location.
String	getName()	Returns the object's name.
GeoPosition	getPosition()	Returns the object's position.
final String	getRegion()	Returns the ICAO region code for this entry.
final Navaid	getType()	Returns the object's type.
int	hashCode()
static CodeType	isCoordinates(String code)	Returns whether a waypoint code is actually encoded coordinates.
boolean	isInTerminalRoute()	Returns whether this waypoint is part of a terminal route.
void	setAirway(String code)	Updates if this entry is on an airway.
void	setCode(String code)	Updates the object's code.
void	setName(String name)	Updates the object's name.
void	setRegion(String rCode)	Updates the ICAO region code for this entry.
String	toString()	Returns this navigation aid's unique ID in a format that matches the ACARS dispatch client.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.deltava.beans.GeoLocation

distanceFeet, distanceTo

Methods inherited from interface org.deltava.beans.IconMapEntry

getIconCode, getPaletteCode

Methods inherited from interface org.deltava.beans.MapEntry

getInfoBox

Methods inherited from interface org.deltava.beans.MarkerMapEntry

getIconColor

Constructor Details

NavigationDataBean

public NavigationDataBean(Navaid type,
 double lat,
 double lon)

Creates a new Navigation Object.

Parameters:

type - the object type code

lat - the latitude in degrees

lon - the longitude in degrees

See Also:

• getLatitude()
• getLongitude()

Method Details

getCode

public String getCode()

Returns the object's code.

Returns:

the navigation object code

See Also:

• setCode(String)

getName

public String getName()

Returns the object's name.

Returns:

the name

See Also:

• setName(String)

getLatitude

public final double getLatitude()

Description copied from interface: GeoLocation

Returns the latitude of this location.

Specified by:

getLatitude in interface GeoLocation

Returns:

the latitude in degrees

getLongitude

public final double getLongitude()

Description copied from interface: GeoLocation

Returns the longitude of this location.

Specified by:

getLongitude in interface GeoLocation

Returns:

the longitude in degrees

getPosition

public GeoPosition getPosition()

Returns the object's position.

Returns:

the GeoPosition of this object

See Also:

• getLatitude()
• getLongitude()

getType

public final Navaid getType()

Returns the object's type.

Returns:

the object type code

getRegion

public final String getRegion()

Returns the ICAO region code for this entry.

Returns:

the region code

See Also:

• setRegion(String)

getAirway

public String getAirway()

Returns if this waypoint is on an Airway.

Returns:

the airway code

isInTerminalRoute

public boolean isInTerminalRoute()

Returns whether this waypoint is part of a terminal route.

Returns:

TRUE if part of a Terminal Route, otherwise FALSE

setCode

public void setCode(String code)

Updates the object's code.

Parameters:

code - the code

See Also:

• getCode()

setName

public void setName(String name)

Updates the object's name.

Parameters:

name - the name

Throws:

NullPointerException - if name is null

See Also:

• setName(String)

setRegion

public void setRegion(String rCode)

Updates the ICAO region code for this entry.

Parameters:

rCode - the ICAO region code

See Also:

• getRegion()

setAirway

public void setAirway(String code)

Updates if this entry is on an airway.

Parameters:

code - the airway code, or null if none

compareTo

public int compareTo(NavigationDataBean nb2)

Compares two objects by comparing their codes. If the codes are equal, then their item types and then distances from point 0,0 are compared.

Specified by:

compareTo in interface Comparable<NavigationDataBean>

getHTMLTitle

protected String getHTMLTitle()

Helper method to return the item type and code for HTML infoboxes.

Returns:

the HTML-formatted code and description

See Also:

• MapEntry.getInfoBox()

getHTMLPosition

protected String getHTMLPosition()

Helper method to return the Latitude/Longitude for HTML infoboxes.

Returns:

the HTML-formatted latitude/longitude

See Also:

• MapEntry.getInfoBox()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o2)

Overrides:

equals in class Object

cacheKey

public Object cacheKey()

Description copied from interface: Cacheable

Returns the cache key for this object. Caches call this method when adding the object.

Specified by:

cacheKey in interface Cacheable

Returns:

the cache key for the object

toString

public String toString()

Returns this navigation aid's unique ID in a format that matches the ACARS dispatch client. Changing this format will probably break the dispatch client!

Overrides:

toString in class Object

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

create

public static NavigationDataBean create(Navaid type,
 double lat,
 double lng)

Creates a bean from a type, latitude and longitude.

Parameters:

type - the navigation aid type

lat - the latitude in degrees

lng - the longitude in degrees

Returns:

a NavigationDataBean, or null if the type is unknown

create

public static NavigationDataBean create(String id)

Creats a bean from a unique ID that matches the ACARS dispatch client.

Parameters:

id - the ID.

Returns:

a NavigationDataBean

isCoordinates

public static CodeType isCoordinates(String code)

Returns whether a waypoint code is actually encoded coordinates.

Parameters:

code - the waypoint code

Returns:

TRUE if in XXYYN format or XXNYYYE format, otherwise FALSE