org.jdesktop.wonderland.server.cell
Class CellComponentMO

java.lang.Object
  extended by org.jdesktop.wonderland.server.cell.CellComponentMO
All Implemented Interfaces:
com.sun.sgs.app.ManagedObject, java.io.Serializable
Direct Known Subclasses:
CellPhysicsPropertiesComponentMO, ChannelComponentMO, InteractionComponentMO, ModelCellComponentMO, MovableComponentMO, ProximityComponentMO

public abstract class CellComponentMO
extends java.lang.Object
implements com.sun.sgs.app.ManagedObject, java.io.Serializable

Author:
paulby
See Also:
Serialized Form

Field Summary
protected  CellID cellID
           
protected  com.sun.sgs.app.ManagedReference<CellMO> cellRef
           
 
Constructor Summary
CellComponentMO(CellMO cell)
           
 
Method Summary
protected abstract  java.lang.String getClientClass()
          If this component has a client side component then return the fully qualified name of the client class.
 CellComponentClientState getClientState(CellComponentClientState state, WonderlandClientID clientID, ClientCapabilities capabilities)
          Returns the client-side state of the cell component .
 CellComponentServerState getServerState(CellComponentServerState state)
          Returns the server state information currently configured in the component.
 boolean isLive()
          Returns true if the component is live, false if not.
protected  void setLive(boolean live)
           
 void setServerState(CellComponentServerState state)
          Sets the server state for the cell component
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cellRef

protected com.sun.sgs.app.ManagedReference<CellMO> cellRef

cellID

protected CellID cellID
Constructor Detail

CellComponentMO

public CellComponentMO(CellMO cell)
Method Detail

setLive

protected void setLive(boolean live)

isLive

public boolean isLive()
Returns true if the component is live, false if not.

Returns:
True if the component is live

setServerState

public void setServerState(CellComponentServerState state)
Sets the server state for the cell component

Parameters:
state - the properties to setup with

getServerState

public CellComponentServerState getServerState(CellComponentServerState state)
Returns the server state information currently configured in the component. If the state argument is non-null, fill in that object and return it. If the state argument is null, create a new state object.

Parameters:
state - The state object, if null, creates one.
Returns:
The current server state information

getClientState

public CellComponentClientState getClientState(CellComponentClientState state,
                                               WonderlandClientID clientID,
                                               ClientCapabilities capabilities)
Returns the client-side state of the cell component . If the state argument is null, then the method should create an appropriate class, otherwise, the method should just fill in details in the class. Returns the client- side state class

Parameters:
state - If null, create a new object
clientID - The unique ID of the client
capabilities - The client capabilities

getClientClass

protected abstract java.lang.String getClientClass()
If this component has a client side component then return the fully qualified name of the client class. If there is no client portion to this component, return null.

Returns:


Open Wonderland - http://openwonderland.org