Package org.alfresco.repo.forms

Class FormData

java.lang.Object

org.alfresco.repo.forms.FormData

All Implemented Interfaces:

Iterable<FormData.FieldData>

public class FormData
extends Object
implements Iterable<FormData.FieldData>

Represents the data going to or coming from a Form.

Author:

Gavin Cornwell

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FormData.FieldData	Inner class to represent the value of a field on a form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,FormData.FieldData>	data

Constructor Summary

Constructors

Constructor	Description
FormData()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	addFieldData(String fieldName, Object fieldValue)	Adds the given data to the form.
void	addFieldData(String fieldName, Object fieldValue, boolean overwrite)	Adds the given data to the form.
void	addFieldData(org.springframework.extensions.webscripts.servlet.FormData.FormField field)	Adds the given webscript FormField object to the form.
FormData.FieldData	getFieldData(String fieldName)	Returns the data for the given field.
Set<String>	getFieldNames()	Returns a list of the names of the fields held by this object.
int	getNumberOfFields()	Returns the number of fields data is being held for.
boolean	hasFieldData(String fieldName)	Determines whether field data for the given item exists.
Iterator<FormData.FieldData>	iterator()	Returns an Iterator over the FieldData objects held by this object.
void	removeFieldData(String fieldName)	Removes the data associated with the given field if it exists.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

data

protected Map<String,FormData.FieldData> data

Constructor Detail

FormData

public FormData()

Default constructor

Method Detail

hasFieldData

public boolean hasFieldData(String fieldName)

Determines whether field data for the given item exists.

Parameters:

fieldName - Name of field to look for

Returns:

true if the field exists, false otherwise

getFieldData

public FormData.FieldData getFieldData(String fieldName)

Returns the data for the given field.

Parameters:

fieldName - Name of field to look for

Returns:

FieldData object representing the data for the field or null if it doesn't exist

addFieldData

public void addFieldData(String fieldName,
                         Object fieldValue)

Adds the given data to the form.

NOTE: Adding the same named data will append the value and thereafter return a List containing all added values.

Parameters:

fieldName - The name of the field

fieldValue - The value of the data

addFieldData

public void addFieldData(org.springframework.extensions.webscripts.servlet.FormData.FormField field)

Adds the given webscript FormField object to the form.

Parameters:

field - A WebScript FormField object

addFieldData

public void addFieldData(String fieldName,
                         Object fieldValue,
                         boolean overwrite)

Adds the given data to the form. If data for the field is already present the behaviour is controlled by the overwrite property.

If overwrite is true the provided value replaces the existing value whereas false will force the creation of a List (if necessary) and the provided value will be added to the List.

Parameters:

fieldName - The name of the field

fieldValue - The value of the data

overwrite - boolean

removeFieldData

public void removeFieldData(String fieldName)

Removes the data associated with the given field if it exists.

Parameters:

fieldName - Name of the field to remove

getFieldNames

public Set<String> getFieldNames()

Returns a list of the names of the fields held by this object.

Returns:

List of String objects

getNumberOfFields

public int getNumberOfFields()

Returns the number of fields data is being held for.

Returns:

Number of fields

iterator

public Iterator<FormData.FieldData> iterator()

Returns an Iterator over the FieldData objects held by this object.

Specified by:

iterator in interface Iterable<FormData.FieldData>

Returns:

Iterator of FieldData

toString

public String toString()

Overrides:

toString in class Object