org.writersforge.catalan.process.workspace
Class XmlWorkspace

java.lang.Object
  org.writersforge.catalan.process.workspace.BaseWorkspace
      org.writersforge.catalan.process.workspace.XmlWorkspace

All Implemented Interfaces:

IPropertyHolder, IWorkspace

public class XmlWorkspace

extends BaseWorkspace

IWorkspace backed by an XML document.

Author:

jsheets

Constructor Summary

XmlWorkspace(org.writersforge.bellows.Datum xml)
Creates a new instance of XmlWorkspace from the given XML document.

XmlWorkspace(java.lang.String workspaceXmlPath)
Creates a new instance of XmlWorkspace using a path to the XML document.

Method Summary

QueueManager	getDataQueues() Retrieves the QueueManager responsible for all queues.
IWorkProperties	getProperties() Retrieves the container for all properties currently set in the workspace.
WorkerRegistry	getWorkerRegistry() Retrieves the WorkerRegistry for this IWorkspace.

Methods inherited from class org.writersforge.catalan.process.workspace.BaseWorkspace

getAlertQueue

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlWorkspace

public XmlWorkspace(java.lang.String workspaceXmlPath)
             throws WorkspaceException

Creates a new instance of XmlWorkspace using a path to the XML document.

Parameters:

workspaceXmlPath - path to XML workspace in classpath

Throws:

WorkspaceException - if unable to find or load workspace from XML

XmlWorkspace

public XmlWorkspace(org.writersforge.bellows.Datum xml)

Creates a new instance of XmlWorkspace from the given XML document.

Parameters:

xml - workspace info in XML form

Method Detail

getProperties

public IWorkProperties getProperties()

Retrieves the container for all properties currently set in the workspace.

Returns:

all workspace properties

getDataQueues

public QueueManager getDataQueues()

Retrieves the QueueManager responsible for all queues.

Returns:

queue manager

getWorkerRegistry

public WorkerRegistry getWorkerRegistry()

Retrieves the WorkerRegistry for this IWorkspace. This registry can be used to find worker implementations by name.

Returns:

worker registry