com.whitestein.lsps.vaadin

Class LspsContextHolder

java.lang.Object

com.whitestein.lsps.vaadin.LspsContextHolder

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractDocumentHolder, AbstractTodoHolder, FormPreviewContextHolder

public abstract class LspsContextHolder
extends Object
implements Serializable

Base class for beans that encapsulate LSPS context and the associated component tree. It holds and provides various contextual information for the view and form components such as opened document/todo, current execution context, model instance, etc.

The API allows the hosting application to send messages to the LSPS forms (reloadContent(), reactivate(), ...). On the other hand it provides services for the various LSPS form components such as access to the ExecutionContext, LspsScreen or garbage collection of unused objects in model instance.

Author:

mbj, mhi

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelInstanceUtilsService	modelInstanceUtilsService Instance of ModelInstanceUtilsService.
protected ModelProviderClientService	modelProviderService Instance of ModelProviderService to be used by subclasses
protected SharedRecordTypeFactory	sharedRecordTypeFactory Instance of SharedRecordTypeFactory to be used by subclasses

Constructor Summary

Constructors

Constructor and Description
LspsContextHolder(LspsAppConnector appConnector, LspsFormConnector formConnector, String userId) Full constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	addSaveMetadataToUploadedBinaryData(BinaryDataServiceLocal binaryDataService, List<Long> uploadedBinaryData) Adds metadata to the binary data uploaded in this holder.
void	collectGarbage() Collects garbage in the used model instance.
protected abstract ExecutionContext	createEvaluationContext() Creates the evaluation context.
abstract RecordHolder	createSavedStateHolder() Returns a representation of the saved state in the model.
protected abstract LspsScreen	createScreen() Creates the user interface.
void	deactivate() Should be called when the content is hidden.
LspsAppConnector	getAppConnector() Returns the application connector.
ExecutionContext	getExecutionContext() Returns the associated evaluation execution context.
ExecutionContext	getExecutionContext(String evaluationLevel) Returns an execution context in the given evaluation level.
LspsFormConnector	getFormConnector() Returns the form connector.
Handle	getHandle(ValueHolder valueHolder) Returns handle for the given value holder.
ModelInstance	getModelInstance() Returns the model instance over which the evaluation context operates.
LspsScreen	getScreen() Returns current screen or null if no screen is active.
abstract Variant.ClosureVariant	getSubmitNavigationDefinition() Gets the navigation definition from the document/todo definition.
abstract String	getTitle() Returns the title for the form content.
ValueHolder	getValueHolder(Handle handle) Returns value holder for the given handle.
<T extends ValueHolder> T	getValueHolderInLevel(T valueHolder, String evaluationLevel) Returns the value holder in the given evaluation level.
void	invalidate() Marks the context as invalid and calls LspsScreen.cleanup().
boolean	isClosureWithQuery(ClosureHolder closureHolder) Returns true if the closure contains a call of a query as the last expression.
abstract boolean	isReadOnly() Returns true if the GUI should be opened in read-only mode.
abstract boolean	isSaved() Returns true if the state of the GUI was already saved before opening.
boolean	isValid() Returns true if the context is valid.
protected Couple<ExecutionContext,ModelInstance>	minimalModelInstanceCopy(ModelInstance modelInstance, UIScreenState uiState)
protected void	performPersist(ModelInstance modelInstance) Persists the changes done within the context.
void	persist() Persists the changes done within the context, using a save point if an exception occurs, model instance is restored.
void	reactivate() Should be called when the content is shown again after it was previously hidden.
void	reloadContent() Loads the context and creates Vaadin component tree that represents the content.
abstract void	save(UIScreenState uiState) Saves the changes done within the context.
protected abstract RecordHolder	submit() Submits the changes done within the context and closes the context.
Variant.RecordVariant	submitContext(Variant.RecordVariant screenNavigation) Submits the context and handles the navigation.
protected void	updateApplicationData(ModelInstance modelInstance) Updates the data available to the model through the getApplicationData() function.

Methods inherited from class java.lang.Object

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

Field Detail

modelProviderService

protected ModelProviderClientService modelProviderService

Instance of ModelProviderService to be used by subclasses

modelInstanceUtilsService

protected ModelInstanceUtilsService modelInstanceUtilsService

Instance of ModelInstanceUtilsService.

sharedRecordTypeFactory

protected SharedRecordTypeFactory sharedRecordTypeFactory

Instance of SharedRecordTypeFactory to be used by subclasses

Constructor Detail

LspsContextHolder

public LspsContextHolder(LspsAppConnector appConnector,
                         LspsFormConnector formConnector,
                         String userId)

Full constructor.

Parameters:

appConnector - not null

formConnector - not null

userId - ?, not null.

Method Detail

getScreen

public LspsScreen getScreen()

Returns current screen or null if no screen is active.

Returns:

the screen or null.

getAppConnector

public LspsAppConnector getAppConnector()

Returns the application connector.

Returns:

application connector

getFormConnector

public LspsFormConnector getFormConnector()

Returns the form connector.

Returns:

form connector

getTitle

public abstract String getTitle()

Returns the title for the form content.

Returns:

title the title or null if no content is currently loaded.

reloadContent

public void reloadContent()
                   throws LspsException

Loads the context and creates Vaadin component tree that represents the content. Has to be called when the content should be shown. Can be called whenever all the changes done by the user should be reverted and the content should be reopened.

Throws:

ErrorException

LspsException

updateApplicationData

protected void updateApplicationData(ModelInstance modelInstance)

Updates the data available to the model through the getApplicationData() function.

Parameters:

modelInstance -

reactivate

public void reactivate()

Should be called when the content is shown again after it was previously hidden. Invokes UIScreen.resume().

deactivate

public void deactivate()

Should be called when the content is hidden.

createEvaluationContext

protected abstract ExecutionContext createEvaluationContext()
                                                     throws LspsException

Creates the evaluation context. Called from reloadContent().

Returns:

evaluation context

Throws:

LspsException

createScreen

protected abstract LspsScreen createScreen()
                                    throws LspsException

Creates the user interface. Called from reloadContent().

Returns:

user interface to be shown

Throws:

LspsException

isSaved

public abstract boolean isSaved()

Returns true if the state of the GUI was already saved before opening.

Returns:

true if saved state is available

isReadOnly

public abstract boolean isReadOnly()

Returns true if the GUI should be opened in read-only mode.

Returns:

true if in read-only mode

createSavedStateHolder

public abstract RecordHolder createSavedStateHolder()

Returns a representation of the saved state in the model. This is called by UISaveAction when the save action is going to be executed.

Returns:

representation of the saved state in the model. Returns null if save is not supported.

submit

protected abstract RecordHolder submit()
                                throws LspsException

Submits the changes done within the context and closes the context.

Returns:

navigation definition or null

Throws:

LspsException

submitContext

public final Variant.RecordVariant submitContext(Variant.RecordVariant screenNavigation)
                                          throws LspsException

Submits the context and handles the navigation. Also invokes UIScreen.cleanup().

Parameters:

screenNavigation - may be null. Note that submit navigation takes precedence.

Returns:

navigation

Throws:

LspsException

save

public abstract void save(UIScreenState uiState)
                   throws LspsException

Saves the changes done within the context. May not be supported by all implementations.

Parameters:

uiState -

Throws:

LspsException

persist

public void persist()
             throws LspsException

Persists the changes done within the context, using a save point if an exception occurs, model instance is restored.

Throws:

LspsException

performPersist

protected void performPersist(ModelInstance modelInstance)
                       throws LspsException

Persists the changes done within the context.

Parameters:

modelInstance -

Throws:

LspsException

collectGarbage

public void collectGarbage()

Collects garbage in the used model instance.

isValid

public boolean isValid()

Returns true if the context is valid. Submitting a screen invalidates the context.

Returns:

true if context is valid

invalidate

public void invalidate()

Marks the context as invalid and calls LspsScreen.cleanup(). Any changes in the context are lost.

Should be invoked whenever the context/screen is not valid anymore.

getExecutionContext

public ExecutionContext getExecutionContext()

Returns the associated evaluation execution context. Fails if this holder is invalid.

Returns:

execution context

getExecutionContext

public ExecutionContext getExecutionContext(String evaluationLevel)

Returns an execution context in the given evaluation level.

Parameters:

evaluationLevel -

Returns:

execution context in given level

minimalModelInstanceCopy

protected Couple<ExecutionContext,ModelInstance> minimalModelInstanceCopy(ModelInstance modelInstance,
                                                                          UIScreenState uiState)

Parameters:

modelInstance - - model to be copied

uiState - - its definition must remain in copy after garbage collection.

Returns:

garbage collected working copy of the model instance. Records defining the ui, shared records must not be garbage collected.

getValueHolderInLevel

public <T extends ValueHolder> T getValueHolderInLevel(T valueHolder,
                                                       String evaluationLevel)

Returns the value holder in the given evaluation level.

Type Parameters:

T -

Parameters:

valueHolder -

evaluationLevel -

Returns:

value holder in the given level

getModelInstance

public ModelInstance getModelInstance()

Returns the model instance over which the evaluation context operates.

Returns:

model instance

getHandle

public Handle getHandle(ValueHolder valueHolder)

Returns handle for the given value holder.

Parameters:

valueHolder -

Returns:

handle

getValueHolder

public ValueHolder getValueHolder(Handle handle)

Returns value holder for the given handle.

Parameters:

handle -

Returns:

value holder

isClosureWithQuery

public boolean isClosureWithQuery(ClosureHolder closureHolder)

Returns true if the closure contains a call of a query as the last expression.

Parameters:

closureHolder - the closure, not null.

Returns:

true if the closure contains a call of a query as the last expression

getSubmitNavigationDefinition

public abstract Variant.ClosureVariant getSubmitNavigationDefinition()

Gets the navigation definition from the document/todo definition.

Returns:

the navigation represented by a closure {Set<Todo> : Navigation}

addSaveMetadataToUploadedBinaryData

public abstract void addSaveMetadataToUploadedBinaryData(BinaryDataServiceLocal binaryDataService,
                                                         List<Long> uploadedBinaryData)

Adds metadata to the binary data uploaded in this holder. The added metadata should provide information about document/todo in which the binary data is uploaded.

Parameters:

binaryDataService -

uploadedBinaryData -