org.geomajas.layer.entity

Interface Entity

@Api(allMethods=true)
@UserImplemented
public interface Entity

An Entity is a representation of an internal layer object (feature, association attribute) as a tree of objects. Navigation and modification of the tree is possible in a generic way by the provided methods.

Since:

1.9.0

Author:

Jan De Moerloose

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String name) Gets the specified primitive (or geometry) value.
Entity	getChild(String name) Returns the child entity of this entity with the specified name (attribute name).
EntityCollection	getChildCollection(String name) Gets the collection of entities with the specified name.
Object	getId(String name) Returns the unique identifier value of this entity.
void	setAttribute(String name, Object value) Sets the specified primitive (or geometry) attribute value.
void	setChild(String name, Entity entity) Sets the child entity with the specified name (attribute name).

Method Detail

getId

Object getId(String name)
             throws LayerException

Returns the unique identifier value of this entity.

Parameters:

name - name of the identifier attribute

Returns:

id

Throws:

LayerException - oops

getChild

Entity getChild(String name)
                throws LayerException

Returns the child entity of this entity with the specified name (attribute name). A single child entity represents a many-to-one association.

Parameters:

name - attribute name

Returns:

the child entity

Throws:

LayerException - oops

setChild

void setChild(String name,
            Entity entity)
              throws LayerException

Sets the child entity with the specified name (attribute name). A single child entity represents a many-to-one association.

Parameters:

name - attribute name

entity - the new entity

Throws:

LayerException - oops

getChildCollection

EntityCollection getChildCollection(String name)
                                    throws LayerException

Gets the collection of entities with the specified name. An empty collection is returned if the corresponding object value is null. An entity collection represents a one-to-many association.

Parameters:

name - attribute name

Returns:

a modifiable collection of entities

Throws:

LayerException - oops

setAttribute

void setAttribute(String name,
                Object value)
                  throws LayerException

Sets the specified primitive (or geometry) attribute value.

Parameters:

name - attribute name

value - attribute value

Throws:

LayerException - oops

getAttribute

Object getAttribute(String name)
                    throws LayerException

Gets the specified primitive (or geometry) value.

Parameters:

name - attribute name

Returns:

the attribute value

Throws:

LayerException - oops