Class OceanicTrack

java.lang.Object

org.deltava.beans.navdata.Airway

org.deltava.beans.navdata.OceanicTrack

All Implemented Interfaces:

Serializable, Comparable<Airway>, GeoLocation, OceanicTrackInfo, Route, Cacheable

public class OceanicTrack
extends Airway
implements OceanicTrackInfo

A bean to store Oceanic Track (NAT/PACOT/AUSOT) information.

Since:

1.0

Version:

9.1

Author:

Luke

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface OceanicTrackInfo

OceanicTrackInfo.Direction, OceanicTrackInfo.Type

Modifier and Type	Interface	Description
static enum	OceanicTrackInfo.Direction	An enumeration for Oceanic Track direction.
static enum	OceanicTrackInfo.Type	An enumeration for Oceanic Track types.

Field Summary

Fields inherited from class Airway

_awseq, _waypoints

Modifier and Type	Field	Description
protected int	_awseq
protected final LinkedList<NavigationDataBean>	_waypoints	Waypoints.

Fields inherited from interface GeoLocation

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

Modifier and Type	Field	Description
static final int	ALL	Format the Longitude and Latitude.
static final double	DEGREE_FEET	Size of a degree in feet.
static final double	DEGREE_MILES	Size of a degree in miles.
static final int	FEET_MILES	Size of a mile in feet.
static final String[]	LAT_DIRECTIONS	Latitude directions.
static final int	LATITUDE	Format the Latitude only.
static final String[]	LON_DIRECTIONS	Longitude directions.
static final int	LONGITUDE	Format the Longitude only.
static final int	RADIAN_MILES	Radius of the Earth in miles.

Constructor Summary

Constructors

Constructor	Description
OceanicTrack(OceanicTrackInfo.Type type, String code)	Creates a new Oceanic Route.

Method Summary

Modifier and Type	Method	Description
void	addWaypoint(NavigationDataBean nd)	Adds a waypoint to the Oceanic Track.
Instant	getDate()	Returns the date of the Oceanic Route NOTAM.
OceanicTrackInfo.Direction	getDirection()	Returns the direction of this Oceanic Track, based on waypoints.
NavigationDataBean	getEnd()	Returns the last waypoint on this track.
NavigationDataBean	getStart()	Returns the first waypoint on this track.
String	getTrack()	Returns the Track ID.
OceanicTrackInfo.Type	getType()	Returns the route type code.
boolean	isFixed()	Returns whether the track is fixed from day to day.
static boolean	isNameValid(String name)	Checks if a route waypoint is really an Oceanic Track name.
OceanicTrack	reverse()	Reverses an Oceanic Track's waypoints.
void	setDate(Instant d)	Updates the NOTAM effective date.
String	toString()

Methods inherited from class Airway

cacheKey, compareTo, contains, equals, find, getCode, getLatitude, getLongitude, getRoute, getSequence, getSize, getWaypoints, getWaypoints, hashCode, isHighLevel, isLowLevel, setCode, setHighLevel, setLowLevel

Modifier and Type	Method	Description
Object	cacheKey()	Returns the cache key for this object.
int	compareTo(Airway a2)
boolean	contains(String code)	Returns whether this Airway contains a particular waypoint.
boolean	equals(Object o2)
protected int	find(String code)	Finds a waypoint in this Airway.
String	getCode()	Returns the airway code.
double	getLatitude()	Returns the latitude of the middle of the Airway.
double	getLongitude()	Returns the longitude of the middle of the Airway.
String	getRoute()	Returns the Airway route.
int	getSequence()	Returns the sequence number, used to differentiate airways with different locations but the same code.
int	getSize()	Returns the number of waypoints in the airway.
LinkedList<NavigationDataBean>	getWaypoints()	Returns the waypoints for this Airway.
List<NavigationDataBean>	getWaypoints(String start, String end)	Returns a subset of waypoints for this Airway between two waypoints.
int	hashCode()
boolean	isHighLevel()	Returns if this Airway is a high-level Airway.
boolean	isLowLevel()	Returns if this Airway is a low-level Airway.
void	setCode(String code)	Updates the Airway code.
void	setHighLevel(boolean isHigh)	Marks this Airway as a high-level Airway.
void	setLowLevel(boolean isLow)	Marks this Airway as a low-level Airway.

Methods inherited from class Object

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

Methods inherited from interface GeoLocation

distanceFeet, distanceTo

Modifier and Type	Method	Description
default int	distanceFeet(GeoLocation l2)	Calculates the distance between two points in feet.
default int	distanceTo(GeoLocation l2)	Calculates the distance between two GeoLocations.

Constructor Details

OceanicTrack

public OceanicTrack(OceanicTrackInfo.Type type,
 String code)

Creates a new Oceanic Route.

Parameters:

type - the route Type

code - the route code

Method Details

getDate

public Instant getDate()

Returns the date of the Oceanic Route NOTAM.

Specified by:

getDate in interface OceanicTrackInfo

Returns:

the route date

See Also:

• setDate(Instant)

getType

public OceanicTrackInfo.Type getType()

Returns the route type code.

Specified by:

getType in interface OceanicTrackInfo

Returns:

the route type

getDirection

public OceanicTrackInfo.Direction getDirection()

Returns the direction of this Oceanic Track, based on waypoints.

Returns:

the Direction

reverse

public OceanicTrack reverse()

Reverses an Oceanic Track's waypoints.

Returns:

an OceanicTrack with reversed waypoints

isFixed

public boolean isFixed()

Returns whether the track is fixed from day to day.

Returns:

FALSE always

getTrack

public String getTrack()

Returns the Track ID.

Returns:

the track ID

getStart

public NavigationDataBean getStart()

Returns the first waypoint on this track.

Returns:

the first waypoint bean

See Also:

• getEnd()

getEnd

public NavigationDataBean getEnd()

Returns the last waypoint on this track.

Returns:

the last waypoint bean

See Also:

• getStart()

setDate

public void setDate(Instant d)

Updates the NOTAM effective date.

Parameters:

d - the NOTAM date

See Also:

• OceanicTrackInfo.getDate()

addWaypoint

public void addWaypoint(NavigationDataBean nd)

Adds a waypoint to the Oceanic Track. This preserves the airway code for the Navigation data bean if it appears to have multiple airways listed (for the NAT/PACOT plotters).

Specified by:

addWaypoint in interface Route

Overrides:

addWaypoint in class Airway

Parameters:

nd - the waypoint

See Also:

• Airway.getWaypoints()

isNameValid

public static boolean isNameValid(String name)

Checks if a route waypoint is really an Oceanic Track name.

Parameters:

name - the waypoint name

Returns:

TRUE if a valid Oceanic Track name, otherwise FALSE

toString

public String toString()

Overrides:

toString in class Airway