OsmPrimitive (JOSM)

java.lang.Object
- org.openstreetmap.josm.data.osm.AbstractPrimitive
- - org.openstreetmap.josm.data.osm.OsmPrimitive

All Implemented Interfaces:

java.lang.Comparable<IPrimitive>, IPrimitive, PrimitiveId, Stylable, Tagged, TemplateEngineDataProvider

Direct Known Subclasses:

Node, Relation, Way
```
public abstract class OsmPrimitive
extends AbstractPrimitive
implements TemplateEngineDataProvider
```
The base class for OSM objects (Node, Way, Relation). It can be created, deleted and uploaded to the OSM-Server. Although OsmPrimitive is designed as a base class, it is not to be meant to subclass it by any other than from the package org.openstreetmap.josm.data.osm. The available primitives are a fixed set that are given by the server environment and not an extendible data stuff.

Field Summary

Fields
Modifier and Type	Field and Description
`private DataSet`	`dataSet` the parent dataset
`(package private) static SearchCompiler.Match`	`directionKeys` A tagged way that matches this pattern has a direction.
`private short`	`mappaintCacheIdx`
`private StyleCache`	`mappaintStyle`
`private java.lang.Object`	`referrers`
`private static SearchCompiler.Match`	`reversedDirectionKeys` A tagged way that matches this pattern has a direction that is reversed.
`private static java.lang.String`	`SPECIAL_VALUE_ID`
`private static java.lang.String`	`SPECIAL_VALUE_LOCAL_NAME`

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
Modifier	Constructor and Description
`protected`	`OsmPrimitive(long id, boolean allowNegativeId)` Creates a new primitive for the given id.
`protected`	`OsmPrimitive(long id, int version, boolean allowNegativeId)` Creates a new primitive for the given id and version.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`accept(OsmPrimitiveVisitor visitor)` Implementation of the visitor scheme.
`protected void`	`addReferrer(OsmPrimitive referrer)` Add new referrer.
`protected abstract void`	`addToBBox(BBox box, java.util.Set<PrimitiveId> visited)` If necessary, extend the bbox to contain this primitive
`void`	`checkDataset()` Throws exception if primitive is not part of the dataset
`protected void`	`checkDatasetNotReadOnly()` Throws exception if primitive is in a read-only dataset
`void`	`clearOsmMetadata()` Clears the metadata, including id and version known to the OSM API.
`void`	`cloneFrom(OsmPrimitive other)` Get and write all attributes from the parameter.
`private static SearchCompiler.Match`	`compileDirectionKeys(java.lang.String prefName, java.lang.String defaultValue)`
`abstract boolean`	`concernsArea()` Determines if this primitive semantically concerns an area.
`void`	`declareCachedStyleUpToDate()` Declare that the cached style for this primitive is up to date.
`private void`	`doVisitReferrers(java.util.function.Consumer<OsmPrimitive> visitor)`
`boolean`	`equals(java.lang.Object obj)` Equal, if the id (and class) is equal.
`boolean`	`evaluateCondition(SearchCompiler.Match condition)` Check if a condition holds for the object represented by this `TemplateEngineDataProvider`.
`StyleCache`	`getCachedStyle()` Returns the cached style.
`DataSet`	`getDataSet()` Returns the parent data set of this primitive.
`boolean`	`getDisabledType()` Get binary property used internally by the filter mechanism.
`protected java.lang.String`	`getFlagsAsString()`
`boolean`	`getHiddenType()` Get binary property used internally by the filter mechanism.
`static java.util.Set<Relation>`	`getParentRelations(java.util.Collection<? extends OsmPrimitive> primitives)` Replies the set of referring relations
`static java.util.Set<OsmPrimitive>`	`getReferrer(java.util.Collection<? extends OsmPrimitive> primitives)` Replies the collection of referring primitives for the primitives in `primitives`.
`java.util.List<OsmPrimitive>`	`getReferrers()` Gets a list of all primitives in the current dataset that reference this primitive.
`java.util.List<OsmPrimitive>`	`getReferrers(boolean allowWithoutDataset)` Find primitives that reference this primitive.
`java.util.Collection<java.lang.String>`	`getTemplateKeys()` Get the collection of all keys that can be mapped to values.
`java.lang.Object`	`getTemplateValue(java.lang.String name, boolean special)` Map a key to a value given the properties of the object.
`boolean`	`hasAreaTags()` Determines if this primitive has tags denoting an area.
`boolean`	`hasDirectionKeys()` true if this object has direction dependent tags (e.g.
`boolean`	`hasEqualSemanticAttributes(OsmPrimitive other)` Replies true if this primitive and other are equal with respect to their semantic attributes.
`(package private) boolean`	`hasEqualSemanticAttributes(OsmPrimitive other, boolean testInterestingTagsOnly)`
`(package private) boolean`	`hasEqualSemanticFlags(OsmPrimitive other)`
`boolean`	`hasEqualTechnicalAttributes(OsmPrimitive other)` Replies true if this primitive and other are equal with respect to their technical attributes.
`int`	`hashCode()` Return the id plus the class type encoded as hashcode or super's hashcode if id is 0.
`boolean`	`isAnnotated()` Determines if this object is considered "annotated".
`boolean`	`isCachedStyleUpToDate()` Check if the cached style for this primitive is up to date.
`boolean`	`isDisabled()` Replies true, if this primitive is disabled.
`boolean`	`isDisabledAndHidden()` Replies true, if this primitive is disabled and marked as completely hidden on the map.
`boolean`	`isDrawable()` Determines if this object is drawable.
`boolean`	`isHighlighted()` Checks if the highlight flag for this primitive was set
`boolean`	`isMemberOfSelected()` Determines if this primitive is a member of a selected relation.
`protected boolean`	`isNodeReferredByWays(int n)` Return true, if this primitive is a node referred by at least n ways
`private boolean`	`isOuterMemberOfMultipolygon(OsmPrimitive ref)`
`boolean`	`isOuterMemberOfSelected()` Determines if this primitive is an outer member of a selected multipolygon relation.
`abstract boolean`	`isOutsideDownloadArea()` Tests if this primitive lies outside of the downloaded area of its `DataSet`.
`boolean`	`isPreserved()` Replies true, if this primitive is preserved from filtering.
`boolean`	`isSelectable()` Determines if this object is selectable.
`boolean`	`isSelected()` Determines whether the primitive is selected
`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.
`void`	`load(PrimitiveData data)` Loads (clone) this primitive from provided PrimitiveData
`void`	`mergeFrom(OsmPrimitive other)` Merges the technical and semantical attributes from `other` onto this.
`void`	`put(java.lang.String key, java.lang.String value)` Set the given value to the given key.
`private <T extends OsmPrimitive> java.util.stream.Stream<T>`	`referrers(boolean allowWithoutDataset, java.lang.Class<T> filter)`
`<T extends OsmPrimitive> java.util.stream.Stream<T>`	`referrers(java.lang.Class<T> filter)` Gets all primitives in the current dataset that reference this primitive.
`void`	`remove(java.lang.String key)` Remove the given key from the list
`void`	`removeAll()` Removes all keys from this primitive.
`protected void`	`removeReferrer(OsmPrimitive referrer)` Remove referrer.
`boolean`	`reversedDirection()` true if this object has the "reversed direction" flag enabled
`abstract PrimitiveData`	`save()` Save parameters of this primitive to the transport object
`protected void`	`saveCommonAttributes(PrimitiveData data)` Save common parameters of primitives to the transport object
`void`	`setCachedStyle(StyleCache mappaintStyle)` Sets the cached style.
`void`	`setChangesetId(int changesetId)` Sets the changeset id of this primitive.
`(package private) void`	`setDataset(DataSet dataSet)` This method should never ever by called from somewhere else than Dataset.addPrimitive or removePrimitive methods
`void`	`setDeleted(boolean deleted)` Sets whether this primitive is deleted or not.
`boolean`	`setDisabledState(boolean hidden)` Make the primitive disabled (e.g. if a filter applies).
`void`	`setDisabledType(boolean isExplicit)` Set binary property used internally by the filter mechanism.
`void`	`setHiddenType(boolean isExplicit)` Set binary property used internally by the filter mechanism.
`void`	`setHighlighted(boolean highlighted)` Updates the highlight flag for this primitive.
`protected void`	`setIncomplete(boolean incomplete)` If set to true, this object is incomplete, which means only the id and type is known (type is the objects instance class)
`void`	`setKeys(java.util.Map<java.lang.String,java.lang.String> keys)` Sets the keys of this primitives to the key/value pairs in `keys`.
`void`	`setKeys(TagMap keys)` Copy the keys from a TagMap.
`void`	`setModified(boolean modified)` Marks this primitive as being modified.
`void`	`setOsmId(long id, int version)` Sets the id and the version of this primitive if it is known to the OSM API.
`void`	`setPreserved(boolean isPreserved)` Set binary property used internally by the filter mechanism.
`void`	`setTimestamp(java.util.Date timestamp)` Sets time of last modification to this object
`void`	`setUser(User user)` Sets the user who has last touched this object.
`void`	`setVisible(boolean visible)` Sets whether this primitive is visible, i.e.
`boolean`	`unsetDisabledState()` Remove the disabled flag from the primitive.
`private void`	`updateAnnotated()`
`private void`	`updateDirectionFlags()`
`protected void`	`updateFlags(short flag, boolean value)`
`private void`	`updateFlagsNoLock(short flag, boolean value)`
`abstract void`	`updatePosition()` Called by Dataset to update cached position information of primitive (bbox, cached EarthNorth, ...)
`private void`	`updateTagged()`
`void`	`visitReferrers(OsmPrimitiveVisitor visitor)` Visits `visitor` for all referrers.
`void`	`visitReferrers(PrimitiveVisitor visitor)` Visits `visitor` for all referrers.
`protected boolean`	`writeLock()`
`protected void`	`writeUnlock(boolean locked)`

Methods inherited from class org.openstreetmap.josm.data.osm.AbstractPrimitive
advanceUniqueId, cloneFrom, currentUniqueId, doGet, generateUniqueId, get, getChangesetId, getDiscardableKeys, 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, setRawTimestamp, visitKeys

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

Methods inherited from interface org.openstreetmap.josm.data.osm.IPrimitive
accept, getBBox, getDisplayName, getDisplayType, getLocalName, getName, getOsmId, getOsmPrimitiveId, getPrimitiveId, hasSameInterestingTags, isMultipolygon

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
  - SPECIAL_VALUE_ID
```
private static final java.lang.String SPECIAL_VALUE_ID
```
    See Also:
    
    Constant Field Values
  - SPECIAL_VALUE_LOCAL_NAME
```
private static final java.lang.String SPECIAL_VALUE_LOCAL_NAME
```
    See Also:
    
    Constant Field Values
  - directionKeys
```
static volatile SearchCompiler.Match directionKeys
```
    A tagged way that matches this pattern has a direction.
    
    See Also:
    
    AbstractPrimitive.FLAG_HAS_DIRECTIONS
  - reversedDirectionKeys
```
private static volatile SearchCompiler.Match reversedDirectionKeys
```
    A tagged way that matches this pattern has a direction that is reversed.
    This pattern should be a subset of directionKeys
    
    See Also:
    
    AbstractPrimitive.FLAG_DIRECTION_REVERSED
  - mappaintStyle
```
private StyleCache mappaintStyle
```
  - mappaintCacheIdx
```
private short mappaintCacheIdx
```
  - dataSet
```
private DataSet dataSet
```
    the parent dataset
  - referrers
```
private java.lang.Object referrers
```
- Constructor Detail
  - OsmPrimitive
```
protected OsmPrimitive(long id,
                       boolean allowNegativeId)
```
    Creates a new primitive for the given id. If allowNegativeId is set, provided id can be < 0 and will be set to primitive without any processing. If allowNegativeId is not set, then id will have to be 0 (in that case new unique id will be generated) or positive number.
    
    Parameters:
    
    id - the id
    
    allowNegativeId - true to allow negative id
    
    Throws:
    
    java.lang.IllegalArgumentException - if id < 0 and allowNegativeId is false
  - OsmPrimitive
```
protected OsmPrimitive(long id,
                       int version,
                       boolean allowNegativeId)
```
    Creates a new primitive for the given id and version. If allowNegativeId is set, provided id can be < 0 and will be set to primitive without any processing. If allowNegativeId is not set, then id will have to be 0 (in that case new unique id will be generated) or positive number. If id is not > 0 version is ignored and set to 0.
    
    Parameters:
    
    id - the id
    
    version - the version (positive integer)
    
    allowNegativeId - true to allow negative id
    
    Throws:
    
    java.lang.IllegalArgumentException - if id < 0 and allowNegativeId is false
- Method Detail
  - getReferrer
```
public static java.util.Set<OsmPrimitive> getReferrer(java.util.Collection<? extends OsmPrimitive> primitives)
```
    Replies the collection of referring primitives for the primitives in primitives.
    
    Parameters:
    
    primitives - the collection of primitives.
    
    Returns:
    
    the collection of referring primitives for the primitives in primitives; empty set if primitives is null or if there are no referring primitives
  - getCachedStyle
```
public final StyleCache getCachedStyle()
```
    Description copied from interface: Stylable
    
    Returns the cached style.
    
    Specified by:
    
    getCachedStyle in interface Stylable
    
    Returns:
    
    the cached style
  - setCachedStyle
```
public final 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 final 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 final 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
  - setDataset
```
void setDataset(DataSet dataSet)
```
    This method should never ever by called from somewhere else than Dataset.addPrimitive or removePrimitive methods
    
    Parameters:
    
    dataSet - the parent dataset
  - getDataSet
```
public DataSet 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.
  - checkDataset
```
public void checkDataset()
```
    Throws exception if primitive is not part of the dataset
  - checkDatasetNotReadOnly
```
protected final void checkDatasetNotReadOnly()
```
    Throws exception if primitive is in a read-only dataset
  - writeLock
```
protected boolean writeLock()
```
  - writeUnlock
```
protected void writeUnlock(boolean locked)
```
  - setOsmId
```
public void setOsmId(long id,
                     int version)
```
    Sets the id and the version of this primitive if it is known to the OSM API. Since we know the id and its version it can't be incomplete anymore. incomplete is set to false.
    
    Specified by:
    
    setOsmId in interface IPrimitive
    
    Overrides:
    
    setOsmId in class AbstractPrimitive
    
    Parameters:
    
    id - the id. > 0 required
    
    version - the version > 0 required
    
    Throws:
    
    java.lang.IllegalArgumentException - if id <= 0
    
    java.lang.IllegalArgumentException - if version <= 0
    
    DataIntegrityProblemException - if id is changed and primitive was already added to the dataset
  - clearOsmMetadata
```
public void clearOsmMetadata()
```
    Clears the metadata, including id and version known to the OSM API. The id is a new unique id. The version, changeset and timestamp are set to 0. incomplete and deleted are set to false. It's preferred to use copy constructor with clearMetadata set to true instead Caution: Do not use this method on primitives which are already added to a DataSet.
    
    Overrides:
    
    clearOsmMetadata in class AbstractPrimitive
    
    Throws:
    
    DataIntegrityProblemException - If primitive was already added to the dataset
    
    Since:
    
    6140
  - setUser
```
public void setUser(User user)
```
    Description copied from interface: IPrimitive
    
    Sets the user who has last touched this object.
    
    Specified by:
    
    setUser in interface IPrimitive
    
    Overrides:
    
    setUser in class AbstractPrimitive
    
    Parameters:
    
    user - the user
  - setChangesetId
```
public void setChangesetId(int changesetId)
```
    Description copied from interface: IPrimitive
    
    Sets the changeset id of this primitive. Can't be set on a new primitive.
    
    Specified by:
    
    setChangesetId in interface IPrimitive
    
    Overrides:
    
    setChangesetId in class AbstractPrimitive
    
    Parameters:
    
    changesetId - the id. >= 0 required.
  - setTimestamp
```
public void setTimestamp(java.util.Date timestamp)
```
    Description copied from interface: IPrimitive
    
    Sets time of last modification to this object
    
    Specified by:
    
    setTimestamp in interface IPrimitive
    
    Overrides:
    
    setTimestamp in class AbstractPrimitive
    
    Parameters:
    
    timestamp - date of last modification
    
    See Also:
    
    IPrimitive.getTimestamp()
  - updateFlagsNoLock
```
private void updateFlagsNoLock(short flag,
                               boolean value)
```
  - updateFlags
```
protected final void updateFlags(short flag,
                                 boolean value)
```
    Overrides:
    
    updateFlags in class AbstractPrimitive
  - setDisabledState
```
public boolean setDisabledState(boolean hidden)
```
    Make the primitive disabled (e.g. if a filter applies). To enable the primitive again, use unsetDisabledState.
    
    Parameters:
    
    hidden - if the primitive should be completely hidden from view or just shown in gray color.
    
    Returns:
    
    true, any flag has changed; false if you try to set the disabled state to the value that is already preset
  - unsetDisabledState
```
public boolean unsetDisabledState()
```
    Remove the disabled flag from the primitive. Afterwards, the primitive is displayed normally and can be selected again.
    
    Returns:
    
    true if a change occurred
  - setDisabledType
```
public void setDisabledType(boolean isExplicit)
```
    Set binary property used internally by the filter mechanism.
    
    Parameters:
    
    isExplicit - new "disabled type" flag value
  - setHiddenType
```
public void setHiddenType(boolean isExplicit)
```
    Set binary property used internally by the filter mechanism.
    
    Parameters:
    
    isExplicit - new "hidden type" flag value
  - setPreserved
```
public void setPreserved(boolean isPreserved)
```
    Set binary property used internally by the filter mechanism.
    
    Parameters:
    
    isPreserved - new "preserved" flag value
    
    Since:
    
    13309
  - isDisabled
```
public boolean isDisabled()
```
    Description copied from interface: IPrimitive
    
    Replies true, if this primitive is disabled. (E.g. a filter applies)
    
    Specified by:
    
    isDisabled in interface IPrimitive
    
    Returns:
    
    true if this object has the "disabled" flag enabled
  - isDisabledAndHidden
```
public boolean isDisabledAndHidden()
```
    Description copied from interface: IPrimitive
    
    Replies true, if this primitive is disabled and marked as completely hidden on the map.
    
    Specified by:
    
    isDisabledAndHidden in interface IPrimitive
    
    Returns:
    
    true if this object has both the "disabled" and "hide if disabled" flags enabled
  - getHiddenType
```
public boolean getHiddenType()
```
    Get binary property used internally by the filter mechanism.
    
    Returns:
    
    true if this object has the "hidden type" flag enabled
  - getDisabledType
```
public boolean getDisabledType()
```
    Get binary property used internally by the filter mechanism.
    
    Returns:
    
    true if this object has the "disabled type" flag enabled
  - isPreserved
```
public boolean isPreserved()
```
    Description copied from interface: IPrimitive
    
    Replies true, if this primitive is preserved from filtering.
    
    Specified by:
    
    isPreserved in interface IPrimitive
    
    Returns:
    
    true if this object has the "preserved" flag enabled
  - isSelectable
```
public boolean isSelectable()
```
    Description copied from interface: IPrimitive
    Determines if this object is selectable.
    A primitive can be selected if all conditions are met:
    - it is drawable
    - it is not disabled (greyed out) by a filter.
    Specified by:
    
    isSelectable in interface IPrimitive
    
    Returns:
    
    true if this object is selectable
  - isDrawable
```
public boolean isDrawable()
```
    Description copied from interface: IPrimitive
    Determines if this object is drawable.
    A primitive is drawable if all conditions are met:
    - type and id is known
    - tags are known
    - it is not deleted
    - it is not hidden by a filter
    - for nodes: lat/lon are known
    - for ways: all nodes are known and complete
    - for relations: all members are known and complete
    Specified by:
    
    isDrawable in interface IPrimitive
    
    Returns:
    
    true if this object is drawable
  - setModified
```
public void setModified(boolean modified)
```
    Description copied from interface: IPrimitive
    
    Marks this primitive as being modified.
    
    Specified by:
    
    setModified in interface IPrimitive
    
    Overrides:
    
    setModified in class AbstractPrimitive
    
    Parameters:
    
    modified - true, if this primitive is to be modified
  - setVisible
```
public void setVisible(boolean visible)
```
    Description copied from interface: IPrimitive
    
    Sets whether this primitive is visible, i.e. whether it is known on the server and not deleted on the server.
    
    Specified by:
    
    setVisible in interface IPrimitive
    
    Overrides:
    
    setVisible in class AbstractPrimitive
    
    Parameters:
    
    visible - true if this primitive is visible
    
    See Also:
    
    IPrimitive.isVisible()
  - setDeleted
```
public void setDeleted(boolean deleted)
```
    Description copied from interface: IPrimitive
    
    Sets whether this primitive is deleted or not. Also marks this primitive as modified if deleted is true.
    
    Specified by:
    
    setDeleted in interface IPrimitive
    
    Overrides:
    
    setDeleted in class AbstractPrimitive
    
    Parameters:
    
    deleted - true, if this primitive is deleted; false, otherwise
  - setIncomplete
```
protected final void setIncomplete(boolean incomplete)
```
    Description copied from class: AbstractPrimitive
    
    If set to true, this object is incomplete, which means only the id and type is known (type is the objects instance class)
    
    Overrides:
    
    setIncomplete in class AbstractPrimitive
    
    Parameters:
    
    incomplete - incomplete flag value
  - isSelected
```
public boolean isSelected()
```
    Description copied from interface: IPrimitive
    
    Determines whether the primitive is selected
    
    Specified by:
    
    isSelected in interface IPrimitive
    
    Returns:
    
    whether the primitive is selected
  - isMemberOfSelected
```
public boolean isMemberOfSelected()
```
    Description copied from interface: IPrimitive
    
    Determines if this primitive is a member of a selected relation.
    
    Specified by:
    
    isMemberOfSelected in interface IPrimitive
    
    Returns:
    
    true if this primitive is a member of a selected relation, false otherwise
  - isOuterMemberOfSelected
```
public boolean isOuterMemberOfSelected()
```
    Description copied from interface: IPrimitive
    
    Determines if this primitive is an outer member of a selected multipolygon relation.
    
    Specified by:
    
    isOuterMemberOfSelected in interface IPrimitive
    
    Returns:
    
    true if this primitive is an outer member of a selected multipolygon relation, false otherwise
  - isOuterMemberOfMultipolygon
```
private boolean isOuterMemberOfMultipolygon(OsmPrimitive ref)
```
  - 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.
  - compileDirectionKeys
```
private static SearchCompiler.Match compileDirectionKeys(java.lang.String prefName,
                                                         java.lang.String defaultValue)
                                                  throws java.lang.AssertionError
```
    Throws:
    
    java.lang.AssertionError
  - updateTagged
```
private void updateTagged()
```
  - updateAnnotated
```
private void updateAnnotated()
```
  - 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"
  - updateDirectionFlags
```
private void updateDirectionFlags()
```
  - 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
  - setKeys
```
public final void setKeys(TagMap keys)
```
    Description copied from class: AbstractPrimitive
    
    Copy the keys from a TagMap.
    
    Overrides:
    
    setKeys in class AbstractPrimitive
    
    Parameters:
    
    keys - The new key map.
  - setKeys
```
public final void setKeys(java.util.Map<java.lang.String,java.lang.String> keys)
```
    Description copied from class: AbstractPrimitive
    
    Sets the keys of this primitives to the key/value pairs in keys. Old key/value pairs are removed. If keys is null, clears existing key/value pairs.
    Note that this method, like all methods that modify keys, is not synchronized and may lead to data corruption when being used from multiple threads.
    
    Specified by:
    
    setKeys in interface Tagged
    
    Overrides:
    
    setKeys in class AbstractPrimitive
    
    Parameters:
    
    keys - the key/value pairs to set. If null, removes all existing key/value pairs.
  - put
```
public final void put(java.lang.String key,
                      java.lang.String value)
```
    Description copied from class: AbstractPrimitive
    
    Set the given value to the given key. If key is null, does nothing. If value is null, removes the key and behaves like AbstractPrimitive.remove(String).
    Note that this method, like all methods that modify keys, is not synchronized and may lead to data corruption when being used from multiple threads.
    
    Specified by:
    
    put in interface Tagged
    
    Overrides:
    
    put in class AbstractPrimitive
    
    Parameters:
    
    key - The key, for which the value is to be set. Can be null or empty, does nothing in this case.
    
    value - The value for the key. If null, removes the respective key/value pair.
    
    See Also:
    
    AbstractPrimitive.remove(String)
  - remove
```
public final void remove(java.lang.String key)
```
    Description copied from class: AbstractPrimitive
    
    Remove the given key from the list
    Note that this method, like all methods that modify keys, is not synchronized and may lead to data corruption when being used from multiple threads.
    
    Specified by:
    
    remove in interface Tagged
    
    Overrides:
    
    remove in class AbstractPrimitive
    
    Parameters:
    
    key - the key to be removed. Ignored, if key is null.
  - removeAll
```
public final void removeAll()
```
    Description copied from class: AbstractPrimitive
    
    Removes all keys from this primitive.
    Note that this method, like all methods that modify keys, is not synchronized and may lead to data corruption when being used from multiple threads.
    
    Specified by:
    
    removeAll in interface Tagged
    
    Overrides:
    
    removeAll in class AbstractPrimitive
  - keysChangedImpl
```
protected 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
  - addReferrer
```
protected void addReferrer(OsmPrimitive referrer)
```
    Add new referrer. If referrer is already included then no action is taken
    
    Parameters:
    
    referrer - The referrer to add
  - removeReferrer
```
protected void removeReferrer(OsmPrimitive referrer)
```
    Remove referrer. No action is taken if referrer is not registered
    
    Parameters:
    
    referrer - The referrer to remove
  - referrers
```
private <T extends OsmPrimitive> java.util.stream.Stream<T> referrers(boolean allowWithoutDataset,
                                                                      java.lang.Class<T> filter)
```
  - referrers
```
public final <T extends OsmPrimitive> java.util.stream.Stream<T> referrers(java.lang.Class<T> filter)
```
    Gets all primitives in the current dataset that reference this primitive.
    
    Type Parameters:
    
    T - type of primitives
    
    Parameters:
    
    filter - restrict primitives to subclasses
    
    Returns:
    
    the referrers as Stream
    
    Since:
    
    14654
  - getReferrers
```
public final java.util.List<OsmPrimitive> 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.
  - getReferrers
```
public final java.util.List<OsmPrimitive> getReferrers()
```
    Description copied from interface: IPrimitive
    
    Gets a list of all primitives in the current dataset that reference this primitive.
    
    Specified by:
    
    getReferrers in interface IPrimitive
    
    Returns:
    
    The referrers
  - visitReferrers
```
public void visitReferrers(OsmPrimitiveVisitor visitor)
```
    Visits visitor for all referrers.
    
    Parameters:
    
    visitor - the visitor. Ignored, if null.
    
    Since:
    
    12809
  - 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.
  - doVisitReferrers
```
private void doVisitReferrers(java.util.function.Consumer<OsmPrimitive> visitor)
```
  - isNodeReferredByWays
```
protected final boolean isNodeReferredByWays(int n)
```
    Return true, if this primitive is a node referred by at least n ways
    
    Parameters:
    
    n - Minimal number of ways to return true. Must be positive
    
    Returns:
    
    true if this primitive is referred by at least n ways
  - accept
```
public abstract void accept(OsmPrimitiveVisitor visitor)
```
    Implementation of the visitor scheme. Subclasses have to call the correct visitor function.
    
    Parameters:
    
    visitor - The visitor from which the visit() function must be called.
    
    Since:
    
    12809
  - cloneFrom
```
public void cloneFrom(OsmPrimitive other)
```
    Get and write all attributes from the parameter. Does not fire any listener, so use this only in the data initializing phase
    
    Parameters:
    
    other - other primitive
  - mergeFrom
```
public void mergeFrom(OsmPrimitive other)
```
    Merges the technical and semantical attributes from other onto this. Both this and other must be new, or both must be assigned an OSM ID. If both this and other have an assigned OSM id, the IDs have to be the same.
    
    Parameters:
    
    other - the other primitive. Must not be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if other is null.
    
    DataIntegrityProblemException - if either this is new and other is not, or other is new and this is not
    
    DataIntegrityProblemException - if other isn't new and other.getId() != this.getId()
  - hasEqualSemanticAttributes
```
public final boolean hasEqualSemanticAttributes(OsmPrimitive other)
```
    Replies true if this primitive and other are equal with respect to their semantic attributes.
    1. equal id
    2. both are complete or both are incomplete
    3. both have the same tags
    Parameters:
    
    other - other primitive to compare
    
    Returns:
    
    true if this primitive and other are equal with respect to their semantic attributes.
  - hasEqualSemanticFlags
```
boolean hasEqualSemanticFlags(OsmPrimitive other)
```
  - hasEqualSemanticAttributes
```
boolean hasEqualSemanticAttributes(OsmPrimitive other,
                                   boolean testInterestingTagsOnly)
```
  - hasEqualTechnicalAttributes
```
public boolean hasEqualTechnicalAttributes(OsmPrimitive other)
```
    Replies true if this primitive and other are equal with respect to their technical attributes. The attributes:
    1. deleted
    2. modified
    3. timestamp
    4. version
    5. visible
    6. user
    have to be equal
    Parameters:
    
    other - the other primitive
    
    Returns:
    
    true if this primitive and other are equal with respect to their technical attributes
  - load
```
public void load(PrimitiveData data)
```
    Loads (clone) this primitive from provided PrimitiveData
    
    Parameters:
    
    data - The object which should be cloned
  - save
```
public abstract PrimitiveData save()
```
    Save parameters of this primitive to the transport object
    
    Returns:
    
    The saved object data
  - saveCommonAttributes
```
protected void saveCommonAttributes(PrimitiveData data)
```
    Save common parameters of primitives to the transport object
    
    Parameters:
    
    data - The object to save the data into
  - updatePosition
```
public abstract void updatePosition()
```
    Called by Dataset to update cached position information of primitive (bbox, cached EarthNorth, ...)
  - getFlagsAsString
```
protected java.lang.String getFlagsAsString()
```
    Overrides:
    
    getFlagsAsString in class AbstractPrimitive
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Equal, if the id (and class) is equal. An primitive is equal to its incomplete counter part.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Return the id plus the class type encoded as hashcode or super's hashcode if id is 0. An primitive has the same hashcode as its incomplete counterpart.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - getTemplateKeys
```
public java.util.Collection<java.lang.String> getTemplateKeys()
```
    Description copied from interface: TemplateEngineDataProvider
    
    Get the collection of all keys that can be mapped to values.
    
    Specified by:
    
    getTemplateKeys in interface TemplateEngineDataProvider
    
    Returns:
    
    all keys that can be mapped to values
  - getTemplateValue
```
public java.lang.Object getTemplateValue(java.lang.String name,
                                         boolean special)
```
    Description copied from interface: TemplateEngineDataProvider
    
    Map a key to a value given the properties of the object.
    
    Specified by:
    
    getTemplateValue in interface TemplateEngineDataProvider
    
    Parameters:
    
    name - the key to map
    
    special - if the key is a "special:*" keyword that is used to get certain information or automated behavior
    
    Returns:
    
    a value that the key is mapped to or "special" information in case special is true
  - evaluateCondition
```
public boolean evaluateCondition(SearchCompiler.Match condition)
```
    Description copied from interface: TemplateEngineDataProvider
    
    Check if a condition holds for the object represented by this TemplateEngineDataProvider.
    
    Specified by:
    
    evaluateCondition in interface TemplateEngineDataProvider
    
    Parameters:
    
    condition - the condition to check (which is a search expression)
    
    Returns:
    
    true if the condition holds
  - getParentRelations
```
public static java.util.Set<Relation> getParentRelations(java.util.Collection<? extends OsmPrimitive> primitives)
```
    Replies the set of referring relations
    
    Parameters:
    
    primitives - primitives to fetch relations from
    
    Returns:
    
    the set of referring relations
  - hasAreaTags
```
public final boolean hasAreaTags()
```
    Determines if this primitive has tags denoting an area.
    
    Returns:
    
    true if this primitive has tags denoting an area, false otherwise.
    
    Since:
    
    6491
  - concernsArea
```
public abstract boolean concernsArea()
```
    Determines if this primitive semantically concerns an area.
    
    Returns:
    
    true if this primitive semantically concerns an area, according to its type, geometry and tags, false otherwise.
    
    Since:
    
    6491
  - isOutsideDownloadArea
```
public abstract boolean isOutsideDownloadArea()
```
    Tests if this primitive lies outside of the downloaded area of its DataSet.
    
    Returns:
    
    true if this primitive lies outside of the downloaded area
  - addToBBox
```
protected abstract void addToBBox(BBox box,
                                  java.util.Set<PrimitiveId> visited)
```
    If necessary, extend the bbox to contain this primitive
    
    Parameters:
    
    box - a bbox instance
    
    visited - a set of visited members or null
    
    Since:
    
    11269

Class OsmPrimitive

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

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

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

Methods inherited from interface java.lang.Comparable

Field Detail

SPECIAL_VALUE_ID

SPECIAL_VALUE_LOCAL_NAME

directionKeys

reversedDirectionKeys

mappaintStyle

mappaintCacheIdx

dataSet

referrers

Constructor Detail

OsmPrimitive

OsmPrimitive

Method Detail

getReferrer

getCachedStyle

setCachedStyle

isCachedStyleUpToDate

declareCachedStyleUpToDate

setDataset

getDataSet

checkDataset

checkDatasetNotReadOnly

writeLock

writeUnlock

setOsmId

clearOsmMetadata

setUser

setChangesetId

setTimestamp

updateFlagsNoLock

updateFlags

setDisabledState

unsetDisabledState

setDisabledType

setHiddenType

setPreserved

isDisabled

isDisabledAndHidden

getHiddenType

getDisabledType

isPreserved

isSelectable

isDrawable

setModified

setVisible

setDeleted

setIncomplete

isSelected

isMemberOfSelected

isOuterMemberOfSelected

isOuterMemberOfMultipolygon

setHighlighted

isHighlighted

compileDirectionKeys

updateTagged

updateAnnotated

isTagged

isAnnotated

updateDirectionFlags

hasDirectionKeys

reversedDirection

setKeys

setKeys

put

remove

removeAll

keysChangedImpl