Package org.openforis.collect.designer.viewmodel

Class SurveyBaseVM

java.lang.Object

org.openforis.collect.designer.viewmodel.BaseVM

org.openforis.collect.designer.viewmodel.SurveyBaseVM

Direct Known Subclasses:

AttributeConversionVM, BaseSurveyFileImportVM, CodeListsPopUpVM, CollectEarthPreviewPopUpVM, PreviewPopUpVM, PreviewPreferencesVM, SamplingPointDataVM, SchemaObjectSelectorPopUpVM, SchemaVM, SurveyEditVM, SurveyObjectBaseVM

public abstract class SurveyBaseVM
extends BaseVM

Author:

S. Ricci

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SurveyBaseVM.CanLeaveFormCompleteConfirmHandler
static interface	SurveyBaseVM.CanLeaveFormConfirmHandler
static class	SurveyBaseVM.SurveyType

Field Summary

Fields

Modifier and Type	Field	Description
protected String	currentLanguageCode
static String	DATE_FORMAT
protected List<String>	fieldLabelKeyPrefixes
static String	NODE_CONVERTED_GLOBAL_COMMAND
static String	SCHEMA_CHANGED_GLOBAL_COMMAND
protected SchemaUpdater	schemaUpdater
protected CollectSurvey	survey
static String	SURVEY_CHANGED_GLOBAL_COMMAND
static String	SURVEY_SAVED_GLOBAL_COMMAND
static String	UNDO_LAST_CHANGES_GLOBAL_COMMAND
static String	VALIDATE_ALL_GLOBAL_COMMAND
static String	VERSIONS_UPDATED_GLOBAL_COMMAND

Fields inherited from class org.openforis.collect.designer.viewmodel.BaseVM

COLLECT_EARTH_PROJECT_FILE_CREATOR_LOADER, jobManager, userGroupManager, userManager

Constructor Summary

Constructors

Constructor	Description
SurveyBaseVM()

Method Summary

Modifier and Type	Method	Description
boolean	checkCanLeaveForm()
boolean	checkCanLeaveForm(SurveyBaseVM.CanLeaveFormConfirmHandler confirmHandler)	If the current form is valid, execute the onOk method of the specified confirmHandler and returns true, otherwise shows a confirm message handled by the specified confirmHandler and returns false If the form is not valid and the confirmHandler is not specified, shows a warning message.
boolean	checkCanLeaveForm(SurveyBaseVM.CanLeaveFormConfirmHandler confirmHandler, String messageKey)
void	codeListsUpdated()
protected Map<String,String>	createBasicModuleParameters()
void	currentFormValidated(boolean valid, Boolean blocking, Map<String,List<String>> validationMessagesByField)
void	currentLanguageChanged()
void	dispatchCurrentFormValidatedCommand()
void	dispatchCurrentFormValidatedCommand(boolean valid)
void	dispatchCurrentFormValidatedCommand(boolean valid, boolean blocking)
void	dispatchCurrentFormValidatedCommand(boolean valid, boolean blocking, Map<String,List<String>> validationMessagesByField)
void	dispatchNodeConvertedCommand(NodeDefinition nodeDef)
void	dispatchSchemaChangedCommand()
void	dispatchSurveyChangedCommand()
void	dispatchTaxonomiesUpdatedCommand()
protected void	dispatchValidateAllCommand()
List<CodeList>	getCodeLists()
String	getCurrentLanguageCode()
String	getDateFormat()
String	getDefaultLanguageCode()
List<String>	getEditableRecordStepNames()
ExpressionValidator	getExpressionValidator()
List<Integer>	getFormVersionIdsWithEmptyOption()
List<ModelVersion>	getFormVersions()
List<Object>	getFormVersionsWithEmptyOption()
List<EntityDefinition>	getRootEntities()
protected SurveyEditVM	getRootVM()
CollectSurvey	getSurvey()
Integer	getSurveyId()
List<String>	getTaxonomyNames()
String	getUnitLabel(UnitFormObject unitFormObject)
String	getUnitLabel(Unit unit)
String	getUnitLabelFromName(String name)
String	getUnitLabelFromPrecision(Precision precision)
List<String>	getUnitNames()
List<Unit>	getUnits()
String	getVersionLabel(int id)
void	init()
protected void	initSurvey()
boolean	isCollectEarthSurvey()
boolean	isCurrentEditedSurvey(SurveySummary surveySummary)
boolean	isCurrentFormBlocking()
boolean	isCurrentFormValid()
boolean	isDefaultLanguage()
boolean	isSingleRootEntityDefined()
boolean	isSurveyChanged()
boolean	isSurveyPublished()
protected boolean	isSurveyRelatedToPublishedSurvey()
boolean	isSurveyStored()
protected <T extends NamedObject> List<T>	sortByName(List<T> items)
void	surveyChanged()
void	surveySaved()
void	tabSetsUpdated()
void	taxonomiesUpdated()
void	undoLastChanges()
void	undoLastChanges(org.zkoss.zk.ui.Component view)
void	unitsUpdated()
void	versionsUpdated()

Methods inherited from class org.openforis.collect.designer.viewmodel.BaseVM

closePopUp, getComponentsPath, getDefaultPublicUserGroupItem, getFormFieldValue, getFormFieldValue, getInitParameter, getLoggedUser, getLoggedUsername, getSession, getSessionStatus, getUserGroupsModel, initUserGroupsModel, joinList, joinValues, notifyChange, openPopUp, openPopUp, prettyDateFormat, setFormFieldValue, setFormFieldValue

Methods inherited from class java.lang.Object

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

Field Detail

VERSIONS_UPDATED_GLOBAL_COMMAND

public static final String VERSIONS_UPDATED_GLOBAL_COMMAND

See Also:

Constant Field Values

UNDO_LAST_CHANGES_GLOBAL_COMMAND

public static final String UNDO_LAST_CHANGES_GLOBAL_COMMAND

See Also:

Constant Field Values

SURVEY_CHANGED_GLOBAL_COMMAND

public static final String SURVEY_CHANGED_GLOBAL_COMMAND

See Also:

Constant Field Values

SCHEMA_CHANGED_GLOBAL_COMMAND

public static final String SCHEMA_CHANGED_GLOBAL_COMMAND

See Also:

Constant Field Values

NODE_CONVERTED_GLOBAL_COMMAND

public static final String NODE_CONVERTED_GLOBAL_COMMAND

See Also:

Constant Field Values

SURVEY_SAVED_GLOBAL_COMMAND

public static final String SURVEY_SAVED_GLOBAL_COMMAND

See Also:

Constant Field Values

VALIDATE_ALL_GLOBAL_COMMAND

public static final String VALIDATE_ALL_GLOBAL_COMMAND

See Also:

Constant Field Values

DATE_FORMAT

public static final String DATE_FORMAT

survey

protected CollectSurvey survey

currentLanguageCode

protected String currentLanguageCode

fieldLabelKeyPrefixes

protected List<String> fieldLabelKeyPrefixes

schemaUpdater

protected SchemaUpdater schemaUpdater

Constructor Detail

SurveyBaseVM

public SurveyBaseVM()

Method Detail

init

public void init()

versionsUpdated

public void versionsUpdated()

codeListsUpdated

public void codeListsUpdated()

unitsUpdated

public void unitsUpdated()

tabSetsUpdated

public void tabSetsUpdated()

taxonomiesUpdated

public void taxonomiesUpdated()

currentFormValidated

public void currentFormValidated(boolean valid,
                                 Boolean blocking,
                                 Map<String,List<String>> validationMessagesByField)

undoLastChanges

public void undoLastChanges(org.zkoss.zk.ui.Component view)

undoLastChanges

public void undoLastChanges()

dispatchCurrentFormValidatedCommand

public void dispatchCurrentFormValidatedCommand()

dispatchCurrentFormValidatedCommand

public void dispatchCurrentFormValidatedCommand(boolean valid)

dispatchCurrentFormValidatedCommand

public void dispatchCurrentFormValidatedCommand(boolean valid,
                                                boolean blocking)

dispatchCurrentFormValidatedCommand

public void dispatchCurrentFormValidatedCommand(boolean valid,
                                                boolean blocking,
                                                Map<String,List<String>> validationMessagesByField)

dispatchSurveyChangedCommand

public void dispatchSurveyChangedCommand()

dispatchSchemaChangedCommand

public void dispatchSchemaChangedCommand()

dispatchTaxonomiesUpdatedCommand

public void dispatchTaxonomiesUpdatedCommand()

dispatchNodeConvertedCommand

public void dispatchNodeConvertedCommand(NodeDefinition nodeDef)

dispatchValidateAllCommand

protected void dispatchValidateAllCommand()

checkCanLeaveForm

public boolean checkCanLeaveForm()

checkCanLeaveForm

public boolean checkCanLeaveForm(SurveyBaseVM.CanLeaveFormConfirmHandler confirmHandler)

If the current form is valid, execute the onOk method of the specified confirmHandler and returns true, otherwise shows a confirm message handled by the specified confirmHandler and returns false If the form is not valid and the confirmHandler is not specified, shows a warning message.

Parameters:

confirmHandler -

Returns:

checkCanLeaveForm

public boolean checkCanLeaveForm(SurveyBaseVM.CanLeaveFormConfirmHandler confirmHandler,
                                 String messageKey)

initSurvey

protected void initSurvey()

getSurvey

public CollectSurvey getSurvey()

getSurveyId

public Integer getSurveyId()

isCollectEarthSurvey

public boolean isCollectEarthSurvey()

isSurveyStored

public boolean isSurveyStored()

isSurveyPublished

public boolean isSurveyPublished()

isSurveyChanged

public boolean isSurveyChanged()

getRootVM

protected SurveyEditVM getRootVM()

currentLanguageChanged

public void currentLanguageChanged()

surveyChanged

public void surveyChanged()

surveySaved

public void surveySaved()

getDateFormat

public String getDateFormat()

getFormVersions

public List<ModelVersion> getFormVersions()

getFormVersionsWithEmptyOption

public List<Object> getFormVersionsWithEmptyOption()

getFormVersionIdsWithEmptyOption

public List<Integer> getFormVersionIdsWithEmptyOption()

getVersionLabel

public String getVersionLabel(int id)

getRootEntities

public List<EntityDefinition> getRootEntities()

isSingleRootEntityDefined

public boolean isSingleRootEntityDefined()

getCodeLists

public List<CodeList> getCodeLists()

getTaxonomyNames

public List<String> getTaxonomyNames()

getUnits

public List<Unit> getUnits()

getUnitNames

public List<String> getUnitNames()

getUnitLabelFromPrecision

public String getUnitLabelFromPrecision(Precision precision)

getUnitLabelFromName

public String getUnitLabelFromName(String name)

getUnitLabel

public String getUnitLabel(Unit unit)

getUnitLabel

public String getUnitLabel(UnitFormObject unitFormObject)

isDefaultLanguage

public boolean isDefaultLanguage()

getDefaultLanguageCode

public String getDefaultLanguageCode()

getCurrentLanguageCode

public String getCurrentLanguageCode()

Overrides:

getCurrentLanguageCode in class BaseVM

isCurrentFormValid

public boolean isCurrentFormValid()

isCurrentFormBlocking

public boolean isCurrentFormBlocking()

getExpressionValidator

public ExpressionValidator getExpressionValidator()

sortByName

protected <T extends NamedObject> List<T> sortByName(List<T> items)

createBasicModuleParameters

protected Map<String,String> createBasicModuleParameters()

isCurrentEditedSurvey

public boolean isCurrentEditedSurvey(SurveySummary surveySummary)

getEditableRecordStepNames

public List<String> getEditableRecordStepNames()

isSurveyRelatedToPublishedSurvey

protected boolean isSurveyRelatedToPublishedSurvey()