org.openstreetmap.josm.gui.history
Class HistoryBrowserModel

java.lang.Object
  java.util.Observable
      org.openstreetmap.josm.gui.history.HistoryBrowserModel

All Implemented Interfaces:

DataSetListener, MapView.LayerChangeListener

public class HistoryBrowserModel
extends java.util.Observable
implements MapView.LayerChangeListener, DataSetListener

This is the model used by the history browser. The model state consists of the following elements:

• the History of a specific OsmPrimitive
• a dedicated version in this History called the PointInTimeType.REFERENCE_POINT_IN_TIME
• another version in this History called the PointInTimeType.CURRENT_POINT_IN_TIME
HistoryBrowser always compares the PointInTimeType.REFERENCE_POINT_IN_TIME with the PointInTimeType.CURRENT_POINT_IN_TIME. This model provides various HistoryBrowserModel.VersionTableModels for JTables used in HistoryBrowser, for instance:
• getTagTableModel(PointInTimeType) replies a HistoryBrowserModel.VersionTableModel for the tags of either of the two selected versions
• getNodeListTableModel(PointInTimeType) replies a HistoryBrowserModel.VersionTableModel for the list of nodes of the two selected versions (if the current history provides information about a Way
• getRelationMemberTableModel(PointInTimeType) replies a HistoryBrowserModel.VersionTableModel for the list of relation members of the two selected versions (if the current history provides information about a Relation

See Also:

HistoryBrowser

Nested Class Summary

(package private) static class	HistoryBrowserModel.HistoryPrimitiveBuilder Creates a HistoryOsmPrimitive from a OsmPrimitive
class	HistoryBrowserModel.RelationMemberTableModel The table model for the relation members of the version at PointInTimeType.REFERENCE_POINT_IN_TIME or PointInTimeType.CURRENT_POINT_IN_TIME
class	HistoryBrowserModel.TagTableModel The table model for the tags of the version at PointInTimeType.REFERENCE_POINT_IN_TIME or PointInTimeType.CURRENT_POINT_IN_TIME
class	HistoryBrowserModel.VersionTableModel The table model for the list of versions in the current history

Field Summary

private HistoryOsmPrimitive	current
private DiffTableModel	currentNodeListTableModel
private HistoryBrowserModel.RelationMemberTableModel	currentRelationMemberTableModel
private HistoryBrowserModel.TagTableModel	currentTagTableModel
private History	history the history of an OsmPrimitive
private HistoryOsmPrimitive	latest latest isn't a reference of history.
private HistoryOsmPrimitive	reference
private DiffTableModel	referenceNodeListTableModel
private HistoryBrowserModel.RelationMemberTableModel	referenceRelationMemberTableModel
private HistoryBrowserModel.TagTableModel	referenceTagTableModel
private HistoryBrowserModel.VersionTableModel	versionTableModel

Constructor Summary

HistoryBrowserModel()
constructor

HistoryBrowserModel(History history)
Creates a new history browser model for a given history.

Method Summary

void	activeLayerChange(Layer oldLayer, Layer newLayer) Notifies this listener that the active layer has changed.
protected boolean	canShowAsLatest(OsmPrimitive primitive)
void	dataChanged(DataChangedEvent event) Called after big changes in dataset.
protected void	fireModelChange()
HistoryOsmPrimitive	getCurrentPointInTime() Replies the history OSM primitive for the PointInTimeType.CURRENT_POINT_IN_TIME
protected OsmDataLayer	getEditLayer() Replies the current edit layer; null, if there isn't a current edit layer of type OsmDataLayer.
History	getHistory() replies the history managed by this model
DiffTableModel	getNodeListTableModel(PointInTimeType pointInTimeType)
HistoryOsmPrimitive	getPointInTime(PointInTimeType type) replies the history OSM primitive for a given point in time
HistoryOsmPrimitive	getReferencePointInTime() Replies the history OSM primitive for the PointInTimeType.REFERENCE_POINT_IN_TIME
HistoryBrowserModel.RelationMemberTableModel	getRelationMemberTableModel(PointInTimeType pointInTimeType)
HistoryBrowserModel.TagTableModel	getTagTableModel(PointInTimeType pointInTimeType) replies the tag table model for the respective point in time
HistoryBrowserModel.VersionTableModel	getVersionTableModel() Replies the table model to be used in a JTable which shows the list of versions in this history.
protected boolean	hasNewNodes(Way way)
protected void	initMemberListTableModels()
protected void	initNodeListTableModels() Should be called everytime either reference of current changes to update the diff.
protected void	initTagTableModels()
boolean	isLatest(HistoryOsmPrimitive primitive) Returns true if primitive is the latest primitive representing the version currently edited in the current data layer.
void	layerAdded(Layer newLayer) Notifies this listener that a layer has been added.
void	layerRemoved(Layer oldLayer) Notifies this listener that a layer has been removed.
void	nodeMoved(NodeMovedEvent event) A node's coordinates were modified.
void	otherDatasetChange(AbstractDatasetChangedEvent event) Minor dataset change, currently only changeset id changed is supported, but can be extended in future.
void	primitivesAdded(PrimitivesAddedEvent event) A bunch of primitives were added into the DataSet, or existing deleted/invisible primitives were resurrected.
void	primitivesRemoved(PrimitivesRemovedEvent event) A bunch of primitives were removed from the DataSet, or preexisting primitives were marked as deleted.
void	relationMembersChanged(RelationMembersChangedEvent event) A relation's members have changed.
void	setCurrentPointInTime(HistoryOsmPrimitive current) Sets the HistoryOsmPrimitive which plays the role of the current point in time (see PointInTimeType).
void	setHistory(History history) sets the history to be managed by this model
protected void	setLatest(HistoryOsmPrimitive latest)
void	setReferencePointInTime(HistoryOsmPrimitive reference) Sets the HistoryOsmPrimitive which plays the role of a reference point in time (see PointInTimeType).
void	tagsChanged(TagsChangedEvent event) There was some change in the tag set of a primitive.
void	unlinkAsListener() Removes this model as listener for data change and layer change events.
void	wayNodesChanged(WayNodesChangedEvent event) A way's node list was changed.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

history

private History history

the history of an OsmPrimitive

reference

private HistoryOsmPrimitive reference

current

private HistoryOsmPrimitive current

latest

private HistoryOsmPrimitive latest

latest isn't a reference of history. It's a clone of the currently edited OsmPrimitive in the current edit layer.

versionTableModel

private HistoryBrowserModel.VersionTableModel versionTableModel

currentTagTableModel

private HistoryBrowserModel.TagTableModel currentTagTableModel

referenceTagTableModel

private HistoryBrowserModel.TagTableModel referenceTagTableModel

currentRelationMemberTableModel

private HistoryBrowserModel.RelationMemberTableModel currentRelationMemberTableModel

referenceRelationMemberTableModel

private HistoryBrowserModel.RelationMemberTableModel referenceRelationMemberTableModel

referenceNodeListTableModel

private DiffTableModel referenceNodeListTableModel

currentNodeListTableModel

private DiffTableModel currentNodeListTableModel

Constructor Detail

HistoryBrowserModel

public HistoryBrowserModel()

constructor

HistoryBrowserModel

public HistoryBrowserModel(History history)

Creates a new history browser model for a given history.

Parameters:

history - the history. Must not be null.

Throws:

java.lang.IllegalArgumentException - thrown if history is null

Method Detail

getEditLayer

protected OsmDataLayer getEditLayer()

Replies the current edit layer; null, if there isn't a current edit layer of type OsmDataLayer.

Returns:

the current edit layer

getHistory

public History getHistory()

replies the history managed by this model

Returns:

the history

hasNewNodes

protected boolean hasNewNodes(Way way)

canShowAsLatest

protected boolean canShowAsLatest(OsmPrimitive primitive)

setHistory

public void setHistory(History history)

sets the history to be managed by this model

Parameters:

history - the history

fireModelChange

protected void fireModelChange()

getVersionTableModel

public HistoryBrowserModel.VersionTableModel getVersionTableModel()

Replies the table model to be used in a JTable which shows the list of versions in this history.

Returns:

the table model

initTagTableModels

protected void initTagTableModels()

initNodeListTableModels

protected void initNodeListTableModels()

Should be called everytime either reference of current changes to update the diff. TODO: Maybe rename to reflect this? eg. updateNodeListTableModels

initMemberListTableModels

protected void initMemberListTableModels()

getTagTableModel

public HistoryBrowserModel.TagTableModel getTagTableModel(PointInTimeType pointInTimeType)
                                                   throws java.lang.IllegalArgumentException

replies the tag table model for the respective point in time

Parameters:

pointInTimeType - the type of the point in time (must not be null)

Returns:

the tag table model

Throws:

java.lang.IllegalArgumentException - thrown, if pointInTimeType is null

getNodeListTableModel

public DiffTableModel getNodeListTableModel(PointInTimeType pointInTimeType)
                                     throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getRelationMemberTableModel

public HistoryBrowserModel.RelationMemberTableModel getRelationMemberTableModel(PointInTimeType pointInTimeType)
                                                                         throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

setReferencePointInTime

public void setReferencePointInTime(HistoryOsmPrimitive reference)
                             throws java.lang.IllegalArgumentException,
                                    java.lang.IllegalStateException

Sets the HistoryOsmPrimitive which plays the role of a reference point in time (see PointInTimeType).

Parameters:

reference - the reference history primitive. Must not be null.

Throws:

java.lang.IllegalArgumentException - thrown if reference is null

java.lang.IllegalStateException - thrown if this model isn't a assigned a history yet

java.lang.IllegalArgumentException - if reference isn't an history primitive for the history managed by this mode

See Also:

setHistory(History), PointInTimeType

setCurrentPointInTime

public void setCurrentPointInTime(HistoryOsmPrimitive current)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.IllegalStateException

Sets the HistoryOsmPrimitive which plays the role of the current point in time (see PointInTimeType).

Parameters:

reference - the reference history primitive. Must not be null.

Throws:

java.lang.IllegalArgumentException - thrown if reference is null

java.lang.IllegalStateException - thrown if this model isn't a assigned a history yet

java.lang.IllegalArgumentException - if reference isn't an history primitive for the history managed by this mode

See Also:

setHistory(History), PointInTimeType

getCurrentPointInTime

public HistoryOsmPrimitive getCurrentPointInTime()

Replies the history OSM primitive for the PointInTimeType.CURRENT_POINT_IN_TIME

Returns:

the history OSM primitive for the PointInTimeType.CURRENT_POINT_IN_TIME (may be null)

getReferencePointInTime

public HistoryOsmPrimitive getReferencePointInTime()

Replies the history OSM primitive for the PointInTimeType.REFERENCE_POINT_IN_TIME

Returns:

the history OSM primitive for the PointInTimeType.REFERENCE_POINT_IN_TIME (may be null)

getPointInTime

public HistoryOsmPrimitive getPointInTime(PointInTimeType type)
                                   throws java.lang.IllegalArgumentException

replies the history OSM primitive for a given point in time

Parameters:

type - the type of the point in time (must not be null)

Returns:

the respective primitive. Can be null.

Throws:

java.lang.IllegalArgumentException - thrown, if type is null

isLatest

public boolean isLatest(HistoryOsmPrimitive primitive)

Returns true if primitive is the latest primitive representing the version currently edited in the current data layer.

Parameters:

primitive - the primitive to check

Returns:

true if primitive is the latest primitive

setLatest

protected void setLatest(HistoryOsmPrimitive latest)

unlinkAsListener

public void unlinkAsListener()

Removes this model as listener for data change and layer change events.

nodeMoved

public void nodeMoved(NodeMovedEvent event)

Description copied from interface: DataSetListener

A node's coordinates were modified.

Specified by:

nodeMoved in interface DataSetListener

primitivesAdded

public void primitivesAdded(PrimitivesAddedEvent event)

Description copied from interface: DataSetListener

A bunch of primitives were added into the DataSet, or existing deleted/invisible primitives were resurrected.

Specified by:

primitivesAdded in interface DataSetListener

primitivesRemoved

public void primitivesRemoved(PrimitivesRemovedEvent event)

Description copied from interface: DataSetListener

A bunch of primitives were removed from the DataSet, or preexisting primitives were marked as deleted.

Specified by:

primitivesRemoved in interface DataSetListener

relationMembersChanged

public void relationMembersChanged(RelationMembersChangedEvent event)

Description copied from interface: DataSetListener

A relation's members have changed.

Specified by:

relationMembersChanged in interface DataSetListener

tagsChanged

public void tagsChanged(TagsChangedEvent event)

Description copied from interface: DataSetListener

There was some change in the tag set of a primitive. It can have been a tag addition, tag removal or change in tag value.

Specified by:

tagsChanged in interface DataSetListener

wayNodesChanged

public void wayNodesChanged(WayNodesChangedEvent event)

Description copied from interface: DataSetListener

A way's node list was changed.

Specified by:

wayNodesChanged in interface DataSetListener

dataChanged

public void dataChanged(DataChangedEvent event)

Description copied from interface: DataSetListener

Called after big changes in dataset. Usually other events are stopped using Dataset.beginUpdate() and after operation is completed (Dataset.endUpdate()), #dataChanged() is called.

Specified by:

dataChanged in interface DataSetListener

otherDatasetChange

public void otherDatasetChange(AbstractDatasetChangedEvent event)

Description copied from interface: DataSetListener

Minor dataset change, currently only changeset id changed is supported, but can be extended in future.

Specified by:

otherDatasetChange in interface DataSetListener

activeLayerChange

public void activeLayerChange(Layer oldLayer,
                              Layer newLayer)

Description copied from interface: MapView.LayerChangeListener

Notifies this listener that the active layer has changed.

Specified by:

activeLayerChange in interface MapView.LayerChangeListener

Parameters:

oldLayer - The previous active layer

newLayer - The new activer layer

layerAdded

public void layerAdded(Layer newLayer)

Description copied from interface: MapView.LayerChangeListener

Notifies this listener that a layer has been added.

Specified by:

layerAdded in interface MapView.LayerChangeListener

Parameters:

newLayer - The new added layer

layerRemoved

public void layerRemoved(Layer oldLayer)

Description copied from interface: MapView.LayerChangeListener

Notifies this listener that a layer has been removed.

Specified by:

layerRemoved in interface MapView.LayerChangeListener

Parameters:

oldLayer - The old removed layer