org.openstreetmap.josm.data.osm

Class PrimitiveData

java.lang.Object

org.openstreetmap.josm.data.osm.AbstractPrimitive

org.openstreetmap.josm.data.osm.PrimitiveData

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IPrimitive>, IPrimitive, PrimitiveId, Stylable, Tagged

Direct Known Subclasses:

NodeData, RelationData, WayData

public abstract class PrimitiveData
extends AbstractPrimitive
implements java.io.Serializable

This class can be used to save properties of OsmPrimitive. The main difference between PrimitiveData and OsmPrimitive is that PrimitiveData is not part of the dataset and changes in PrimitiveData are not reported by events

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID

Fields inherited from class org.openstreetmap.josm.data.osm.AbstractPrimitive

changesetId, FLAG_ANNOTATED, FLAG_DELETED, FLAG_DIRECTION_REVERSED, FLAG_DISABLED, FLAG_DISABLED_TYPE, FLAG_HAS_DIRECTIONS, FLAG_HIDDEN_TYPE, FLAG_HIDE_IF_DISABLED, FLAG_HIGHLIGHTED, FLAG_INCOMPLETE, FLAG_MODIFIED, FLAG_PRESERVED, FLAG_TAGGED, FLAG_VISIBLE, flags, id, keys, timestamp, user, version

Fields inherited from interface org.openstreetmap.josm.data.osm.Tagged

MAX_TAG_LENGTH

Constructor Summary

Constructors

Constructor and Description
PrimitiveData() Constructs a new PrimitiveData.
PrimitiveData(long id) Constructs a new PrimitiveData with given id.
PrimitiveData(PrimitiveData data) Constructs a new PrimitiveData from an existing one.

Method Summary

Modifier and Type	Method and Description
void	declareCachedStyleUpToDate() Declare that the cached style for this primitive is up to date.
StyleCache	getCachedStyle() Returns the cached style.
OsmData<?,?,?,?>	getDataSet() Returns the parent data set of this primitive.
static <T extends PrimitiveData> java.util.List<T>	getFilteredList(java.util.Collection<T> list, OsmPrimitiveType type) Returns a filtered list for a given primitive type.
java.util.List<PrimitiveData>	getReferrers(boolean allowWithoutDataset) Find primitives that reference this primitive.
boolean	hasDirectionKeys() true if this object has direction dependent tags (e.g.
boolean	isAnnotated() Determines if this object is considered "annotated".
boolean	isCachedStyleUpToDate() Check if the cached style for this primitive is up to date.
boolean	isHighlighted() Checks if the highlight flag for this primitive was set
boolean	isTagged() Determines if this object is considered "tagged".
protected void	keysChangedImpl(java.util.Map<java.lang.String,java.lang.String> originalKeys) What to do, when the tags have changed by one of the tag-changing methods.
abstract PrimitiveData	makeCopy() Returns a copy of this primitive data.
private void	readObject(java.io.ObjectInputStream ois)
boolean	reversedDirection() true if this object has the "reversed direction" flag enabled
void	setCachedStyle(StyleCache mappaintStyle) Sets the cached style.
void	setHighlighted(boolean highlighted) Updates the highlight flag for this primitive.
void	setId(long id) Sets the primitive identifier.
void	setIncomplete(boolean incomplete) override to make it public
void	setVersion(int version) Sets the primitive version.
java.lang.String	toString()
void	visitReferrers(PrimitiveVisitor visitor) Visits visitor for all referrers.
private void	writeObject(java.io.ObjectOutputStream oos)

Methods inherited from class org.openstreetmap.josm.data.osm.AbstractPrimitive

advanceUniqueId, clearOsmMetadata, cloneFrom, currentUniqueId, doGet, generateUniqueId, get, getChangesetId, getDiscardableKeys, getFlagsAsString, getId, getIgnoreCase, getInterestingTags, getKeys, getNumKeys, getRawTimestamp, getTimestamp, getUninterestingKeys, getUniqueId, getUser, getVersion, getWorkInProgressKeys, hasKey, hasKey, hasKeys, isDeleted, isIncomplete, isModified, isNew, isNewOrUndeleted, isTimestampEmpty, isUndeleted, isUninterestingKey, isUsable, isVisible, keySet, put, remove, removeAll, setChangesetId, setDeleted, setKeys, setKeys, setModified, setOsmId, setRawTimestamp, setTimestamp, setUser, setVisible, updateFlags, visitKeys

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.josm.data.osm.IPrimitive

accept, getBBox, getDisplayName, getDisplayType, getLocalName, getName, getOsmId, getOsmPrimitiveId, getPrimitiveId, getReferrers, hasSameInterestingTags, isDisabled, isDisabledAndHidden, isDrawable, isMemberOfSelected, isMultipolygon, isOuterMemberOfSelected, isPreserved, isSelectable, isSelected

Methods inherited from interface org.openstreetmap.josm.data.osm.Tagged

hasTag, hasTag, hasTag, hasTag, hasTagDifferent, hasTagDifferent, hasTagDifferent, isKeyFalse, isKeyTrue, put

Methods inherited from interface org.openstreetmap.josm.data.osm.PrimitiveId

getType

Methods inherited from interface org.openstreetmap.josm.data.osm.Stylable

clearCachedStyle

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

PrimitiveData

public PrimitiveData()

Constructs a new PrimitiveData.

PrimitiveData

public PrimitiveData(long id)

Constructs a new PrimitiveData with given id.

Parameters:

id - id

Since:

12017

PrimitiveData

public PrimitiveData(PrimitiveData data)

Constructs a new PrimitiveData from an existing one.

Parameters:

data - the data to copy

Method Detail

setId

public void setId(long id)

Sets the primitive identifier.

Parameters:

id - primitive identifier

setVersion

public void setVersion(int version)

Sets the primitive version.

Parameters:

version - primitive version

setIncomplete

public void setIncomplete(boolean incomplete)

override to make it public

Overrides:

setIncomplete in class AbstractPrimitive

Parameters:

incomplete - incomplete flag value

makeCopy

public abstract PrimitiveData makeCopy()

Returns a copy of this primitive data.

Returns:

a copy of this primitive data

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFilteredList

public static <T extends PrimitiveData> java.util.List<T> getFilteredList(java.util.Collection<T> list,
                                                                          OsmPrimitiveType type)

Returns a filtered list for a given primitive type.

Type Parameters:

T - primitive type

Parameters:

list - list to filter

type - primitive type

Returns:

a filtered list for given primitive type

keysChangedImpl

protected final void keysChangedImpl(java.util.Map<java.lang.String,java.lang.String> originalKeys)

Description copied from class: AbstractPrimitive

What to do, when the tags have changed by one of the tag-changing methods.

Specified by:

keysChangedImpl in class AbstractPrimitive

Parameters:

originalKeys - original tags

writeObject

private void writeObject(java.io.ObjectOutputStream oos)
                  throws java.io.IOException

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream ois)
                 throws java.lang.ClassNotFoundException,
                        java.io.IOException

Throws:

java.lang.ClassNotFoundException

java.io.IOException

isTagged

public boolean isTagged()

Description copied from interface: IPrimitive

Determines if this object is considered "tagged". To be "tagged", an object must have one or more "interesting" tags. "created_by" and "source" are typically considered "uninteresting" and do not make an object "tagged".

Specified by:

isTagged in interface IPrimitive

Returns:

true if this object is considered "tagged"

isAnnotated

public boolean isAnnotated()

Description copied from interface: IPrimitive

Determines if this object is considered "annotated". To be "annotated", an object must have one or more "work in progress" tags, such as "note" or "fixme".

Specified by:

isAnnotated in interface IPrimitive

Returns:

true if this object is considered "annotated"

hasDirectionKeys

public boolean hasDirectionKeys()

Description copied from interface: IPrimitive

true if this object has direction dependent tags (e.g. oneway)

Specified by:

hasDirectionKeys in interface IPrimitive

Returns:

true if this object has direction dependent tags

reversedDirection

public boolean reversedDirection()

Description copied from interface: IPrimitive

true if this object has the "reversed direction" flag enabled

Specified by:

reversedDirection in interface IPrimitive

Returns:

true if this object has the "reversed direction" flag enabled

setHighlighted

public void setHighlighted(boolean highlighted)

Description copied from interface: IPrimitive

Updates the highlight flag for this primitive.

Specified by:

setHighlighted in interface IPrimitive

Parameters:

highlighted - The new highlight flag.

isHighlighted

public boolean isHighlighted()

Description copied from interface: IPrimitive

Checks if the highlight flag for this primitive was set

Specified by:

isHighlighted in interface IPrimitive

Returns:

The highlight flag.

getReferrers

public final java.util.List<PrimitiveData> getReferrers(boolean allowWithoutDataset)

Description copied from interface: IPrimitive

Find primitives that reference this primitive. Returns only primitives that are included in the same dataset as this primitive.
For example following code will add wnew as referer to all nodes of existingWay, but this method will not return wnew because it's not part of the dataset
Way wnew = new Way(existingWay)

Specified by:

getReferrers in interface IPrimitive

Parameters:

allowWithoutDataset - If true, method will return empty list if primitive is not part of the dataset. If false, exception will be thrown in this case

Returns:

a collection of all primitives that reference this primitive.

visitReferrers

public void visitReferrers(PrimitiveVisitor visitor)

Description copied from interface: IPrimitive

Visits visitor for all referrers.

Specified by:

visitReferrers in interface IPrimitive

Parameters:

visitor - the visitor. Ignored, if null.

getDataSet

public OsmData<?,?,?,?> getDataSet()

Description copied from interface: IPrimitive

Returns the parent data set of this primitive.

Specified by:

getDataSet in interface IPrimitive

Returns:

OsmData this primitive is part of.

getCachedStyle

public StyleCache getCachedStyle()

Description copied from interface: Stylable

Returns the cached style.

Specified by:

getCachedStyle in interface Stylable

Returns:

the cached style

setCachedStyle

public void setCachedStyle(StyleCache mappaintStyle)

Description copied from interface: Stylable

Sets the cached style.

Specified by:

setCachedStyle in interface Stylable

Parameters:

mappaintStyle - the cached style

isCachedStyleUpToDate

public boolean isCachedStyleUpToDate()

Description copied from interface: Stylable

Check if the cached style for this primitive is up to date.

Specified by:

isCachedStyleUpToDate in interface Stylable

Returns:

true if the cached style for this primitive is up to date

declareCachedStyleUpToDate

public void declareCachedStyleUpToDate()

Description copied from interface: Stylable

Declare that the cached style for this primitive is up to date.

Specified by:

declareCachedStyleUpToDate in interface Stylable