Package org.ametys.cms.form

Class Form

java.lang.Object

org.ametys.cms.form.Form

Direct Known Subclasses:

RepeaterField.RepeaterEntry

public class Form
extends Object

Abstraction of the form submitted by the client.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,MetadataComment[]>	_comments
private Map<String,Object>	_fields

Constructor Summary

Constructors

Constructor	Description
Form()

Method Summary

Modifier and Type	Method	Description
BinaryField	getBinaryField(String fieldName)	Returns the named field's value as BinaryField.
SimpleField<Boolean>	getBooleanArray(String fieldName)	Returns the named field's value as boolean array.
MetadataComment[]	getCommentArray(String metadataName)	Return the array of comments for the named field.
Form	getCompositeField(String fieldName)	Returns the named field's value as Form.
SimpleField<Content>	getContentArray(String fieldName)	Returns the named field's value as a content array.
SimpleField<Date>	getDateArray(String fieldName)	Returns the named field's value as Date array.
SimpleField<Double>	getDoubleArray(String fieldName)	Returns the named field's value as double array.
ExternalizableField	getExternalizableField(String fieldName)	Returns the named field's value as a ExternalizableField
AbstractField	getField(String fieldName)	Get a non-typed field.
Set<String>	getFieldNames()	Returns an array containing field names.
SimpleField<Long>	getLongArray(String fieldName)	Returns the named field's value as long array.
SimpleField<MultilingualString>	getMultilingualStringArray(String fieldName)	Returns the named field's value as MultilingualString array.
ReferenceField	getReferenceField(String fieldName)	Returns the named field's value as ReferenceField.
RepeaterField	getRepeaterField(String fieldName)	Returns the named field's value as RepeaterField.
RichTextField	getRichTextField(String fieldName)	Returns the named field's value as RichTextField.
SimpleField<String>	getStringArray(String fieldName)	Returns the named field's value as String array.
SubContentField	getSubContentField(String fieldName)	Returns the named field's value as SubContentField.
SimpleField<UserIdentity>	getUserArray(String fieldName)	Returns the named field's value as UserIdentity array.
void	setCommentsField(String fieldName, MetadataComment[] comments)	Set the comment of a field
void	setCompositeField(String fieldName, Form compositeField)	Set a composite field.
void	setField(String fieldName, AbstractField values)	Set a multi-valued date field.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_fields

private final Map<String,Object> _fields

_comments

private final Map<String,MetadataComment[]> _comments

Constructor Detail

Form

public Form()

Method Detail

getFieldNames

public Set<String> getFieldNames()

Returns an array containing field names.

Returns:

an array containing field names.

getCompositeField

public Form getCompositeField(String fieldName)

Returns the named field's value as Form.

Parameters:

fieldName - the field name.

Returns:

the field value as Form.

setCompositeField

public void setCompositeField(String fieldName,
                              Form compositeField)

Set a composite field.

Parameters:

fieldName - the field name.

compositeField - the composite field.

getRepeaterField

public RepeaterField getRepeaterField(String fieldName)

Returns the named field's value as RepeaterField.

Parameters:

fieldName - the field name.

Returns:

the field value as RepeaterField.

getRichTextField

public RichTextField getRichTextField(String fieldName)

Returns the named field's value as RichTextField.

Parameters:

fieldName - the field name.

Returns:

the field value as RichText.

getBinaryField

public BinaryField getBinaryField(String fieldName)

Returns the named field's value as BinaryField.

Parameters:

fieldName - the field name.

Returns:

the field value as a BinaryField.

getSubContentField

public SubContentField getSubContentField(String fieldName)

Returns the named field's value as SubContentField.

Parameters:

fieldName - the field name.

Returns:

the field value as a SubContentField.

getReferenceField

public ReferenceField getReferenceField(String fieldName)

Returns the named field's value as ReferenceField.

Parameters:

fieldName - the field name.

Returns:

the field value as a ReferenceField.

getStringArray

public SimpleField<String> getStringArray(String fieldName)

Returns the named field's value as String array.

Parameters:

fieldName - the field name.

Returns:

field value as String array.

getDateArray

public SimpleField<Date> getDateArray(String fieldName)

Returns the named field's value as Date array.

Parameters:

fieldName - the field name.

Returns:

field value as Date array.

getLongArray

public SimpleField<Long> getLongArray(String fieldName)

Returns the named field's value as long array.

Parameters:

fieldName - the field name.

Returns:

field value as long array.

getDoubleArray

public SimpleField<Double> getDoubleArray(String fieldName)

Returns the named field's value as double array.

Parameters:

fieldName - the field name.

Returns:

field value as double array.

getBooleanArray

public SimpleField<Boolean> getBooleanArray(String fieldName)

Returns the named field's value as boolean array.

Parameters:

fieldName - the field name.

Returns:

field value as boolean array.

getUserArray

public SimpleField<UserIdentity> getUserArray(String fieldName)

Returns the named field's value as UserIdentity array.

Parameters:

fieldName - the field name.

Returns:

field value as UserIdentity array.

getMultilingualStringArray

public SimpleField<MultilingualString> getMultilingualStringArray(String fieldName)

Returns the named field's value as MultilingualString array.

Parameters:

fieldName - the field name.

Returns:

field value as UserIdentity array.

getContentArray

public SimpleField<Content> getContentArray(String fieldName)

Returns the named field's value as a content array.

Parameters:

fieldName - the field name.

Returns:

the field value as a content array.

getExternalizableField

public ExternalizableField getExternalizableField(String fieldName)

Returns the named field's value as a ExternalizableField

Parameters:

fieldName - the field name.

Returns:

the externalizable field

setField

public void setField(String fieldName,
                     AbstractField values)

Set a multi-valued date field.

Parameters:

fieldName - the field name.

values - the Date array containing values of this field.

getField

public AbstractField getField(String fieldName)

Get a non-typed field.

Parameters:

fieldName - The name of the field

Returns:

The desired field or null

getCommentArray

public MetadataComment[] getCommentArray(String metadataName)

Return the array of comments for the named field.

Parameters:

metadataName - the field name.

Returns:

the array of comments

setCommentsField

public void setCommentsField(String fieldName,
                             MetadataComment[] comments)

Set the comment of a field

Parameters:

fieldName - The field name

comments - The array of metadata comments

toString

public String toString()

Overrides:

toString in class Object