no.g9.client.core.controller

Class DialogController

java.lang.Object

no.esito.jvine.controller.StateController

no.g9.client.core.controller.DialogController

public abstract class DialogController
extends no.esito.jvine.controller.StateController

The abstract dialog control.

Field Summary

Fields

Modifier and Type	Field and Description
String	dialogName The dialog name

Constructor Summary

Constructors

Constructor and Description
DialogController(String dialogName, ApplicationController applicationController) Constructs a new DialogControl with the specified dialog name.

Method Summary

Modifier and Type	Method and Description
boolean	checkChange(RoleConstant role, CheckType checkType) Perform the specified check change on the specified role.
void	clear(RoleConstant role, boolean intercept) Clears the specified role and all children.
void	clearCurrent(RoleConstant role, boolean intercept) Clears the current instance of the specified role and propagates the change to children.
void	clearKeepKeys(RoleConstant role) Clears the specified role and children but keeps the data belonging to the key fields.
MessageReply	dispatchMessage(Message message) Dispatch the specified message.
MessageReply	dispatchMessage(String messageID, Object... args) Dispatch the message with specified messageID and arguments.
MessageReply	dispatchMessage(String messageID, Throwable exception, Object... args) Dispatch the message with specified messageID, exception and arguments.
void	display(RoleConstant role, Object instance) Displays the fields of the specified instance.
void	display(RoleConstant role, Object instance, boolean changed) Displays all fields of the specified instance.
void	doCallBack(DialogCallBackValue callBackValue) Perform the call back to the invoking dialog.
void	doCallBack(Object value) Perform the call back to the invoking dialog.
void	doCallBack(Object value, Integer opCode) Perform the call back to the invoking dialog
Map<ValidationResult,ValidateContext>	failedOnChangeValidator(Map<ValidationResult,ValidateContext> failedResult) Hook method invoked when on change validation fails.
ActionHookList<?>	getActionHookList(ActionTarget actionTarget, ActionType actionType) Get the list of action hooks for the specified action target and type.
<T> Collection<T>	getAllInstances(RoleConstant role) Get all the displayed instances of the specified role.
ApplicationController	getApplicationController() Get the application controller for this dialog
Collection<AttributeConstant>	getChangedAttributes(RoleConstant role) Gets the changed field attributes for the specified role.
Map<DialogObjectConstant,Collection<?>>	getConversionMessages(RoleConstant role) Get a map of dialog objects and conversion error messages for the specified role.
<T> T	getCurrentInstance(RoleConstant role) Gets the current instance of the specified role.
<T extends DialogView> T	getDialogView() Gets the dialog view class of this dialog.
DispatcherContext	getDispatcherContext() Get the message context.
<T> T	getFieldValue(AttributeConstant attribute) Gets the specified displayed attribute value.
<T> T	getFieldValue(DialogObjectConstant dataItem) Gets the specified displayed field value (converted from to model).
MessageDispatcher	getMessageDispatcher() Get the message dispatcher for this dialog controller
abstract String	getObjectSelectionName() Returns the name of the object selection.
abstract <T extends RoleConstant> T	getOSConst(String role) Returns the constant denoting the role.
<T extends OSRole<?>> T	getOSRole(RoleConstant role) Gets the object selection role.
abstract List<RoleConstant>	getRoleConstants() Returns the list of all role constants for the object selection used in the dialog.
abstract Map<RoleConstant,OSRole<?>>	getRoleMap() Gives a map of role constants and object selection roles.
String	getRoleStates() Returns a string containing the role states of each role in this dialog's object selection.
DialogSetupValue<?>	getSetupValue()
SpreadsheetExporter	getSpreadsheetExporter()
RoleState	getState(RoleConstant role) Get the state of the specified object selection role.
ViewModel	getViewModel() Get the ViewModel for the this dialog.
boolean	hasConversionErrors(RoleConstant role) Test if there are any current conversion errors for the specified role
void	init() Invoked after the dialog controller has been fully initialized.
<V> V	invokeOnGui(Callable<V> guiMethod) Invoke the specified callable on the gui thread.
void	invokeOnGui(Runnable guiMethod) Invoke the specified runnable on the gui thread.
boolean	isChanged(RoleConstant role) Test if any fields of the specified role is changed in the gui.
<T> T	peek(RoleConstant role) Create a new instance of the specified root and update it with the view's field values.
void	registerHook(ActionTarget actionTarget, ActionType actionType, ActionHook<?> hook) Register the specified action hook.
void	registerInterceptor(CheckType checkType, Interceptor interceptor) Registers an interceptor.
void	setCallBack(CallBack callBack) Set the call back used to perform dialog interaction between dialogs.
void	setCurrentInstance(RoleConstant role, Object instance) Sets the current instance and recursively updates the view's model of instances to display.
<T> void	setCurrentInstances(RoleConstant role, Collection<T> instances) Sets the current instances for a "many" root role, and recursively updates the view's model of instances to display.
void	setFieldValue(AttributeConstant attribute, Object value) Sets the specified field value.
void	setFieldValue(AttributeConstant attribute, Object value, boolean changed) Sets the specified field value and changed status.
void	setFieldValue(DialogObjectConstant field, Object value) Set the specified field value.
void	setFieldValue(DialogObjectConstant field, Object fieldValue, boolean changed) Set the specified field value and field changed status.
void	setSetupValue(DialogSetupValue<?> setupValue) Set a new setupValue for the dialog.
void	setSpreadsheetExporter(SpreadsheetExporter spreadsheetExporter) Set the current spreadsheet exporter.
void	setState(RoleConstant role, RoleState state) Set the state of the specified object selection role.
void	setup(DialogSetupValue<?> setupValue) Invoked each time the dialog is opened.
String	toString()
Map<ValidationResult,ValidateContext>	validate(RoleConstant osRole, ValidationPolicy.Policy validationPolicy) Run all validators with the specified policy for the specified role.

Methods inherited from class no.esito.jvine.controller.StateController

getDialogConstant, getDialogInstanceNumber, performAction, setDialogInstanceNumber, validateField

Methods inherited from class java.lang.Object

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

Field Detail

dialogName

public final String dialogName

The dialog name

Constructor Detail

DialogController

public DialogController(String dialogName,
                        ApplicationController applicationController)

Constructs a new DialogControl with the specified dialog name.

Parameters:

dialogName - the name of the dialog.

applicationController - the application controller

Method Detail

getChangedAttributes

public final Collection<AttributeConstant> getChangedAttributes(RoleConstant role)

Gets the changed field attributes for the specified role.

Parameters:

role - the role in question

Returns:

a collection of the roles changed attributes.

setFieldValue

public final void setFieldValue(AttributeConstant attribute,
                                Object value)

Sets the specified field value.

Parameters:

attribute - constant denoting the field.

value - the value to display.

setFieldValue

public final void setFieldValue(AttributeConstant attribute,
                                Object value,
                                boolean changed)

Sets the specified field value and changed status.

Parameters:

attribute - constant denoting the field.

value - the value to display.

changed - the changed status of the field.

init

public void init()

Invoked after the dialog controller has been fully initialized.

setup

public void setup(DialogSetupValue<?> setupValue)

Invoked each time the dialog is opened. The setupValue is initialized by hooks.

Parameters:

setupValue - the setup value.

getDialogView

public final <T extends DialogView> T getDialogView()

Gets the dialog view class of this dialog.

Type Parameters:

T - The dialog view type

Returns:

the dialog view.

getViewModel

public final ViewModel getViewModel()

Get the ViewModel for the this dialog.

Specified by:

getViewModel in class no.esito.jvine.controller.StateController

Returns:

the ViewModel for this dialog.

See Also:

JVineController.getViewModel()

getOSRole

public final <T extends OSRole<?>> T getOSRole(RoleConstant role)

Gets the object selection role.

Type Parameters:

T - The expected return type, e.g. OSRole<?>.

Parameters:

role - the constant denoting the role.

Returns:

the OSRole of said role.

Throws:

ClassCastException - if the returned type does not match the expected type.

IllegalArgumentException - if the specified role is not found among this dialog's object selection.

getFieldValue

public final <T> T getFieldValue(DialogObjectConstant dataItem)

Gets the specified displayed field value (converted from to model).

Type Parameters:

T - The expected field value type

Parameters:

dataItem - the constant denoting the view data item.

Returns:

the displayed field value

Throws:

ClassCastException - if the actual field value type is not assignable to the expected field value type.

getFieldValue

public final <T> T getFieldValue(AttributeConstant attribute)

Gets the specified displayed attribute value.

Type Parameters:

T - The expected field value type

Parameters:

attribute - the constant denoting the attribute.

Returns:

the displayed field value

Throws:

IllegalArgumentException - if no data item corresponds to the specified attribute.

ClassCastException - if the actual field value type is not assignable to the expected field value type.

setFieldValue

public final void setFieldValue(DialogObjectConstant field,
                                Object value)

Set the specified field value.

Parameters:

field - dialog object constant denoting the view's data item.

value - the value to display.

setFieldValue

public final void setFieldValue(DialogObjectConstant field,
                                Object fieldValue,
                                boolean changed)

Set the specified field value and field changed status. If the changed parameter is true the field will be considered changed (as if changed by a user). Otherwise the field will be considered unchanged.

Parameters:

field - the dialog object constant denoting the view's data item.

fieldValue - the value to display

changed - if true

toString

public String toString()

Overrides:

toString in class Object

registerHook

public final void registerHook(ActionTarget actionTarget,
                               ActionType actionType,
                               ActionHook<?> hook)

Register the specified action hook.

Parameters:

actionTarget - the action target

actionType - the action type

hook - an action hook that should be invoked when the action runs

getActionHookList

public ActionHookList<?> getActionHookList(ActionTarget actionTarget,
                                           ActionType actionType)

Get the list of action hooks for the specified action target and type.

Parameters:

actionTarget - the target of the action

actionType - the action type

Returns:

the action hooks registered for the specified action target and type

clear

public final void clear(RoleConstant role,
                        boolean intercept)

Clears the specified role and all children.

Parameters:

role - the role to clear.

intercept - if true, clear intercept will be invoked during clear

clearCurrent

public final void clearCurrent(RoleConstant role,
                               boolean intercept)

Clears the current instance of the specified role and propagates the change to children.

Parameters:

role - the role to clear.

intercept - if true, clear intecept will be invoked during clear.

clearKeepKeys

public final void clearKeepKeys(RoleConstant role)

Clears the specified role and children but keeps the data belonging to the key fields. All fields belonging to the specified role except the key fields are cleared. Child roles are completely cleared.

Parameters:

role - the role to clear.

getApplicationController

public final ApplicationController getApplicationController()

Get the application controller for this dialog

Specified by:

getApplicationController in class no.esito.jvine.controller.StateController

Returns:

the application controller

setCallBack

public final void setCallBack(CallBack callBack)

Set the call back used to perform dialog interaction between dialogs.

Parameters:

callBack - the call back

getSetupValue

public DialogSetupValue<?> getSetupValue()

Returns:

the current setupValue for the dialog

setSetupValue

public void setSetupValue(DialogSetupValue<?> setupValue)

Set a new setupValue for the dialog.

Parameters:

setupValue - the setupValue to set

isChanged

public final boolean isChanged(RoleConstant role)

Test if any fields of the specified role is changed in the gui.

Parameters:

role - the role to test.

Returns:

true if at least one field value of the specified role is dirty.

See Also:

ViewModel.getChangedAttributes(RoleConstant)

hasConversionErrors

public final boolean hasConversionErrors(RoleConstant role)

Test if there are any current conversion errors for the specified role

Parameters:

role - the role to test for

Returns:

true if any fields in the specified role has a conversion error.

getConversionMessages

public final Map<DialogObjectConstant,Collection<?>> getConversionMessages(RoleConstant role)

Get a map of dialog objects and conversion error messages for the specified role.

Parameters:

role - the role to get messages for

Returns:

all messages relating to conversion errors on the role

getObjectSelectionName

public abstract String getObjectSelectionName()

Returns the name of the object selection.

Returns:

the object selection name

getRoleConstants

public abstract List<RoleConstant> getRoleConstants()

Returns the list of all role constants for the object selection used in the dialog.

Returns:

all role constants

getOSConst

public abstract <T extends RoleConstant> T getOSConst(String role)

Returns the constant denoting the role. The role must be part of this dialog's object selection.

Type Parameters:

T - The expected role constant type.

Parameters:

role - the name of the role

Returns:

the role constant

Throws:

ClassCastException - if the returned type does not match the expected type.

doCallBack

public final void doCallBack(Object value)

Perform the call back to the invoking dialog.

Parameters:

value - an object to transfer back to the invoking dialog

doCallBack

public final void doCallBack(DialogCallBackValue callBackValue)

Perform the call back to the invoking dialog.

Parameters:

callBackValue - the call back value to return to the invoking dialog's call back.

doCallBack

public final void doCallBack(Object value,
                             Integer opCode)

Perform the call back to the invoking dialog

Parameters:

value - an object to transfer back to the invoking dialog

opCode - the opCode to transfer back to the invoking dialog

registerInterceptor

public final void registerInterceptor(CheckType checkType,
                                      Interceptor interceptor)

Registers an interceptor. The interceptorType defines which action type the interceptor applies to, typically FIND, SAVE or DELETE.

Parameters:

checkType - the action type this interceptor intercepts.

interceptor - the interceptor to register.

checkChange

public final boolean checkChange(RoleConstant role,
                                 CheckType checkType)

Perform the specified check change on the specified role.

Parameters:

role - the target role of the check change.

checkType - the check type to perform

Returns:

true if the specified role and all child roles are unchanged.

peek

public final <T> T peek(RoleConstant role)

Create a new instance of the specified root and update it with the view's field values.

Type Parameters:

T - The domain object type.

Parameters:

role - the role to peek at.

Returns:

an new instance of the specified role with values from the view.

Throws:

G9ClientException - if either convert of validate failed during the update of the domain object from the view.

ClassCastException - if the returned type does not match the expected type.

display

public final void display(RoleConstant role,
                          Object instance)

Displays the fields of the specified instance.

Parameters:

role - the role of the instance to display.

instance - the instance to display.

getAllInstances

public final <T> Collection<T> getAllInstances(RoleConstant role)

Get all the displayed instances of the specified role.

Type Parameters:

T - the expected domain type of the role

Parameters:

role - the constant denoting the role

Returns:

a collection of the displayed instances.

Throws:

ClassCastException - if the actual domain type does not match the expected domain type of the specified role.

display

public final void display(RoleConstant role,
                          Object instance,
                          boolean changed)

Displays all fields of the specified instance.

Parameters:

role - the role of the instance to display.

instance - the instance to display.

changed - if true the view's corresponding data items will be considered changed, otherwise unchanged.

setCurrentInstance

public final void setCurrentInstance(RoleConstant role,
                                     Object instance)

Sets the current instance and recursively updates the view's model of instances to display.

Parameters:

role - the role of the new current instance

instance - the instance to set as the new current instance.

setCurrentInstances

public final <T> void setCurrentInstances(RoleConstant role,
                                          Collection<T> instances)

Sets the current instances for a "many" root role, and recursively updates the view's model of instances to display.

Type Parameters:

T - the expected domain type

Parameters:

role - the root role for the instances

instances - the collection of instances to set

getCurrentInstance

public final <T> T getCurrentInstance(RoleConstant role)

Gets the current instance of the specified role.

Type Parameters:

T - the expected domain type

Parameters:

role - the constant denoting the role.

Returns:

the current displayed instance.

Throws:

ClassCastException - if the expected domain type is not assignable to the actual domain type of the object selection role.

getState

public final RoleState getState(RoleConstant role)

Get the state of the specified object selection role.

Parameters:

role - the constant denoting the object selection role

Returns:

the role's state.

setState

public final void setState(RoleConstant role,
                           RoleState state)

Set the state of the specified object selection role.

Parameters:

role - the constant denoting the object selection role.

state - the new state to set.

getRoleStates

public final String getRoleStates()

Returns a string containing the role states of each role in this dialog's object selection. This is mainly intended for short term debugging purposes. The returned string consists of one line per object selection role listing the role's name, the role's state and the list of changed attributes.

Returns:

a listing of all role's state.

invokeOnGui

public final void invokeOnGui(Runnable guiMethod)
                       throws InvocationTargetException

Invoke the specified runnable on the gui thread.

Parameters:

guiMethod - the runnable to be run by the gui thread.

Throws:

InvocationTargetException - exceptions thrown by the runnable are wrapped in an InvocationTargetException and re-thrown.

invokeOnGui

public final <V> V invokeOnGui(Callable<V> guiMethod)
                        throws InvocationTargetException

Invoke the specified callable on the gui thread.

Type Parameters:

V - the return value

Parameters:

guiMethod - the callable to be invoked by the gui thread.

Returns:

the callable's return value

Throws:

InvocationTargetException - exceptions thrown by the callable are wrapped in an InvocationTargetException and re-thrown.

validate

public final Map<ValidationResult,ValidateContext> validate(RoleConstant osRole,
                                                            ValidationPolicy.Policy validationPolicy)

Run all validators with the specified policy for the specified role.

Parameters:

osRole - role to validate

validationPolicy - policy to use when finding validators

Returns:

map of all validation results (both succeeded and failed) and corresponding validation context

failedOnChangeValidator

public Map<ValidationResult,ValidateContext> failedOnChangeValidator(Map<ValidationResult,ValidateContext> failedResult)

Hook method invoked when on change validation fails. This method should be overridden in concrete dialog controllers which can handle validation failures at own discretion. The returned map should contain validation failures that are to be handled by the G9 runtime.

Parameters:

failedResult - map of failed validation results and corresponding context

Returns:

map of unprocessed failed validations

getDispatcherContext

public DispatcherContext getDispatcherContext()

Get the message context.

Returns:

a message context suitable for use in a jVine interactor setting.

getMessageDispatcher

public MessageDispatcher getMessageDispatcher()

Description copied from class: no.esito.jvine.controller.StateController

Get the message dispatcher for this dialog controller

Specified by:

getMessageDispatcher in class no.esito.jvine.controller.StateController

Returns:

message dispatcher with a message context.

dispatchMessage

public MessageReply dispatchMessage(String messageID,
                                    Object... args)

Dispatch the message with specified messageID and arguments.

Parameters:

messageID - string identifying the message

args - message arguments

Returns:

the message reply (if applicable)

See Also:

MessageDispatcher.dispatch(String, Object...)

dispatchMessage

public MessageReply dispatchMessage(Message message)

Dispatch the specified message.

Parameters:

message - the message to dispatch

Returns:

the message reply (if applicable)

See Also:

MessageDispatcher.dispatch(Message)

dispatchMessage

public MessageReply dispatchMessage(String messageID,
                                    Throwable exception,
                                    Object... args)

Dispatch the message with specified messageID, exception and arguments.

Parameters:

messageID - string identifying the message

exception - the exception that caused the message to be dispatched

args - message arguments

Returns:

the message reply (if applicable)

See Also:

MessageDispatcher.dispatch(String, Throwable, Object...)

getRoleMap

public abstract Map<RoleConstant,OSRole<?>> getRoleMap()

Gives a map of role constants and object selection roles.

Returns:

a map from role constant to object selection role.

getSpreadsheetExporter

public SpreadsheetExporter getSpreadsheetExporter()

Returns:

The current spreadsheet exporter

setSpreadsheetExporter

public void setSpreadsheetExporter(SpreadsheetExporter spreadsheetExporter)

Set the current spreadsheet exporter.

Parameters:

spreadsheetExporter - the new current spreadsheet exporter