org.jdesktop.wonderland.server.wfs.exporter
Class CellExporterUtils

java.lang.Object
  extended by org.jdesktop.wonderland.server.wfs.exporter.CellExporterUtils

public class CellExporterUtils
extends java.lang.Object

The CellExporter contains a collection of static utility methods to export WFS information from the WFS web service.

Author:
Jordan Slott , Bernard Horan

Constructor Summary
CellExporterUtils()
           
 
Method Summary
static void createCell(CellDescriptor descriptor)
          Creates a cell on disk given the description of the cell, which includes the root of the wfs, the path of the parent, the child name, and the cell's setup information
static WorldRoot createRecording(java.lang.String name)
          Creates a new recording, returns a WorldRoot object representing the new WFS or null upon failure
static WorldRoot createSnapshot(java.lang.String name)
          Creates a new snapshot, returns a WorldRoot object representing the new WFS or null upon failure
static CellDescriptor getCellDescriptor(WorldRoot worldRoot, CellPath parentPath, CellMO cellMO, boolean recordCellIDs)
          Get a cell descriptor for the given cell.
static java.net.URL getWebServerURL()
          Returns the base URL of the web server.
static WFSRecordingList getWFSRecordings()
          Returns all of the WFS recording names or null upon error
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CellExporterUtils

public CellExporterUtils()
Method Detail

createSnapshot

public static WorldRoot createSnapshot(java.lang.String name)
                                throws java.io.IOException,
                                       javax.xml.bind.JAXBException
Creates a new snapshot, returns a WorldRoot object representing the new WFS or null upon failure

Parameters:
name - the name of the snapshot to create, or null to use the default name
Throws:
java.io.IOException
javax.xml.bind.JAXBException

createRecording

public static WorldRoot createRecording(java.lang.String name)
                                 throws java.io.IOException,
                                        javax.xml.bind.JAXBException
Creates a new recording, returns a WorldRoot object representing the new WFS or null upon failure

Parameters:
name - the name of the recording to create, or null to use the default name
Throws:
java.io.IOException
javax.xml.bind.JAXBException

getCellDescriptor

public static CellDescriptor getCellDescriptor(WorldRoot worldRoot,
                                               CellPath parentPath,
                                               CellMO cellMO,
                                               boolean recordCellIDs)
                                        throws java.io.IOException,
                                               javax.xml.bind.JAXBException
Get a cell descriptor for the given cell.

Parameters:
worldRoot - the root this cell will be written to
parentPath - the path of the parent cell
cellMO - the cell to get a descriptor for
recordCellIDs - if true, record the cellID of the cell
Throws:
java.io.IOException
javax.xml.bind.JAXBException

createCell

public static void createCell(CellDescriptor descriptor)
                       throws java.io.IOException,
                              javax.xml.bind.JAXBException
Creates a cell on disk given the description of the cell, which includes the root of the wfs, the path of the parent, the child name, and the cell's setup information

Throws:
java.io.IOException
javax.xml.bind.JAXBException

getWFSRecordings

public static WFSRecordingList getWFSRecordings()
                                         throws java.io.IOException,
                                                javax.xml.bind.JAXBException
Returns all of the WFS recording names or null upon error

Returns:
a list of names of recordings
Throws:
java.io.IOException
javax.xml.bind.JAXBException

getWebServerURL

public static java.net.URL getWebServerURL()
                                    throws java.net.MalformedURLException
Returns the base URL of the web server.

Throws:
java.net.MalformedURLException


Open Wonderland - http://openwonderland.org