org.jdesktop.wonderland.common.wfs
Class CellDescriptor

java.lang.Object
  extended by org.jdesktop.wonderland.common.wfs.CellDescriptor
Direct Known Subclasses:
CellExportDescriptor

public class CellDescriptor
extends java.lang.Object

Describes a cell within a wfs, including the root path of the wfs, the path of the parent, the name of the cell, and the XML setup information

Author:
Jordan Slott

Constructor Summary
CellDescriptor()
          Default constructor
CellDescriptor(WorldRoot worldRoot, CellPath cellParent, java.lang.String cellID, java.lang.String cellName, java.lang.String setupInfo)
          Constructor, takes all of the class attributes
 
Method Summary
static CellDescriptor decode(java.io.Reader r)
          Takes a reader for the XML stream and returns an instance of this class
 void encode(java.io.Writer w)
          Writes the XML representation of this class to a writer.
 java.lang.String getCellID()
           
 java.lang.String getCellName()
           
 java.lang.String getCellUniqueName()
          The unique name is a combination of the cell's name and its CellID.
 CellPath getParentPath()
           
 WorldRoot getRootPath()
           
 java.lang.String getSetupInfo()
           
 void setCellID(java.lang.String cellID)
           
 void setCellName(java.lang.String cellName)
           
 void setParentPath(CellPath cellParent)
           
 void setRootPath(WorldRoot worldRoot)
           
 void setSetupInfo(java.lang.String setupInfo)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CellDescriptor

public CellDescriptor()
Default constructor


CellDescriptor

public CellDescriptor(WorldRoot worldRoot,
                      CellPath cellParent,
                      java.lang.String cellID,
                      java.lang.String cellName,
                      java.lang.String setupInfo)
Constructor, takes all of the class attributes

Method Detail

getCellID

public java.lang.String getCellID()

setCellID

public void setCellID(java.lang.String cellID)

getCellName

public java.lang.String getCellName()

setCellName

public void setCellName(java.lang.String cellName)

getCellUniqueName

public java.lang.String getCellUniqueName()
The unique name is a combination of the cell's name and its CellID. These unique names are used to store the cell, and in places like the parent path.


getParentPath

public CellPath getParentPath()

setParentPath

public void setParentPath(CellPath cellParent)

getRootPath

public WorldRoot getRootPath()

setRootPath

public void setRootPath(WorldRoot worldRoot)

getSetupInfo

public java.lang.String getSetupInfo()

setSetupInfo

public void setSetupInfo(java.lang.String setupInfo)

decode

public static CellDescriptor decode(java.io.Reader r)
                             throws javax.xml.bind.JAXBException
Takes a reader for the XML stream and returns an instance of this class

Parameters:
r - The reader of the XML stream
Throws:
javax.xml.bind.JAXBException

encode

public void encode(java.io.Writer w)
            throws javax.xml.bind.JAXBException
Writes the XML representation of this class to a writer.

Parameters:
w - The output writer to write to
Throws:
javax.xml.bind.JAXBException


Open Wonderland - http://openwonderland.org