Package de.mid.innovator.m2msdk.model.configuration

Class ConfigurationModel

java.lang.Object

de.mid.innovator.m2msdk.model.configuration.ConfigurationModel

All Implemented Interfaces:

ConfigurationInterface, Serializable, Remote

public class ConfigurationModel
extends Object
implements ConfigurationInterface

This class implements the ModelTransformationConfiguratonInterface. Thus it is responsible for initializing a tree of ConfigurationItems based on a XML configuration.

Version:

10.1.1

Author:

Fabian Knoll fabian.knoll@koelsch-altmann.de

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConfigurationModel(SessionInterface iSession)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addItem(ConfigurationItemIF item)	Add the configuration item to the model.
void	addOrRemoveCustomer(boolean bCustomerMode)	Remove or add the customer items depending on the value of the customer mode parameter.
ConfigurationItemIF	createConfigurationItem(ConfigurationItemIF iParent, org.jdom2.Element xmlElement, boolean bCustomer, boolean bCheckOnly)	Create a configuration item from an XML element in this model.
org.jdom2.Document	getDocument(ConfigurationTag tag)	Get content of configuration as a document.
ConfigurationItemIF	getInsert(ConfigurationItemIF inserted, boolean bCreate, boolean bCheckOnly)	Get insert for an inserted item.
ConfigurationItemIF	getItem(String id)	Get the configuration item defined with the given id.
ConfigurationItems	getItems(String id)	Get the configuration items using the given id.
ConfigurationItemIF	getModification(ConfigurationItemIF original, boolean bCreate, boolean bCheckOnly)	Get modified item of an original item.
ConfigurationItemIF	getRoot(ConfigurationTag tag)	Get the root of the configuration.
boolean	hasChanged(ConfigurationTag tag)	Has model transformation configuration content changed since last save or load?
void	initialize(org.jdom2.Document configuration, org.jdom2.Document workflow, org.jdom2.Document templates, org.jdom2.Document customer, boolean bExpand)	Initialize the model configuration based on given documents.
void	removeItem(ConfigurationItemIF iItem)	Remove the configuration item from the model.
void	setContentChanged(ConfigurationTag tag)	The content of the model has changed.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationModel

public ConfigurationModel(SessionInterface iSession)

Constructor

Method Details

initialize

public void initialize(org.jdom2.Document configuration,
 org.jdom2.Document workflow,
 org.jdom2.Document templates,
 org.jdom2.Document customer,
 boolean bExpand)
                throws M2MException,
RemoteException

Description copied from interface: ConfigurationInterface

Initialize the model configuration based on given documents.

Specified by:

initialize in interface ConfigurationInterface

Parameters:

configuration - document containing the model transformation configuration

workflow - document containing the workflow configuration

templates - document containing the templates

customer - document containing the customer modifications and inserts

bExpand - expand the model so that all references are instantiated

Throws:

M2MException

RemoteException

getRoot

public ConfigurationItemIF getRoot(ConfigurationTag tag)
                            throws M2MException,
RemoteException

Description copied from interface: ConfigurationInterface

Get the root of the configuration.

Specified by:

getRoot in interface ConfigurationInterface

Parameters:

tag - tag may either be model transformation or customer or workflow or templates.

Returns:

The root ConfigurationItem of a tree of ConfigurationItems.

Throws:

M2MException

RemoteException

createConfigurationItem

public ConfigurationItemIF createConfigurationItem(ConfigurationItemIF iParent,
 org.jdom2.Element xmlElement,
 boolean bCustomer,
 boolean bCheckOnly)
                                            throws RemoteException,
M2MException

Description copied from interface: ConfigurationInterface

Create a configuration item from an XML element in this model. And put it beneath the parent.

Specified by:

createConfigurationItem in interface ConfigurationInterface

Parameters:

iParent - parent of new item,maybe null for a root

xmlElement - XML element describing a configuration item

bCustomer - import it from customer

bCheckOnly - only check it and do not add to model

Returns:

configuration item

Throws:

RemoteException

M2MException

getDocument

public org.jdom2.Document getDocument(ConfigurationTag tag)
                               throws RemoteException,
M2MException

Description copied from interface: ConfigurationInterface

Get content of configuration as a document. Important side effect: The configuration model is marked as unchanged because it is assumed that the reading into a document is used to save the model.

Specified by:

getDocument in interface ConfigurationInterface

Parameters:

tag - tag of root specifies the configuration which is exported ModelTransformation exports model transformation configuration Customer exports customer modifications Workflow exports workflow configuration Templates exports templates

Returns:

XML document containing the content of the model transformation configuration

Throws:

RemoteException

M2MException

hasChanged

public boolean hasChanged(ConfigurationTag tag)
                   throws M2MException,
RemoteException

Description copied from interface: ConfigurationInterface

Has model transformation configuration content changed since last save or load?

Specified by:

hasChanged in interface ConfigurationInterface

Parameters:

tag - tag of root specifies the configuration which is exported ModelTransformation exports model transformation configuration Customer exports customer modifications Workflow exports workflow configuration Templates exports templates

Returns:

true, if the content of the model has changed.

Throws:

M2MException

RemoteException

setContentChanged

public void setContentChanged(ConfigurationTag tag)

Description copied from interface: ConfigurationInterface

The content of the model has changed.

Specified by:

setContentChanged in interface ConfigurationInterface

Parameters:

tag - tag of root specifies the configuration which is exported ModelTransformation exports model transformation configuration Customer exports customer modifications Workflow exports workflow configuration

getItem

public ConfigurationItemIF getItem(String id)

Description copied from interface: ConfigurationInterface

Get the configuration item defined with the given id.

Specified by:

getItem in interface ConfigurationInterface

Parameters:

id - qualified id or string containing a qualified id in double quotes

Returns:

null if no item has this id

getItems

public ConfigurationItems getItems(String id)
                            throws RemoteException,
M2MException

Description copied from interface: ConfigurationInterface

Get the configuration items using the given id. Use means it is within the value of a parameter.

Specified by:

getItems in interface ConfigurationInterface

Parameters:

id - qualified id

Returns:

null if no item uses this id, else the parameter using it directly or within a string and double quotes

Throws:

RemoteException

M2MException

addItem

public void addItem(ConfigurationItemIF item)
             throws RemoteException,
M2MException

Description copied from interface: ConfigurationInterface

Add the configuration item to the model.

Specified by:

addItem in interface ConfigurationInterface

Parameters:

item - configuration item to add

Throws:

RemoteException

M2MException

getModification

public ConfigurationItemIF getModification(ConfigurationItemIF original,
 boolean bCreate,
 boolean bCheckOnly)
                                    throws RemoteException,
M2MException

Description copied from interface: ConfigurationInterface

Get modified item of an original item. Only available if running in customer mode.

Specified by:

getModification in interface ConfigurationInterface

Parameters:

original - original configuration item

bCreate - true to create a new modification if there is not yet a modification defined. This only works in customer mode.

bCheckOnly - Only check if this is possible

Returns:

null, if there is no modification or no customer mode

Throws:

RemoteException

M2MException

getInsert

public ConfigurationItemIF getInsert(ConfigurationItemIF inserted,
 boolean bCreate,
 boolean bCheckOnly)
                              throws RemoteException,
M2MException

Description copied from interface: ConfigurationInterface

Get insert for an inserted item.

Specified by:

getInsert in interface ConfigurationInterface

Parameters:

inserted - inserted item

bCreate - true to create a new insert

bCheckOnly - Only check if this is possible

Returns:

insertion which defines the insertion of the inserted item

Throws:

RemoteException

M2MException

removeItem

public void removeItem(ConfigurationItemIF iItem)
                throws RemoteException,
M2MException

Description copied from interface: ConfigurationInterface

Remove the configuration item from the model.

Specified by:

removeItem in interface ConfigurationInterface

Parameters:

iItem - configuration item to remove

Throws:

RemoteException

M2MException

addOrRemoveCustomer

public void addOrRemoveCustomer(boolean bCustomerMode)
                         throws RemoteException,
M2MException

Description copied from interface: ConfigurationInterface

Remove or add the customer items depending on the value of the customer mode parameter.

Specified by:

addOrRemoveCustomer in interface ConfigurationInterface

Parameters:

bCustomerMode - true means add false means remove

Throws:

RemoteException

M2MException