com.eteks.sweethome3d.applet

Class HomeAppletRecorder

java.lang.Object

com.eteks.sweethome3d.applet.HomeAppletRecorder

All Implemented Interfaces:

HomeRecorder

public class HomeAppletRecorder
extends java.lang.Object
implements HomeRecorder

Recorder that stores homes on a HTTP server.

Author:

Emmanuel Puybaret

Nested Class Summary

Nested classes/interfaces inherited from interface com.eteks.sweethome3d.model.HomeRecorder

HomeRecorder.Type

Constructor Summary

Constructors

Constructor and Description
HomeAppletRecorder(java.lang.String writeHomeURL, java.lang.String readHomeURL, java.lang.String listHomesURL) Creates a recorder that will use the URLs in parameter to write, read and list homes.
HomeAppletRecorder(java.lang.String writeHomeURL, java.lang.String readHomeURL, java.lang.String listHomesURL, boolean includeTemporaryContent) Creates a recorder that will use the URLs in parameter to write, read and list homes.
HomeAppletRecorder(java.lang.String writeHomeURL, java.lang.String readHomeURL, java.lang.String listHomesURL, ContentRecording contentRecording) Creates a recorder that will use the URLs in parameter to write, read and list homes.
HomeAppletRecorder(java.lang.String writeHomeURL, java.lang.String readHomeURL, java.lang.String listHomesURL, java.lang.String deleteHomeURL, ContentRecording contentRecording) Creates a recorder that will use the URLs in parameter to write, read, list and delete homes.
HomeAppletRecorder(java.lang.String writeHomeURL, java.lang.String readHomeURL, java.lang.String listHomesURL, java.lang.String deleteHomeURL, ContentRecording contentRecording, HomeXMLHandler xmlHandler, HomeXMLExporter xmlExporter) Creates a recorder that will use the URLs in parameter to write, read, list and delete homes.

Method Summary

Modifier and Type	Method and Description
void	deleteHome(java.lang.String name) Deletes on server a home from its file name.
boolean	exists(java.lang.String name) Returns true if the home name exists.
java.lang.String[]	getAvailableHomes() Returns the available homes on server.
long	getHomeLength(Home home) Returns the length of the home data that will be saved by this recorder.
boolean	isHomeDeletionAvailable() Returns true if this recorder provides a service able to delete homes.
Home	readHome(java.lang.String name) Returns a home instance read from its file name.
void	writeHome(Home home, java.lang.String name) Posts home data to the server URL returned by getHomeSaveURL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HomeAppletRecorder

public HomeAppletRecorder(java.lang.String writeHomeURL,
                          java.lang.String readHomeURL,
                          java.lang.String listHomesURL)

Creates a recorder that will use the URLs in parameter to write, read and list homes. Homes will be saved with Home Java serialized entry.

See Also:

SweetHome3DApplet

HomeAppletRecorder

public HomeAppletRecorder(java.lang.String writeHomeURL,
                          java.lang.String readHomeURL,
                          java.lang.String listHomesURL,
                          boolean includeTemporaryContent)

Creates a recorder that will use the URLs in parameter to write, read and list homes.

See Also:

SweetHome3DApplet

HomeAppletRecorder

public HomeAppletRecorder(java.lang.String writeHomeURL,
                          java.lang.String readHomeURL,
                          java.lang.String listHomesURL,
                          ContentRecording contentRecording)

Creates a recorder that will use the URLs in parameter to write, read and list homes.

See Also:

SweetHome3DApplet

HomeAppletRecorder

public HomeAppletRecorder(java.lang.String writeHomeURL,
                          java.lang.String readHomeURL,
                          java.lang.String listHomesURL,
                          java.lang.String deleteHomeURL,
                          ContentRecording contentRecording)

Creates a recorder that will use the URLs in parameter to write, read, list and delete homes.

See Also:

SweetHome3DApplet

HomeAppletRecorder

public HomeAppletRecorder(java.lang.String writeHomeURL,
                          java.lang.String readHomeURL,
                          java.lang.String listHomesURL,
                          java.lang.String deleteHomeURL,
                          ContentRecording contentRecording,
                          HomeXMLHandler xmlHandler,
                          HomeXMLExporter xmlExporter)

Creates a recorder that will use the URLs in parameter to write, read, list and delete homes. If xmlHandler and xmlExporter are not null, this recorder will write a Home.xml entry rather than a Home Java serialized entry in saveed files.

See Also:

SweetHome3DApplet

Method Detail

writeHome

public void writeHome(Home home,
                      java.lang.String name)
               throws RecorderException

Posts home data to the server URL returned by getHomeSaveURL.

Specified by:

writeHome in interface HomeRecorder

Parameters:

home - the home to write.

name - the name of the resource in which the home will be written.

Throws:

RecorderException - if a problem occurred while writing home.

readHome

public Home readHome(java.lang.String name)
              throws RecorderException

Returns a home instance read from its file name.

Specified by:

readHome in interface HomeRecorder

Parameters:

name - the name of the resource from which the home will be read.

Throws:

RecorderException - if a problem occurred while reading home, or if file name doesn't exist.

exists

public boolean exists(java.lang.String name)
               throws RecorderException

Returns true if the home name exists.

Specified by:

exists in interface HomeRecorder

Parameters:

name - the name of the resource to check

Throws:

RecorderException

getAvailableHomes

public java.lang.String[] getAvailableHomes()
                                     throws RecorderException

Returns the available homes on server.

Throws:

RecorderException

deleteHome

public void deleteHome(java.lang.String name)
                throws RecorderException

Deletes on server a home from its file name.

Throws:

RecorderException - if a problem occurred while deleting home, or if file name doesn't exist.

isHomeDeletionAvailable

public boolean isHomeDeletionAvailable()

Returns true if this recorder provides a service able to delete homes.

getHomeLength

public long getHomeLength(Home home)
                   throws RecorderException

Returns the length of the home data that will be saved by this recorder.

Throws:

RecorderException