org.universAAL.ui.handler.web.html

Class HTMLUserGenerator

java.lang.Object

org.universAAL.ui.handler.web.html.HTMLUserGenerator

public class HTMLUserGenerator
extends Object

Coordinator Class for Web HTML Handler per user. It will provide all of the needed properties and constants for all other classes, as well as acting as placeholder for all the needed classes to work. This placeholding and mutual reference (between contained and container classes) enables the renderer to be loaded more than once per instance.

Author:

amedrano

Field Summary

Fields

Modifier and Type	Field and Description
protected FormManager	fm Form Logic Manager.
protected static String	GLOBAL_LOCATION The default Location, which is global.
static String	HIDEN_DIALOG_NAME
protected Set	missingInputs the set of missing inputs of the last form.
protected ModelMapper	modelMapper The ModelMapper in order to find the correct Model for each rdf class.
protected Properties	properties The parent service that contains the properties.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HTMLUserGenerator() Only to be used by TestCases.
	HTMLUserGenerator(ModuleContext mc, Properties props, User usr) Constructor for one Renderer on a certain file.

Method Summary

Modifier and Type	Method and Description
void	finish() Terminate current dialog and all pending dialogs.
Form	getCurrentForm() Gets the form being displayed right now.
User	getCurrentUser() Get the logged in user, the one that is in theory receiving and manipulating the dialogs.
FormManager	getFormManagement() Get the FormManager being used, useful to access the current UIResquest and current form.
Handler	getHandler() get the Handler of this HTMLUserGenerator.
String	getHTML() Check if there is a form available, if there is it models it and generates HTML.
String	getLanguage() Get the Language that should be used.
ModelMapper	getModelMapper() Returns the ModelMapper that automatically assigns this Renderer to the Models.
ModuleContext	getModuleContext() get the ModuleContext.
String	getProperty(String key) Access to the property file.
String	getProperty(String key, String defaultVal) Access to the property file.
AbsLocation	getUserLocation() Get the location of the user, always a global location.
boolean	hasImpairment(AccessImpairment impariment) Check if impairment is listed as present impairments for the current user and form.
boolean	isMissingInput(Input i)
void	processInput(Map parameters) Get the input from user and send it.

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_LOCATION

protected static final String GLOBAL_LOCATION

The default Location, which is global.

See Also:

Constant Field Values

HIDEN_DIALOG_NAME

public static final String HIDEN_DIALOG_NAME

See Also:

Constant Field Values

modelMapper

protected ModelMapper modelMapper

The ModelMapper in order to find the correct Model for each rdf class.

fm

protected FormManager fm

Form Logic Manager. it will decide which Form to show when.

properties

protected Properties properties

The parent service that contains the properties.

missingInputs

protected Set missingInputs

the set of missing inputs of the last form.

Constructor Detail

HTMLUserGenerator

protected HTMLUserGenerator()

Only to be used by TestCases.

HTMLUserGenerator

public HTMLUserGenerator(ModuleContext mc,
                         Properties props,
                         User usr)

Constructor for one Renderer on a certain file.

Parameters:

mc - the ModuleContext to work in universAAL.

usr - the user for which this renderer is working.

mc - the ModuleContext to create UIHandler and send logs

Method Detail

getModuleContext

public final ModuleContext getModuleContext()

get the ModuleContext.

Returns:

the module context.

See Also:

HTMLUserGenerator#moduleContext

finish

public void finish()

Terminate current dialog and all pending dialogs.

getProperty

public final String getProperty(String key)

Access to the property file.

Parameters:

key - Key of property to access

Returns:

String Value of the property

See Also:

properties

getProperty

public final String getProperty(String key,
                                String defaultVal)

Access to the property file.

Parameters:

key - Key of property to access

defaultVal - default value for the propertie if isn't int he property file.

Returns:

String Value of the property.

See Also:

properties

getCurrentForm

public final Form getCurrentForm()

Gets the form being displayed right now.

Returns:

the current Form being processed.

getCurrentUser

public final User getCurrentUser()

Get the logged in user, the one that is in theory receiving and manipulating the dialogs.

Returns:

ontlogical representation of the user.

hasImpairment

public final boolean hasImpairment(AccessImpairment impariment)

Check if impairment is listed as present impairments for the current user and form.

Parameters:

impariment - the AccessImpairment to be checked

Returns:

true is impairment is present in the current Dialog Request.

See Also:

AccessImpairment, UIRequest

getLanguage

public final String getLanguage()

Get the Language that should be used.

Returns:

the two-letter representation of the language-

getFormManagement

public FormManager getFormManagement()

Get the FormManager being used, useful to access the current UIResquest and current form.

Returns:

fm

getModelMapper

public final ModelMapper getModelMapper()

Returns the ModelMapper that automatically assigns this Renderer to the Models.

Returns:

getHandler

public final Handler getHandler()

get the Handler of this HTMLUserGenerator.

Returns:

the Handler

getUserLocation

public final AbsLocation getUserLocation()

Get the location of the user, always a global location.

Returns:

getHTML

public String getHTML()

Check if there is a form available, if there is it models it and generates HTML. If not it will request a main menu and wait for one.

Returns:

processInput

public void processInput(Map parameters)

Get the input from user and send it.

Parameters:

parameters -

isMissingInput

public boolean isMissingInput(Input i)