Package org.ametys.plugins.forms.table

Class FormTableManager

java.lang.Object

org.ametys.plugins.forms.table.FormTableManager

All Implemented Interfaces:

Component, Serviceable

public class FormTableManager
extends Object
implements Component, Serviceable

Class that handles creation and deletion of a table used by a form.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREATION_DATE_FIELD	Creation date field name.
static final String	FILE_NAME_COLUMN_SUFFIX	Suffix for filename column.
static final String	FORMS_POOL_CONFIG_PARAM	The id of the configuration parameter used for the forms' datasource
static final String	ID_FIELD	ID field name.
static final String	LOGIN_FIELD	Current user login field name.
static final String	POPULATION_ID_FIELD	Current user population id field name.
static final String	ROLE	Avalon Role
static final int	TABLE_CREATED_AND_UP_TO_DATE	Constant for table state
static final int	TABLE_CREATED_BUT_NEED_UPDATE	Constant for table state
static final int	TABLE_NOT_CREATED	Constant for table state
static final String	TABLE_PREFIX	Prefix for database tables
static final int	TABLE_UNKOWN_STATUS	Constant for table state
static final String	WORKFLOW_ID_FIELD	Workflow id column name.

Constructor Summary

Constructors

Constructor	Description
FormTableManager()

Method Summary

Modifier and Type	Method	Description
protected String	_getColumnType(int sqlType, String dbType)	Get the full column type corresponding to the database type (with precision).
protected String	_getColumnTypeName(int sqlType, String dbType)	Get the column type name (without precision) corresponding to the SQL type.
protected UserEntry	_getUserEntryFromResultSet(ResultSet rs, Form form, Map<String,FieldValue> columns, String dbType)	Get a user entry from a result set
protected boolean	_isSameType(org.ametys.plugins.forms.table.FormTableManager.DbColumn column, FieldValue newColumn, String dbType)	Test if two columns have the same type.
void	addWorkflowIdColumn(String formId)	Add a workflow id column to the given table
void	clearEntries(String siteName, List<String> formIds)	Clear all entries of the forms corresponding to the given list of ids.
boolean	createTable(Form form)	Create database table to store results of content forms
void	deleteEntry(String siteName, String formId, List<Integer> entries)	Delete a list of entries of a form
boolean	dropTable(String table)	Drop the table by its name
void	dropWorkflowIdColumn(String formId)	Delete the workflow id column of the given table
List<Map<String,Object>>	getColumns(String siteName, String formId)	Get the columns information of a form
Map<String,FieldValue>	getColumns(Form form)	Form to tableinfo.
List<Map<String,Object>>	getContentForms(List<String> contentIds, String currentLanguage)	Get the forms of contents
static int	getFieldSqlType(Field.FieldType fieldType)	Get the SQL type corresponding to a field type.
Map<String,String>	getSelectStatement(String siteName, String formId)	Get the SELECT statement for retrieving the form entries from the database.
UserEntry	getSubmission(Form form, Map<String,FieldValue> columns, Integer entryId)	Get the submission for a form.
List<UserEntry>	getSubmissions(Form form, Map<String,FieldValue> columns, int offset, int length, List<Integer> entryIds)	Get all the submissions for a form.
List<String>	getTableNames()	Get all the table names
int	getTotalSubmissions(String formId)	Get the total count of submissions for a form.
List<Answer>	getUserAnwsers(List<Form> forms, UserIdentity user)	Get the user answers from a list of forms
List<Integer>	getWorkflowIds(String formId, Integer entryId)	Get the workflow id of the given form entry or of all the entries
boolean	hasWorkflowIdColumn(String formId)	Does the given form have a workflow id column in its SQL table ?
void	removeTables(List<String> tableNames)	Remove a list of tables
void	service(ServiceManager smanager)
void	setWorkflowId(Form form, long entryId, long newWorkflowId)	Set a new workflow id to the column that has the given old workflow id

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

FORMS_POOL_CONFIG_PARAM

public static final String FORMS_POOL_CONFIG_PARAM

The id of the configuration parameter used for the forms' datasource

See Also:

• Constant Field Values

TABLE_PREFIX

public static final String TABLE_PREFIX

Prefix for database tables

See Also:

• Constant Field Values

ID_FIELD

public static final String ID_FIELD

ID field name.

See Also:

• Constant Field Values

CREATION_DATE_FIELD

public static final String CREATION_DATE_FIELD

Creation date field name.

See Also:

• Constant Field Values

LOGIN_FIELD

public static final String LOGIN_FIELD

Current user login field name.

See Also:

• Constant Field Values

POPULATION_ID_FIELD

public static final String POPULATION_ID_FIELD

Current user population id field name.

See Also:

• Constant Field Values

WORKFLOW_ID_FIELD

public static final String WORKFLOW_ID_FIELD

Workflow id column name.

See Also:

• Constant Field Values

FILE_NAME_COLUMN_SUFFIX

public static final String FILE_NAME_COLUMN_SUFFIX

Suffix for filename column.

See Also:

• Constant Field Values

TABLE_CREATED_AND_UP_TO_DATE

public static final int TABLE_CREATED_AND_UP_TO_DATE

Constant for table state

See Also:

• Constant Field Values

TABLE_CREATED_BUT_NEED_UPDATE

public static final int TABLE_CREATED_BUT_NEED_UPDATE

Constant for table state

See Also:

• Constant Field Values

TABLE_NOT_CREATED

public static final int TABLE_NOT_CREATED

Constant for table state

See Also:

• Constant Field Values

TABLE_UNKOWN_STATUS

public static final int TABLE_UNKOWN_STATUS

Constant for table state

See Also:

• Constant Field Values

Constructor Details

FormTableManager

public FormTableManager()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

createTable

public boolean createTable(Form form)

Create database table to store results of content forms

Parameters:

form - informations used to create table

Returns:

true if the table was created false else

dropTable

public boolean dropTable(String table)

Drop the table by its name

Parameters:

table - the name of the table to drop

Returns:

true if the table was dropped, false otherwise

getTableNames

public List<String> getTableNames()

Get all the table names

Returns:

the list of all the forms' table names

getUserAnwsers

public List<Answer> getUserAnwsers(List<Form> forms,
 UserIdentity user)
                            throws FormsException

Get the user answers from a list of forms

Parameters:

forms - the list of forms

user - the user

Returns:

the list of common answer

Throws:

FormsException - if an forms error occurred

getSubmissions

public List<UserEntry> getSubmissions(Form form,
 Map<String,FieldValue> columns,
 int offset,
 int length,
 List<Integer> entryIds)
                               throws FormsException

Get all the submissions for a form.

Parameters:

form - the form object.

columns - the columns

offset - The number of results to ignore.

length - The maximum number of results to return

entryIds - the ids of the submissions to retrieve

Returns:

the list of submissions.

Throws:

FormsException - if an error occurs.

getSubmission

public UserEntry getSubmission(Form form,
 Map<String,FieldValue> columns,
 Integer entryId)
                        throws FormsException

Get the submission for a form.

Parameters:

form - the form object.

columns - the columns

entryId - the id of the submission to retrieve

Returns:

the submission.

Throws:

FormsException - if an error occurs.

_getUserEntryFromResultSet

protected UserEntry _getUserEntryFromResultSet(ResultSet rs,
 Form form,
 Map<String,FieldValue> columns,
 String dbType)
                                        throws SQLException,
IOException

Get a user entry from a result set

Parameters:

rs - the result set

form - the form

columns - the columns

dbType - the db type

Returns:

the user entry

Throws:

SQLException - if a sql error occurred

IOException - is a io error occurred

getTotalSubmissions

public int getTotalSubmissions(String formId)
                        throws FormsException

Get the total count of submissions for a form.

Parameters:

formId - the id of the form

Returns:

the total count of submissions, or -1 if an error occurs.

Throws:

FormsException - if an error occurs.

getContentForms

public List<Map<String,Object>> getContentForms(List<String> contentIds,
 String currentLanguage)
                                         throws FormsException,
URISyntaxException

Get the forms of contents

Parameters:

contentIds - The ids of contents

currentLanguage - The current language

Returns:

The forms

Throws:

FormsException - if an error occurred while getting content' form

URISyntaxException - if an error occurred when URL encoding form's label

getColumns

public List<Map<String,Object>> getColumns(String siteName,
 String formId)
                                    throws FormsException

Get the columns information of a form

Parameters:

siteName - The site name

formId - the identifier of form

Returns:

The columns

Throws:

FormsException - if an error occurred

removeTables

public void removeTables(List<String> tableNames)
                  throws FormsException

Remove a list of tables

Parameters:

tableNames - the names of the tables to delete

Throws:

FormsException - if the drop of the tables is not successful

getColumns

public Map<String,FieldValue> getColumns(Form form)

Form to tableinfo.

Parameters:

form - the form.

Returns:

the tableinfo.

_getColumnType

protected String _getColumnType(int sqlType,
 String dbType)

Get the full column type corresponding to the database type (with precision).

Parameters:

sqlType - the sqltype value.

dbType - the database type.

Returns:

the real column type identifier (to be included in CREATE statement).

_getColumnTypeName

protected String _getColumnTypeName(int sqlType,
 String dbType)

Get the column type name (without precision) corresponding to the SQL type.

Parameters:

sqlType - the SQL type value.

dbType - the database type.

Returns:

the real column type name (without precision).

_isSameType

protected boolean _isSameType(org.ametys.plugins.forms.table.FormTableManager.DbColumn column,
 FieldValue newColumn,
 String dbType)

Test if two columns have the same type.

Parameters:

column - the column retrieved from the database.

newColumn - the new column.

dbType - the database type.

Returns:

true if the two columns have the same type.

getFieldSqlType

public static int getFieldSqlType(Field.FieldType fieldType)

Get the SQL type corresponding to a field type.

Parameters:

fieldType - the field

Returns:

the sql type as indicated in Types.

addWorkflowIdColumn

public void addWorkflowIdColumn(String formId)
                         throws FormsException

Add a workflow id column to the given table

Parameters:

formId - the id of the form to alter

Throws:

FormsException - if an error occurs

dropWorkflowIdColumn

public void dropWorkflowIdColumn(String formId)
                          throws FormsException

Delete the workflow id column of the given table

Parameters:

formId - the id of the form to alter

Throws:

FormsException - if an error occurs

setWorkflowId

public void setWorkflowId(Form form,
 long entryId,
 long newWorkflowId)
                   throws FormsException

Set a new workflow id to the column that has the given old workflow id

Parameters:

form - the form

entryId - the id of the entry

newWorkflowId - the new workflow id

Throws:

FormsException - if an error occurs

getWorkflowIds

public List<Integer> getWorkflowIds(String formId,
 Integer entryId)
                             throws FormsException

Get the workflow id of the given form entry or of all the entries

Parameters:

formId - the id of the form

entryId - the entry to get the workflow id from. If null, all the workflow ids are returned

Returns:

the list of workflow ids

Throws:

FormsException - if an error occurs.

hasWorkflowIdColumn

public boolean hasWorkflowIdColumn(String formId)
                            throws SQLException

Does the given form have a workflow id column in its SQL table ?

Parameters:

formId - the id of the form

Returns:

true if the form has a workflow id column, false otherwise

Throws:

SQLException - if a database access error occurs

deleteEntry

public void deleteEntry(String siteName,
 String formId,
 List<Integer> entries)
                 throws ProcessingException,
FormsException

Delete a list of entries of a form

Parameters:

siteName - The site name

formId - The form id

entries - The list of entries to delete

Throws:

ProcessingException - if the given parameters are wrong

FormsException - if an error occurs when deleting the form submission

clearEntries

public void clearEntries(String siteName,
 List<String> formIds)
                  throws ProcessingException,
FormsException

Clear all entries of the forms corresponding to the given list of ids.

Parameters:

siteName - the name of the site.

formIds - the list of form ids

Throws:

ProcessingException - if an error occurs.

FormsException - if an error occurs.

getSelectStatement

public Map<String,String> getSelectStatement(String siteName,
 String formId)
                                      throws ProcessingException

Get the SELECT statement for retrieving the form entries from the database.

Parameters:

siteName - The site name

formId - The form id

Returns:

A result map with the SQL query and the table name

Throws:

ProcessingException - if the given parameters are wrong