net.systemeD.halcyon.connection.EntityCollection

	Property	Defined by
		connection : Connection Connection to which this entity belongs.	Entity
		deleted : Boolean = false	Entity
		entities : Array [read-only]	EntityCollection
		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 [read-only]	EntityCollection
		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
		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 [read-only]	EntityCollection
		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
		EntityCollection(entities:Array)	EntityCollection
		addParent(parent:Entity):void Create parent link from this entity to another.	Entity
		countParentObjects(within:Object):uint How many parents does this entity have that satisfy the "within" constraint?	Entity
		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	EntityCollection
		getRelationMemberships():Array	EntityCollection
		getTag(key:String):String	EntityCollection
		getTagArray():Array	EntityCollection
		getTagList():TagList	EntityCollection
		getTagsCopy():Object	EntityCollection
		getTagsHash():Object	EntityCollection
		getType():String	EntityCollection
		hasInterestingTags():Boolean	EntityCollection
		hasParent(entity:Entity):Boolean Whether 'entity' is a parent of this Entity.	Entity
		hasTags():Boolean	EntityCollection
		isDeleted():Boolean Whether entity is marked deleted.	Entity
		isEmpty():Boolean Whether entity is "empty" - to be overridden by subclass.	Entity
		isType(str:String):Boolean Compare type against supplied string	Entity
		isUneditedTiger():Boolean	EntityCollection
		markClean():void	EntityCollection
		markDirty():void	EntityCollection
		mergeTags(source:Entity, performAction:Function):Boolean Copy tags from another entity into this one, creating "key=value1; value2" pairs if necessary.	Entity
		nullify():void Free up memory by converting entity to a dummy entity, for entities that we no longer need but which are part of a still-in-memory relation	Entity
		remove(performAction:Function):void Delete entity - must be overridden.	Entity
		removeFromParents(performAction:Function):void	Entity
		removeParent(parent:Entity):void Remove parent link.	Entity
		renameTag(oldKey:String, newKey:String, performAction:Function):void	EntityCollection
		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
		setStatus(s:String):void Change entity status.	Entity
		setTag(key:String, value:String, performAction:Function):void	EntityCollection
		suspend():void Temporarily prevent redrawing of the object.	Entity
		tagIs(key:String, value:String):Boolean	EntityCollection
		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

entities

property

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

isDirty

property

isDirty:Boolean [read-only]Implementation
public function get isDirty():Boolean

parentRelations

property

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

Constructor detail

EntityCollection

()

constructor

public function EntityCollection(entities:Array)Parameters

entities:Array

Method detail

getDescription

()

method

public override function getDescription():String

Returns

String

getRelationMemberships

()

method

public override function getRelationMemberships():Array

Returns

Array

getTag

()

method

public override function getTag(key:String):StringParameters

key:String

Returns

String

getTagArray

()

method

public override function getTagArray():Array

Returns

Array

getTagList

()

method

public override function getTagList():TagList

Returns

TagList

getTagsCopy

()

method

public override function getTagsCopy():Object

Returns

Object

getTagsHash

()

method

public override function getTagsHash():Object

Returns

Object

getType

()

method

public override function getType():String

Returns

String

hasInterestingTags

()

method

public override function hasInterestingTags():Boolean

Returns

Boolean

hasTags

()

method

public override function hasTags():Boolean

Returns

Boolean

isUneditedTiger

()

method

public override function isUneditedTiger():Boolean

Returns

Boolean

markClean

()

method

public override function markClean():void

markDirty

()

method

public override function markDirty():void

renameTag

()

method

public override function renameTag(oldKey:String, newKey:String, performAction:Function):voidParameters

	`oldKey:String`

	`newKey:String`

	`performAction:Function`

setTag

()

method

public override function setTag(key:String, value:String, performAction:Function):voidParameters

	`key:String`

	`value:String`

	`performAction:Function`

tagIs

()

method

public override function tagIs(key:String, value:String):BooleanParameters

	`key:String`

	`value:String`

Returns

Boolean

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 EntityCollection	Properties \| Methods

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