IPrimitive (JOSM)

All Superinterfaces:

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

All Known Subinterfaces:

INode, IRelation, IWay

All Known Implementing Classes:

AbstractPrimitive, Node, NodeData, OsmPrimitive, PrimitiveData, Relation, RelationData, Way, WayData
```
public interface IPrimitive
extends Tagged, PrimitiveId, Stylable, java.lang.Comparable<IPrimitive>
```
IPrimitive captures the common functions of OsmPrimitive and PrimitiveData.

Since:

4098

Field Summary
- Fields inherited from interface org.openstreetmap.josm.data.osm.Tagged
  MAX_TAG_LENGTH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`accept(PrimitiveVisitor visitor)` Makes the given visitor visit this primitive.
`int`	`getChangesetId()` Replies the id of the changeset this primitive was last uploaded to.
`java.lang.String`	`getDisplayName(NameFormatter formatter)` Replies the display name of a primitive formatted by `formatter`
`default OsmPrimitiveType`	`getDisplayType()` Gets the type this primitive is displayed at
`long`	`getId()` Replies the id of this primitive.
`java.lang.String`	`getLocalName()` Replies a localized name for this primitive given by the value of the name tags accessed from very specific (language variant) to more generic (default name).
`java.lang.String`	`getName()` Replies the name of this primitive.
`PrimitiveId`	`getPrimitiveId()` Replies the unique primitive id for this primitive
`int`	`getRawTimestamp()` Time of last modification to this object.
`java.util.Date`	`getTimestamp()` Time of last modification to this object.
`User`	`getUser()` Replies the user who has last touched this object.
`int`	`getVersion()` Replies the version number as returned by the API.
`boolean`	`hasDirectionKeys()` true if this object has direction dependent tags (e.g.
`boolean`	`isAnnotated()` Determines if this object is considered "annotated".
`boolean`	`isDeleted()` Replies `true`, if the object has been deleted.
`default boolean`	`isDisabled()` Replies true, if this primitive is disabled.
`default boolean`	`isDisabledAndHidden()` Replies true, if this primitive is disabled and marked as completely hidden on the map.
`default boolean`	`isDrawable()` Determines if this object is drawable.
`boolean`	`isHighlighted()` Checks if the highlight flag for this primitive was set
`boolean`	`isIncomplete()` Determines if this primitive is incomplete.
`default boolean`	`isMemberOfSelected()` Determines if this primitive is a member of a selected relation.
`boolean`	`isModified()` Replies `true` if the object has been modified since it was loaded from the server.
`default boolean`	`isMultipolygon()` Determines if this object is a relation and behaves as a multipolygon.
`boolean`	`isNewOrUndeleted()` Determines if this primitive is new or undeleted.
`default boolean`	`isOuterMemberOfSelected()` Determines if this primitive is an outer member of a selected multipolygon relation.
`default boolean`	`isSelectable()` Determines if this object is selectable.
`default boolean`	`isSelected()` Determines whether the primitive is selected
`boolean`	`isTagged()` Determines if this object is considered "tagged".
`boolean`	`isTimestampEmpty()` Determines if this primitive has no timestamp information.
`boolean`	`isUndeleted()` Replies `true` if the object has been deleted on the server and was undeleted by the user.
`boolean`	`isUsable()` Replies `true`, if the object is usable (i.e.
`boolean`	`isVisible()` Checks if object is known to the server.
`boolean`	`reversedDirection()` true if this object has the "reversed direction" flag enabled
`void`	`setChangesetId(int changesetId)` Sets the changeset id of this primitive.
`void`	`setDeleted(boolean deleted)` Sets whether this primitive is deleted or not.
`void`	`setHighlighted(boolean highlighted)` Updates the highlight flag for this primitive.
`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`	`setRawTimestamp(int timestamp)` Sets time of last modification to this object
`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.

Methods inherited from interface org.openstreetmap.josm.data.osm.Tagged
get, getKeys, getNumKeys, hasKey, hasKeys, hasTag, hasTag, hasTag, hasTag, hasTagDifferent, hasTagDifferent, hasTagDifferent, keySet, put, put, remove, removeAll, setKeys, visitKeys

Methods inherited from interface org.openstreetmap.josm.data.osm.PrimitiveId
getType, getUniqueId, isNew

Methods inherited from interface org.openstreetmap.josm.data.osm.Stylable
clearCachedStyle, declareCachedStyleUpToDate, getCachedStyle, isCachedStyleUpToDate, setCachedStyle

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - isModified
```
boolean isModified()
```
    Replies true if the object has been modified since it was loaded from the server. In this case, on next upload, this object will be updated. Deleted objects are deleted from the server. If the objects are added (id=0), the modified is ignored and the object is added to the server.
    
    Returns:
    
    true if the object has been modified since it was loaded from the server
  - setModified
```
void setModified(boolean modified)
```
    Marks this primitive as being modified.
    
    Parameters:
    
    modified - true, if this primitive is to be modified
  - isVisible
```
boolean isVisible()
```
    Checks if object is known to the server. Replies true if this primitive is either unknown to the server (i.e. its id is 0) or it is known to the server and it hasn't be deleted on the server. Replies false, if this primitive is known on the server and has been deleted on the server.
    
    Returns:
    
    true, if the object is visible on server.
    
    See Also:
    
    setVisible(boolean)
  - setVisible
```
void setVisible(boolean visible)
```
    Sets whether this primitive is visible, i.e. whether it is known on the server and not deleted on the server.
    
    Parameters:
    
    visible - true if this primitive is visible
    
    Throws:
    
    java.lang.IllegalStateException - if visible is set to false on an primitive with id==0
    
    See Also:
    
    isVisible()
  - isDeleted
```
boolean isDeleted()
```
    Replies true, if the object has been deleted.
    
    Returns:
    
    true, if the object has been deleted.
    
    See Also:
    
    setDeleted(boolean)
  - setDeleted
```
void setDeleted(boolean deleted)
```
    Sets whether this primitive is deleted or not. Also marks this primitive as modified if deleted is true.
    
    Parameters:
    
    deleted - true, if this primitive is deleted; false, otherwise
  - isIncomplete
```
boolean isIncomplete()
```
    Determines if this primitive is incomplete.
    
    Returns:
    
    true if this primitive is incomplete, false otherwise
  - isUndeleted
```
boolean isUndeleted()
```
    Replies true if the object has been deleted on the server and was undeleted by the user.
    
    Returns:
    
    true if the object has been undeleted
  - isUsable
```
boolean isUsable()
```
    Replies true, if the object is usable (i.e. complete and not deleted).
    
    Returns:
    
    true, if the object is usable.
    
    See Also:
    
    setDeleted(boolean)
  - isNewOrUndeleted
```
boolean isNewOrUndeleted()
```
    Determines if this primitive is new or undeleted.
    
    Returns:
    
    True if primitive is new or undeleted
    
    See Also:
    
    PrimitiveId.isNew(), isUndeleted()
  - isDisabled
```
default boolean isDisabled()
```
    Replies true, if this primitive is disabled. (E.g. a filter applies)
    
    Returns:
    
    true if this object has the "disabled" flag enabled
    
    Since:
    
    13662
  - isDisabledAndHidden
```
default boolean isDisabledAndHidden()
```
    Replies true, if this primitive is disabled and marked as completely hidden on the map.
    
    Returns:
    
    true if this object has both the "disabled" and "hide if disabled" flags enabled
    
    Since:
    
    13662
  - isSelectable
```
default boolean isSelectable()
```
    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.
    Returns:
    
    true if this object is selectable
    
    Since:
    
    13664
  - isDrawable
```
default boolean isDrawable()
```
    Determines if this object is drawable.
    A primitive is complete 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
    Returns:
    
    true if this object is drawable
    
    Since:
    
    13664
  - isSelected
```
default boolean isSelected()
```
    Determines whether the primitive is selected
    
    Returns:
    
    whether the primitive is selected
    
    Since:
    
    13664
  - isMemberOfSelected
```
default boolean isMemberOfSelected()
```
    Determines if this primitive is a member of a selected relation.
    
    Returns:
    
    true if this primitive is a member of a selected relation, false otherwise
    
    Since:
    
    13664
  - isOuterMemberOfSelected
```
default boolean isOuterMemberOfSelected()
```
    Determines if this primitive is an outer member of a selected multipolygon relation.
    
    Returns:
    
    true if this primitive is an outer member of a selected multipolygon relation, false otherwise
    
    Since:
    
    13664
  - getId
```
long getId()
```
    Replies the id of this primitive.
    
    Returns:
    
    the id of this primitive.
  - getPrimitiveId
```
PrimitiveId getPrimitiveId()
```
    Replies the unique primitive id for this primitive
    
    Returns:
    
    the unique primitive id for this primitive
  - getVersion
```
int getVersion()
```
    Replies the version number as returned by the API. The version is 0 if the id is 0 or if this primitive is incomplete.
    
    Returns:
    
    the version number as returned by the API
    
    See Also:
    
    PrimitiveData.setVersion(int)
  - setOsmId
```
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.
    
    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
  - getUser
```
User getUser()
```
    Replies the user who has last touched this object. May be null.
    
    Returns:
    
    the user who has last touched this object. May be null.
  - setUser
```
void setUser(User user)
```
    Sets the user who has last touched this object.
    
    Parameters:
    
    user - the user
  - getTimestamp
```
java.util.Date getTimestamp()
```
    Time of last modification to this object. This is not set by JOSM but read from the server and delivered back to the server unmodified. It is used to check against edit conflicts.
    
    Returns:
    
    date of last modification
    
    See Also:
    
    setTimestamp(java.util.Date)
  - getRawTimestamp
```
int getRawTimestamp()
```
    Time of last modification to this object. This is not set by JOSM but read from the server and delivered back to the server unmodified. It is used to check against edit conflicts.
    
    Returns:
    
    last modification as timestamp
    
    See Also:
    
    setRawTimestamp(int)
  - setTimestamp
```
void setTimestamp(java.util.Date timestamp)
```
    Sets time of last modification to this object
    
    Parameters:
    
    timestamp - date of last modification
    
    See Also:
    
    getTimestamp()
  - setRawTimestamp
```
void setRawTimestamp(int timestamp)
```
    Sets time of last modification to this object
    
    Parameters:
    
    timestamp - date of last modification
    
    See Also:
    
    getRawTimestamp()
  - isTimestampEmpty
```
boolean isTimestampEmpty()
```
    Determines if this primitive has no timestamp information.
    
    Returns:
    
    true if this primitive has no timestamp information
    
    See Also:
    
    getTimestamp(), getRawTimestamp()
  - getChangesetId
```
int getChangesetId()
```
    Replies the id of the changeset this primitive was last uploaded to. 0 if this primitive wasn't uploaded to a changeset yet or if the changeset isn't known.
    
    Returns:
    
    the id of the changeset this primitive was last uploaded to.
  - setChangesetId
```
void setChangesetId(int changesetId)
```
    Sets the changeset id of this primitive. Can't be set on a new primitive.
    
    Parameters:
    
    changesetId - the id. >= 0 required.
    
    Throws:
    
    java.lang.IllegalStateException - if this primitive is new.
    
    java.lang.IllegalArgumentException - if id < 0
  - accept
```
void accept(PrimitiveVisitor visitor)
```
    Makes the given visitor visit this primitive.
    
    Parameters:
    
    visitor - visitor
  - getName
```
java.lang.String getName()
```
    Replies the name of this primitive. The default implementation replies the value of the tag name or null, if this tag is not present.
    
    Returns:
    
    the name of this primitive
  - getLocalName
```
java.lang.String getLocalName()
```
    Replies a localized name for this primitive given by the value of the name tags accessed from very specific (language variant) to more generic (default name).
    
    Returns:
    
    the name of this primitive, null if no name exists
    
    See Also:
    
    LanguageInfo.getLanguageCodes(java.util.Locale)
  - getDisplayName
```
java.lang.String getDisplayName(NameFormatter formatter)
```
    Replies the display name of a primitive formatted by formatter
    
    Parameters:
    
    formatter - formatter to use
    
    Returns:
    
    the display name
    
    Since:
    
    13564
  - getDisplayType
```
default OsmPrimitiveType getDisplayType()
```
    Gets the type this primitive is displayed at
    
    Returns:
    
    A OsmPrimitiveType
    
    Since:
    
    13564
  - setHighlighted
```
void setHighlighted(boolean highlighted)
```
    Updates the highlight flag for this primitive.
    
    Parameters:
    
    highlighted - The new highlight flag.
    
    Since:
    
    13664
  - isHighlighted
```
boolean isHighlighted()
```
    Checks if the highlight flag for this primitive was set
    
    Returns:
    
    The highlight flag.
    
    Since:
    
    13664
  - isTagged
```
boolean isTagged()
```
    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".
    
    Returns:
    
    true if this object is considered "tagged"
    
    Since:
    
    13662
  - isAnnotated
```
boolean isAnnotated()
```
    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".
    
    Returns:
    
    true if this object is considered "annotated"
    
    Since:
    
    13662
  - isMultipolygon
```
default boolean isMultipolygon()
```
    Determines if this object is a relation and behaves as a multipolygon.
    
    Returns:
    
    true if it is a real multipolygon or a boundary relation
    
    Since:
    
    13667
  - hasDirectionKeys
```
boolean hasDirectionKeys()
```
    true if this object has direction dependent tags (e.g. oneway)
    
    Returns:
    
    true if this object has direction dependent tags
    
    Since:
    
    13662
  - reversedDirection
```
boolean reversedDirection()
```
    true if this object has the "reversed direction" flag enabled
    
    Returns:
    
    true if this object has the "reversed direction" flag enabled
    
    Since:
    
    13662

Interface IPrimitive

Field Summary

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

Method Summary

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

Method Detail

isModified

setModified

isVisible

setVisible

isDeleted

setDeleted

isIncomplete

isUndeleted

isUsable

isNewOrUndeleted

isDisabled

isDisabledAndHidden

isSelectable

isDrawable

isSelected

isMemberOfSelected

isOuterMemberOfSelected

getId

getPrimitiveId

getVersion

setOsmId

getUser

setUser

getTimestamp

getRawTimestamp

setTimestamp

setRawTimestamp

isTimestampEmpty

getChangesetId

setChangesetId

accept

getName

getLocalName

getDisplayName

getDisplayType

setHighlighted

isHighlighted

isTagged

isAnnotated

isMultipolygon

hasDirectionKeys

reversedDirection