Package org.silverpeas.core.contribution.content.form.record

Class GenericRecordTemplate

java.lang.Object

org.silverpeas.core.contribution.content.form.record.GenericRecordTemplate

All Implemented Interfaces:

Serializable, RecordTemplate

public class GenericRecordTemplate
extends Object
implements RecordTemplate, Serializable

A GenericRecordTemplate is the template for all of the GenericDataRecords. It uses a map in which each field name is mapped to an indexed field template.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GenericRecordTemplate()	The default constructor.

Method Summary

Modifier and Type	Method	Description
void	addFieldTemplate(FieldTemplate fieldTemplate)	Adds a new field template at the end of this record template.
boolean	checkDataRecord(DataRecord record)	Checks the specified DataRecord instance matches this template.
DataRecord	getEmptyRecord()	Gets an empty DataRecord built on this template.
int	getFieldIndex(String fieldName)	Gets the index in this template of of the named field.
List<FieldTemplate>	getFieldList()	Gets all the templates modelling each of them a field of a DataRecord.
String[]	getFieldNames()	Gets all the field names of the DataRecords built on this template.
FieldTemplate	getFieldTemplate(String fieldName)	Gets the FieldTemplate modelling the specified named field.
FieldTemplate[]	getFieldTemplates()	Gets all the fields defined by this template.
void	setTemplateName(String templateName)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericRecordTemplate

public GenericRecordTemplate()

The default constructor. It builds an empty template.

Method Detail

getFieldList

public List<FieldTemplate> getFieldList()

Gets all the templates modelling each of them a field of a DataRecord.

Returns:

a list of FieldTemplates.

addFieldTemplate

public void addFieldTemplate(FieldTemplate fieldTemplate)

Adds a new field template at the end of this record template.

Parameters:

fieldTemplate - the template of a field.

getFieldNames

public String[] getFieldNames()

Description copied from interface: RecordTemplate

Gets all the field names of the DataRecords built on this template.

Specified by:

getFieldNames in interface RecordTemplate

Returns:

an array with the name of the fields defined by this template.

getFieldTemplates

public FieldTemplate[] getFieldTemplates()

Description copied from interface: RecordTemplate

Gets all the fields defined by this template.

Specified by:

getFieldTemplates in interface RecordTemplate

Returns:

an array of FieldTemplate instances, each of them being a template of a DataRecord field.

getFieldTemplate

public FieldTemplate getFieldTemplate(String fieldName)
                               throws FormException

Description copied from interface: RecordTemplate

Gets the FieldTemplate modelling the specified named field.

Specified by:

getFieldTemplate in interface RecordTemplate

Parameters:

fieldName - the name of a field

Returns:

a FieldTemplate instance or null if there is no such template.

Throws:

FormException - if the template of the specified named field cannot be got.

getFieldIndex

public int getFieldIndex(String fieldName)
                  throws FormException

Description copied from interface: RecordTemplate

Gets the index in this template of of the named field.

Specified by:

getFieldIndex in interface RecordTemplate

Parameters:

fieldName - the name of a field.

Returns:

the index of the named field in this template or -1 if no template of this field can be found.

Throws:

FormException - if the template of the specified named field cannot be got.

getEmptyRecord

public DataRecord getEmptyRecord()
                          throws FormException

Description copied from interface: RecordTemplate

Gets an empty DataRecord built on this template.

Specified by:

getEmptyRecord in interface RecordTemplate

Returns:

an empty DataRecord instance.

Throws:

FormException

checkDataRecord

public boolean checkDataRecord(DataRecord record)

Description copied from interface: RecordTemplate

Checks the specified DataRecord instance matches this template.

Specified by:

checkDataRecord in interface RecordTemplate

Parameters:

record - a DataRecord object.

Returns:

true if the data record is built on this template and all the constraints are satisfied.

setTemplateName

public void setTemplateName(String templateName)