Package org.openforis.collect.designer.viewmodel

Class SchemaVM

java.lang.Object

org.openforis.collect.designer.viewmodel.BaseVM

org.openforis.collect.designer.viewmodel.SurveyBaseVM

org.openforis.collect.designer.viewmodel.SchemaVM

public class SchemaVM
extends SurveyBaseVM

Author:

S. Ricci

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SchemaVM.TreeViewType

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	EDITED_NODE_TYPE_CHANGED

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
SchemaVM()

Method Summary

Modifier and Type	Method	Description
void	addAttribute(org.zkoss.bind.Binder binder, String attributeType)
void	addChildAttribute(org.zkoss.bind.Binder binder, String attributeType)
void	addChildEntity(org.zkoss.bind.Binder binder, boolean multiple, String layout, boolean virtual)
void	addChildTab(org.zkoss.bind.Binder binder)
void	addEntity(org.zkoss.bind.Binder binder, boolean multiple, String layout)
void	addRootEntity()
void	addTab(org.zkoss.bind.Binder binder)
protected void	addTabInternal(org.zkoss.bind.Binder binder, UITabSet parentTabSet)
void	applyChangesToEditedNodeInPopUp(org.zkoss.bind.Binder binder)
protected void	applyChangesToForm(org.zkoss.zk.ui.IdSpace idSpace)
protected void	buildTreeModel()
void	cancelChangesToEditedNodeInPopUp(org.zkoss.bind.Binder binder)
void	collapseTree()
protected EntityDefinition	createEntityDefinition()
protected EntityDefinition	createRootEntityDefinition()
void	currentLanguageChanged()
static void	dispatchEditedNodeTypeChangedGlobalCommand()
void	doAfterCompose(org.zkoss.zk.ui.Component view)
void	editedNodeCalculatedPropertyChanging(SurveyObject item, boolean calculated)
void	editedNodeChanged(org.zkoss.zk.ui.Component view, EntityDefinition parentEntity, SurveyObject editedNode, Boolean newNode)
void	editedNodeKeyChanging(SurveyObject item, boolean key)
void	editedNodeNameChanging(SurveyObject item, String name)
void	editedNodeTypeChanged()
protected void	editNode(org.zkoss.bind.Binder binder, boolean newNode, EntityDefinition parentEntity, SurveyObject node)
void	editRootEntity()
void	expandTree()
String	getAttributeIcon(String attributeTypeStr)	Called from UI
String	getAttributeInstanceLabel(AttributeDefinition attrDefn)
String	getAttributeType()
String	getAttributeTypeLabel()
String	getAttributeTypeLabel(String typeValue)
String	getAttributeTypeLabelFromDefinition(AttributeDefinition attrDefn)
List<String>	getAttributeTypeValues()
SurveyObject	getEditedNode()
String	getEditedNodePath()
protected static String	getEntityIcon(EntityDefinition entityDefn)
static String	getIcon(SurveyObject surveyObject)
static String	getIcon(SurveyObject surveyObject, boolean key, boolean calculated)
protected org.zkoss.bind.Binder	getNodeFormBinder(org.zkoss.zk.ui.IdSpace idSpace)
protected org.zkoss.zk.ui.Component	getNodeFormComponent(org.zkoss.zk.ui.IdSpace idSpace)
static String	getNodeTooltiptext(SurveyObject surveyObject)
String	getNodeType()
String	getNodeTypeHeaderLabel()
org.zkoss.zul.Menupopup	getPopupMenu(SchemaTreeModel.SchemaNodeData data)
EntityDefinition	getSelectedRootEntity()
SchemaTreeModel.SchemaNodeData	getSelectedTreeNode()
String	getSelectedTreeViewType()
ModelVersion	getSelectedVersion()
protected List<SurveyObject>	getSiblingsInTree(SurveyObject surveyObject)
SchemaTreeModel	getTreeModel()
String	getTreeViewTypeLabel(String type)
String[]	getTreeViewTypes()
void	init()
boolean	isEditingNode()
boolean	isEntity(SchemaTreeModel.SchemaNodeData data)
boolean	isMainTab(SchemaTreeModel.SchemaNodeData data)
protected boolean	isMoveItemDisabled(List<?> siblings, int index, boolean up)
protected boolean	isMoveNodeDisabled(boolean up)
boolean	isMoveNodeDownDisabled()
boolean	isMoveNodeUpDisabled()
boolean	isNewNode()
boolean	isRootEntitySelected()
boolean	isSingleEntity(SchemaTreeModel.SchemaNodeData data)
boolean	isTab(SchemaTreeModel.SchemaNodeData data)
boolean	isTableEntity(SchemaTreeModel.SchemaNodeData data)
protected boolean	isVersionSelected()
protected void	moveNode(boolean up)
protected void	moveNode(int newIndexInTree)
void	moveNodeDown()
void	moveNodeUp()
void	nodeConverted(org.zkoss.bind.Binder binder, NodeDefinition nodeDef)
void	nodeSelected(org.zkoss.bind.Binder binder, org.zkoss.zk.ui.Component view, SchemaTreeModel.SchemaNodeData data)
protected void	nodesTreeFilterChanged(EntityDefinition rootEntity, ModelVersion version)
void	openDuplicateNodePopup()
void	openMoveNodePopup()
void	openNodeConversionPopup()
void	openSelectNodeFromAnotherSurveyPopUp()
protected void	performRemoveNode(NodeDefinition nodeDefn)
protected void	performRemoveSelectedTreeNode()
protected void	performRemoveTab(UITab tab)
protected void	performSelectNode(org.zkoss.bind.Binder binder, SchemaTreeModel.SchemaNodeData data)
protected void	refreshNodeForm()
protected void	refreshSelectedTreeNode(org.zkoss.zk.ui.Component view)
protected void	refreshTreeModel()
void	removeNode()
protected void	removeNodeDefinition(NodeDefinition nodeDefn)
void	removeRootEntity()
void	removeTab()
protected void	resetEditingStatus()
protected void	resetEditingStatus(boolean notifyChange)
protected void	resetNodeSelection()
protected void	resetTreeSelection()
void	rootEntitySelected(EntityDefinition rootEntity)
void	schemaChanged()
protected void	selectTreeNode(SurveyObject surveyObject)
void	treeViewTypeSelected(String type)
void	undoLastChanges()
void	updateTabLabel(UITab tab, String label)
protected void	validateForm()
protected void	validateForm(org.zkoss.bind.Binder binder)
protected boolean	validateTabLabel(String label)
void	versionSelected(Object version)
void	versionsUpdated()

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

checkCanLeaveForm, checkCanLeaveForm, checkCanLeaveForm, codeListsUpdated, 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, getUnitLabel, getUnitLabelFromName, getUnitLabelFromPrecision, getUnitNames, getUnits, getVersionLabel, initSurvey, isCollectEarthSurvey, isCurrentEditedSurvey, isCurrentFormBlocking, isCurrentFormValid, isDefaultLanguage, isSingleRootEntityDefined, isSurveyChanged, isSurveyPublished, isSurveyRelatedToPublishedSurvey, isSurveyStored, sortByName, surveyChanged, surveySaved, tabSetsUpdated, taxonomiesUpdated, undoLastChanges, unitsUpdated

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

EDITED_NODE_TYPE_CHANGED

public static final String EDITED_NODE_TYPE_CHANGED

See Also:

Constant Field Values

Constructor Detail

SchemaVM

public SchemaVM()

Method Detail

init

public void init()

Overrides:

init in class SurveyBaseVM

doAfterCompose

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

nodeSelected

public void nodeSelected(org.zkoss.bind.Binder binder,
                         org.zkoss.zk.ui.Component view,
                         SchemaTreeModel.SchemaNodeData data)

rootEntitySelected

public void rootEntitySelected(EntityDefinition rootEntity)

versionSelected

public void versionSelected(Object version)

nodesTreeFilterChanged

protected void nodesTreeFilterChanged(EntityDefinition rootEntity,
                                      ModelVersion version)

performSelectNode

protected void performSelectNode(org.zkoss.bind.Binder binder,
                                 SchemaTreeModel.SchemaNodeData data)

addRootEntity

public void addRootEntity()

addEntity

public void addEntity(org.zkoss.bind.Binder binder,
                      boolean multiple,
                      String layout)

addChildEntity

public void addChildEntity(org.zkoss.bind.Binder binder,
                           boolean multiple,
                           String layout,
                           boolean virtual)

addAttribute

public void addAttribute(org.zkoss.bind.Binder binder,
                         String attributeType)
                  throws Exception

Throws:

Exception

addChildAttribute

public void addChildAttribute(org.zkoss.bind.Binder binder,
                              String attributeType)
                       throws Exception

Throws:

Exception

expandTree

public void expandTree()

collapseTree

public void collapseTree()

undoLastChanges

public void undoLastChanges()

Overrides:

undoLastChanges in class SurveyBaseVM

editedNodeNameChanging

public void editedNodeNameChanging(SurveyObject item,
                                   String name)

editedNodeKeyChanging

public void editedNodeKeyChanging(SurveyObject item,
                                  boolean key)

editedNodeCalculatedPropertyChanging

public void editedNodeCalculatedPropertyChanging(SurveyObject item,
                                                 boolean calculated)

dispatchEditedNodeTypeChangedGlobalCommand

public static void dispatchEditedNodeTypeChangedGlobalCommand()

editedNodeTypeChanged

public void editedNodeTypeChanged()

currentLanguageChanged

public void currentLanguageChanged()

Overrides:

currentLanguageChanged in class SurveyBaseVM

schemaChanged

public void schemaChanged()

nodeConverted

public void nodeConverted(org.zkoss.bind.Binder binder,
                          NodeDefinition nodeDef)

resetEditingStatus

protected void resetEditingStatus()

resetEditingStatus

protected void resetEditingStatus(boolean notifyChange)

resetNodeSelection

protected void resetNodeSelection()

resetTreeSelection

protected void resetTreeSelection()

selectTreeNode

protected void selectTreeNode(SurveyObject surveyObject)

versionsUpdated

public void versionsUpdated()

Overrides:

versionsUpdated in class SurveyBaseVM

editNode

protected void editNode(org.zkoss.bind.Binder binder,
                        boolean newNode,
                        EntityDefinition parentEntity,
                        SurveyObject node)

refreshNodeForm

protected void refreshNodeForm()

validateForm

protected void validateForm()

validateForm

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

getNodeFormBinder

protected org.zkoss.bind.Binder getNodeFormBinder(org.zkoss.zk.ui.IdSpace idSpace)

getNodeFormComponent

protected org.zkoss.zk.ui.Component getNodeFormComponent(org.zkoss.zk.ui.IdSpace idSpace)

applyChangesToForm

protected void applyChangesToForm(org.zkoss.zk.ui.IdSpace idSpace)

removeNode

public void removeNode()

removeNodeDefinition

protected void removeNodeDefinition(NodeDefinition nodeDefn)

removeRootEntity

public void removeRootEntity()

editRootEntity

public void editRootEntity()

applyChangesToEditedNodeInPopUp

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

cancelChangesToEditedNodeInPopUp

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

moveNodeUp

public void moveNodeUp()

moveNodeDown

public void moveNodeDown()

moveNode

protected void moveNode(boolean up)

moveNode

protected void moveNode(int newIndexInTree)

performRemoveSelectedTreeNode

protected void performRemoveSelectedTreeNode()

performRemoveNode

protected void performRemoveNode(NodeDefinition nodeDefn)

editedNodeChanged

public void editedNodeChanged(org.zkoss.zk.ui.Component view,
                              EntityDefinition parentEntity,
                              SurveyObject editedNode,
                              Boolean newNode)

refreshSelectedTreeNode

protected void refreshSelectedTreeNode(org.zkoss.zk.ui.Component view)

createRootEntityDefinition

protected EntityDefinition createRootEntityDefinition()

createEntityDefinition

protected EntityDefinition createEntityDefinition()

getTreeModel

public SchemaTreeModel getTreeModel()

buildTreeModel

protected void buildTreeModel()

isVersionSelected

protected boolean isVersionSelected()

refreshTreeModel

protected void refreshTreeModel()

isTab

public boolean isTab(SchemaTreeModel.SchemaNodeData data)

isMainTab

public boolean isMainTab(SchemaTreeModel.SchemaNodeData data)

isEntity

public boolean isEntity(SchemaTreeModel.SchemaNodeData data)

isSingleEntity

public boolean isSingleEntity(SchemaTreeModel.SchemaNodeData data)

isTableEntity

public boolean isTableEntity(SchemaTreeModel.SchemaNodeData data)

getSiblingsInTree

protected List<SurveyObject> getSiblingsInTree(SurveyObject surveyObject)

isMoveNodeUpDisabled

public boolean isMoveNodeUpDisabled()

isMoveNodeDownDisabled

public boolean isMoveNodeDownDisabled()

isMoveNodeDisabled

protected boolean isMoveNodeDisabled(boolean up)

isMoveItemDisabled

protected boolean isMoveItemDisabled(List<?> siblings,
                                     int index,
                                     boolean up)

getNodeTypeHeaderLabel

public String getNodeTypeHeaderLabel()

getNodeType

public String getNodeType()

getAttributeType

public String getAttributeType()

getAttributeTypeLabel

public String getAttributeTypeLabel()

getAttributeTypeLabel

public String getAttributeTypeLabel(String typeValue)

getAttributeTypeValues

public List<String> getAttributeTypeValues()

getAttributeTypeLabelFromDefinition

public String getAttributeTypeLabelFromDefinition(AttributeDefinition attrDefn)

getAttributeInstanceLabel

public String getAttributeInstanceLabel(AttributeDefinition attrDefn)

getIcon

public static String getIcon(SurveyObject surveyObject)

getIcon

public static String getIcon(SurveyObject surveyObject,
                             boolean key,
                             boolean calculated)

getEntityIcon

protected static String getEntityIcon(EntityDefinition entityDefn)

getAttributeIcon

public String getAttributeIcon(String attributeTypeStr)

Called from UI

getNodeTooltiptext

public static String getNodeTooltiptext(SurveyObject surveyObject)

getEditedNodePath

public String getEditedNodePath()

addTab

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

addChildTab

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

addTabInternal

protected void addTabInternal(org.zkoss.bind.Binder binder,
                              UITabSet parentTabSet)

removeTab

public void removeTab()

performRemoveTab

protected void performRemoveTab(UITab tab)

updateTabLabel

public void updateTabLabel(UITab tab,
                           String label)

validateTabLabel

protected boolean validateTabLabel(String label)

treeViewTypeSelected

public void treeViewTypeSelected(String type)

getPopupMenu

public org.zkoss.zul.Menupopup getPopupMenu(SchemaTreeModel.SchemaNodeData data)

openMoveNodePopup

public void openMoveNodePopup()

openDuplicateNodePopup

public void openDuplicateNodePopup()

openNodeConversionPopup

public void openNodeConversionPopup()

openSelectNodeFromAnotherSurveyPopUp

public void openSelectNodeFromAnotherSurveyPopUp()

getSelectedTreeNode

public SchemaTreeModel.SchemaNodeData getSelectedTreeNode()

getEditedNode

public SurveyObject getEditedNode()

isEditingNode

public boolean isEditingNode()

isNewNode

public boolean isNewNode()

getSelectedRootEntity

public EntityDefinition getSelectedRootEntity()

getSelectedVersion

public ModelVersion getSelectedVersion()

isRootEntitySelected

public boolean isRootEntitySelected()

getSelectedTreeViewType

public String getSelectedTreeViewType()

getTreeViewTypes

public String[] getTreeViewTypes()

getTreeViewTypeLabel

public String getTreeViewTypeLabel(String type)