org.alfresco.web.scripts.forms

Class FormUIGet

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.web.scripts.forms.FormUIGet

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

public class FormUIGet
extends org.springframework.extensions.webscripts.DeclarativeWebScript

Form UI Component web script implementation. Requests the form definition from the server, combines that with the form configuration for the item being requested resulting in the form UI model which gets passed to the FreeMarker engine for rendering. NOTE: The general approach to naming in this class is as follows: - processXYZ: Logic - discoverXYZ: Searching context for appropriate value - generateXYZ: Creating model representations - retrieveXYZ: Fetches data from another service

Author:

Gavin Cornwell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FormUIGet.Constraint Represents a field constraint.
class	FormUIGet.Element Base inner class to represent form elements i.e a field or set NOTE: This class has to be public for the template engine to access the object correctly.
class	FormUIGet.Field Represents a field on a form.
class	FormUIGet.FieldControl Represents the control used by a form field.
class	FormUIGet.FieldPointer Represents a pointer to a field, used in the form UI model.
protected class	FormUIGet.MessageHelper Helper class used to retrieve localized messages.
protected class	FormUIGet.ModelContext Inner class used to hold all the context required to generate the model and the model itself.
class	FormUIGet.Set Represents a set of fields and/or nested sets.

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALFRESCO_PROXY
protected static String	ASSOC_PREFIX
protected static String	ASSOCIATION
protected static String	CM_NAME_PROP
protected static String	CONFIG_FORMS
protected org.springframework.extensions.config.ConfigService	configService
protected static String	CONSTRAINT_FILE_NAME_HANDLER
protected static String	CONSTRAINT_LENGTH
protected static String	CONSTRAINT_LIST
protected static String	CONSTRAINT_MANDATORY
protected static String	CONSTRAINT_MINMAX
protected static String	CONSTRAINT_MSG_LENGTH
protected static String	CONSTRAINT_MSG_MINMAX
protected static String	CONSTRAINT_MSG_NUMBER
protected static String	CONSTRAINT_NODE_HANDLER
protected static String	CONSTRAINT_NUMBER
protected static String	CONSTRAINT_REGEX
protected static String	CONTROL_PARAM_OPTION_SEPARATOR
protected static String	CONTROL_PARAM_OPTIONS
protected static String	CONTROL_SELECT_MANY
protected static String	CONTROL_SELECT_ONE
protected static String	DEFAULT_CONSTRAINT_EVENT
protected static String	DEFAULT_FIELD_TYPE
protected static String	DEFAULT_METHOD
protected static String	DEFAULT_MODE
protected static String	DEFAULT_SUBMIT_TYPE
protected static String	DELIMITER
protected static String	ENCTYPE_JSON
protected static String	ENCTYPE_MULTIPART
protected static String	ENCTYPE_URL
protected static String	ENDPOINT_ID
protected static String	FIELD
protected static String	INDENT
protected static String	MODEL_ARGUMENTS
protected static String	MODEL_CAPABILITIES
protected static String	MODEL_CONSTRAINTS
protected static String	MODEL_CREATE_TEMPLATE
protected static String	MODEL_DATA
protected static String	MODEL_DATA_KEY_NAME
protected static String	MODEL_DATA_TYPE
protected static String	MODEL_DATA_TYPE_PARAMETERS
protected static String	MODEL_DEFAULT_VALUE
protected static String	MODEL_DEFINITION
protected static String	MODEL_DESCRIPTION
protected static String	MODEL_DESTINATION
protected static String	MODEL_EDIT_TEMPLATE
protected static String	MODEL_ENCTYPE
protected static String	MODEL_ENDPOINT_DIRECTION
protected static String	MODEL_ENDPOINT_MANDATORY
protected static String	MODEL_ENDPOINT_MANY
protected static String	MODEL_ENDPOINT_TYPE
protected static String	MODEL_ERROR
protected static String	MODEL_FIELDS
protected static String	MODEL_FORCE
protected static String	MODEL_FORM
protected static String	MODEL_FORM_DATA
protected static String	MODEL_GROUP
protected static String	MODEL_INDEX_TOKENISATION_MODE
protected static String	MODEL_JAVASCRIPT
protected static String	MODEL_LABEL
protected static String	MODEL_MANDATORY
protected static String	MODEL_MAX_LENGTH
protected static String	MODEL_MESSAGE
protected static String	MODEL_METHOD
protected static String	MODEL_MODE
protected static String	MODEL_NAME
protected static String	MODEL_PARAMETERS
protected static String	MODEL_PROTECTED_FIELD
protected static String	MODEL_REDIRECT
protected static String	MODEL_REPEATING
protected static String	MODEL_SHOW_CANCEL_BUTTON
protected static String	MODEL_SHOW_CAPTION
protected static String	MODEL_SHOW_RESET_BUTTON
protected static String	MODEL_SHOW_SUBMIT_BUTTON
protected static String	MODEL_STRUCTURE
protected static String	MODEL_SUBMISSION_URL
protected static String	MODEL_TYPE
protected static String	MODEL_VIEW_TEMPLATE
protected static String	MSG_DEFAULT_FORM_ERROR
protected static String	MSG_DEFAULT_SET_LABEL
protected static String	OLD_DATA_TYPE_PREFIX
protected static String	PARAM_ERROR_KEY
protected static String	PARAM_FORM_ID
protected static String	PARAM_ITEM_ID
protected static String	PARAM_ITEM_KIND
protected static String	PARAM_JS
protected static String	PARAM_SUBMISSION_URL
protected static String	PARAM_SUBMIT_TYPE
protected static String	PROP_PREFIX
protected static String	PROPERTY
protected static String	SET
protected static String	SUBMIT_TYPE_JSON
protected static String	SUBMIT_TYPE_MULTIPART
protected static String	SUBMIT_TYPE_URL

Constructor Summary

Constructors

Constructor and Description
FormUIGet()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,String>	discoverArguments(FormUIGet.ModelContext context) Determines the "arguments" that should be used for the form.
protected boolean	discoverBooleanParam(FormUIGet.ModelContext context, String name) Returns the value of the given boolean parameter.
protected boolean	discoverBooleanParam(FormUIGet.ModelContext context, String name, boolean defaultValue) Returns the value of the given boolean parameter.
protected Map<String,Object>	discoverData(FormUIGet.ModelContext context) Determines the "data" that should be used for the form.
protected String	discoverEncodingFormat(FormUIGet.ModelContext context) Determines the "enctype" that should be used for the form.
protected org.json.JSONObject	discoverFieldDefinition(FormUIGet.ModelContext context, String fieldName) Returns the field definition for the given field name.
protected String	discoverSetLabel(FormSet setConfig) Determines the label to use for the given set configuration.
protected Map<String,List<String>>	discoverSetMembership(FormUIGet.ModelContext context) Determines the set membership hierarchy.
protected String	discoverSubmissionUrl(FormUIGet.ModelContext context) Determines the "submissionUrl" that should be used for the form.
protected void	dumpFormUIModel(Map<String,Object> model) Dumps the given form UI model to debug output (when debug is enabled).
protected String	dumpMap(Map<String,Object> map, String indent)
protected Map<String,Object>	executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
protected FormUIGet.Constraint	generateConstraintModel(FormUIGet.ModelContext context, FormUIGet.Field field, FormField fieldConfig, String constraintId, org.json.JSONObject constraintParams, ConstraintHandlerDefinition defaultConstraintConfig) Generates the model for a single constraint.
protected FormUIGet.Constraint	generateConstraintModel(FormUIGet.ModelContext context, FormUIGet.Field field, org.json.JSONObject fieldDefinition, FormField fieldConfig, org.json.JSONObject constraintDefinition) Generates the model for a single constraint.
protected FormUIGet.Constraint	generateConstraintModel(FormUIGet.ModelContext context, FormUIGet.Field field, org.json.JSONObject fieldDefinition, FormField fieldConfig, String constraintId) Generates the model for a single constraint.
protected FormUIGet.Set	generateDefaultSetModelUsingServerFields(FormUIGet.ModelContext context) Generates the model for the default set, this will contain all the fields returned from the server.
protected Map<String,Object>	generateErrorModel(org.springframework.extensions.webscripts.connector.Response errorResponse) Generates the "error" model used when an error occurs.
protected Map<String,Object>	generateErrorModel(org.springframework.extensions.webscripts.connector.Response errorResponse, String errorKey) Generates the "error" model used when an error occurs.
protected FormUIGet.Field	generateFieldModel(FormUIGet.ModelContext context, String fieldName, FormField fieldConfig) Generates the model for the given field.
protected ByteArrayInputStream	generateFormDefPostBody(String itemKind, String itemId, List<String> visibleFields, FormConfigElement formConfig) Generates the POST body to send to the FormService.
protected Map<String,Object>	generateFormModel(org.springframework.extensions.webscripts.WebScriptRequest request, Mode mode, org.springframework.extensions.webscripts.connector.Response formSvcResponse, FormConfigElement formConfig) Generates the "form" model passed to the FreeMarker engine.
protected Map<String,Object>	generateFormUIModel(FormUIGet.ModelContext context) Generates the model that will be processed by the FreeMarker engine and thus render the form UI.
protected Map<String,Object>	generateModel(String itemKind, String itemId, org.springframework.extensions.webscripts.WebScriptRequest request, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache) Generates the model to send to the FreeMarker engine.
protected FormUIGet.Set	generateSetModel(FormUIGet.ModelContext context, FormSet setConfig, List<String> fields) Generates the model for the given set and it's fields.
protected FormUIGet.Set	generateSetModelUsingServerFields(FormUIGet.ModelContext context, FormSet setConfig, Map<String,List<String>> setMembership) Generates the model for the given set, this method also recursively generates any child sets the given set has.
protected FormUIGet.Set	generateSetModelUsingVisibleFields(FormUIGet.ModelContext context, FormSet setConfig) Generates the model for the given set, this method also recursively generates any child sets the given set has.
protected FormUIGet.Field	generateTransientFieldModel(FormUIGet.ModelContext context, String fieldName, org.json.JSONObject fieldDefinition, FormField fieldConfig) Generates a model for a "transient" field.
protected FormUIGet.Field	generateTransientFieldModel(String fieldName, String template) Generates a model for a "transient" field.
protected FormConfigElement	getFormConfig(String itemId, String formId) Returns the form configuration for the given item id and optional form id.
protected String	getParameter(org.springframework.extensions.webscripts.WebScriptRequest req, String name) Returns the named parameter.
protected String	getParameter(org.springframework.extensions.webscripts.WebScriptRequest req, String name, String defaultValue) Returns the named parameter, returning the given default value if the parameter can not be found.
protected String	getProxyPath(FormUIGet.ModelContext context) Returns the base path to the proxy to use
protected List<String>	getVisibleFields(Mode mode, FormConfigElement formConfig) Returns the list of visible field names for the given mode.
protected List<String>	getVisibleFieldsInSet(FormUIGet.ModelContext context, FormSet setConfig) Returns the list of visible field names for the given set.
protected boolean	isFieldAmbiguous(FormUIGet.ModelContext context, String fieldName) Determines whether the given field is ambiguous (a property and association have the same name).
protected void	processCapabilities(FormUIGet.ModelContext context, Map<String,Object> formUIModel) Processes the "js" parameter, if present.
protected void	processFieldConstraintControl(FormUIGet.ModelContext context, FormUIGet.Field field, FormField fieldConfig, FormUIGet.Constraint constraint) Processes the given constraint to ensure the field's control adheres to the constraint.
protected void	processFieldConstraintHelp(FormUIGet.ModelContext context, FormUIGet.Field field, FormField fieldConfig, FormUIGet.Constraint constraint) Processes the given constraint to add help text to the field's control if relevant.
protected void	processFieldConstraints(FormUIGet.ModelContext context, FormUIGet.Field field, org.json.JSONObject fieldDefinition, FormField fieldConfig) Processes the constraints for the field.
protected void	processFieldContent(FormUIGet.ModelContext context, FormUIGet.Field field, org.json.JSONObject fieldDefinition, FormField fieldConfig) Processes the field for content.
protected void	processFieldControl(FormUIGet.ModelContext context, FormUIGet.Field field, org.json.JSONObject fieldDefinition, FormField fieldConfig) Processes the control for the field.
protected void	processFieldData(FormUIGet.ModelContext context, FormUIGet.Field field, org.json.JSONObject fieldDefinition, FormField fieldConfig) Processes the "data" part of the field model.
protected void	processFieldIdentification(FormUIGet.ModelContext context, FormUIGet.Field field, org.json.JSONObject fieldDefinition, FormField fieldConfig) Processes the identification part of the field model.
protected void	processFields(FormUIGet.ModelContext context, Map<String,Object> formUIModel) Processes the "fields" section of the model.
protected void	processFieldState(FormUIGet.ModelContext context, FormUIGet.Field field, org.json.JSONObject fieldDefinition, FormField fieldConfig) Processes the "state" part of the field model i.e.
protected void	processFieldText(FormUIGet.ModelContext context, FormUIGet.Field field, org.json.JSONObject fieldDefinition, FormField fieldConfig) Processes the "text" part of the field model i.e.
protected void	processServerFields(FormUIGet.ModelContext context) Processes the fields returned from the server (the form definition), this method is called when there are no visible fields configured.
protected void	processTemplates(FormUIGet.ModelContext context, Map<String,Object> formUIModel) Processes the optional custom templates configuration.
protected void	processVisibleFields(FormUIGet.ModelContext context) Processes the fields configured to be visible for the form.
protected org.springframework.extensions.webscripts.connector.Response	retrieveFormDefinition(String itemKind, String itemId, List<String> visibleFields, FormConfigElement formConfig) Retrieves the form definition from the repository FormService for the given item.
protected String	retrieveMessage(String messageKey, Object... args) Retrieves a localized message string.
void	setConfigService(org.springframework.extensions.config.ConfigService configService) Sets the ConfigService instance

Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript

execute, executeFinallyImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate

Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY

protected static final String PROPERTY

See Also:

Constant Field Values

ASSOCIATION

protected static final String ASSOCIATION

See Also:

Constant Field Values

PROP_PREFIX

protected static final String PROP_PREFIX

See Also:

Constant Field Values

FIELD

protected static final String FIELD

See Also:

Constant Field Values

SET

protected static final String SET

See Also:

Constant Field Values

ASSOC_PREFIX

protected static final String ASSOC_PREFIX

See Also:

Constant Field Values

OLD_DATA_TYPE_PREFIX

protected static final String OLD_DATA_TYPE_PREFIX

See Also:

Constant Field Values

ENDPOINT_ID

protected static final String ENDPOINT_ID

See Also:

Constant Field Values

ALFRESCO_PROXY

protected static final String ALFRESCO_PROXY

See Also:

Constant Field Values

CM_NAME_PROP

protected static final String CM_NAME_PROP

See Also:

Constant Field Values

MSG_DEFAULT_SET_LABEL

protected static final String MSG_DEFAULT_SET_LABEL

See Also:

Constant Field Values

MSG_DEFAULT_FORM_ERROR

protected static final String MSG_DEFAULT_FORM_ERROR

See Also:

Constant Field Values

INDENT

protected static final String INDENT

See Also:

Constant Field Values

DELIMITER

protected static final String DELIMITER

See Also:

Constant Field Values

SUBMIT_TYPE_MULTIPART

protected static final String SUBMIT_TYPE_MULTIPART

See Also:

Constant Field Values

SUBMIT_TYPE_JSON

protected static final String SUBMIT_TYPE_JSON

See Also:

Constant Field Values

SUBMIT_TYPE_URL

protected static final String SUBMIT_TYPE_URL

See Also:

Constant Field Values

ENCTYPE_MULTIPART

protected static final String ENCTYPE_MULTIPART

See Also:

Constant Field Values

ENCTYPE_JSON

protected static final String ENCTYPE_JSON

See Also:

Constant Field Values

ENCTYPE_URL

protected static final String ENCTYPE_URL

See Also:

Constant Field Values

DEFAULT_MODE

protected static final String DEFAULT_MODE

See Also:

Constant Field Values

DEFAULT_SUBMIT_TYPE

protected static final String DEFAULT_SUBMIT_TYPE

See Also:

Constant Field Values

DEFAULT_METHOD

protected static final String DEFAULT_METHOD

See Also:

Constant Field Values

DEFAULT_FIELD_TYPE

protected static final String DEFAULT_FIELD_TYPE

See Also:

Constant Field Values

DEFAULT_CONSTRAINT_EVENT

protected static final String DEFAULT_CONSTRAINT_EVENT

See Also:

Constant Field Values

CONFIG_FORMS

protected static final String CONFIG_FORMS

See Also:

Constant Field Values

PARAM_ITEM_KIND

protected static final String PARAM_ITEM_KIND

See Also:

Constant Field Values

PARAM_ITEM_ID

protected static final String PARAM_ITEM_ID

See Also:

Constant Field Values

PARAM_FORM_ID

protected static final String PARAM_FORM_ID

See Also:

Constant Field Values

PARAM_SUBMIT_TYPE

protected static final String PARAM_SUBMIT_TYPE

See Also:

Constant Field Values

PARAM_SUBMISSION_URL

protected static final String PARAM_SUBMISSION_URL

See Also:

Constant Field Values

PARAM_JS

protected static final String PARAM_JS

See Also:

Constant Field Values

PARAM_ERROR_KEY

protected static final String PARAM_ERROR_KEY

See Also:

Constant Field Values

CONSTRAINT_MANDATORY

protected static final String CONSTRAINT_MANDATORY

See Also:

Constant Field Values

CONSTRAINT_LIST

protected static final String CONSTRAINT_LIST

See Also:

Constant Field Values

CONSTRAINT_LENGTH

protected static final String CONSTRAINT_LENGTH

See Also:

Constant Field Values

CONSTRAINT_NUMBER

protected static final String CONSTRAINT_NUMBER

See Also:

Constant Field Values

CONSTRAINT_MINMAX

protected static final String CONSTRAINT_MINMAX

See Also:

Constant Field Values

CONSTRAINT_REGEX

protected static final String CONSTRAINT_REGEX

See Also:

Constant Field Values

CONSTRAINT_NODE_HANDLER

protected static final String CONSTRAINT_NODE_HANDLER

See Also:

Constant Field Values

CONSTRAINT_FILE_NAME_HANDLER

protected static final String CONSTRAINT_FILE_NAME_HANDLER

See Also:

Constant Field Values

CONSTRAINT_MSG_LENGTH

protected static final String CONSTRAINT_MSG_LENGTH

See Also:

Constant Field Values

CONSTRAINT_MSG_MINMAX

protected static final String CONSTRAINT_MSG_MINMAX

See Also:

Constant Field Values

CONSTRAINT_MSG_NUMBER

protected static final String CONSTRAINT_MSG_NUMBER

See Also:

Constant Field Values

CONTROL_SELECT_MANY

protected static final String CONTROL_SELECT_MANY

See Also:

Constant Field Values

CONTROL_SELECT_ONE

protected static final String CONTROL_SELECT_ONE

See Also:

Constant Field Values

CONTROL_PARAM_OPTIONS

protected static final String CONTROL_PARAM_OPTIONS

See Also:

Constant Field Values

CONTROL_PARAM_OPTION_SEPARATOR

protected static final String CONTROL_PARAM_OPTION_SEPARATOR

See Also:

Constant Field Values

MODEL_DATA

protected static final String MODEL_DATA

See Also:

Constant Field Values

MODEL_DEFINITION

protected static final String MODEL_DEFINITION

See Also:

Constant Field Values

MODEL_FIELDS

protected static final String MODEL_FIELDS

See Also:

Constant Field Values

MODEL_FORM_DATA

protected static final String MODEL_FORM_DATA

See Also:

Constant Field Values

MODEL_FORCE

protected static final String MODEL_FORCE

See Also:

Constant Field Values

MODEL_MESSAGE

protected static final String MODEL_MESSAGE

See Also:

Constant Field Values

MODEL_PROTECTED_FIELD

protected static final String MODEL_PROTECTED_FIELD

See Also:

Constant Field Values

MODEL_REPEATING

protected static final String MODEL_REPEATING

See Also:

Constant Field Values

MODEL_DEFAULT_VALUE

protected static final String MODEL_DEFAULT_VALUE

See Also:

Constant Field Values

MODEL_FORM

protected static final String MODEL_FORM

See Also:

Constant Field Values

MODEL_ERROR

protected static final String MODEL_ERROR

See Also:

Constant Field Values

MODEL_NAME

protected static final String MODEL_NAME

See Also:

Constant Field Values

MODEL_MODE

protected static final String MODEL_MODE

See Also:

Constant Field Values

MODEL_METHOD

protected static final String MODEL_METHOD

See Also:

Constant Field Values

MODEL_ENCTYPE

protected static final String MODEL_ENCTYPE

See Also:

Constant Field Values

MODEL_SUBMISSION_URL

protected static final String MODEL_SUBMISSION_URL

See Also:

Constant Field Values

MODEL_SHOW_CANCEL_BUTTON

protected static final String MODEL_SHOW_CANCEL_BUTTON

See Also:

Constant Field Values

MODEL_SHOW_RESET_BUTTON

protected static final String MODEL_SHOW_RESET_BUTTON

See Also:

Constant Field Values

MODEL_SHOW_SUBMIT_BUTTON

protected static final String MODEL_SHOW_SUBMIT_BUTTON

See Also:

Constant Field Values

MODEL_SHOW_CAPTION

protected static final String MODEL_SHOW_CAPTION

See Also:

Constant Field Values

MODEL_DESTINATION

protected static final String MODEL_DESTINATION

See Also:

Constant Field Values

MODEL_REDIRECT

protected static final String MODEL_REDIRECT

See Also:

Constant Field Values

MODEL_ARGUMENTS

protected static final String MODEL_ARGUMENTS

See Also:

Constant Field Values

MODEL_STRUCTURE

protected static final String MODEL_STRUCTURE

See Also:

Constant Field Values

MODEL_CONSTRAINTS

protected static final String MODEL_CONSTRAINTS

See Also:

Constant Field Values

MODEL_VIEW_TEMPLATE

protected static final String MODEL_VIEW_TEMPLATE

See Also:

Constant Field Values

MODEL_EDIT_TEMPLATE

protected static final String MODEL_EDIT_TEMPLATE

See Also:

Constant Field Values

MODEL_CREATE_TEMPLATE

protected static final String MODEL_CREATE_TEMPLATE

See Also:

Constant Field Values

MODEL_TYPE

protected static final String MODEL_TYPE

See Also:

Constant Field Values

MODEL_LABEL

protected static final String MODEL_LABEL

See Also:

Constant Field Values

MODEL_DESCRIPTION

protected static final String MODEL_DESCRIPTION

See Also:

Constant Field Values

MODEL_MANDATORY

protected static final String MODEL_MANDATORY

See Also:

Constant Field Values

MODEL_DATA_TYPE

protected static final String MODEL_DATA_TYPE

See Also:

Constant Field Values

MODEL_DATA_TYPE_PARAMETERS

protected static final String MODEL_DATA_TYPE_PARAMETERS

See Also:

Constant Field Values

MODEL_DATA_KEY_NAME

protected static final String MODEL_DATA_KEY_NAME

See Also:

Constant Field Values

MODEL_ENDPOINT_TYPE

protected static final String MODEL_ENDPOINT_TYPE

See Also:

Constant Field Values

MODEL_ENDPOINT_MANDATORY

protected static final String MODEL_ENDPOINT_MANDATORY

See Also:

Constant Field Values

MODEL_ENDPOINT_MANY

protected static final String MODEL_ENDPOINT_MANY

See Also:

Constant Field Values

MODEL_ENDPOINT_DIRECTION

protected static final String MODEL_ENDPOINT_DIRECTION

See Also:

Constant Field Values

MODEL_JAVASCRIPT

protected static final String MODEL_JAVASCRIPT

See Also:

Constant Field Values

MODEL_CAPABILITIES

protected static final String MODEL_CAPABILITIES

See Also:

Constant Field Values

MODEL_PARAMETERS

protected static final String MODEL_PARAMETERS

See Also:

Constant Field Values

MODEL_MAX_LENGTH

protected static final String MODEL_MAX_LENGTH

See Also:

Constant Field Values

MODEL_GROUP

protected static final String MODEL_GROUP

See Also:

Constant Field Values

MODEL_INDEX_TOKENISATION_MODE

protected static final String MODEL_INDEX_TOKENISATION_MODE

See Also:

Constant Field Values

configService

protected org.springframework.extensions.config.ConfigService configService

Constructor Detail

FormUIGet

public FormUIGet()

Method Detail

setConfigService

public void setConfigService(org.springframework.extensions.config.ConfigService configService)

Sets the ConfigService instance

Parameters:

configService -

executeImpl

protected Map<String,Object> executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req,
                             org.springframework.extensions.webscripts.Status status,
                             org.springframework.extensions.webscripts.Cache cache)

Overrides:

executeImpl in class org.springframework.extensions.webscripts.DeclarativeWebScript

generateModel

protected Map<String,Object> generateModel(String itemKind,
                               String itemId,
                               org.springframework.extensions.webscripts.WebScriptRequest request,
                               org.springframework.extensions.webscripts.Status status,
                               org.springframework.extensions.webscripts.Cache cache)

Generates the model to send to the FreeMarker engine.

Parameters:

itemKind - The form itemKind

itemId - The form itemId

request - The WebScriptRequest

status - The response status

cache - Cache control

Returns:

getParameter

protected String getParameter(org.springframework.extensions.webscripts.WebScriptRequest req,
                  String name)

Returns the named parameter.

Parameters:

req - The WebScriptRequest

name - The name of the parameter to find

Returns:

The value of the parameter or null if not found

getParameter

protected String getParameter(org.springframework.extensions.webscripts.WebScriptRequest req,
                  String name,
                  String defaultValue)

Returns the named parameter, returning the given default value if the parameter can not be found.

Parameters:

req - The WebScriptRequest

name - The name of the parameter to find

defaultValue - The default value

Returns:

The value of the parameter or the default value if the parameter is not found

getFormConfig

protected FormConfigElement getFormConfig(String itemId,
                              String formId)

Returns the form configuration for the given item id and optional form id.

Parameters:

itemId - The form itemId

formId - The id of the form to lookup

Returns:

The FormConfigElement object or null if no configuration is found

getVisibleFields

protected List<String> getVisibleFields(Mode mode,
                            FormConfigElement formConfig)

Returns the list of visible field names for the given mode.

Parameters:

mode - The form mode

formConfig - The form configuration

Returns:

List of field names configured to be visible

getVisibleFieldsInSet

protected List<String> getVisibleFieldsInSet(FormUIGet.ModelContext context,
                                 FormSet setConfig)

Returns the list of visible field names for the given set.

Parameters:

context - The context

setConfig - Set configuration

Returns:

List of field names configured to be visible for the set

retrieveFormDefinition

protected org.springframework.extensions.webscripts.connector.Response retrieveFormDefinition(String itemKind,
                                                                                  String itemId,
                                                                                  List<String> visibleFields,
                                                                                  FormConfigElement formConfig)

Retrieves the form definition from the repository FormService for the given item.

Parameters:

itemKind - The form item kind

itemId - The form item id

visibleFields - The list of field names to return or null to return all fields

formConfig - The form configuration

Returns:

Response object from the remote call

retrieveMessage

protected String retrieveMessage(String messageKey,
                     Object... args)

Retrieves a localized message string.

Parameters:

messageKey - The message key to lookup

args - Optional replacement arguments

Returns:

The localized string

generateFormDefPostBody

protected ByteArrayInputStream generateFormDefPostBody(String itemKind,
                                           String itemId,
                                           List<String> visibleFields,
                                           FormConfigElement formConfig)
                                                throws IOException

Generates the POST body to send to the FormService.

Parameters:

itemKind - The form item kind

itemId - The form item id

visibleFields - The list of field names to return or null to return all fields

formConfig - The form configuration

Returns:

ByteArrayInputStream representing the POST body

Throws:

IOException

generateFormModel

protected Map<String,Object> generateFormModel(org.springframework.extensions.webscripts.WebScriptRequest request,
                                   Mode mode,
                                   org.springframework.extensions.webscripts.connector.Response formSvcResponse,
                                   FormConfigElement formConfig)

Generates the "form" model passed to the FreeMarker engine.

Parameters:

request - The WebScriptRequest

mode - The mode of the form

formSvcResponse - Response representing the form definition

formConfig - The form configuration

Returns:

Map representing the "form" model

generateFormUIModel

protected Map<String,Object> generateFormUIModel(FormUIGet.ModelContext context)

Generates the model that will be processed by the FreeMarker engine and thus render the form UI.

Parameters:

context - The context

Returns:

Map representing the form UI model

discoverEncodingFormat

protected String discoverEncodingFormat(FormUIGet.ModelContext context)

Determines the "enctype" that should be used for the form.

Parameters:

context - The context

Returns:

The enctype the form should use

discoverSubmissionUrl

protected String discoverSubmissionUrl(FormUIGet.ModelContext context)

Determines the "submissionUrl" that should be used for the form.

Parameters:

context - The context

Returns:

The submissionUrl the form should use

getProxyPath

protected String getProxyPath(FormUIGet.ModelContext context)

Returns the base path to the proxy to use

Parameters:

context - Contains the request and context path

Returns:

The base path to the proxy to use

discoverArguments

protected Map<String,String> discoverArguments(FormUIGet.ModelContext context)

Determines the "arguments" that should be used for the form.

Parameters:

context - The context

Returns:

The arguments the form should use

discoverData

protected Map<String,Object> discoverData(FormUIGet.ModelContext context)

Determines the "data" that should be used for the form.

Parameters:

context - The context

Returns:

The data the form should use

discoverBooleanParam

protected boolean discoverBooleanParam(FormUIGet.ModelContext context,
                           String name)

Returns the value of the given boolean parameter.

Parameters:

context - The context

name - The name of the parameter

Returns:

The value of parameter, false is returned if the parameter is not found

discoverBooleanParam

protected boolean discoverBooleanParam(FormUIGet.ModelContext context,
                           String name,
                           boolean defaultValue)

Returns the value of the given boolean parameter.

Parameters:

context - The context

name - The name of the parameter

defaultValue - The default value to use if the parameter is not found

Returns:

The value of parameter, defaultValue is returned if the parameter is not found

discoverFieldDefinition

protected org.json.JSONObject discoverFieldDefinition(FormUIGet.ModelContext context,
                                          String fieldName)

Returns the field definition for the given field name.

Parameters:

context - The context

fieldName - The name of the field to get the definition for

Returns:

JSONObject representing the field definition

discoverSetLabel

protected String discoverSetLabel(FormSet setConfig)

Determines the label to use for the given set configuration.

Parameters:

setConfig - Set configuration

Returns:

The label of the set.

discoverSetMembership

protected Map<String,List<String>> discoverSetMembership(FormUIGet.ModelContext context)

Determines the set membership hierarchy.

Parameters:

context - The context

Returns:

Map of field name lists representing the set hierarchy

processCapabilities

protected void processCapabilities(FormUIGet.ModelContext context,
                       Map<String,Object> formUIModel)

Processes the "js" parameter, if present.

Parameters:

context - The context

formUIModel - The form UI model

processTemplates

protected void processTemplates(FormUIGet.ModelContext context,
                    Map<String,Object> formUIModel)

Processes the optional custom templates configuration.

Parameters:

context - The context

formUIModel - The form UI model

processFields

protected void processFields(FormUIGet.ModelContext context,
                 Map<String,Object> formUIModel)

Processes the "fields" section of the model.

Parameters:

context - The context

formUIModel - The form UI model

processVisibleFields

protected void processVisibleFields(FormUIGet.ModelContext context)

Processes the fields configured to be visible for the form.

Parameters:

context - The context

processServerFields

protected void processServerFields(FormUIGet.ModelContext context)

Processes the fields returned from the server (the form definition), this method is called when there are no visible fields configured.

Parameters:

context - The context

generateSetModelUsingVisibleFields

protected FormUIGet.Set generateSetModelUsingVisibleFields(FormUIGet.ModelContext context,
                                               FormSet setConfig)

Generates the model for the given set, this method also recursively generates any child sets the given set has. The contents of the sets are purely driven by the configured visible fields.

Parameters:

context - The context

setConfig - The set configuration

Returns:

The set model

generateSetModelUsingServerFields

protected FormUIGet.Set generateSetModelUsingServerFields(FormUIGet.ModelContext context,
                                              FormSet setConfig,
                                              Map<String,List<String>> setMembership)

Generates the model for the given set, this method also recursively generates any child sets the given set has. The contents of the sets are the result of combining the form configuration and form definition.

Parameters:

context - The context

setConfig - Set configuration

setMembership - The set hierarchy

Returns:

The set model

generateSetModel

protected FormUIGet.Set generateSetModel(FormUIGet.ModelContext context,
                             FormSet setConfig,
                             List<String> fields)

Generates the model for the given set and it's fields. This method does NOT recurse through any child sets.

Parameters:

context - The context

setConfig - The set configuration

fields - List of field in the set

Returns:

The set model

generateDefaultSetModelUsingServerFields

protected FormUIGet.Set generateDefaultSetModelUsingServerFields(FormUIGet.ModelContext context)

Generates the model for the default set, this will contain all the fields returned from the server.

Parameters:

context - The context

Returns:

The set model

generateFieldModel

protected FormUIGet.Field generateFieldModel(FormUIGet.ModelContext context,
                                 String fieldName,
                                 FormField fieldConfig)

Generates the model for the given field. The form definition from the form service and the given form configuration are combined to give the field model to send to the template for rendering.

Parameters:

context - The context

fieldName - The name of the field to be generated

fieldConfig - The configuration for the field

Returns:

A field model

isFieldAmbiguous

protected boolean isFieldAmbiguous(FormUIGet.ModelContext context,
                       String fieldName)

Determines whether the given field is ambiguous (a property and association have the same name).

Parameters:

context - The context

fieldName - The name of the field

Returns:

true if the field is ambiguous

generateTransientFieldModel

protected FormUIGet.Field generateTransientFieldModel(String fieldName,
                                          String template)

Generates a model for a "transient" field.

Parameters:

fieldName - The name of the field

template - The control template to use

Returns:

The field model

generateTransientFieldModel

protected FormUIGet.Field generateTransientFieldModel(FormUIGet.ModelContext context,
                                          String fieldName,
                                          org.json.JSONObject fieldDefinition,
                                          FormField fieldConfig)
                                               throws org.json.JSONException

Generates a model for a "transient" field.

Parameters:

context - The context

fieldName - The name of the field to be added

Returns:

The field model

Throws:

org.json.JSONException

processFieldIdentification

protected void processFieldIdentification(FormUIGet.ModelContext context,
                              FormUIGet.Field field,
                              org.json.JSONObject fieldDefinition,
                              FormField fieldConfig)
                                   throws org.json.JSONException

Processes the identification part of the field model.

Parameters:

context - The context

field - The field to be processed

fieldDefinition - The definition of the field to be processed

fieldConfig - The configuration of the field to be processed

Throws:

org.json.JSONException

processFieldState

protected void processFieldState(FormUIGet.ModelContext context,
                     FormUIGet.Field field,
                     org.json.JSONObject fieldDefinition,
                     FormField fieldConfig)
                          throws org.json.JSONException

Processes the "state" part of the field model i.e. disabled, mandatory

Parameters:

context - The context

field - The field to be processed

fieldDefinition - The definition of the field to be processed

fieldConfig - The configuration of the field to be processed

Throws:

org.json.JSONException

processFieldText

protected void processFieldText(FormUIGet.ModelContext context,
                    FormUIGet.Field field,
                    org.json.JSONObject fieldDefinition,
                    FormField fieldConfig)
                         throws org.json.JSONException

Processes the "text" part of the field model i.e. label, description, help

Parameters:

context - The context

field - The field to be processed

fieldDefinition - The definition of the field to be processed

fieldConfig - The configuration of the field to be processed

Throws:

org.json.JSONException

processFieldData

protected void processFieldData(FormUIGet.ModelContext context,
                    FormUIGet.Field field,
                    org.json.JSONObject fieldDefinition,
                    FormField fieldConfig)
                         throws org.json.JSONException

Processes the "data" part of the field model.

Parameters:

context - The context

field - The field to be processed

fieldDefinition - The definition of the field to be processed

fieldConfig - The configuration of the field to be processed

Throws:

org.json.JSONException

processFieldConstraints

protected void processFieldConstraints(FormUIGet.ModelContext context,
                           FormUIGet.Field field,
                           org.json.JSONObject fieldDefinition,
                           FormField fieldConfig)
                                throws org.json.JSONException

Processes the constraints for the field. NOTE: This method MUST be called with the Field object having it's identification, state and text already processed.

Parameters:

context - The context

field - The field to be processed

fieldDefinition - The definition of the field to be processed

fieldConfig - The configuration of the field to be processed

Throws:

org.json.JSONException

generateConstraintModel

protected FormUIGet.Constraint generateConstraintModel(FormUIGet.ModelContext context,
                                           FormUIGet.Field field,
                                           org.json.JSONObject fieldDefinition,
                                           FormField fieldConfig,
                                           String constraintId)
                                                throws org.json.JSONException

Generates the model for a single constraint.

Parameters:

context - The context

field - The field to be processed

fieldDefinition - The definition of the field to be processed

fieldConfig - The configuration of the field to be processed

constraintId - The constraint identifier

Returns:

Throws:

org.json.JSONException

generateConstraintModel

protected FormUIGet.Constraint generateConstraintModel(FormUIGet.ModelContext context,
                                           FormUIGet.Field field,
                                           org.json.JSONObject fieldDefinition,
                                           FormField fieldConfig,
                                           org.json.JSONObject constraintDefinition)
                                                throws org.json.JSONException

Generates the model for a single constraint.

Parameters:

context - The context

field - The field to be processed

fieldDefinition - The definition of the field to be processed

fieldConfig - The configuration of the field to be processed

constraintDefinition - The constraint definition

Returns:

Throws:

org.json.JSONException

generateConstraintModel

protected FormUIGet.Constraint generateConstraintModel(FormUIGet.ModelContext context,
                                           FormUIGet.Field field,
                                           FormField fieldConfig,
                                           String constraintId,
                                           org.json.JSONObject constraintParams,
                                           ConstraintHandlerDefinition defaultConstraintConfig)
                                                throws org.json.JSONException

Generates the model for a single constraint.

Parameters:

context - The context

field - The field to be processed

fieldConfig - The configuration of the field to be processed

constraintId - The constraint identifier

constraintParams - The constraint parameters

defaultConstraintConfig -

Returns:

The constraint moel

Throws:

org.json.JSONException

processFieldConstraintControl

protected void processFieldConstraintControl(FormUIGet.ModelContext context,
                                 FormUIGet.Field field,
                                 FormField fieldConfig,
                                 FormUIGet.Constraint constraint)
                                      throws org.json.JSONException

Processes the given constraint to ensure the field's control adheres to the constraint.

Parameters:

context - The context

field - The field to be processed

fieldConfig - The configuration of the field to be processed

constraint - The constraint

Throws:

org.json.JSONException

processFieldConstraintHelp

protected void processFieldConstraintHelp(FormUIGet.ModelContext context,
                              FormUIGet.Field field,
                              FormField fieldConfig,
                              FormUIGet.Constraint constraint)
                                   throws org.json.JSONException

Processes the given constraint to add help text to the field's control if relevant.

Parameters:

context - The context

field - The field to be processed

fieldConfig - The configuration of the field to be processed

constraint - The constraint

Throws:

org.json.JSONException

processFieldControl

protected void processFieldControl(FormUIGet.ModelContext context,
                       FormUIGet.Field field,
                       org.json.JSONObject fieldDefinition,
                       FormField fieldConfig)
                            throws org.json.JSONException

Processes the control for the field.

Parameters:

context - The context

field - The field to be processed

fieldDefinition - The definition of the field to be processed

fieldConfig - The configuration of the field to be processed

Throws:

org.json.JSONException

processFieldContent

protected void processFieldContent(FormUIGet.ModelContext context,
                       FormUIGet.Field field,
                       org.json.JSONObject fieldDefinition,
                       FormField fieldConfig)
                            throws org.json.JSONException

Processes the field for content. This method is used when a content field is being used in a form where JavaScript is disabled and thus AJAX is unavailable to retrieve the content, it must therefore be done server side.

Parameters:

context - The context

field - The field to be processed

fieldDefinition - The definition of the field to be processed

fieldConfig - The configuration of the field to be processed

Throws:

org.json.JSONException

generateErrorModel

protected Map<String,Object> generateErrorModel(org.springframework.extensions.webscripts.connector.Response errorResponse)

Generates the "error" model used when an error occurs.

Parameters:

errorResponse - Response object representing the error

Returns:

The "error" model

generateErrorModel

protected Map<String,Object> generateErrorModel(org.springframework.extensions.webscripts.connector.Response errorResponse,
                                    String errorKey)

Generates the "error" model used when an error occurs.

Parameters:

errorResponse - Response object representing the error

errorKey -

Returns:

The "error" model

dumpFormUIModel

protected void dumpFormUIModel(Map<String,Object> model)

Dumps the given form UI model to debug output (when debug is enabled).

Parameters:

model - The form UI model to dump

dumpMap

protected String dumpMap(Map<String,Object> map,
             String indent)