org.simbrain.workspace

Class ArchiveContents

java.lang.Object

org.simbrain.workspace.ArchiveContents

class ArchiveContents
extends java.lang.Object

Instances of this class are used for building and reading the TOC of an archive.

This is the class that XStream serializes.

Author:

Matt Watson, Jeff Yoshimi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArchiveContents.ArchivedAttribute The class used to represent an attribute in the archive.
(package private) static class	ArchiveContents.ArchivedComponent Represents the data used to store components in the archive.
(package private) static class	ArchiveContents.ArchivedCoupling Class used to represent a coupling in the archive.
(package private) static class	ArchiveContents.ArchivedUpdateAction A persistable form of update action that can be used to recreate the action.

Constructor Summary

Constructors

Constructor and Description
ArchiveContents(Workspace workspace, WorkspaceComponentSerializer serializer) The component serializer for this archive.

Method Summary

Modifier and Type	Method and Description
(package private) ArchiveContents.ArchivedComponent	addComponent(WorkspaceComponent workspaceComponent) Adds a new workspace Component to the archive.
(package private) ArchiveContents.ArchivedCoupling	addCoupling(Coupling<?> coupling) Adds a coupling to the archive.
(package private) void	addUpdateAction(UpdateAction action) Adds an update action the archive.
(package private) UpdateAction	createUpdateAction(Workspace workspace, WorkspaceComponentDeserializer componentDeserializer, ArchiveContents.ArchivedUpdateAction archivedAction) Create a "real" update action from an archived update action.
java.util.List<ArchiveContents.ArchivedUpdateAction>	getArchivedActions()
(package private) ArchiveContents.ArchivedComponent	getArchivedComponent(java.lang.String uri) Returns the component associated with the uri.
(package private) java.util.List<? extends ArchiveContents.ArchivedComponent>	getArchivedComponents() Returns an immutable list of the components in this archive.
(package private) java.util.List<? extends ArchiveContents.ArchivedCoupling>	getArchivedCouplings() Returns an immutable list of the couplings in this archive.
Workspace	getWorkspaceParameters()
(package private) void	toXml(java.io.OutputStream stream) Writes this instance to XML.
(package private) static com.thoughtworks.xstream.XStream	xstream() Returns the XStream instance used to serialize and deserialize instances of this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveContents

ArchiveContents(Workspace workspace,
                WorkspaceComponentSerializer serializer)

The component serializer for this archive.

Parameters:

workspace - references to parent workspace

serializer - The component serializer for this archive.

Method Detail

addComponent

ArchiveContents.ArchivedComponent addComponent(WorkspaceComponent workspaceComponent)

Adds a new workspace Component to the archive.

Parameters:

workspaceComponent - The workspace component to add.

Returns:

The component created for this WorkspaceComponent.

addUpdateAction

void addUpdateAction(UpdateAction action)

Adds an update action the archive.

Parameters:

action - the action to archive.

getArchivedComponents

java.util.List<? extends ArchiveContents.ArchivedComponent> getArchivedComponents()

Returns an immutable list of the components in this archive.

Returns:

An immutable list of the components in this archive.

getArchivedCouplings

java.util.List<? extends ArchiveContents.ArchivedCoupling> getArchivedCouplings()

Returns an immutable list of the couplings in this archive.

Returns:

An immutable list of the couplings in this archive.

getArchivedComponent

ArchiveContents.ArchivedComponent getArchivedComponent(java.lang.String uri)

Returns the component associated with the uri.

Parameters:

uri - The uri for the component.

Returns:

The component associated with the uri.

createUpdateAction

UpdateAction createUpdateAction(Workspace workspace,
                                WorkspaceComponentDeserializer componentDeserializer,
                                ArchiveContents.ArchivedUpdateAction archivedAction)

Create a "real" update action from an archived update action.

Parameters:

workspace - parent workspace in which to place the new action

componentDeserializer - used to get the workspace component corresponding to a workspace component id

archivedAction - the archived action to convert into a real action

Returns:

the "real" update action

addCoupling

ArchiveContents.ArchivedCoupling addCoupling(Coupling<?> coupling)

Adds a coupling to the archive.

Parameters:

coupling - The coupling to add.

Returns:

The coupling entry in the archive.

toXml

void toXml(java.io.OutputStream stream)

Writes this instance to XML.

Parameters:

stream - The stream to write to.

xstream

static com.thoughtworks.xstream.XStream xstream()

Returns the XStream instance used to serialize and deserialize instances of this class.

Returns:

An XStream instance.

getWorkspaceParameters

public Workspace getWorkspaceParameters()

Returns:

the workspaceParameters

getArchivedActions

public java.util.List<ArchiveContents.ArchivedUpdateAction> getArchivedActions()

Returns:

the archivedActions