Package de.mid.innovator.m2msdk.model.progress

Class ProgressModelStub

java.lang.Object

de.mid.innovator.m2msdk.model.progress.ProgressModelStub

All Implemented Interfaces:

ProgressModelInterface, Serializable, Remote

public class ProgressModelStub
extends Object
implements ProgressModelInterface

Stub class living on client side and always forwarding the calls to the server.

Version:

11.3.1

Author:

jmback

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProgressModelStub(ProgressModelInterface iProgress)

Method Summary

Modifier and Type	Method	Description
void	elementAdvance()	Advance the element counter
ConfigurationItemIF	getCurrentConfigurationItem()	Get the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.
ProgressInfo	getCurrentElement()	gets the current processed model element.
org.jdom2.Document	getDocument()	Get content of progress model as a document.
ProgressStep	getModelElement()	Get number of model elements treated in the current progress step and number of current model element.
ProgressStep	getStep()	Get the number of progress steps to be executed and number of current progress step.
boolean	isClientWaiting()	The progress model is waiting for new information from engine.
boolean	isStarted()	Has the progress model already started? Only for a started progress model a progress dialog is shown.
void	reset()	Resets the ProgressModel.
void	setClientWaiting(boolean waiting)	Tell the progress model, whether the progress client is waiting on new information from server engine.
void	setCurrentConfigurationItem(ConfigurationItemIF iItem)	Set the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.
void	setCurrentElement(ProgressInfo iInfo)	Set the current element.
void	setNumModelElements(int numModelElements)	Set number of model elements treated in the current progress step.
void	setNumSteps(int numSteps)	Set number of model transformation steps to be executed.
void	setStarted(boolean started)	Set to true, if the progress model already has started.
void	stepAdvance()	Advance the step counter
void	stepInto()	Continue processing until the next of the son type.
void	stepOut()	Continue processing until the next of the parent type.
void	stepOver()	Continue processing until the next of the same type.

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressModelStub

public ProgressModelStub(ProgressModelInterface iProgress)

Method Details

setCurrentElement

public void setCurrentElement(ProgressInfo iInfo)
                       throws M2MException

Description copied from interface: ProgressModelInterface

Set the current element.

Specified by:

setCurrentElement in interface ProgressModelInterface

Parameters:

iInfo - Next element

Throws:

M2MException

getCurrentElement

public ProgressInfo getCurrentElement()
                               throws M2MException,
RemoteException

Description copied from interface: ProgressModelInterface

gets the current processed model element.

Specified by:

getCurrentElement in interface ProgressModelInterface

Returns:

currently processed element

Throws:

M2MException

RemoteException

getModelElement

public ProgressStep getModelElement()
                             throws RemoteException

Description copied from interface: ProgressModelInterface

Get number of model elements treated in the current progress step and number of current model element.

Specified by:

getModelElement in interface ProgressModelInterface

Returns:

relative number of model elements

Throws:

RemoteException - communication error

getStep

public ProgressStep getStep()
                     throws RemoteException

Description copied from interface: ProgressModelInterface

Get the number of progress steps to be executed and number of current progress step.

Specified by:

getStep in interface ProgressModelInterface

Returns:

relative number of steps

Throws:

RemoteException - communication error

isStarted

public boolean isStarted()
                  throws RemoteException

Description copied from interface: ProgressModelInterface

Has the progress model already started? Only for a started progress model a progress dialog is shown.

Specified by:

isStarted in interface ProgressModelInterface

Returns:

True if progress model has started

Throws:

RemoteException - communication error

reset

public void reset()
           throws RemoteException

Description copied from interface: ProgressModelInterface

Resets the ProgressModel.

Specified by:

reset in interface ProgressModelInterface

Throws:

RemoteException - communication error

setNumModelElements

public void setNumModelElements(int numModelElements)
                         throws RemoteException

Description copied from interface: ProgressModelInterface

Set number of model elements treated in the current progress step.

Specified by:

setNumModelElements in interface ProgressModelInterface

Parameters:

numModelElements - Number of model elements

Throws:

RemoteException - communication error

setNumSteps

public void setNumSteps(int numSteps)
                 throws RemoteException

Description copied from interface: ProgressModelInterface

Set number of model transformation steps to be executed.

Specified by:

setNumSteps in interface ProgressModelInterface

Parameters:

numSteps - Number of steps

Throws:

RemoteException - communication error

setStarted

public void setStarted(boolean started)
                throws RemoteException

Description copied from interface: ProgressModelInterface

Set to true, if the progress model already has started.

Specified by:

setStarted in interface ProgressModelInterface

Parameters:

started - True if progress model has started

Throws:

RemoteException - communication error

stepInto

public void stepInto()
              throws RemoteException

Description copied from interface: ProgressModelInterface

Continue processing until the next of the son type.

Specified by:

stepInto in interface ProgressModelInterface

Throws:

RemoteException - communication error

stepOut

public void stepOut()
             throws RemoteException

Description copied from interface: ProgressModelInterface

Continue processing until the next of the parent type.

Specified by:

stepOut in interface ProgressModelInterface

Throws:

RemoteException - communication error

stepOver

public void stepOver()
              throws RemoteException

Description copied from interface: ProgressModelInterface

Continue processing until the next of the same type.

Specified by:

stepOver in interface ProgressModelInterface

Throws:

RemoteException - communication error

getCurrentConfigurationItem

public ConfigurationItemIF getCurrentConfigurationItem()
                                                throws M2MException,
RemoteException

Description copied from interface: ProgressModelInterface

Get the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.

Specified by:

getCurrentConfigurationItem in interface ProgressModelInterface

Returns:

underlying configuration item

Throws:

M2MException

RemoteException

setCurrentConfigurationItem

public void setCurrentConfigurationItem(ConfigurationItemIF iItem)
                                 throws M2MException,
RemoteException

Description copied from interface: ProgressModelInterface

Set the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.

Specified by:

setCurrentConfigurationItem in interface ProgressModelInterface

Parameters:

iItem - underlying configuration item

Throws:

M2MException

RemoteException

isClientWaiting

public boolean isClientWaiting()
                        throws M2MException,
RemoteException

Description copied from interface: ProgressModelInterface

The progress model is waiting for new information from engine. This is for synchronization of progress client and server engine.

Specified by:

isClientWaiting in interface ProgressModelInterface

Returns:

true, if the progress client is waiting for new information.

Throws:

M2MException

RemoteException

setClientWaiting

public void setClientWaiting(boolean waiting)
                      throws M2MException,
RemoteException

Description copied from interface: ProgressModelInterface

Tell the progress model, whether the progress client is waiting on new information from server engine. This is for synchronization of progress client and server engine.

Specified by:

setClientWaiting in interface ProgressModelInterface

Parameters:

waiting - true, if the progress client is waiting for new information.

Throws:

M2MException

RemoteException

getDocument

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

Description copied from interface: ProgressModelInterface

Get content of progress model as a document.

Specified by:

getDocument in interface ProgressModelInterface

Returns:

XML document containing the content of the progress model

Throws:

M2MException

RemoteException

stepAdvance

public void stepAdvance()

Description copied from interface: ProgressModelInterface

Advance the step counter

Specified by:

stepAdvance in interface ProgressModelInterface

elementAdvance

public void elementAdvance()

Description copied from interface: ProgressModelInterface

Advance the element counter

Specified by:

elementAdvance in interface ProgressModelInterface