org.openstreetmap.josm.data.osm

Interface IRelation<M extends IRelationMember<?>>

Type Parameters:

M - Type of OSM relation member

All Superinterfaces:

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

All Known Implementing Classes:

Relation, RelationData

public interface IRelation<M extends IRelationMember<?>>
extends IPrimitive

IRelation captures the common functions of Relation and RelationData.

Since:

4098

Field Summary

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

MAX_TAG_LENGTH

Method Summary

Modifier and Type	Method and Description
default int	compareTo(IPrimitive o)
default java.util.List<? extends IPrimitive>	findRelationMembers(java.lang.String role) Returns a list of relation members having the specified role.
default java.lang.String	getDisplayName(NameFormatter formatter) Replies the display name of a primitive formatted by formatter
default java.util.Collection<? extends IPrimitive>	getIncompleteMembers() Replies a collection with the incomplete children this relation refers to.
M	getMember(int index) Returns the relation member at the specified index.
long	getMemberId(int idx) Returns id of the member at given index.
default java.util.List<? extends IPrimitive>	getMemberPrimitivesList() Returns an unmodifiable list of the OsmPrimitives referred to by at least one member of this relation.
java.util.List<M>	getMembers() Returns members of the relation.
int	getMembersCount() Returns the number of members.
OsmPrimitiveType	getMemberType(int idx) Returns type of the member at given index.
java.lang.String	getRole(int idx) Returns role of the member at given index.
default boolean	hasIncompleteMembers() Determines if at least one child primitive is incomplete.
default boolean	isBoundary() Determines if this relation is a boundary.
default boolean	isMultipolygon() Determines if this object is a relation and behaves as a multipolygon.
void	setMembers(java.util.List<M> members) Sets members of the relation.

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

accept, getBBox, getChangesetId, getDataSet, getDisplayType, getId, getInterestingTags, getLocalName, getName, getOsmId, getOsmPrimitiveId, getPrimitiveId, getRawTimestamp, getReferrers, getReferrers, getTimestamp, getUser, getVersion, hasDirectionKeys, hasSameInterestingTags, isAnnotated, isDeleted, isDisabled, isDisabledAndHidden, isDrawable, isHighlighted, isIncomplete, isMemberOfSelected, isModified, isNewOrUndeleted, isOuterMemberOfSelected, isPreserved, isSelectable, isSelected, isTagged, isTimestampEmpty, isUndeleted, isUsable, isVisible, reversedDirection, setChangesetId, setDeleted, setHighlighted, setModified, setOsmId, setRawTimestamp, setTimestamp, setUser, setVisible, visitReferrers

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

get, getKeys, getNumKeys, hasKey, hasKeys, hasTag, hasTag, hasTag, hasTag, hasTagDifferent, hasTagDifferent, hasTagDifferent, isKeyFalse, isKeyTrue, 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

Method Detail

getMembersCount

int getMembersCount()

Returns the number of members.

Returns:

number of members

getMember

M getMember(int index)

Returns the relation member at the specified index.

Parameters:

index - the index of the relation member

Returns:

relation member at the specified index

Since:

13766 (IRelation)

getMembers

java.util.List<M> getMembers()

Returns members of the relation.

Returns:

Members of the relation. Changes made in returned list are not mapped back to the primitive, use setMembers(java.util.List<M>) to modify the members

Since:

1925, 13766 (IRelation)

setMembers

void setMembers(java.util.List<M> members)

Sets members of the relation.

Parameters:

members - Can be null, in that case all members are removed

getMemberId

long getMemberId(int idx)

Returns id of the member at given index.

Parameters:

idx - member index

Returns:

id of the member at given index

getRole

java.lang.String getRole(int idx)

Returns role of the member at given index.

Parameters:

idx - member index

Returns:

role of the member at given index

getMemberType

OsmPrimitiveType getMemberType(int idx)

Returns type of the member at given index.

Parameters:

idx - member index

Returns:

type of the member at given index

hasIncompleteMembers

default boolean hasIncompleteMembers()

Determines if at least one child primitive is incomplete.

Returns:

true if at least one child primitive is incomplete

Since:

13564

compareTo

default int compareTo(IPrimitive o)

Specified by:

compareTo in interface java.lang.Comparable<IPrimitive>

getDisplayName

default java.lang.String getDisplayName(NameFormatter formatter)

Description copied from interface: IPrimitive

Replies the display name of a primitive formatted by formatter

Specified by:

getDisplayName in interface IPrimitive

Parameters:

formatter - formatter to use

Returns:

the display name

isBoundary

default boolean isBoundary()

Determines if this relation is a boundary.

Returns:

true if a boundary relation

isMultipolygon

default boolean isMultipolygon()

Description copied from interface: IPrimitive

Determines if this object is a relation and behaves as a multipolygon.

Specified by:

isMultipolygon in interface IPrimitive

Returns:

true if it is a real multipolygon or a boundary relation

getMemberPrimitivesList

default java.util.List<? extends IPrimitive> getMemberPrimitivesList()

Returns an unmodifiable list of the OsmPrimitives referred to by at least one member of this relation.

Returns:

an unmodifiable list of the primitives

Since:

13957

getIncompleteMembers

default java.util.Collection<? extends IPrimitive> getIncompleteMembers()

Replies a collection with the incomplete children this relation refers to.

Returns:

the incomplete children. Empty collection if no children are incomplete.

Since:

13957

findRelationMembers

default java.util.List<? extends IPrimitive> findRelationMembers(java.lang.String role)

Returns a list of relation members having the specified role.

Parameters:

role - role

Returns:

a list of relation members having the specified role

Since:

15418