Package overit.geocallapp.wfm.core.bl.datacollection.converter.template.structure.node

Class DataCollectionNodeConverter

java.lang.Object

overit.geocallapp.wfm.core.bl.datacollection.converter.template.structure.node.DataCollectionNodeConverter

Direct Known Subclasses:

DataCollectionAttachmentToAttachmentNodeConverter, DataCollectionBarcodeToBarcodeNodeConverter, DataCollectionBooleanToBooleanNodeConverter, DataCollectionComboboxToSelectionNodeConverter, DataCollectionCoordinatesToCoordinateNodeConverter, DataCollectionDateToDateNodeConverter, DataCollectionDiscardNodeConverter, DataCollectionDoubleToDoubleNodeConverter, DataCollectionEuroToDoubleNodeConverter, DataCollectionNodeToSectionNodeConverter, DataCollectionNumberToLongNodeConverter, DataCollectionOptionalNodeToSectionNodeConverter, DataCollectionPersonalizedFormatToRegExNodeConverter, DataCollectionQuestionsGroupToSectionNodeConverter, DataCollectionSignatureToSignatureNodeConverter, DataCollectionTimeToTimeNodeConverter, DataCollectionVarcharToTextNodeConverter

public abstract class DataCollectionNodeConverter
extends Object

This class is the base for the node converters. It manages the DataCollectionNodeProperties and the mandatory field of DataCollectionNodeExpressions.
All node converter are added to the DataCollectionNodeConverterBucket and associated to the node type they convert.
This is the class to extend to build a custom Node Converter.

Since:

13.0

Constructor Summary

Constructors

Constructor	Description
DataCollectionNodeConverter()

Method Summary

Modifier and Type	Method	Description
DataCollectionNodeConversionResult	convert(overit.geocallapp.wfm.survey.template.TemplateTree currentNode)	Main method to call to convert an old TemplateTree into a new DataCollectionNode.
protected abstract DataCollectionNodeConversionResult	convertBody(overit.geocallapp.wfm.survey.template.TemplateTree currentNode, DataCollectionNodeConversionResult conversionResult)	Contains the logic to convert specific node characteristics.
protected DataCollectionNodeConversionResult	getDataCollectionNodeConversionResult(DataCollectionNode newNode)	Get the DataCollectionNodeConversionResult starting from the newNode.
protected LocalizedString	getLocalizedField(String description)	Create a LocalizedString starting from input string
protected LocalizedString	getLocalizedField(overit.geocallapp.wfm.survey.template.TemplateTree currentNode, String fieldName, String code)	Create a LocalizedString copying old values divided by language.
protected String	getStackTrace(Exception e)	Convert an exception to a string.
protected DataCollectionNode	initNode(overit.geocallapp.wfm.survey.template.TemplateTree currentNode, DataCollectionNodeConversionResult conversionResult)	Initialize the new node with DataCollectionNodeProperties and mandatory and initial value fields of DataCollectionNodeExpressions.
protected void	loadDefaultFields(overit.geocallapp.wfm.survey.template.TemplateTree currentNode, StringBuilder sbNote)	Add the Value class, Value, Feature class and Featurevalues to the notes.
protected abstract void	setInitialValue(DataCollectionNode newNode, HashGetter data)	Contains the logic to transform the old default value into the new initial value.

Methods inherited from class java.lang.Object

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

Constructor Details

DataCollectionNodeConverter

public DataCollectionNodeConverter()

Method Details

convertBody

protected abstract DataCollectionNodeConversionResult convertBody(overit.geocallapp.wfm.survey.template.TemplateTree currentNode,
 DataCollectionNodeConversionResult conversionResult)
                                                           throws DataCollectionInitialValueException

Contains the logic to convert specific node characteristics.

Parameters:

currentNode - the old node

conversionResult - the DataCollectionNodeConversionResult to populate

Returns:

the conversion result DataCollectionNodeConversionResult

Throws:

DataCollectionInitialValueException

setInitialValue

protected abstract void setInitialValue(DataCollectionNode newNode,
 HashGetter data)

Contains the logic to transform the old default value into the new initial value. If no default value where present this method does nothing.

Parameters:

newNode - the new node

data - old node data

convert

public DataCollectionNodeConversionResult convert(overit.geocallapp.wfm.survey.template.TemplateTree currentNode)

Main method to call to convert an old TemplateTree into a new DataCollectionNode.

Parameters:

currentNode - the old node

Returns:

the conversion result

initNode

protected DataCollectionNode initNode(overit.geocallapp.wfm.survey.template.TemplateTree currentNode,
 DataCollectionNodeConversionResult conversionResult)
                               throws DataCollectionInitialValueException

Initialize the new node with DataCollectionNodeProperties and mandatory and initial value fields of DataCollectionNodeExpressions.

Parameters:

currentNode - the old node

conversionResult - the conversion result

Returns:

the new node with the base value

Throws:

DataCollectionInitialValueException

getLocalizedField

protected LocalizedString getLocalizedField(String description)

Create a LocalizedString starting from input string

Parameters:

description -

Returns:

a LocalizedString object

getLocalizedField

protected LocalizedString getLocalizedField(overit.geocallapp.wfm.survey.template.TemplateTree currentNode,
 String fieldName,
 String code)

Create a LocalizedString copying old values divided by language.

Parameters:

currentNode - the old node

fieldName - the field to copy from

code - the node's code

Returns:

the LocalizedString description

getStackTrace

protected String getStackTrace(Exception e)

Convert an exception to a string.

Parameters:

e - the exception

Returns:

the sting representation of the exception

getDataCollectionNodeConversionResult

protected DataCollectionNodeConversionResult getDataCollectionNodeConversionResult(DataCollectionNode newNode)

Get the DataCollectionNodeConversionResult starting from the newNode.

Parameters:

newNode - the new node

Returns:

the conversion result

loadDefaultFields

protected void loadDefaultFields(overit.geocallapp.wfm.survey.template.TemplateTree currentNode,
 StringBuilder sbNote)

Add the Value class, Value, Feature class and Featurevalues to the notes.

Parameters:

currentNode - the old node

sbNote - the note