livespace.services.entities.room_presentation
Class RoomSchematicEntity

java.lang.Object
  extended by dsto.dfc.databeans.AbstractDataObject
      extended by dsto.dfc.databeans.SimpleDataObject
          extended by dsto.dfc.databeans.FancyDataObject
              extended by livespace.services.Entity
                  extended by livespace.services.entities.room_presentation.RoomSchematicEntity
All Implemented Interfaces:
IDataObject, IDataObjectChildListener, Cloneable

public class RoomSchematicEntity
extends Entity

Maintains a list of SchematicItem instances

Author:
karu

Field Summary
 EntityRegistry schematicItems
          set of SchematicItem instance
static String TYPE
           
 
Fields inherited from class livespace.services.Entity
container, id, lastTouched, name, unconfirmedUpdates
 
Fields inherited from class dsto.dfc.databeans.AbstractDataObject
listeners
 
Fields inherited from interface dsto.dfc.databeans.IDataObject
OVERRIDE, PERSISTENT, PERSISTENT_OVERRIDE, TRANSIENT, TRANSIENT_OVERRIDE
 
Constructor Summary
RoomSchematicEntity()
          Constructor
RoomSchematicEntity(String id)
           
RoomSchematicEntity(String id, String name)
           
 
Method Summary
 boolean add(SchematicItem item)
          Adds a SchematicItem instance to the container
 void addSchematicListener(PropertyListener listener)
          Adds a listener to the container of SchemtaticItems instances
 SchematicItem createSchematicItem(Entity entity)
          Creates a SchematicItem instance and add's the instance to the internal container
 SchematicItem createSchematicItem(Entity entity, Point location)
          Creates a SchematicItem instance and add's the instance to the internal container
 SchematicItem find(String entityId)
          Finds a SchamaticItem instance based on the id of the represented entity
 String getType()
          The type of the object (eg "room", "light", "volume", etc).
 
Methods inherited from class livespace.services.Entity
create, createId, getElvin, getType, getTypeInfo, mutex, sameEntity, shallowClone, waitForProperty, waitForProperty, waitForProperty, waitForProperty
 
Methods inherited from class dsto.dfc.databeans.FancyDataObject
childPropertyChanged, getValue, isTransient, propertyIterator, setValue
 
Methods inherited from class dsto.dfc.databeans.SimpleDataObject
getFieldNames, setValue
 
Methods inherited from class dsto.dfc.databeans.AbstractDataObject
addFirstPropertyListener, addPropertyListener, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, getBeanValue, getBooleanValue, getBooleanValue, getCharValue, getCharValue, getDoubleValue, getDoubleValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getObjectValue, getPropertyListeners, getShortValue, getStringValue, registerValue, removePropertyListener, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, unregisterValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

public static final String TYPE
See Also:
Constant Field Values

schematicItems

public EntityRegistry schematicItems
set of SchematicItem instance

Constructor Detail

RoomSchematicEntity

public RoomSchematicEntity()
Constructor


RoomSchematicEntity

public RoomSchematicEntity(String id)

RoomSchematicEntity

public RoomSchematicEntity(String id,
                           String name)
Method Detail

addSchematicListener

public void addSchematicListener(PropertyListener listener)
Adds a listener to the container of SchemtaticItems instances

Parameters:
listener -

getType

public String getType()
Description copied from class: Entity
The type of the object (eg "room", "light", "volume", etc). This must be unique to the entity class.

NOTE: it is also a good practice to provide a static field that defines the entity type on the class: eg

 public static final String ENTITY_TYPE = "room";
 

Specified by:
getType in class Entity

add

public boolean add(SchematicItem item)
Adds a SchematicItem instance to the container

Parameters:
item -

find

public SchematicItem find(String entityId)
Finds a SchamaticItem instance based on the id of the represented entity

Parameters:
entityId -

createSchematicItem

public SchematicItem createSchematicItem(Entity entity)
Creates a SchematicItem instance and add's the instance to the internal container

Parameters:
entity -
Returns:
Returns the instance

createSchematicItem

public SchematicItem createSchematicItem(Entity entity,
                                         Point location)
Creates a SchematicItem instance and add's the instance to the internal container

Parameters:
entity -
Returns:
Returns the instance


Copyright © 2008 Commonwealth of Australia