Package org.openstreetmap.josm.io

Class GpxWriter

java.lang.Object

org.openstreetmap.josm.io.XmlWriter

org.openstreetmap.josm.io.GpxWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, GpxConstants

Direct Known Subclasses:

MarkerSessionExporter.MarkerWriter

public class GpxWriter
extends XmlWriter
implements GpxConstants

Writes GPX files from GPX data or OSM data.

Nested Class Summary

Nested classes/interfaces inherited from interface org.openstreetmap.josm.data.gpx.GpxConstants

GpxConstants.ColorFormat

Field Summary

Fields

Modifier and Type	Field	Description
private GpxData	data
private java.lang.String	indent
private java.time.Instant	metaTime
private static int	ROUTE_POINT
private static int	TRACK_POINT
private java.util.List<java.lang.String>	validprefixes
private static int	WAY_POINT

Fields inherited from class org.openstreetmap.josm.io.XmlWriter

out

Fields inherited from interface org.openstreetmap.josm.data.gpx.GpxConstants

EXTENSION_ABBREVIATIONS, FIX_VALUES, GARMIN_COLORS, GPX_CMT, GPX_DESC, GPX_NAME, GPX_PREFIX, GPX_SRC, JOSM_CREATOR_NAME, META_AUTHOR_EMAIL, META_AUTHOR_LINK, META_AUTHOR_NAME, META_BOUNDS, META_COPYRIGHT_AUTHOR, META_COPYRIGHT_LICENSE, META_COPYRIGHT_YEAR, META_DESC, META_KEYWORDS, META_LINKS, META_NAME, META_PREFIX, META_TIME, PT_AGEOFDGPSDATA, PT_COURSE, PT_DGPSID, PT_ELE, PT_FIX, PT_GEOIDHEIGHT, PT_HDOP, PT_MAGVAR, PT_PDOP, PT_SAT, PT_STD_HDEV, PT_STD_VDEV, PT_SYM, PT_TIME, PT_TYPE, PT_VDOP, RTE_TRK_KEYS, RTKLIB_AGE, RTKLIB_Q, RTKLIB_RATIO, RTKLIB_SDE, RTKLIB_SDEU, RTKLIB_SDN, RTKLIB_SDNE, RTKLIB_SDU, RTKLIB_SDUN, WPT_KEYS, XML_URI_EXTENSIONS_DRAWING, XML_URI_EXTENSIONS_GARMIN, XML_URI_EXTENSIONS_JOSM, XML_URI_XSD, XML_XSD_EXTENSIONS_DRAWING, XML_XSD_EXTENSIONS_GARMIN, XML_XSD_EXTENSIONS_JOSM

Constructor Summary

Constructors

Constructor	Description
GpxWriter(java.io.OutputStream out)	Constructs a new GpxWriter.
GpxWriter(java.io.PrintWriter out)	Constructs a new GpxWriter.

Method Summary

Modifier and Type	Method	Description
private void	close(java.lang.String tag)
private void	closeln(java.lang.String tag)
java.time.Instant	getMetaTime()	Returns the forced metadata time information, if any.
private void	gpxExtensions(GpxExtensionCollection allExtensions)
private void	gpxLink(GpxLink link)	output link
private void	inline(java.lang.String tag, java.lang.String attributes)
private void	open(java.lang.String tag)
private void	open(java.lang.String tag, java.lang.String attributes)
private void	openln(java.lang.String tag)
private void	openln(java.lang.String tag, java.lang.String attributes)
void	setMetaTime(java.time.Instant metaTime)	Sets the forced metadata time information.
private void	simpleTag(java.lang.String tag, java.lang.String content)	if content not null, open tag, write encoded content, and close tag else do nothing.
private void	simpleTag(java.lang.String tag, java.lang.String content, java.lang.String attributes)
private void	wayPoint(WayPoint pnt, int mode)	output a point
void	write(GpxData data)	Writes the given GPX data.
void	write(GpxData data, GpxConstants.ColorFormat colorFormat, boolean savePrefs)	Writes the given GPX data.
private void	writeAttr(IWithAttributes obj, java.util.List<java.lang.String> keys)
private void	writeExtension(java.util.List<GpxExtension> extensions)
private void	writeMetaData()
private void	writeRoutes()
private void	writeTracks()
private void	writeWayPoints()

Methods inherited from class org.openstreetmap.josm.io.XmlWriter

close, encode, encode, flush

Methods inherited from class java.lang.Object

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

Field Detail

data

private GpxData data

indent

private java.lang.String indent

metaTime

private java.time.Instant metaTime

validprefixes

private java.util.List<java.lang.String> validprefixes

WAY_POINT

private static final int WAY_POINT

See Also:

Constant Field Values

ROUTE_POINT

private static final int ROUTE_POINT

See Also:

Constant Field Values

TRACK_POINT

private static final int TRACK_POINT

See Also:

Constant Field Values

Constructor Detail

GpxWriter

public GpxWriter(java.io.PrintWriter out)

Constructs a new GpxWriter.

Parameters:

out - The output writer

GpxWriter

public GpxWriter(java.io.OutputStream out)

Constructs a new GpxWriter.

Parameters:

out - The output stream

Method Detail

getMetaTime

public java.time.Instant getMetaTime()

Returns the forced metadata time information, if any.

Returns:

the forced metadata time information, or null

Since:

18219

setMetaTime

public void setMetaTime(java.time.Instant metaTime)

Sets the forced metadata time information.

Parameters:

metaTime - the forced metadata time information, or null to use the current time

Since:

18219

write

public void write(GpxData data)

Writes the given GPX data.

Parameters:

data - The data to write

write

public void write(GpxData data,
                  GpxConstants.ColorFormat colorFormat,
                  boolean savePrefs)

Writes the given GPX data.

Parameters:

data - The data to write

colorFormat - determines if colors are saved and which extension is to be used

savePrefs - whether layer specific preferences are saved

writeAttr

private void writeAttr(IWithAttributes obj,
                       java.util.List<java.lang.String> keys)

writeMetaData

private void writeMetaData()

writeWayPoints

private void writeWayPoints()

writeRoutes

private void writeRoutes()

writeTracks

private void writeTracks()

openln

private void openln(java.lang.String tag)

openln

private void openln(java.lang.String tag,
                    java.lang.String attributes)

open

private void open(java.lang.String tag)

open

private void open(java.lang.String tag,
                  java.lang.String attributes)

inline

private void inline(java.lang.String tag,
                    java.lang.String attributes)

close

private void close(java.lang.String tag)

closeln

private void closeln(java.lang.String tag)

simpleTag

private void simpleTag(java.lang.String tag,
                       java.lang.String content)

if content not null, open tag, write encoded content, and close tag else do nothing.

Parameters:

tag - GPX tag

content - content

simpleTag

private void simpleTag(java.lang.String tag,
                       java.lang.String content,
                       java.lang.String attributes)

gpxLink

private void gpxLink(GpxLink link)

output link

Parameters:

link - link

wayPoint

private void wayPoint(WayPoint pnt,
                      int mode)

output a point

Parameters:

pnt - waypoint

mode - WAY_POINT for wpt, ROUTE_POINT for rtept, TRACK_POINT for trkpt

gpxExtensions

private void gpxExtensions(GpxExtensionCollection allExtensions)

writeExtension

private void writeExtension(java.util.List<GpxExtension> extensions)