org.openstreetmap.josm.data.osm

Class RelationMember

java.lang.Object

org.openstreetmap.josm.data.osm.RelationMember

All Implemented Interfaces:

PrimitiveId

public class RelationMember
extends Object
implements PrimitiveId

A linkage class that can be used by an relation to keep a list of members. Since membership may be qualified by a "role", a simple list is not sufficient.

Field Summary

Fields

Modifier and Type	Field and Description
private OsmPrimitive	member
private String	role

Constructor Summary

Constructors

Constructor and Description
RelationMember(RelationMember other) Copy constructor.
RelationMember(String role, OsmPrimitive member) Constructs a new RelationMember.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
OsmPrimitiveType	getDisplayType()
OsmPrimitive	getMember() Returns the relation member.
Node	getNode() Returns the relation member as a node.
Relation	getRelation() Returns the relation member as a relation.
String	getRole() Returns the role of this relation member.
OsmPrimitiveType	getType() PrimitiveId implementation.
long	getUniqueId() PrimitiveId implementation.
Way	getWay() Returns the relation member as a way.
int	hashCode()
boolean	hasRole() Determines if this relation member has a role.
boolean	hasRole(String... roles) Determines if this relation member's role is in the given list.
boolean	isNew() Replies true if this id represents a new primitive.
boolean	isNode() Determines if this relation member is a node.
boolean	isRelation() Determines if this relation member is a relation.
boolean	isWay() Determines if this relation member is a way.
boolean	refersTo(OsmPrimitive primitive) Replies true, if this relation member refers to the primitive
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

role

private final String role

member

private final OsmPrimitive member

Constructor Detail

RelationMember

public RelationMember(String role,
                      OsmPrimitive member)

Constructs a new RelationMember.

Parameters:

role - Can be null, in this case it's save as ""

member - Cannot be null

Throws:

IllegalArgumentException - if member is null

RelationMember

public RelationMember(RelationMember other)

Copy constructor. This constructor is left only for backwards compatibility. Copying RelationMember doesn't make sense because it's immutable

Parameters:

other - relation member to be copied.

Method Detail

getRole

public String getRole()

Returns the role of this relation member.

Returns:

Role name or "". Never returns null

Since:

1930

hasRole

public boolean hasRole()

Determines if this relation member has a role.

Returns:

True if role is set

Since:

1930

hasRole

public boolean hasRole(String... roles)

Determines if this relation member's role is in the given list.

Parameters:

roles - The roles to look after

Returns:

True if role is in the given list

Since:

6305

isRelation

public boolean isRelation()

Determines if this relation member is a relation.

Returns:

True if member is relation

Since:

1937

isWay

public boolean isWay()

Determines if this relation member is a way.

Returns:

True if member is way

Since:

1937

getDisplayType

public OsmPrimitiveType getDisplayType()

Returns:

type of member for icon display

Since:

3844

isNode

public boolean isNode()

Determines if this relation member is a node.

Returns:

True if member is node

Since:

1937

getRelation

public Relation getRelation()

Returns the relation member as a relation.

Returns:

Member as relation

Since:

1937

getWay

public Way getWay()

Returns the relation member as a way.

Returns:

Member as way

Since:

1937

getNode

public Node getNode()

Returns the relation member as a node.

Returns:

Member as node

Since:

1937

getMember

public OsmPrimitive getMember()

Returns the relation member.

Returns:

Member. Returned value is never null.

Since:

1937

toString

public String toString()

Overrides:

toString in class Object

refersTo

public boolean refersTo(OsmPrimitive primitive)

Replies true, if this relation member refers to the primitive

Parameters:

primitive - the primitive to check

Returns:

true, if this relation member refers to the primitive

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getType

public OsmPrimitiveType getType()

PrimitiveId implementation. Returns the same value as getMember().getType()

Specified by:

getType in interface PrimitiveId

Returns:

the object type

See Also:

Node, Way, Relation

getUniqueId

public long getUniqueId()

PrimitiveId implementation. Returns the same value as getMemberType().getUniqueId()

Specified by:

getUniqueId in interface PrimitiveId

Returns:

the id number

isNew

public boolean isNew()

Description copied from interface: PrimitiveId

Replies true if this id represents a new primitive.

Specified by:

isNew in interface PrimitiveId

Returns:

true if this id represents a new primitive.