Java tutorial
/** * Copyright (C) 2013 BonitaSoft S.A. * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 2.0 of the License, or * (at your option) any later version. * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ package org.bonitasoft.studio.businessobject.ui.wizard; import static com.google.common.base.Strings.isNullOrEmpty; import static org.bonitasoft.studio.common.jface.databinding.UpdateStrategyFactory.neverUpdateValueStrategy; import static org.bonitasoft.studio.common.jface.databinding.UpdateStrategyFactory.updateValueStrategy; import static org.bonitasoft.studio.common.jface.databinding.validator.ValidatorFactory.groovyReferenceValidator; import static org.bonitasoft.studio.common.jface.databinding.validator.ValidatorFactory.mandatoryValidator; import static org.bonitasoft.studio.common.jface.databinding.validator.ValidatorFactory.maxLengthValidator; import static org.bonitasoft.studio.common.jface.databinding.validator.ValidatorFactory.multiValidator; import static org.eclipse.jface.layout.GridDataFactory.fillDefaults; import java.util.ArrayList; import java.util.List; import java.util.Set; import org.bonitasoft.engine.bdm.model.BusinessObject; import org.bonitasoft.studio.businessobject.core.repository.BusinessObjectModelFileStore; import org.bonitasoft.studio.businessobject.core.repository.BusinessObjectModelRepositoryStore; import org.bonitasoft.studio.businessobject.i18n.Messages; import org.bonitasoft.studio.businessobject.ui.handler.ManageBusinessObjectHandler; import org.bonitasoft.studio.common.ExpressionConstants; import org.bonitasoft.studio.common.NamingUtils; import org.bonitasoft.studio.common.log.BonitaStudioLog; import org.bonitasoft.studio.expression.editor.filter.AvailableExpressionTypeFilter; import org.bonitasoft.studio.expression.editor.viewer.ExpressionViewer; import org.bonitasoft.studio.model.expression.ExpressionPackage; import org.bonitasoft.studio.model.process.BusinessObjectData; import org.bonitasoft.studio.model.process.DataAware; import org.bonitasoft.studio.model.process.ProcessPackage; import org.eclipse.core.commands.ExecutionException; import org.eclipse.core.databinding.beans.PojoObservables; import org.eclipse.core.databinding.conversion.Converter; import org.eclipse.core.databinding.conversion.IConverter; import org.eclipse.core.databinding.observable.list.WritableList; import org.eclipse.core.databinding.observable.value.IObservableValue; import org.eclipse.core.databinding.validation.IValidator; import org.eclipse.core.databinding.validation.MultiValidator; import org.eclipse.core.databinding.validation.ValidationStatus; import org.eclipse.core.runtime.IStatus; import org.eclipse.emf.databinding.EMFDataBindingContext; import org.eclipse.emf.databinding.EMFObservables; import org.eclipse.jface.databinding.swt.SWTObservables; import org.eclipse.jface.databinding.viewers.IViewerObservableValue; import org.eclipse.jface.databinding.viewers.ObservableListContentProvider; import org.eclipse.jface.databinding.viewers.ViewersObservables; import org.eclipse.jface.databinding.wizard.WizardPageSupport; import org.eclipse.jface.fieldassist.ControlDecoration; import org.eclipse.jface.layout.GridDataFactory; import org.eclipse.jface.layout.GridLayoutFactory; import org.eclipse.jface.viewers.ComboViewer; import org.eclipse.jface.viewers.LabelProvider; import org.eclipse.jface.wizard.WizardPage; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionAdapter; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.widgets.Button; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Label; import org.eclipse.swt.widgets.Link; import org.eclipse.swt.widgets.Text; /** * @author Romain Bioteau */ public class BusinessObjectDataWizardPage extends WizardPage { private final BusinessObjectModelRepositoryStore businessObjectModelStore; private final BusinessObjectData businessObjectData; private final Set<String> existingNames; private final DataAware container; private IObservableValue multipleObservableValue; private IObservableValue classNameObservable; private IObservableValue defaultValueReturnTypeObservable; private IObservableValue defaultValueContentObservable; private final HintImageProvider imageProvider; private IObservableValue defaultReturnTypeObservable; protected BusinessObjectDataWizardPage(final DataAware container, final BusinessObjectData businessObjectData, final BusinessObjectModelRepositoryStore businessObjectDefinitionStore, final Set<String> existingNames, final HintImageProvider imageProvider) { super(BusinessObjectDataWizardPage.class.getName()); this.container = container; businessObjectModelStore = businessObjectDefinitionStore; this.existingNames = existingNames; this.businessObjectData = businessObjectData; this.imageProvider = imageProvider; } /* * (non-Javadoc) * @see org.eclipse.jface.dialogs.IDialogPage#createControl(org.eclipse.swt.widgets.Composite) */ @Override public void createControl(final Composite parent) { final EMFDataBindingContext ctx = new EMFDataBindingContext(); final Composite mainComposite = createMainComposite(parent); createNameControl(mainComposite, ctx); createDescriptionControl(mainComposite, ctx); createBusinessObjectTypeControl(mainComposite, ctx); createIsMultipleControl(mainComposite, ctx); createDefaultValueControl(mainComposite, ctx); defaultValueContentObservable = EMFObservables.observeValue(businessObjectData.getDefaultValue(), ExpressionPackage.Literals.EXPRESSION__CONTENT); ctx.addValidationStatusProvider(defaultValueReturnTypeValidator()); WizardPageSupport.create(this, ctx); setControl(mainComposite); } private MultiValidator defaultValueReturnTypeValidator() { return new MultiValidator() { @Override protected IStatus validate() { final boolean isMultiple = Boolean.valueOf((Boolean) multipleObservableValue.getValue()); final String className = (String) classNameObservable.getValue(); if (!isNullOrEmpty(className) && !isNullOrEmpty((String) defaultValueContentObservable.getValue())) { return isMultiple ? returnTypeIs(List.class.getName()) : returnTypeIs(className); } return ValidationStatus.ok(); } }; } private IStatus returnTypeIs(final String expectedReturnType) { final String actualReturnType = (String) defaultValueReturnTypeObservable.getValue(); return expectedReturnType.equals(actualReturnType) ? ValidationStatus.ok() : ValidationStatus.error(Messages.bind(Messages.defaultValueReturnTypeValidationMessage, actualReturnType, expectedReturnType)); } protected ExpressionViewer createDefaultValueControl(final Composite mainComposite, final EMFDataBindingContext ctx) { final Label defaultValue = new Label(mainComposite, SWT.NONE); defaultValue.setLayoutData(GridDataFactory.fillDefaults().align(SWT.END, SWT.TOP).create()); defaultValue.setText(Messages.defaultValue); final ExpressionViewer defaultValueExpressionViewer = new ExpressionViewer(mainComposite, SWT.BORDER); defaultValueExpressionViewer.getControl() .setLayoutData(GridDataFactory.fillDefaults().grab(true, false).create()); defaultValueExpressionViewer.addFilter( new AvailableExpressionTypeFilter(ExpressionConstants.SCRIPT_TYPE, ExpressionConstants.QUERY_TYPE, ExpressionConstants.CONTRACT_INPUT_TYPE, ExpressionConstants.PARAMETER_TYPE)); defaultValueExpressionViewer.addEditorFilter(ExpressionConstants.CONTRACT_INPUT_TYPE, ExpressionConstants.PARAMETER_TYPE); final ControlDecoration hint = new ControlDecoration(defaultValueExpressionViewer.getTextControl(), SWT.LEFT);//TODO: remove me for 7.0.0 GA hint.setShowOnlyOnFocus(false); hint.setImage(imageProvider.getHintImage()); hint.setDescriptionText(Messages.defaultValueBusinessDataTooltip); defaultValueExpressionViewer.setInput(container); ctx.bindValue(ViewersObservables.observeSingleSelection(defaultValueExpressionViewer), EMFObservables.observeValue(businessObjectData, ProcessPackage.Literals.DATA__DEFAULT_VALUE)); defaultReturnTypeObservable = PojoObservables.observeValue(defaultValueExpressionViewer, "defaultReturnType"); ctx.bindValue(defaultReturnTypeObservable, classNameObservable, neverUpdateValueStrategy().create(), updateValueStrategy().withConverter(listConverter()).create()); ctx.bindValue(defaultReturnTypeObservable, multipleObservableValue, neverUpdateValueStrategy().create(), updateValueStrategy().withConverter(multipleConverter()).create()); return defaultValueExpressionViewer; } private IConverter listConverter() { return new Converter(String.class, String.class) { @Override public Object convert(final Object fromObject) { if (businessObjectData.isMultiple()) { return List.class.getName(); } return fromObject; } }; } private IConverter multipleConverter() { return new Converter(Boolean.class, String.class) { @Override public Object convert(final Object fromObject) { if ((boolean) fromObject) { return List.class.getName(); } return classNameObservable.getValue(); } }; } protected void createIsMultipleControl(final Composite mainComposite, final EMFDataBindingContext ctx) { new Label(mainComposite, SWT.NONE); final Button multipleCheckbox = new Button(mainComposite, SWT.CHECK); multipleCheckbox.setLayoutData(fillDefaults().grab(true, false).create()); multipleCheckbox.setText(Messages.multipleBusinessData); multipleObservableValue = EMFObservables.observeValue(businessObjectData, ProcessPackage.Literals.DATA__MULTIPLE); ctx.bindValue(SWTObservables.observeSelection(multipleCheckbox), multipleObservableValue); } protected void createBusinessObjectTypeControl(final Composite mainComposite, final EMFDataBindingContext ctx) { final Label businessObjectLabel = new Label(mainComposite, SWT.NONE); businessObjectLabel.setLayoutData(fillDefaults().align(SWT.END, SWT.CENTER).create()); businessObjectLabel.setText(Messages.businessObject + " *"); final Composite comboComposite = new Composite(mainComposite, SWT.NONE); comboComposite.setLayout(GridLayoutFactory.fillDefaults().numColumns(2).margins(0, 0).create()); comboComposite.setLayoutData(fillDefaults().grab(true, false).create()); final ComboViewer businessObjectComboViewer = new ComboViewer(comboComposite, SWT.READ_ONLY | SWT.BORDER); businessObjectComboViewer.getControl().setLayoutData(fillDefaults().grab(true, false).create()); businessObjectComboViewer.setContentProvider(new ObservableListContentProvider()); businessObjectComboViewer.setLabelProvider(businessObjectLabelProvider()); final WritableList businessObjectsObservableList = new WritableList(getAllBusinessObjects(), BusinessObject.class); final IViewerObservableValue observeSingleSelection = ViewersObservables .observeSingleSelection(businessObjectComboViewer); createNewBusinessObjectLink(comboComposite, businessObjectsObservableList, observeSingleSelection); businessObjectComboViewer.setInput(businessObjectsObservableList); classNameObservable = EMFObservables.observeValue(businessObjectData, ProcessPackage.Literals.JAVA_OBJECT_DATA__CLASS_NAME); ctx.bindValue(observeSingleSelection, classNameObservable, updateValueStrategy().withConverter(businessObjectToFQN()) .withValidator(mandatoryValidator(Messages.businessObject)).create(), updateValueStrategy().withConverter(fqnToBusinessObject()).create()); defaultValueReturnTypeObservable = EMFObservables.observeValue(businessObjectData.getDefaultValue(), ExpressionPackage.Literals.EXPRESSION__RETURN_TYPE); final String className = businessObjectData.getClassName(); if ((className == null || className.isEmpty()) && !businessObjectsObservableList.isEmpty()) { observeSingleSelection.setValue(businessObjectsObservableList.get(0)); } } private LabelProvider businessObjectLabelProvider() { return new LabelProvider() { @Override public String getText(final Object element) { if (element instanceof BusinessObject) { return NamingUtils.getSimpleName(((BusinessObject) element).getQualifiedName()); } return super.getText(element); } }; } private void createNewBusinessObjectLink(final Composite comboComposite, final WritableList businessObjectsObservableList, final IViewerObservableValue observeSingleSelection) { final Link createBusinessObjectLink = new Link(comboComposite, SWT.NO_FOCUS); createBusinessObjectLink.setLayoutData(GridDataFactory.fillDefaults().align(SWT.FILL, SWT.CENTER).create()); createBusinessObjectLink.setText(Messages.createNewBusinessObject); createBusinessObjectLink.addSelectionListener(new SelectionAdapter() { @Override public void widgetSelected(final SelectionEvent e) { final Object value = observeSingleSelection.getValue(); openNewBusinessObjectWizard(); final List<BusinessObject> allBusinessObjects = getAllBusinessObjects(); businessObjectsObservableList.clear(); businessObjectsObservableList.addAll(allBusinessObjects); if (value != null && allBusinessObjects.contains(value)) { observeSingleSelection.setValue(value); } else if (!allBusinessObjects.isEmpty()) { observeSingleSelection.setValue(businessObjectsObservableList.get(0)); } } }); } private Converter fqnToBusinessObject() { return new Converter(String.class, BusinessObject.class) { @Override public Object convert(final Object fromObject) { if (fromObject instanceof String) { final String qualifiedName = fromObject.toString(); final BusinessObjectModelFileStore childByQualifiedName = businessObjectModelStore .getChildByQualifiedName(qualifiedName); if (childByQualifiedName != null) { return childByQualifiedName.getBusinessObject(qualifiedName); } } return null; } }; } private Converter businessObjectToFQN() { return new Converter(BusinessObject.class, String.class) { @Override public Object convert(final Object fromObject) { if (fromObject instanceof BusinessObject) { return ((BusinessObject) fromObject).getQualifiedName(); } return null; } }; } protected void openNewBusinessObjectWizard() { try { new ManageBusinessObjectHandler().execute(null); } catch (final ExecutionException e) { BonitaStudioLog.error(e); } } protected List<BusinessObject> getAllBusinessObjects() { final List<BusinessObject> result = new ArrayList<BusinessObject>(); for (final BusinessObjectModelFileStore def : businessObjectModelStore.getChildren()) { final List<BusinessObject> bo = def.getBusinessObjects(); result.addAll(bo); } return result; } protected Text createDescriptionControl(final Composite mainComposite, final EMFDataBindingContext ctx) { final Label descriptionLabel = new Label(mainComposite, SWT.NONE); descriptionLabel.setLayoutData(GridDataFactory.fillDefaults().align(SWT.END, SWT.TOP).create()); descriptionLabel.setText(Messages.description); final Text descriptionText = new Text(mainComposite, SWT.BORDER | SWT.MULTI | SWT.WRAP); descriptionText .setLayoutData(GridDataFactory.fillDefaults().grab(true, false).hint(SWT.DEFAULT, 70).create()); ctx.bindValue(SWTObservables.observeText(descriptionText, SWT.Modify), EMFObservables.observeValue(businessObjectData, ProcessPackage.Literals.ELEMENT__DOCUMENTATION), updateValueStrategy().withValidator(maxLengthValidator(Messages.description, 255)).create(), null); return descriptionText; } protected Text createNameControl(final Composite mainComposite, final EMFDataBindingContext ctx) { final Label nameLabel = new Label(mainComposite, SWT.NONE); nameLabel.setLayoutData(GridDataFactory.fillDefaults().align(SWT.END, SWT.CENTER).create()); nameLabel.setText(Messages.name + " *"); final Text nameText = new Text(mainComposite, SWT.BORDER); nameText.setLayoutData(GridDataFactory.fillDefaults().grab(true, false).create()); ctx.bindValue(SWTObservables.observeText(nameText, SWT.Modify), EMFObservables.observeValue(businessObjectData, ProcessPackage.Literals.ELEMENT__NAME), updateValueStrategy() .withValidator(multiValidator().addValidator(maxLengthValidator(Messages.name, 50)) .addValidator(groovyReferenceValidator(Messages.name).startsWithLowerCase()) .addValidator(uniqueDataNameValidator()).create()) .create(), null); return nameText; } private IValidator uniqueDataNameValidator() { return new IValidator() { @Override public IStatus validate(final Object value) { if (existingNames.contains(value.toString())) { return ValidationStatus.error(Messages.dataWithSameNameAlreadyExists); } return ValidationStatus.ok(); } }; } protected Composite createMainComposite(final Composite parent) { final Composite mainComposite = new Composite(parent, SWT.NONE); mainComposite.setLayoutData(GridDataFactory.fillDefaults().grab(true, true).create()); mainComposite.setLayout(GridLayoutFactory.fillDefaults().numColumns(2).margins(10, 10).create()); return mainComposite; } }