org.eclipse.rse.persistence.dom
Interface IRSEDOMExporter

public interface IRSEDOMExporter

Method Summary

RSEDOMNode	createNode(RSEDOMNode parent, IConnectorService cs, boolean clean) Creates a DOM node for a connector service
RSEDOMNode	createNode(RSEDOMNode parent, IHost host, boolean clean) Create a DOM node representing a host
RSEDOMNode	createNode(RSEDOMNode parent, IServerLauncherProperties sl, boolean clean) Creates a DOM node for a server launcher
RSEDOMNode	createNode(RSEDOMNode parent, ISubSystem ss, boolean clean) Creates a DOM node for a subsystem
RSEDOMNode	createNode(RSEDOMNode parent, ISystemFilter filter, boolean clean) Creates a DOM node for a filter
RSEDOMNode	createNode(RSEDOMNode parent, ISystemFilterPool fp, boolean clean) Create a DOM node representing a filter pool
RSEDOMNode	createNode(RSEDOMNode parent, ISystemFilterPoolReference fpr, boolean clean) Creates a DOM node for a filter pool reference
RSEDOMNode	createNode(RSEDOMNode parent, ISystemFilterString fs, boolean clean) Creates a DOM node for a filter string
RSEDOMNode[]	createPropertySetNodes(RSEDOMNode parent, IRSEModelObject mo, boolean clean) Creates DOM nodes for each associated property set of a model object
RSEDOM	createRSEDOM(ISystemProfile profile, boolean clean) Creates the RSE DOM for this profile
RSEDOM	getRSEDOM(ISystemProfile profile) Returns the RSEDOM for this profile iff it exists
RSEDOM	populateRSEDOM(RSEDOM dom, ISystemProfile profile, boolean clean) Creates an RSE DOM for use in persistence

Method Detail

createRSEDOM

public RSEDOM createRSEDOM(ISystemProfile profile,
                           boolean clean)

Creates the RSE DOM for this profile

Parameters:

profile -

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

the created DOM

populateRSEDOM

public RSEDOM populateRSEDOM(RSEDOM dom,
                             ISystemProfile profile,
                             boolean clean)

Creates an RSE DOM for use in persistence

Parameters:

dom -

profile -

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

the created DOM

getRSEDOM

public RSEDOM getRSEDOM(ISystemProfile profile)

Returns the RSEDOM for this profile iff it exists

Parameters:

profile -

Returns:

The DOM retrieved from the profile

createNode

public RSEDOMNode createNode(RSEDOMNode parent,
                             IHost host,
                             boolean clean)

Create a DOM node representing a host

Parameters:

parent - the parent of this node, must be node for an ISystemProfile

host - the host from which to create this node

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

The DOM node for the IHost

createNode

public RSEDOMNode createNode(RSEDOMNode parent,
                             IConnectorService cs,
                             boolean clean)

Creates a DOM node for a connector service

Parameters:

parent - the parent of this node, must be node for an IHost

cs - the connector service from which to create a node

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

The DOM node for the IConnectorService

createNode

public RSEDOMNode createNode(RSEDOMNode parent,
                             IServerLauncherProperties sl,
                             boolean clean)

Creates a DOM node for a server launcher

Parameters:

parent - the parent of this node, must be a node for an IConnectorService

sl - the server launcher properties from which to create a node

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

the DOM node for the IServerLauncherProperties

createNode

public RSEDOMNode createNode(RSEDOMNode parent,
                             ISubSystem ss,
                             boolean clean)

Creates a DOM node for a subsystem

Parameters:

parent - the parent of this node, must be a node for an IConnectorService

ss - the subsystem from which to create a node

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

The DOM node for the ISubSystem

createNode

public RSEDOMNode createNode(RSEDOMNode parent,
                             ISystemFilter filter,
                             boolean clean)

Creates a DOM node for a filter

Parameters:

parent - the parent DOM node for this new node, must be a node for an ISystemFilterPool

filter - the filter from which to create the node

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

The DOM node for the filter

createNode

public RSEDOMNode createNode(RSEDOMNode parent,
                             ISystemFilterPool fp,
                             boolean clean)

Create a DOM node representing a filter pool

Parameters:

parent - the parent DOM node for this new node, must be a node for an ISystemProfile

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

The DOM node for the filter pool

createNode

public RSEDOMNode createNode(RSEDOMNode parent,
                             ISystemFilterPoolReference fpr,
                             boolean clean)

Creates a DOM node for a filter pool reference

Parameters:

parent - the parent DOM node for this new node, must be a node for an ISubSystem

fpr - the filter pool reference from which to create the node

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

The DOM node for this filter pool reference

createNode

public RSEDOMNode createNode(RSEDOMNode parent,
                             ISystemFilterString fs,
                             boolean clean)

Creates a DOM node for a filter string

Parameters:

parent - the parent DOM node for this new node, must be node for an ISystemFilter

fs - the filter string from which to create the node

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

the DOM node for this filter string

createPropertySetNodes

public RSEDOMNode[] createPropertySetNodes(RSEDOMNode parent,
                                           IRSEModelObject mo,
                                           boolean clean)

Creates DOM nodes for each associated property set of a model object

Parameters:

parent - the parent DOM node for these new nodes, can be DOM node for any RSE model object

mo - the model object

clean - true if the node should being created from scratch, false if the an existing node should be found and merged

Returns:

an array of DOM nodes for the property sets of an RSE model object