OsmDataLayer (JOSM)

java.lang.Object
- org.openstreetmap.josm.gui.layer.Layer
- - org.openstreetmap.josm.gui.layer.AbstractModifiableLayer
  - - org.openstreetmap.josm.gui.layer.OsmDataLayer

All Implemented Interfaces:

DataSetListenerAdapter.Listener, ProjectionChangeListener, SelectionChangedListener, MapViewPaintable, Destroyable
```
public class OsmDataLayer
extends AbstractModifiableLayer
implements DataSetListenerAdapter.Listener, SelectionChangedListener
```
A layer that holds OSM data from a specific dataset. The data can be fully edited.

Since:

17

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`OsmDataLayer.CommandQueueListener`
`private class`	`OsmDataLayer.ConsistencyTestAction`
`class`	`OsmDataLayer.ConvertToGpxLayerAction` Action that converts this OSM layer to a GPX layer.
`static class`	`OsmDataLayer.DataCountVisitor`
`static interface`	`OsmDataLayer.LayerStateChangeListener` Listener called when a state of this layer has changed.

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.Layer
Layer.LayerAction, Layer.LayerGpxExportAction, Layer.LayerSaveAction, Layer.LayerSaveAsAction, Layer.MultiLayerAction, Layer.SeparatorLayerAction

Field Summary

Fields
Modifier and Type	Field and Description
`private ConflictCollection`	`conflicts` the collection of conflicts detected in this layer
`DataSet`	`data` The data behind this layer.
`private static int`	`dataLayerCounter` the global counter for created data layers
`private static TexturePaint`	`hatched` a paint texture for non-downloaded area
`private int`	`highlightUpdateCount`
`private boolean`	`isChanged`
`private CopyOnWriteArrayList<OsmDataLayer.LayerStateChangeListener>`	`layerStateChangeListeners`
`static String`	`REQUIRES_SAVE_TO_DISK_PROP` Property used to know if this layer has to be saved on disk
`static String`	`REQUIRES_UPLOAD_TO_SERVER_PROP` Property used to know if this layer has to be uploaded
`private boolean`	`requiresSaveToFile`
`private boolean`	`requiresUploadToServer`
`List<TestError>`	`validationErrors` List of validation errors in this layer.

Fields inherited from class org.openstreetmap.josm.gui.layer.Layer
FILTER_STATE_PROP, ICON_SIZE, NAME_PROP, OPACITY_PROP, propertyChangeSupport, VISIBLE_PROP

Constructor Summary

Constructors
Constructor and Description

OsmDataLayer(DataSet data, String name, File associatedFile)
Construct a new OsmDataLayer.

Constructors
Constructor and Description
`OsmDataLayer(DataSet data, String name, File associatedFile)` Construct a new `OsmDataLayer`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static void`	`addDoubleIfPresent(WayPoint wpt, OsmPrimitive p, String gpxKey, String... osmKeys)`
`private static void`	`addIntegerIfPresent(WayPoint wpt, OsmPrimitive p, String gpxKey, String... osmKeys)`
`void`	`addLayerStateChangeListener(OsmDataLayer.LayerStateChangeListener listener)` Adds a layer state change listener
`private static void`	`addStringIfPresent(WayPoint wpt, OsmPrimitive p, String gpxKey, String... osmKeys)`
`boolean`	`checkSaveConditions()` Checks whether it is ok to launch a save (whether we have data, there is no conflict etc.)
`void`	`cleanupAfterUpload(Collection<IPrimitive> processed)` Clean out the data behind the layer.
`boolean`	`containsPoint(LatLon coor)` Determines if this layer contains data at the given coordinate.
`File`	`createAndOpenSaveFileChooser()` Creates a new "Save" dialog for this layer and makes it visible. When the user has chosen a file, checks the file extension, and confirms overwrite if needed.
`static void`	`createHatchTexture()` Initialize the hatch pattern used to paint the non-downloaded area
`static String`	`createNewName()` Replies a new unique name for a data layer
`AbstractIOTask`	`createUploadTask(ProgressMonitor monitor)` Creates a new `AbstractIOTask` for uploading data.
`void`	`destroy()` Called, when the layer is removed from the mapview and is going to be destroyed.
`static Color`	`getBackgroundColor()` Replies background color for downloaded areas.
`protected ImageProvider`	`getBaseIconProvider()` Return the image provider to get the base icon
`ConflictCollection`	`getConflicts()` Replies the set of conflicts currently managed in this layer.
`Icon`	`getIcon()` Return a representative small image for this layer.
`Object`	`getInfoComponent()`
`Action[]`	`getMenuEntries()` Returns list of actions.
`static Color`	`getOutsideColor()` Replies background color for non-downloaded areas.
`String`	`getToolTipText()`
`AbstractUploadDialog`	`getUploadDialog()` Returns the upload dialog for this layer.
`boolean`	`isChanged()` Check changed status of layer
`private boolean`	`isDataSetEmpty()` Check the data set if it would be empty on save.
`boolean`	`isMergable(Layer other)`
`boolean`	`isModified()` Determines if data managed by this layer has been modified.
`boolean`	`isSavable()` Replies the savable state of this layer (i.e if it can be saved through a "File->Save" dialog).
`boolean`	`isUploadDiscouraged()` Determines if upload of data managed by this layer is discouraged.
`void`	`mergeFrom(DataSet from)` merges the primitives in dataset `from` into the dataset of this layer
`void`	`mergeFrom(DataSet from, ProgressMonitor progressMonitor)` merges the primitives in dataset `from` into the dataset of this layer
`void`	`mergeFrom(Layer from)` Merges the given layer into this layer.
`private static void`	`nodesToGpxData(Collection<Node> nodes, GpxData gpxData, Set<Node> doneNodes)`
`private static WayPoint`	`nodeToWayPoint(Node n)`
`void`	`onPostDownloadFromServer()` Actions run after data has been downloaded to this layer.
`void`	`onPostLoadFromFile()` Initializes the layer after a successful load of data from a file
`void`	`onPostSaveToFile()` Initializes the layer after a successful save of data to a file.
`void`	`onPostUploadToServer()` Initializes the layer after a successful upload to the server.
`void`	`paint(Graphics2D g, MapView mv, Bounds box)` Draw all primitives in this layer but do not draw modified ones (they are drawn by the edit layer).
`void`	`processDatasetEvent(AbstractDatasetChangedEvent event)`
`void`	`projectionChanged(Projection oldValue, Projection newValue)`
`void`	`removeLayerPropertyChangeListener(OsmDataLayer.LayerStateChangeListener listener)` Removes a layer property change listener
`boolean`	`requiresSaveToFile()` Determines if the data managed by this layer needs to be saved to a file.
`boolean`	`requiresUploadToServer()` Determines if the data managed by this layer needs to be uploaded to the server because it contains modified data.
`void`	`selectionChanged(Collection<? extends OsmPrimitive> newSelection)` Informs the listener that the selection in the dataset has changed.
`protected void`	`setRequiresSaveToFile(boolean newValue)`
`protected void`	`setRequiresUploadToServer(boolean newValue)`
`void`	`setUploadDiscouraged(boolean uploadDiscouraged)` Sets the "discouraged upload" flag.
`GpxData`	`toGpxData()` Converts OSM data behind this layer to GPX data.
`static GpxData`	`toGpxData(DataSet data, File file)` Converts given OSM dataset to GPX data.
`void`	`visitBoundingBox(BoundingXYVisitor v)`
`private static void`	`waysToGpxData(Collection<Way> ways, GpxData gpxData, Set<Node> doneNodes)`

Methods inherited from class org.openstreetmap.josm.gui.layer.Layer
addPropertyChangeListener, estimateMemoryUsage, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColor, getName, getOpacity, hookUpMapView, isBackgroundLayer, isInfoResizable, isProjectionSupported, isVisible, nameSupportedProjections, removePropertyChangeListener, setAssociatedFile, setBackgroundLayer, setFilterStateChanged, setName, setOpacity, setVisible, toggleVisible

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REQUIRES_SAVE_TO_DISK_PROP
```
public static final String REQUIRES_SAVE_TO_DISK_PROP
```
    Property used to know if this layer has to be saved on disk
  - REQUIRES_UPLOAD_TO_SERVER_PROP
```
public static final String REQUIRES_UPLOAD_TO_SERVER_PROP
```
    Property used to know if this layer has to be uploaded
  - requiresSaveToFile
```
private boolean requiresSaveToFile
```
  - requiresUploadToServer
```
private boolean requiresUploadToServer
```
  - isChanged
```
private boolean isChanged
```
  - highlightUpdateCount
```
private int highlightUpdateCount
```
  - validationErrors
```
public final List<TestError> validationErrors
```
    List of validation errors in this layer.
    
    Since:
    
    3669
  - dataLayerCounter
```
private static int dataLayerCounter
```
    the global counter for created data layers
  - layerStateChangeListeners
```
private final CopyOnWriteArrayList<OsmDataLayer.LayerStateChangeListener> layerStateChangeListeners
```
  - data
```
public final DataSet data
```
    The data behind this layer.
  - conflicts
```
private final ConflictCollection conflicts
```
    the collection of conflicts detected in this layer
  - hatched
```
private static volatile TexturePaint hatched
```
    a paint texture for non-downloaded area
- Constructor Detail
  - OsmDataLayer
```
public OsmDataLayer(DataSet data,
                    String name,
                    File associatedFile)
```
    Construct a new OsmDataLayer.
    
    Parameters:
    
    data - OSM data
    
    name - Layer name
    
    associatedFile - Associated .osm file (can be null)
- Method Detail
  - setRequiresSaveToFile
```
protected void setRequiresSaveToFile(boolean newValue)
```
  - setRequiresUploadToServer
```
protected void setRequiresUploadToServer(boolean newValue)
```
  - createNewName
```
public static String createNewName()
```
    Replies a new unique name for a data layer
    
    Returns:
    
    a new unique name for a data layer
  - addLayerStateChangeListener
```
public void addLayerStateChangeListener(OsmDataLayer.LayerStateChangeListener listener)
```
    Adds a layer state change listener
    
    Parameters:
    
    listener - the listener. Ignored if null or already registered.
    
    Since:
    
    5519
  - removeLayerPropertyChangeListener
```
public void removeLayerPropertyChangeListener(OsmDataLayer.LayerStateChangeListener listener)
```
    Removes a layer property change listener
    
    Parameters:
    
    listener - the listener. Ignored if null or already registered.
    
    Since:
    
    5519
  - getBackgroundColor
```
public static Color getBackgroundColor()
```
    Replies background color for downloaded areas.
    
    Returns:
    
    background color for downloaded areas. Black by default
  - getOutsideColor
```
public static Color getOutsideColor()
```
    Replies background color for non-downloaded areas.
    
    Returns:
    
    background color for non-downloaded areas. Yellow by default
  - createHatchTexture
```
public static void createHatchTexture()
```
    Initialize the hatch pattern used to paint the non-downloaded area
  - getBaseIconProvider
```
protected ImageProvider getBaseIconProvider()
```
    Return the image provider to get the base icon
    
    Returns:
    
    image provider class which can be modified
    
    Since:
    
    8323
  - getIcon
```
public Icon getIcon()
```
    Description copied from class: Layer
    
    Return a representative small image for this layer. The image must not be larger than 64 pixel in any dimension.
    
    Specified by:
    
    getIcon in class Layer
    
    Returns:
    
    layer icon
  - paint
```
public void paint(Graphics2D g,
                  MapView mv,
                  Bounds box)
```
    Draw all primitives in this layer but do not draw modified ones (they are drawn by the edit layer). Draw nodes last to overlap the ways they belong to.
    
    Specified by:
    
    paint in interface MapViewPaintable
    
    Specified by:
    
    paint in class Layer
    
    Parameters:
    
    g - Graphics
    
    mv - The object that can translate GeoPoints to screen coordinates.
    
    box - Bounding box
  - getToolTipText
```
public String getToolTipText()
```
    Specified by:
    
    getToolTipText in class Layer
    
    Returns:
    
    A small tooltip hint about some statistics for this layer.
  - mergeFrom
```
public void mergeFrom(Layer from)
```
    Description copied from class: Layer
    
    Merges the given layer into this layer. Throws if the layer types are incompatible.
    
    Specified by:
    
    mergeFrom in class Layer
    
    Parameters:
    
    from - The layer that get merged into this one. After the merge, the other layer is not usable anymore and passing to one others mergeFrom should be one of the last things to do with a layer.
  - mergeFrom
```
public void mergeFrom(DataSet from)
```
    merges the primitives in dataset from into the dataset of this layer
    
    Parameters:
    
    from - the source data set
  - mergeFrom
```
public void mergeFrom(DataSet from,
                      ProgressMonitor progressMonitor)
```
    merges the primitives in dataset from into the dataset of this layer
    
    Parameters:
    
    from - the source data set
    
    progressMonitor - the progress monitor, can be null
  - isMergable
```
public boolean isMergable(Layer other)
```
    Specified by:
    
    isMergable in class Layer
    
    Parameters:
    
    other - The other layer that is tested to be mergable with this.
    
    Returns:
    
    Whether the other layer can be merged into this layer.
  - visitBoundingBox
```
public void visitBoundingBox(BoundingXYVisitor v)
```
    Specified by:
    
    visitBoundingBox in class Layer
  - cleanupAfterUpload
```
public void cleanupAfterUpload(Collection<IPrimitive> processed)
```
    Clean out the data behind the layer. This means clearing the redo/undo lists, really deleting all deleted objects and reset the modified flags. This should be done after an upload, even after a partial upload.
    
    Parameters:
    
    processed - A list of all objects that were actually uploaded. May be null, which means nothing has been uploaded
  - getInfoComponent
```
public Object getInfoComponent()
```
    Specified by:
    
    getInfoComponent in class Layer
  - getMenuEntries
```
public Action[] getMenuEntries()
```
    Description copied from class: Layer
    
    Returns list of actions. Action can implement LayerAction interface when it needs to be represented by other menu component than JMenuItem or when it supports multiple layers. Actions that support multiple layers should also have correct equals implementation. Use Layer.SeparatorLayerAction.INSTANCE instead of new JSeparator
    
    Specified by:
    
    getMenuEntries in class Layer
    
    Returns:
    
    menu actions for this layer
  - toGpxData
```
public static GpxData toGpxData(DataSet data,
                                File file)
```
    Converts given OSM dataset to GPX data.
    
    Parameters:
    
    data - OSM dataset
    
    file - output .gpx file
    
    Returns:
    
    GPX data
  - waysToGpxData
```
private static void waysToGpxData(Collection<Way> ways,
                                  GpxData gpxData,
                                  Set<Node> doneNodes)
```
  - nodeToWayPoint
```
private static WayPoint nodeToWayPoint(Node n)
```
  - nodesToGpxData
```
private static void nodesToGpxData(Collection<Node> nodes,
                                   GpxData gpxData,
                                   Set<Node> doneNodes)
```
  - addIntegerIfPresent
```
private static void addIntegerIfPresent(WayPoint wpt,
                                        OsmPrimitive p,
                                        String gpxKey,
                                        String... osmKeys)
```
  - addDoubleIfPresent
```
private static void addDoubleIfPresent(WayPoint wpt,
                                       OsmPrimitive p,
                                       String gpxKey,
                                       String... osmKeys)
```
  - addStringIfPresent
```
private static void addStringIfPresent(WayPoint wpt,
                                       OsmPrimitive p,
                                       String gpxKey,
                                       String... osmKeys)
```
  - toGpxData
```
public GpxData toGpxData()
```
    Converts OSM data behind this layer to GPX data.
    
    Returns:
    
    GPX data
  - containsPoint
```
public boolean containsPoint(LatLon coor)
```
    Determines if this layer contains data at the given coordinate.
    
    Parameters:
    
    coor - the coordinate
    
    Returns:
    
    true if data sources bounding boxes contain coor
  - getConflicts
```
public ConflictCollection getConflicts()
```
    Replies the set of conflicts currently managed in this layer.
    
    Returns:
    
    the set of conflicts currently managed in this layer
  - requiresUploadToServer
```
public boolean requiresUploadToServer()
```
    Description copied from class: AbstractModifiableLayer
    
    Determines if the data managed by this layer needs to be uploaded to the server because it contains modified data.
    
    Overrides:
    
    requiresUploadToServer in class AbstractModifiableLayer
    
    Returns:
    
    true if the data managed by this layer needs to be uploaded to the server because it contains modified data; false, otherwise
  - requiresSaveToFile
```
public boolean requiresSaveToFile()
```
    Description copied from class: AbstractModifiableLayer
    
    Determines if the data managed by this layer needs to be saved to a file. Only replies true if a file is assigned to this layer and if the data managed by this layer has been modified since the last save operation to the file.
    
    Overrides:
    
    requiresSaveToFile in class AbstractModifiableLayer
    
    Returns:
    
    true if the data managed by this layer needs to be saved to a file
  - onPostLoadFromFile
```
public void onPostLoadFromFile()
```
    Description copied from class: Layer
    
    Initializes the layer after a successful load of data from a file
    
    Overrides:
    
    onPostLoadFromFile in class Layer
  - onPostDownloadFromServer
```
public void onPostDownloadFromServer()
```
    Actions run after data has been downloaded to this layer.
  - isChanged
```
public boolean isChanged()
```
    Description copied from class: Layer
    
    Check changed status of layer
    
    Overrides:
    
    isChanged in class Layer
    
    Returns:
    
    True if layer was changed since last paint
  - onPostSaveToFile
```
public void onPostSaveToFile()
```
    Description copied from class: AbstractModifiableLayer
    
    Initializes the layer after a successful save of data to a file.
    
    Overrides:
    
    onPostSaveToFile in class AbstractModifiableLayer
  - onPostUploadToServer
```
public void onPostUploadToServer()
```
    Description copied from class: AbstractModifiableLayer
    
    Initializes the layer after a successful upload to the server.
    
    Overrides:
    
    onPostUploadToServer in class AbstractModifiableLayer
  - destroy
```
public void destroy()
```
    Description copied from class: Layer
    
    Called, when the layer is removed from the mapview and is going to be destroyed. This is because the Layer constructor can not add itself safely as listener to the layerlist dialog, because there may be no such dialog yet (loaded via command line parameter).
    
    Specified by:
    
    destroy in interface Destroyable
    
    Overrides:
    
    destroy in class Layer
  - processDatasetEvent
```
public void processDatasetEvent(AbstractDatasetChangedEvent event)
```
    Specified by:
    
    processDatasetEvent in interface DataSetListenerAdapter.Listener
  - selectionChanged
```
public void selectionChanged(Collection<? extends OsmPrimitive> newSelection)
```
    Description copied from interface: SelectionChangedListener
    
    Informs the listener that the selection in the dataset has changed.
    
    Specified by:
    
    selectionChanged in interface SelectionChangedListener
    
    Parameters:
    
    newSelection - The new selection.
  - projectionChanged
```
public void projectionChanged(Projection oldValue,
                              Projection newValue)
```
    Specified by:
    
    projectionChanged in interface ProjectionChangeListener
    
    Overrides:
    
    projectionChanged in class Layer
  - isUploadDiscouraged
```
public final boolean isUploadDiscouraged()
```
    Description copied from class: AbstractModifiableLayer
    
    Determines if upload of data managed by this layer is discouraged. This feature allows to use "private" data layers.
    
    Overrides:
    
    isUploadDiscouraged in class AbstractModifiableLayer
    
    Returns:
    
    true if upload is discouraged for this layer; false, otherwise
  - setUploadDiscouraged
```
public final void setUploadDiscouraged(boolean uploadDiscouraged)
```
    Sets the "discouraged upload" flag.
    
    Parameters:
    
    uploadDiscouraged - true if upload of data managed by this layer is discouraged. This feature allows to use "private" data layers.
  - isModified
```
public final boolean isModified()
```
    Description copied from class: AbstractModifiableLayer
    
    Determines if data managed by this layer has been modified.
    
    Specified by:
    
    isModified in class AbstractModifiableLayer
    
    Returns:
    
    true if data has been modified; false, otherwise
  - isSavable
```
public boolean isSavable()
```
    Description copied from class: Layer
    
    Replies the savable state of this layer (i.e if it can be saved through a "File->Save" dialog).
    
    Overrides:
    
    isSavable in class Layer
    
    Returns:
    
    true if this layer can be saved to a file
  - checkSaveConditions
```
public boolean checkSaveConditions()
```
    Description copied from class: Layer
    
    Checks whether it is ok to launch a save (whether we have data, there is no conflict etc.)
    
    Overrides:
    
    checkSaveConditions in class Layer
    
    Returns:
    
    true, if it is safe to save.
  - isDataSetEmpty
```
private boolean isDataSetEmpty()
```
    Check the data set if it would be empty on save. It is empty, if it contains no objects (after all objects that are created and deleted without being transferred to the server have been removed).
    
    Returns:
    
    true, if a save result in an empty data set.
  - createAndOpenSaveFileChooser
```
public File createAndOpenSaveFileChooser()
```
    Description copied from class: Layer
    
    Creates a new "Save" dialog for this layer and makes it visible.
    When the user has chosen a file, checks the file extension, and confirms overwrite if needed.
    
    Overrides:
    
    createAndOpenSaveFileChooser in class Layer
    
    Returns:
    
    The output File
    
    See Also:
    
    SaveActionBase.createAndOpenSaveFileChooser(java.lang.String, org.openstreetmap.josm.actions.ExtensionFileFilter)
  - createUploadTask
```
public AbstractIOTask createUploadTask(ProgressMonitor monitor)
```
    Description copied from class: AbstractModifiableLayer
    
    Creates a new AbstractIOTask for uploading data.
    
    Overrides:
    
    createUploadTask in class AbstractModifiableLayer
    
    Parameters:
    
    monitor - The progress monitor
    
    Returns:
    
    a new AbstractIOTask for uploading data, or null if not applicable
  - getUploadDialog
```
public AbstractUploadDialog getUploadDialog()
```
    Description copied from class: AbstractModifiableLayer
    
    Returns the upload dialog for this layer.
    
    Overrides:
    
    getUploadDialog in class AbstractModifiableLayer
    
    Returns:
    
    the upload dialog for this layer, or null if not applicable

Class OsmDataLayer

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.Layer

Field Summary

Fields inherited from class org.openstreetmap.josm.gui.layer.Layer

Constructor Summary

Method Summary

Methods inherited from class org.openstreetmap.josm.gui.layer.Layer

Methods inherited from class java.lang.Object

Field Detail

REQUIRES_SAVE_TO_DISK_PROP

REQUIRES_UPLOAD_TO_SERVER_PROP

requiresSaveToFile

requiresUploadToServer

isChanged

highlightUpdateCount

validationErrors

dataLayerCounter

layerStateChangeListeners

data

conflicts

hatched

Constructor Detail

OsmDataLayer

Method Detail

setRequiresSaveToFile

setRequiresUploadToServer

createNewName

addLayerStateChangeListener

removeLayerPropertyChangeListener

getBackgroundColor

getOutsideColor

createHatchTexture

getBaseIconProvider

getIcon

paint

getToolTipText

mergeFrom

mergeFrom

mergeFrom

isMergable

visitBoundingBox

cleanupAfterUpload

getInfoComponent

getMenuEntries

toGpxData

waysToGpxData

nodeToWayPoint

nodesToGpxData

addIntegerIfPresent

addDoubleIfPresent

addStringIfPresent

toGpxData

containsPoint

getConflicts

requiresUploadToServer

requiresSaveToFile

onPostLoadFromFile

onPostDownloadFromServer

isChanged

onPostSaveToFile

onPostUploadToServer

destroy

processDatasetEvent

selectionChanged

projectionChanged

isUploadDiscouraged

setUploadDiscouraged

isModified

isSavable

checkSaveConditions

isDataSetEmpty

createAndOpenSaveFileChooser

createUploadTask

getUploadDialog