Package slash.navigation.columbus

Class ColumbusGpsFormat

java.lang.Object

slash.navigation.base.BaseNavigationFormat<Wgs84Route>

slash.navigation.base.TextNavigationFormat<Wgs84Route>

slash.navigation.base.SimpleFormat<Wgs84Route>

slash.navigation.base.SimpleLineBasedFormat<Wgs84Route>

slash.navigation.columbus.ColumbusGpsFormat

All Implemented Interfaces:

NavigationFormat<Wgs84Route>

Direct Known Subclasses:

ColumbusFusionFormat, ColumbusGpsType1Format, ColumbusGpsType2Format

public abstract class ColumbusGpsFormat
extends SimpleLineBasedFormat<Wgs84Route>

The base of all Columbus GPS formats.

Author:

Christian Pesch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Logger	log
protected static final char	SEPARATOR
protected static final String	SPACE_OR_ZERO
protected static final String	VALID_TAG_VALUES

Fields inherited from class slash.navigation.base.SimpleFormat

BEGIN_OF_LINE, END_OF_LINE, POSITION, WHITE_SPACE

Fields inherited from class slash.navigation.base.TextNavigationFormat

BYTE_ORDER_MARK

Fields inherited from class slash.navigation.base.BaseNavigationFormat

GENERATED_BY, UNLIMITED_MAXIMUM_POSITION_COUNT

Constructor Summary

Constructors

Constructor	Description
ColumbusGpsFormat()

Method Summary

Modifier and Type	Method	Description
protected CompactCalendar	asDeviceLocalTime(CompactCalendar time, TimeZone timeZone)	Inverts CompactCalendar.asUTCTimeInTimeZone(java.util.TimeZone), which stores local - offset(local) where local is the file's wall clock read as UTC.
protected static String	coordinate(String hemisphere)	A coordinate field: a decimal number followed by its hemisphere letter, each captured.
<P extends NavigationPosition> Wgs84Route	createRoute(RouteCharacteristics characteristics, String name, List<P> positions)
protected static String	field(String regex)	A comma-terminated capturing field surrounded by optional whitespace/NUL padding.
protected String	fillWithZeros(String string, int length)
protected String	formatCommonPrefix(Wgs84Position position, int index)
protected String	formatDate(CompactCalendar date)
protected String	formatTag(Wgs84Position position)
protected String	formatTime(CompactCalendar time)
protected CompactCalendar	getDeviceLocalTimeToWrite(Wgs84Position position)	Shared getTimeToWrite(slash.navigation.base.Wgs84Position) body for the formats that do convert device-local time to UTC on read (Type2, Fusion) — both inverted it identically, so it lives here once instead of twice.
String	getExtension()
protected abstract String	getHeader()
protected abstract Pattern	getHeaderPattern()
protected abstract Pattern	getLinePattern()
protected RouteCharacteristics	getRouteCharacteristics()
protected CompactCalendar	getTimeToWrite(Wgs84Position position)	The time to write for this position.
protected abstract boolean	hasValidFix(String line, Matcher matcher)
protected boolean	isHeader(String line)
protected boolean	isPosition(String line)
protected boolean	isValidLine(String line)
protected static String	lastField(String regex)	A capturing field without a trailing separator (the last field of a line).
protected String	latitudeHemisphere(Wgs84Position position)
protected String	longitudeHemisphere(Wgs84Position position)
protected Wgs84Position	parseCommonPosition(Matcher matcher, ParserContext<?> context, CompactCalendar dateAndTime, int descriptionGroup, boolean isTypeA)	Parses the fields common to every Columbus line format (index, tag, date/time, latitude/longitude with hemisphere sign, height, speed, heading, description) and builds the position; format-specific fields (dop/pressure/temperature) are set by callers.
protected CompactCalendar	parseDateAndTime(String date, String time)
protected String	parseDescription(String description, String index, WaypointType waypointType)
protected WaypointType	parseTag(String string)
protected String	removeZeros(String string)
protected void	writeHeader(PrintWriter writer, Wgs84Route route)

Methods inherited from class slash.navigation.base.SimpleLineBasedFormat

createRoute, getGarbleCount, getMaximumPositionCount, parsePosition, read, write, writeFooter, writePosition

Methods inherited from class slash.navigation.base.SimpleFormat

isSupportsMultipleRoutes, isWritingRouteCharacteristics

Methods inherited from class slash.navigation.base.TextNavigationFormat

isValidStartDate, read, read, write, write

Methods inherited from class slash.navigation.base.BaseNavigationFormat

asDesc, asDesc, asDescription, asDescription, asName, asName, asRouteName, equals, getCreator, getMaximumFileNameLength, getMaximumRouteNameLength, hashCode, isSupportsReading, isSupportsWriting

Methods inherited from class java.lang.Object

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

Methods inherited from interface slash.navigation.base.NavigationFormat

getName

Field Details

log

protected static final Logger log

SEPARATOR

protected static final char SEPARATOR

See Also:

• Constant Field Values

SPACE_OR_ZERO

protected static final String SPACE_OR_ZERO

See Also:

• Constant Field Values

VALID_TAG_VALUES

protected static final String VALID_TAG_VALUES

See Also:

• Constant Field Values

Constructor Details

ColumbusGpsFormat

public ColumbusGpsFormat()

Method Details

getExtension

public String getExtension()

createRoute

public <P extends NavigationPosition> Wgs84Route createRoute(RouteCharacteristics characteristics,
 String name,
 List<P> positions)

getRouteCharacteristics

protected RouteCharacteristics getRouteCharacteristics()

Overrides:

getRouteCharacteristics in class SimpleLineBasedFormat<Wgs84Route>

isValidLine

protected boolean isValidLine(String line)

Overrides:

isValidLine in class SimpleLineBasedFormat<Wgs84Route>

getLinePattern

protected abstract Pattern getLinePattern()

isPosition

protected boolean isPosition(String line)

Specified by:

isPosition in class SimpleLineBasedFormat<Wgs84Route>

hasValidFix

protected abstract boolean hasValidFix(String line,
 Matcher matcher)

getHeaderPattern

protected abstract Pattern getHeaderPattern()

isHeader

protected boolean isHeader(String line)

getHeader

protected abstract String getHeader()

parseDateAndTime

protected CompactCalendar parseDateAndTime(String date,
 String time)

parseTag

protected WaypointType parseTag(String string)

parseDescription

protected String parseDescription(String description,
 String index,
 WaypointType waypointType)

removeZeros

protected String removeZeros(String string)

writeHeader

protected void writeHeader(PrintWriter writer,
 Wgs84Route route)

Overrides:

writeHeader in class SimpleLineBasedFormat<Wgs84Route>

fillWithZeros

protected String fillWithZeros(String string,
 int length)

formatDate

protected String formatDate(CompactCalendar date)

formatTime

protected String formatTime(CompactCalendar time)

formatTag

protected String formatTag(Wgs84Position position)

field

protected static String field(String regex)

A comma-terminated capturing field surrounded by optional whitespace/NUL padding.

lastField

protected static String lastField(String regex)

A capturing field without a trailing separator (the last field of a line).

coordinate

protected static String coordinate(String hemisphere)

A coordinate field: a decimal number followed by its hemisphere letter, each captured.

parseCommonPosition

protected Wgs84Position parseCommonPosition(Matcher matcher,
 ParserContext<?> context,
 CompactCalendar dateAndTime,
 int descriptionGroup,
 boolean isTypeA)

Parses the fields common to every Columbus line format (index, tag, date/time, latitude/longitude with hemisphere sign, height, speed, heading, description) and builds the position; format-specific fields (dop/pressure/temperature) are set by callers.

Parameters:

descriptionGroup - the matcher group holding the description/voice column

isTypeA - whether the line has the extended (Type-A) columns, enabling a voice file

latitudeHemisphere

protected String latitudeHemisphere(Wgs84Position position)

longitudeHemisphere

protected String longitudeHemisphere(Wgs84Position position)

getTimeToWrite

protected CompactCalendar getTimeToWrite(Wgs84Position position)

The time to write for this position. Formats that convert the device-local time of a file to UTC while reading must invert that here, or every roundtrip shifts by the zone offset — see asDeviceLocalTime(slash.common.type.CompactCalendar, java.util.TimeZone). Default: no conversion, for the formats that do not convert on read either (Type1).

getDeviceLocalTimeToWrite

protected CompactCalendar getDeviceLocalTimeToWrite(Wgs84Position position)

Shared getTimeToWrite(slash.navigation.base.Wgs84Position) body for the formats that do convert device-local time to UTC on read (Type2, Fusion) — both inverted it identically, so it lives here once instead of twice. Not the base getTimeToWrite(slash.navigation.base.Wgs84Position) default itself, since Type1 must keep the plain no-conversion behaviour regardless of the use-local-time-zone preference (it never converts on read either).

asDeviceLocalTime

protected CompactCalendar asDeviceLocalTime(CompactCalendar time,
 TimeZone timeZone)

Inverts CompactCalendar.asUTCTimeInTimeZone(java.util.TimeZone), which stores local - offset(local) where local is the file's wall clock read as UTC. Recovering local from that needs the offset *at the local instant*, not at the UTC one: the two are an offset apart, so around a DST transition they differ and a single-step utc + offset(utc) lands an hour out. One refinement pass settles it everywhere except inside the fall-back hour, which the file cannot disambiguate anyway (it records no offset).

formatCommonPrefix

protected String formatCommonPrefix(Wgs84Position position,
 int index)