net.systemeD.halcyon.connection.Relation

	Property	Defined by
		connection : Connection Connection to which this entity belongs.	Entity
		deleted : Boolean = false	Entity
		entities : Array List of entities.	Entity
		entity_type : String = "relation" [static]	Relation
		hasParents : Boolean Whether this entity has any parents.	Entity
		hasParentWays : Boolean Whether this entity has any parents that are Ways.	Entity
		id : Number OSM ID.	Entity
		isDirty : Boolean Check if entity is modified since last markClean().	Entity
		length : uint [read-only]	Relation
		loaded : Boolean Is entity fully loaded, or is it just a placeholder reference (as a relation member)?	Entity
		locked : Boolean = false Lock against purging when off-screen	Entity
		memberEntities : Array [read-only]	Relation
		memberships : Array Returns all relations that this Entity is part of, as array of {relation, position, role}, sorted by position.	Entity
		numParentWays : uint How many parents are Ways?	Entity
		parentObjects : Array All parents of this entity.	Entity
		parentRelations : Array All parents that are Relations	Entity
		parentsLoaded : Boolean = true Have all its parents (ie, relations that contain this object as a member, ways that contain this node) been loaded into memory	Entity
		parentWays : Array Get array of all Ways of which this object (presumably a node) is a child.	Entity
		status : String	Entity
		timestamp : String Most recent modification of the entity (from OSM API).	Entity
		uid : Number User ID who last edited this entity (from OSM API).	Entity
		version : uint Current version number.	Entity

Public Methods

	Method		Defined by
		Relation(connection:Connection, id:Number, version:uint, tags:Object, loaded:Boolean, members:Array, uid:Number, timestamp:String = null)	Relation
		addParent(parent:Entity):void Create parent link from this entity to another.	Entity
		appendMember(member:RelationMember, performAction:Function):uint	Relation
		countParentObjects(within:Object):uint How many parents does this entity have that satisfy the "within" constraint?	Entity
		findEntityMemberIndex(entity:Entity):int	Relation
		findEntityMemberIndexes(entity:Entity):Array	Relation
		findMembersByRole(role:String, entityType:Class = null):Array	Relation
		findParentRelationsOfType(type:String, role:String = null):Array Returns parents that are relations, and of the specified type, and of which this entity is the correct role (if provided).	Entity
		getDescription():String	Relation
		getMember(index:uint):RelationMember	Relation
		getRelationMemberships():Array	Entity
		getTag(key:String):String Retrieve a tag by key.	Entity
		getTagArray():Array Returns an array that duplicates the tags on this entity.	Entity
		getTagList():TagList	Entity
		getTagsCopy():Object Returns an object that duplicates the tags on this entity.	Entity
		getTagsHash():Object	Entity
		getType():String	Relation
		hasInterestingTags():Boolean Whether the entity has any tags other than meta-tags (attribution, created_by, source, tiger:...)	Entity
		hasMemberInRole(entity:Entity, role:String):Boolean	Relation
		hasParent(entity:Entity):Boolean Whether 'entity' is a parent of this Entity.	Entity
		hasTags():Boolean Whether the entity has > 0 tags.	Entity
		insertMember(index:uint, member:RelationMember, performAction:Function):void	Relation
		isDeleted():Boolean Whether entity is marked deleted.	Entity
		isEmpty():Boolean	Relation
		isType(str:String):Boolean Compare type against supplied string	Entity
		isUneditedTiger():Boolean Rough function to detect entities untouched since TIGER import.	Entity
		markClean():void Reset modified flag.	Entity
		markDirty():void Set entity as modified.	Entity
		mergeTags(source:Entity, performAction:Function):Boolean Copy tags from another entity into this one, creating "key=value1; value2" pairs if necessary.	Entity
		nullify():void	Relation
		remove(performAction:Function):void	Relation
		removeFromParents(performAction:Function):void	Entity
		removeMember(entity:Entity, performAction:Function):void	Relation
		removeMemberByIndex(index:uint, performAction:Function):void	Relation
		removeParent(parent:Entity):void Remove parent link.	Entity
		renameTag(oldKey:String, newKey:String, performAction:Function):void Change oldKey=[value] to newKey=[value], with optional undoability.	Entity
		renumber(newID:Number, newVersion:uint):void Assign a new ID and version.	Entity
		resume():void Resume redrawing of the object	Entity
		sameTags(entity:Entity):Boolean Compare tags between two entities.	Entity
		setDeletedState(isDeleted:Boolean):void Mark entity as deleted.	Entity
		setMember(index:uint, member:RelationMember, performAction:Function):void	Relation
		setStatus(s:String):void Change entity status.	Entity
		setTag(key:String, value:String, performAction:Function):void Set key=value, with optional undoability.	Entity
		suspend():void Temporarily prevent redrawing of the object.	Entity
		tagIs(key:String, value:String):Boolean	Entity
		toString():String	Relation
		update(version:uint, tags:Object, loaded:Boolean, parentsLoaded:Boolean, members:Array, uid:Number, timestamp:String = null):void	Relation
		updateEntityProperties(version:uint, tags:Object, loaded:Boolean, parentsLoaded:Boolean, uid:Number, timestamp:String):void Set a bunch of properties in one hit.	Entity
		within(left:Number, right:Number, top:Number, bottom:Number):Boolean	Entity

	Method	Defined by
		nullifyEntity():void Implement nullifybehaviour: delete tags, etc.	Entity

Property detail

entity_type

property

public static var entity_type:String = "relation"

length

property

length:uint [read-only]Implementation
public function get length():uint

memberEntities

property

memberEntities:Array [read-only]Implementation
public function get memberEntities():Array

Constructor detail

Relation

()

constructor

public function Relation(connection:Connection, id:Number, version:uint, tags:Object, loaded:Boolean, members:Array, uid:Number, timestamp:String = null)

Parameters

	`connection:Connection`

	`id:Number`

	`version:uint`

	`tags:Object`

	`loaded:Boolean`

	`members:Array`

	`uid:Number`

	`timestamp:String` (default = `null`)

Method detail

appendMember

()

method

public function appendMember(member:RelationMember, performAction:Function):uintParameters

	`member:RelationMember`

	`performAction:Function`

Returns

uint

findEntityMemberIndex

()

method

public function findEntityMemberIndex(entity:Entity):intParameters

entity:Entity

Returns

int

findEntityMemberIndexes

()

method

public function findEntityMemberIndexes(entity:Entity):ArrayParameters

entity:Entity

Returns

Array

findMembersByRole

()

method

public function findMembersByRole(role:String, entityType:Class = null):ArrayParameters

	`role:String`

	`entityType:Class` (default = `null`)

Returns

Array

getDescription

()

method

public override function getDescription():String

Returns

String

getMember

()

method

public function getMember(index:uint):RelationMemberParameters

index:uint

Returns

RelationMember

getType

()

method

public override function getType():String

Returns

String

hasMemberInRole

()

method

public function hasMemberInRole(entity:Entity, role:String):BooleanParameters

	`entity:Entity`

	`role:String`

Returns

Boolean

insertMember

()

method

public function insertMember(index:uint, member:RelationMember, performAction:Function):voidParameters

	`index:uint`

	`member:RelationMember`

	`performAction:Function`

isEmpty

()

method

public override function isEmpty():Boolean

Returns

Boolean

nullify

()

method

public override function nullify():void

remove

()

method

public override function remove(performAction:Function):voidParameters

performAction:Function

removeMember

()

method

public function removeMember(entity:Entity, performAction:Function):voidParameters

	`entity:Entity`

	`performAction:Function`

removeMemberByIndex

()

method

public function removeMemberByIndex(index:uint, performAction:Function):voidParameters

	`index:uint`

	`performAction:Function`

setMember

()

method

public function setMember(index:uint, member:RelationMember, performAction:Function):voidParameters

	`index:uint`

	`member:RelationMember`

	`performAction:Function`

toString

()

method

public override function toString():String

Returns

String

update

()

method

public function update(version:uint, tags:Object, loaded:Boolean, parentsLoaded:Boolean, members:Array, uid:Number, timestamp:String = null):void

Parameters

	`version:uint`

	`tags:Object`

	`loaded:Boolean`

	`parentsLoaded:Boolean`

	`members:Array`

	`uid:Number`

	`timestamp:String` (default = `null`)

Found an error? Help us fix it. http://wiki.openstreetmap.org/wiki/Potlatch2

Halcyon and Potlatch2 Developer documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Relation	Properties \| Methods

Package	net.systemeD.halcyon.connection
Class	public class Relation
Inheritance	Relation Entity flash.events.EventDispatcher