Package org.openforis.collect.designer.viewmodel

Class CodeListsVM

java.lang.Object

org.openforis.collect.designer.viewmodel.BaseVM

org.openforis.collect.designer.viewmodel.SurveyBaseVM

org.openforis.collect.designer.viewmodel.SurveyObjectBaseVM<CodeList>

org.openforis.collect.designer.viewmodel.CodeListsVM

public class CodeListsVM
extends SurveyObjectBaseVM<CodeList>

Author:

S. Ricci

Nested Class Summary

Nested classes/interfaces inherited from class org.openforis.collect.designer.viewmodel.SurveyBaseVM

SurveyBaseVM.CanLeaveFormCompleteConfirmHandler, SurveyBaseVM.CanLeaveFormConfirmHandler, SurveyBaseVM.SurveyType

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLOSE_CODE_LIST_IMPORT_POP_UP_COMMAND
static String	CLOSE_CODE_LIST_ITEM_POP_UP_COMMAND
static String	EDITING_ATTRIBUTE_PARAM
static String	SELECTED_CODE_LIST_PARAM

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

APPLY_CHANGES_COMMAND, changed, COMMIT_CHANGES_COMMAND, commitChangesOnApply, editedItem, formObject, newItem, selectedItem, VALIDATE_COMMAND

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

currentLanguageCode, DATE_FORMAT, fieldLabelKeyPrefixes, NODE_CONVERTED_GLOBAL_COMMAND, SCHEMA_CHANGED_GLOBAL_COMMAND, schemaUpdater, survey, SURVEY_CHANGED_GLOBAL_COMMAND, SURVEY_SAVED_GLOBAL_COMMAND, UNDO_LAST_CHANGES_GLOBAL_COMMAND, VALIDATE_ALL_GLOBAL_COMMAND, 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
CodeListsVM()

Method Summary

Modifier and Type	Method	Description
void	addItemInLevel(int levelIndex)
void	addLevel()
protected void	addNewItemToSurvey()
void	batchExport()
void	batchImportFileUploaded(org.zkoss.zk.ui.event.UploadEvent event)
protected boolean	canImportCodeList()
void	close(org.zkoss.zk.ui.event.Event event)
void	closeCodeListImportPopUp()
void	closeCodeListItemPopUp(boolean undoChanges, boolean imageModified, FileWrapper imageFileWrapper)
void	closeCodeListsManagerPopUp()
protected void	closeJobStatusPopUp()
void	closeReferenceDataImportErrorPopUp()
protected void	closeReferencedNodesPopUp()
void	codeListAssigned(CodeList list, CodeList oldList)
void	codeListsUpdated()
void	commitChanges(org.zkoss.bind.Binder binder)
protected CodeListItem	createChildItem()
protected FormObject<CodeList>	createFormObject()
protected CodeList	createItemInstance()
void	deleteCodeList(CodeList item)
void	deleteCodeListItem(CodeListItem item)
protected void	deleteItemFromSurvey(CodeList item)
protected void	deselectItemsAfterLevel(int levelIndex)
static void	dispatchCodeListsUpdatedCommand()
void	doAfterCompose(org.zkoss.zk.ui.Component view)
void	editCodeListItem(CodeListItem item)
void	exportCodeListToCsv()
void	exportCodeListToExcel()
protected String	generateItemCode(CodeListItem item)
String	getCodeListItemLabel(CodeListItem item)
String	getHierarchyLevelNameValidationKey(int levelIdx)
org.zkoss.bind.Validator	getHierarchyLevelNameValidator(int levelIdx)
protected int	getItemIndex(CodeListItem item)
protected List<CodeList>	getItemsInternal()
List<List<CodeListItem>>	getItemsPerLevel()
int	getLastSelectedLevelIndex()
protected int	getLevelIndex(CodeListItem item)
List<CodeListLevel>	getListLevels()
protected List<NodeDefinition>	getReferences(CodeList item)
List<CodeListItem>	getSelectedItemsPerLevel()
protected List<CodeListItem>	getSiblings(CodeListItem item)
String	getWarnings(CodeList list)
boolean	hasChildItems(CodeListItem item)
boolean	hasWarnings(CodeList list)
void	init(Boolean editingAttribute, CodeList selectedCodeList)
protected void	initItemsPerLevel()
protected boolean	isCodeListInPublishedSurvey()
boolean	isCodeListItemSelected(CodeListItem item)
boolean	isEditingAttribute()
protected boolean	isEnumeratingCodeList()
boolean	isMultipleLevelsPresent()
void	listItemSelected(CodeListItem item, int levelIndex)
protected void	moveChildItem(CodeListItem item, int toIndex)
void	moveChildItem(org.zkoss.zk.ui.event.DropEvent event)
protected void	moveSelectedItemInSurvey(int indexTo)
void	openChildItemEditPopUp()
void	openCodeListImportPopUp()
protected void	performDeleteCodeListItem(CodeListItem item)
protected void	performItemSelection(CodeList item)
protected void	performNewItemCreation(org.zkoss.bind.Binder binder)
protected void	performRemoveLevel(int levelIndex)
protected void	reloadSiblingsSortOrder(PersistedCodeListItem item)	Reloads the siblings from the database.
void	removeLevel()
void	setEditedItem(CodeList editedItem)
void	typeChanged(String type)

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

applyChanges, currentLanguageChanged, deleteItem, dispatchApplyChangesCommand, dispatchValidateCommand, getConfirmDeleteMessageKey, getEditedItem, getFormObject, getItems, getNameTextbox, getSelectedItem, getSelectedItemIndex, isChanged, isCommitChangesOnApply, isEditingItem, isMoveSelectedItemDownDisabled, isMoveSelectedItemUpDisabled, isNewItem, moveSelectedItem, moveSelectedItem, moveSelectedItemDown, moveSelectedItemUp, newItem, performDeleteItem, resetEditedItem, selectionChanged, setCommitChangesOnApply, setFocusOnNameTextbox, setSelectedItem, suggestInternalName, suggestLabel, undoLastChanges, validate, validateAll, validateForm

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

checkCanLeaveForm, checkCanLeaveForm, checkCanLeaveForm, createBasicModuleParameters, currentFormValidated, dispatchCurrentFormValidatedCommand, dispatchCurrentFormValidatedCommand, dispatchCurrentFormValidatedCommand, dispatchCurrentFormValidatedCommand, dispatchNodeConvertedCommand, dispatchSchemaChangedCommand, dispatchSurveyChangedCommand, dispatchTaxonomiesUpdatedCommand, dispatchValidateAllCommand, getCodeLists, getCurrentLanguageCode, getDateFormat, getDefaultLanguageCode, getEditableRecordStepNames, getExpressionValidator, getFormVersionIdsWithEmptyOption, getFormVersions, getFormVersionsWithEmptyOption, getRootEntities, getRootVM, getSurvey, getSurveyId, getTaxonomyNames, getUnitLabel, getUnitLabelFromPrecision, getUnits, getVersionLabel, init, initSurvey, isCollectEarthSurvey, isCurrentEditedSurvey, isCurrentFormBlocking, isCurrentFormValid, isDefaultLanguage, isSingleRootEntityDefined, isSurveyChanged, isSurveyPublished, isSurveyRelatedToPublishedSurvey, isSurveyStored, sortByName, surveyChanged, surveySaved, tabSetsUpdated, taxonomiesUpdated, undoLastChanges, unitsUpdated, 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

EDITING_ATTRIBUTE_PARAM

public static final String EDITING_ATTRIBUTE_PARAM

See Also:

Constant Field Values

SELECTED_CODE_LIST_PARAM

public static final String SELECTED_CODE_LIST_PARAM

See Also:

Constant Field Values

CLOSE_CODE_LIST_ITEM_POP_UP_COMMAND

public static final String CLOSE_CODE_LIST_ITEM_POP_UP_COMMAND

See Also:

Constant Field Values

CLOSE_CODE_LIST_IMPORT_POP_UP_COMMAND

public static final String CLOSE_CODE_LIST_IMPORT_POP_UP_COMMAND

See Also:

Constant Field Values

Constructor Detail

CodeListsVM

public CodeListsVM()

Method Detail

init

public void init(Boolean editingAttribute,
                 CodeList selectedCodeList)

doAfterCompose

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

Overrides:

doAfterCompose in class SurveyObjectBaseVM<CodeList>

getItemsInternal

protected List<CodeList> getItemsInternal()

Specified by:

getItemsInternal in class SurveyObjectBaseVM<CodeList>

addNewItemToSurvey

protected void addNewItemToSurvey()

Specified by:

addNewItemToSurvey in class SurveyObjectBaseVM<CodeList>

deleteItemFromSurvey

protected void deleteItemFromSurvey(CodeList item)

Specified by:

deleteItemFromSurvey in class SurveyObjectBaseVM<CodeList>

createFormObject

protected FormObject<CodeList> createFormObject()

Specified by:

createFormObject in class SurveyObjectBaseVM<CodeList>

dispatchCodeListsUpdatedCommand

public static void dispatchCodeListsUpdatedCommand()

performNewItemCreation

protected void performNewItemCreation(org.zkoss.bind.Binder binder)

Overrides:

performNewItemCreation in class SurveyObjectBaseVM<CodeList>

createItemInstance

protected CodeList createItemInstance()

Specified by:

createItemInstance in class SurveyObjectBaseVM<CodeList>

performItemSelection

protected void performItemSelection(CodeList item)

Overrides:

performItemSelection in class SurveyObjectBaseVM<CodeList>

moveSelectedItemInSurvey

protected void moveSelectedItemInSurvey(int indexTo)

Specified by:

moveSelectedItemInSurvey in class SurveyObjectBaseVM<CodeList>

deleteCodeList

public void deleteCodeList(CodeList item)

closeReferencedNodesPopUp

protected void closeReferencedNodesPopUp()

getReferences

protected List<NodeDefinition> getReferences(CodeList item)

typeChanged

public void typeChanged(String type)

addLevel

public void addLevel()

removeLevel

public void removeLevel()

getHierarchyLevelNameValidationKey

public String getHierarchyLevelNameValidationKey(int levelIdx)

getHierarchyLevelNameValidator

public org.zkoss.bind.Validator getHierarchyLevelNameValidator(int levelIdx)

performRemoveLevel

protected void performRemoveLevel(int levelIndex)

addItemInLevel

public void addItemInLevel(int levelIndex)

createChildItem

protected CodeListItem createChildItem()

deleteCodeListItem

public void deleteCodeListItem(CodeListItem item)

isEnumeratingCodeList

protected boolean isEnumeratingCodeList()

performDeleteCodeListItem

protected void performDeleteCodeListItem(CodeListItem item)

moveChildItem

public void moveChildItem(org.zkoss.zk.ui.event.DropEvent event)

setEditedItem

public void setEditedItem(CodeList editedItem)

Overrides:

setEditedItem in class SurveyObjectBaseVM<CodeList>

editCodeListItem

public void editCodeListItem(CodeListItem item)

batchImportFileUploaded

public void batchImportFileUploaded(org.zkoss.zk.ui.event.UploadEvent event)

batchExport

public void batchExport()

codeListsUpdated

public void codeListsUpdated()

Overrides:

codeListsUpdated in class SurveyBaseVM

generateItemCode

protected String generateItemCode(CodeListItem item)

openChildItemEditPopUp

public void openChildItemEditPopUp()

listItemSelected

public void listItemSelected(CodeListItem item,
                             int levelIndex)

isMultipleLevelsPresent

public boolean isMultipleLevelsPresent()

deselectItemsAfterLevel

protected void deselectItemsAfterLevel(int levelIndex)

moveChildItem

protected void moveChildItem(CodeListItem item,
                             int toIndex)

reloadSiblingsSortOrder

protected void reloadSiblingsSortOrder(PersistedCodeListItem item)

Reloads the siblings from the database. The sort order of these items changes after calling codeListManager.shiftItem method.

Parameters:

item -

getLevelIndex

protected int getLevelIndex(CodeListItem item)

getSiblings

protected List<CodeListItem> getSiblings(CodeListItem item)

getItemIndex

protected int getItemIndex(CodeListItem item)

closeCodeListItemPopUp

public void closeCodeListItemPopUp(boolean undoChanges,
                                   boolean imageModified,
                                   FileWrapper imageFileWrapper)

commitChanges

public void commitChanges(org.zkoss.bind.Binder binder)

Overrides:

commitChanges in class SurveyObjectBaseVM<CodeList>

openCodeListImportPopUp

public void openCodeListImportPopUp()

exportCodeListToCsv

public void exportCodeListToCsv()
                         throws IOException

Throws:

IOException

exportCodeListToExcel

public void exportCodeListToExcel()
                           throws IOException

Throws:

IOException

closeReferenceDataImportErrorPopUp

public void closeReferenceDataImportErrorPopUp()

canImportCodeList

protected boolean canImportCodeList()

isCodeListInPublishedSurvey

protected boolean isCodeListInPublishedSurvey()

closeCodeListImportPopUp

public void closeCodeListImportPopUp()

closeCodeListsManagerPopUp

public void closeCodeListsManagerPopUp()

initItemsPerLevel

protected void initItemsPerLevel()

getListLevels

public List<CodeListLevel> getListLevels()

getSelectedItemsPerLevel

public List<CodeListItem> getSelectedItemsPerLevel()

getLastSelectedLevelIndex

public int getLastSelectedLevelIndex()

getItemsPerLevel

public List<List<CodeListItem>> getItemsPerLevel()

isCodeListItemSelected

public boolean isCodeListItemSelected(CodeListItem item)

hasChildItems

public boolean hasChildItems(CodeListItem item)

getCodeListItemLabel

public String getCodeListItemLabel(CodeListItem item)

isEditingAttribute

public boolean isEditingAttribute()

hasWarnings

public boolean hasWarnings(CodeList list)

getWarnings

public String getWarnings(CodeList list)

codeListAssigned

public void codeListAssigned(CodeList list,
                             CodeList oldList)

close

public void close(org.zkoss.zk.ui.event.Event event)

closeJobStatusPopUp

protected void closeJobStatusPopUp()