--- /dev/null
+/**
+* Copyright (C) 2018 EDIT
+* European Distributed Institute of Taxonomy
+* http://www.e-taxonomy.eu
+*
+* The contents of this file are subject to the Mozilla Public License Version 1.1
+* See LICENSE.TXT at the top of this package for the full license terms.
+*/
+package eu.etaxonomy.cdm.vaadin.model;
+
+import java.io.Serializable;
+import java.util.UUID;
+
+import org.joda.time.DateTime;
+
+import eu.etaxonomy.cdm.model.common.CdmBase;
+import eu.etaxonomy.cdm.model.common.User;
+
+/**
+ * @author a.kohlbecker
+ * @since Apr 23, 2018
+ *
+ */
+public class CdmEntityDecoraterDTO<CDM extends CdmBase> implements Serializable {
+
+ private static final long serialVersionUID = 1715911851453178727L;
+
+ protected CDM entity;
+
+ public CdmEntityDecoraterDTO(CDM entity){
+ this.entity = entity;
+ }
+
+ public CDM cdmEntity(){
+ return entity;
+ }
+
+ public void setCreated(DateTime created) {
+ entity.setCreated(created);
+ }
+
+ public void setCreatedBy(User createdBy) {
+ entity.setCreatedBy(createdBy);
+ }
+
+ public DateTime getCreated() {
+ return entity.getCreated();
+ }
+
+ public User getCreatedBy() {
+ return entity.getCreatedBy();
+ }
+
+ public int getId() {
+ return entity.getId();
+ }
+
+ public void setId(int id) {
+ entity.setId(id);
+ }
+
+ public UUID getUuid() {
+ return entity.getUuid();
+ }
+
+ public void setUuid(UUID uuid) {
+ entity.setUuid(uuid);
+ }
+
+}
--- /dev/null
+/**
+* Copyright (C) 2017 EDIT
+* European Distributed Institute of Taxonomy
+* http://www.e-taxonomy.eu
+*
+* The contents of this file are subject to the Mozilla Public License Version 1.1
+* See LICENSE.TXT at the top of this package for the full license terms.
+*/
+package eu.etaxonomy.vaadin.mvp;
+
+import eu.etaxonomy.cdm.model.common.CdmBase;
+import eu.etaxonomy.cdm.vaadin.model.CdmEntityDecoraterDTO;
+
+/**
+ * Provides generic save operations of modified cdm entities.
+ *
+ * @author a.kohlbecker
+ * @since Apr 5, 2017
+ *
+ */
+public abstract class AbstractCdmDTOEditorPresenter<DTO extends CdmEntityDecoraterDTO<CDM>, CDM extends CdmBase, V extends ApplicationView<?>> extends CdmEditorPresenterBase<DTO, CDM, V> {
+
+ private static final long serialVersionUID = -6315824180341694825L;
+
+
+ @Override
+ protected CDM cdmEntity(DTO dto) {
+ return dto.cdmEntity();
+ }
+
+
+
+}
\ No newline at end of file
*/
package eu.etaxonomy.vaadin.mvp;
-import java.util.Collection;
-import java.util.EnumSet;
-import java.util.HashSet;
-import java.util.UUID;
-
-import org.apache.log4j.Logger;
-import org.hibernate.HibernateException;
-
-import eu.etaxonomy.cdm.api.service.IService;
-import eu.etaxonomy.cdm.cache.CdmTransientEntityCacher;
-import eu.etaxonomy.cdm.debug.PersistentContextAnalyzer;
-import eu.etaxonomy.cdm.model.ICdmCacher;
import eu.etaxonomy.cdm.model.common.CdmBase;
-import eu.etaxonomy.cdm.model.common.User;
-import eu.etaxonomy.cdm.persistence.hibernate.permission.CRUD;
-import eu.etaxonomy.cdm.persistence.hibernate.permission.CdmAuthority;
-import eu.etaxonomy.cdm.service.CdmStore;
-import eu.etaxonomy.cdm.vaadin.event.EntityChangeEvent;
-import eu.etaxonomy.cdm.vaadin.permission.UserHelper;
-import eu.etaxonomy.cdm.vaadin.view.name.CachingPresenter;
-import eu.etaxonomy.vaadin.mvp.event.EditorPreSaveEvent;
-import eu.etaxonomy.vaadin.mvp.event.EditorSaveEvent;
/**
* Provides generic save operations of modified cdm entities.
* @since Apr 5, 2017
*
*/
-public abstract class AbstractCdmEditorPresenter<DTO extends CdmBase, V extends ApplicationView<?>> extends AbstractEditorPresenter<DTO, V>
- implements CachingPresenter {
-
- private static final long serialVersionUID = 2218185546277084261L;
-
- private static final Logger logger = Logger.getLogger(AbstractCdmEditorPresenter.class);
-
- /**
- * if not null, this CRUD set is to be used to create a CdmAuthoritiy for the base entity which will be
- * granted to the current use as long this grant is not assigned yet.
- */
- protected EnumSet<CRUD> crud = null;
-
-
- private ICdmCacher cache;
-
- private java.util.Collection<CdmBase> rootEntities = new HashSet<>();
+public abstract class AbstractCdmEditorPresenter<CDM extends CdmBase, V extends ApplicationView<?>> extends CdmEditorPresenterBase<CDM, CDM, V> {
- public AbstractCdmEditorPresenter() {
- super();
- logger.trace(this._toString() + " constructor");
- }
-
- CdmStore<DTO, IService<DTO>> store ;
-
- protected CdmAuthority newAuthorityCreated;
-
- protected CdmStore<DTO, IService<DTO>> getStore() {
- if(store == null){
- store = new CdmStore<>(getRepo(), getService());
- }
- return store;
- }
+ private static final long serialVersionUID = -6315824180341694825L;
@Override
- protected DTO loadBeanById(Object identifier) {
-
- DTO cdmEntitiy;
- if(identifier != null) {
- UUID uuidIdentifier = (UUID)identifier;
- // CdmAuthority is needed before the bean is loaded into the session.
- // otherwise adding the authority to the user would cause a flush
- cdmEntitiy = loadCdmEntity(uuidIdentifier);
- guaranteePerEntityCRUDPermissions(cdmEntitiy);
- } else {
- cdmEntitiy = loadCdmEntity(null);
- if(cdmEntitiy != null){
- guaranteePerEntityCRUDPermissions(cdmEntitiy);
- }
- }
- cache = new CdmTransientEntityCacher(this);
- // need to use load but put see #7214
- cdmEntitiy = cache.load(cdmEntitiy);
- addRootEntity(cdmEntitiy);
-
+ protected CDM createDTODecorator(CDM cdmEntitiy) {
return cdmEntitiy;
}
- /**
- * @param cdmEntitiy
- */
- @Override
- protected void adaptToUserPermission(DTO cdmEntitiy) {
- UserHelper userHelper = UserHelper.fromSession();
- boolean canDelte = userHelper.userHasPermission(cdmEntitiy, CRUD.DELETE);
- boolean canEdit = userHelper.userHasPermission(cdmEntitiy, CRUD.UPDATE);
-
- User user = userHelper.user();
-
- if(AbstractCdmPopupEditor.class.isAssignableFrom(getView().getClass())){
- AbstractCdmPopupEditor popupView = ((AbstractCdmPopupEditor)getView());
-
- if(!canEdit){
- popupView.setReadOnly(true); // never reset true to false here!
- logger.debug("setting editor to readonly");
- }
- if(!canDelte){
- popupView.withDeleteButton(false);
- logger.debug("removing delete button");
- }
- }
-
- }
-
- /**
- * @param identifier
- * @return
- */
- protected abstract DTO loadCdmEntity(UUID uuid);
-
- /**
- * Grant per entity CdmAuthority to the current user <b>for the bean which is not yet loaded</b>
- * into the editor. The <code>CRUD</code> to be granted are stored in the <code>crud</code> field.
- */
- protected abstract void guaranteePerEntityCRUDPermissions(UUID identifier);
-
- /**
- * Grant per entity CdmAuthority to the current user for the bean which is loaded
- * into the editor. The <code>CRUD</code> to be granted are stored in the <code>crud</code> field.
- */
- protected abstract void guaranteePerEntityCRUDPermissions(DTO bean);
-
- /**
- * @return
- */
- protected abstract IService<DTO> getService();
-
- @SuppressWarnings("unchecked")
- @Override
- // @EventBusListenerMethod // already annotated at super class
- public void onEditorPreSaveEvent(EditorPreSaveEvent preSaveEvent){
-
- if(!isFromOwnView(preSaveEvent)){
- return;
- }
- super.onEditorPreSaveEvent(preSaveEvent);
- }
-
- @SuppressWarnings("unchecked")
- @Override
- // @EventBusListenerMethod // already annotated at super class
- public void onEditorSaveEvent(EditorSaveEvent<DTO> saveEvent){
-
- if(!isFromOwnView(saveEvent)){
- return;
- }
-
- // the bean is now updated with the changes made by the user
- DTO bean = saveEvent.getBean();
-
- if(logger.isTraceEnabled()){
- PersistentContextAnalyzer pca = new PersistentContextAnalyzer(bean);
- pca.printEntityGraph(System.err);
- pca.printCopyEntities(System.err);
- }
- bean = handleTransientProperties(bean);
-
- if(logger.isTraceEnabled()){
- PersistentContextAnalyzer pca = new PersistentContextAnalyzer(bean);
- pca.printEntityGraph(System.err);
- pca.printCopyEntities(System.err);
- }
- try {
- EntityChangeEvent changeEvent = getStore().saveBean(bean, (AbstractView) getView());
-
- if(changeEvent != null){
- viewEventBus.publish(this, changeEvent);
- }
- } catch (HibernateException e){
- if(newAuthorityCreated != null){
- UserHelper.fromSession().removeAuthorityForCurrentUser(newAuthorityCreated);
- }
- throw e;
- }
- }
-
- /**
- * EditorPresenters for beans with transient properties should overwrite this method to
- * update the beanItem with the changes made to the transient properties.
- * <p>
- * This is necessary because Vaadin MethodProperties are readonly when no setter is
- * available. This can be the case with transient properties. Automatic updating
- * of the property during the fieldGroup commit does not work in this case.
- *
- * @deprecated editors should operate on DTOs instead, remove this method if unused.
- */
- @Deprecated
- protected DTO handleTransientProperties(DTO bean) {
- // no need to handle transient properties in the generic case
- return bean;
- }
-
-// @Override
-// protected DTO prepareAsFieldGroupDataSource(DTO bean){
-// DTO mergedBean = getStore().mergedBean(bean);
-// // DTO mergedBean = bean;
-// return mergedBean;
-// }
-
- /**
- * If the bean is contained in the session it is being updated by
- * doing an evict and merge. The fieldGroup is updated with the merged bean.
- *
- * @param bean
- *
- * @return The bean merged to the session or original bean in case a merge was not necessary.
- */
- private DTO mergedBean(DTO bean) {
- DTO mergedBean = getStore().mergedBean(bean);
- ((AbstractPopupEditor<DTO, AbstractCdmEditorPresenter<DTO, V>>)getView()).updateItemDataSource(mergedBean);
- return mergedBean;
-
- }
-
@Override
- protected
- final void saveBean(DTO bean){
- // blank implementation, since this is not needed in this or any sub class
- // see onEditorSaveEvent() instead
+ protected CDM cdmEntity(CDM dto) {
+ return dto;
}
- @Override
- protected void deleteBean(DTO bean){
- EntityChangeEvent changeEvent = getStore().deleteBean(bean, (AbstractView) getView());
- if(changeEvent != null){
- viewEventBus.publish(this, changeEvent);
- }
-
- }
-
- /**
- * @param crud
- */
- public void setGrantsForCurrentUser(EnumSet<CRUD> crud) {
- this.crud = crud;
-
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- public ICdmCacher getCache() {
- return cache;
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- public void addRootEntity(CdmBase entity) {
- rootEntities.add(entity);
- }
-
-
- /**
- * {@inheritDoc}
- */
- @Override
- public Collection<CdmBase> getRootEntities() {
- return rootEntities;
- }
-
-
-}
+}
\ No newline at end of file
--- /dev/null
+/**
+* Copyright (C) 2017 EDIT
+* European Distributed Institute of Taxonomy
+* http://www.e-taxonomy.eu
+*
+* The contents of this file are subject to the Mozilla Public License Version 1.1
+* See LICENSE.TXT at the top of this package for the full license terms.
+*/
+package eu.etaxonomy.vaadin.mvp;
+
+import java.util.Collection;
+import java.util.EnumSet;
+import java.util.HashSet;
+import java.util.UUID;
+
+import org.apache.log4j.Logger;
+import org.hibernate.HibernateException;
+
+import eu.etaxonomy.cdm.api.service.IService;
+import eu.etaxonomy.cdm.cache.CdmTransientEntityCacher;
+import eu.etaxonomy.cdm.debug.PersistentContextAnalyzer;
+import eu.etaxonomy.cdm.model.ICdmCacher;
+import eu.etaxonomy.cdm.model.common.CdmBase;
+import eu.etaxonomy.cdm.model.common.User;
+import eu.etaxonomy.cdm.persistence.hibernate.permission.CRUD;
+import eu.etaxonomy.cdm.persistence.hibernate.permission.CdmAuthority;
+import eu.etaxonomy.cdm.service.CdmStore;
+import eu.etaxonomy.cdm.vaadin.event.EntityChangeEvent;
+import eu.etaxonomy.cdm.vaadin.permission.UserHelper;
+import eu.etaxonomy.cdm.vaadin.view.name.CachingPresenter;
+import eu.etaxonomy.vaadin.mvp.event.EditorPreSaveEvent;
+import eu.etaxonomy.vaadin.mvp.event.EditorSaveEvent;
+
+/**
+ * Provides generic save operations of modified cdm entities.
+ *
+ * @author a.kohlbecker
+ * @since Apr 5, 2017
+ *
+ */
+public abstract class CdmEditorPresenterBase<DTO, CDM extends CdmBase, V extends ApplicationView<?>> extends AbstractEditorPresenter<DTO, V>
+ implements CachingPresenter {
+
+ private static final long serialVersionUID = 2218185546277084261L;
+
+ private static final Logger logger = Logger.getLogger(CdmEditorPresenterBase.class);
+
+ /**
+ * if not null, this CRUD set is to be used to create a CdmAuthoritiy for the base entity which will be
+ * granted to the current use as long this grant is not assigned yet.
+ */
+ protected EnumSet<CRUD> crud = null;
+
+
+ private ICdmCacher cache;
+
+ private java.util.Collection<CdmBase> rootEntities = new HashSet<>();
+
+ public CdmEditorPresenterBase() {
+ super();
+ logger.trace(this._toString() + " constructor");
+ }
+
+ CdmStore<CDM, IService<CDM>> store ;
+
+ protected CdmAuthority newAuthorityCreated;
+
+ protected CdmStore<CDM, IService<CDM>> getStore() {
+ if(store == null){
+ store = new CdmStore<>(getRepo(), getService());
+ }
+ return store;
+ }
+
+ @Override
+ protected DTO loadBeanById(Object identifier) {
+
+ CDM cdmEntitiy;
+ if(identifier != null) {
+ UUID uuidIdentifier = (UUID)identifier;
+ // CdmAuthority is needed before the bean is loaded into the session.
+ // otherwise adding the authority to the user would cause a flush
+ cdmEntitiy = loadCdmEntity(uuidIdentifier);
+ guaranteePerEntityCRUDPermissions(cdmEntitiy);
+ } else {
+ cdmEntitiy = loadCdmEntity(null);
+ if(cdmEntitiy != null){
+ guaranteePerEntityCRUDPermissions(cdmEntitiy);
+ }
+ }
+ cache = new CdmTransientEntityCacher(this);
+ // need to use load but put see #7214
+ cdmEntitiy = cache.load(cdmEntitiy);
+ addRootEntity(cdmEntitiy);
+
+ DTO dto = createDTODecorator(cdmEntitiy);
+
+ return dto;
+ }
+
+ /**
+ * @param cdmEntitiy
+ * @return
+ */
+ protected abstract DTO createDTODecorator(CDM cdmEntitiy);
+
+ /**
+ * @param cdmEntitiy
+ */
+ @Override
+ protected void adaptToUserPermission(DTO dto) {
+
+ CDM cdmEntitiy = cdmEntity(dto);
+
+ UserHelper userHelper = UserHelper.fromSession();
+ boolean canDelte = userHelper.userHasPermission(cdmEntitiy, CRUD.DELETE);
+ boolean canEdit = userHelper.userHasPermission(cdmEntitiy, CRUD.UPDATE);
+
+ User user = userHelper.user();
+
+ if(AbstractCdmPopupEditor.class.isAssignableFrom(getView().getClass())){
+ AbstractCdmPopupEditor popupView = ((AbstractCdmPopupEditor)getView());
+
+ if(!canEdit){
+ popupView.setReadOnly(true); // never reset true to false here!
+ logger.debug("setting editor to readonly");
+ }
+ if(!canDelte){
+ popupView.withDeleteButton(false);
+ logger.debug("removing delete button");
+ }
+ }
+
+ }
+
+ /**
+ * @param dto
+ * @return
+ */
+ protected abstract CDM cdmEntity(DTO dto);
+
+ /**
+ * @param identifier
+ * @return
+ */
+ protected abstract CDM loadCdmEntity(UUID uuid);
+
+ /**
+ * Grant per entity CdmAuthority to the current user <b>for the bean which is not yet loaded</b>
+ * into the editor. The <code>CRUD</code> to be granted are stored in the <code>crud</code> field.
+ */
+ protected abstract void guaranteePerEntityCRUDPermissions(UUID identifier);
+
+ /**
+ * Grant per entity CdmAuthority to the current user for the bean which is loaded
+ * into the editor. The <code>CRUD</code> to be granted are stored in the <code>crud</code> field.
+ */
+ protected abstract void guaranteePerEntityCRUDPermissions(CDM bean);
+
+ /**
+ * @return
+ */
+ protected abstract IService<CDM> getService();
+
+ @SuppressWarnings("unchecked")
+ @Override
+ // @EventBusListenerMethod // already annotated at super class
+ public void onEditorPreSaveEvent(EditorPreSaveEvent preSaveEvent){
+
+ if(!isFromOwnView(preSaveEvent)){
+ return;
+ }
+ super.onEditorPreSaveEvent(preSaveEvent);
+ }
+
+ @SuppressWarnings("unchecked")
+ @Override
+ // @EventBusListenerMethod // already annotated at super class
+ public void onEditorSaveEvent(EditorSaveEvent<DTO> saveEvent){
+
+ if(!isFromOwnView(saveEvent)){
+ return;
+ }
+
+ // the bean is now updated with the changes made by the user
+ DTO dto = saveEvent.getBean();
+ CDM cdmEntity = cdmEntity(dto);
+
+ if(logger.isTraceEnabled()){
+ PersistentContextAnalyzer pca = new PersistentContextAnalyzer(cdmEntity);
+ pca.printEntityGraph(System.err);
+ pca.printCopyEntities(System.err);
+ }
+ dto = handleTransientProperties(dto);
+
+ if(logger.isTraceEnabled()){
+ PersistentContextAnalyzer pca = new PersistentContextAnalyzer(cdmEntity);
+ pca.printEntityGraph(System.err);
+ pca.printCopyEntities(System.err);
+ }
+ try {
+ EntityChangeEvent changeEvent = getStore().saveBean(cdmEntity, (AbstractView) getView());
+
+ if(changeEvent != null){
+ viewEventBus.publish(this, changeEvent);
+ }
+ } catch (HibernateException e){
+ if(newAuthorityCreated != null){
+ UserHelper.fromSession().removeAuthorityForCurrentUser(newAuthorityCreated);
+ }
+ throw e;
+ }
+ }
+
+ /**
+ * EditorPresenters for beans with transient properties should overwrite this method to
+ * update the beanItem with the changes made to the transient properties.
+ * <p>
+ * This is necessary because Vaadin MethodProperties are readonly when no setter is
+ * available. This can be the case with transient properties. Automatic updating
+ * of the property during the fieldGroup commit does not work in this case.
+ *
+ * @deprecated editors should operate on DTOs instead, remove this method if unused.
+ */
+ @Deprecated
+ protected DTO handleTransientProperties(DTO bean) {
+ // no need to handle transient properties in the generic case
+ return bean;
+ }
+
+// @Override
+// protected DTO prepareAsFieldGroupDataSource(DTO bean){
+// DTO mergedBean = getStore().mergedBean(bean);
+// // DTO mergedBean = bean;
+// return mergedBean;
+// }
+
+// /**
+// * If the bean is contained in the session it is being updated by
+// * doing an evict and merge. The fieldGroup is updated with the merged bean.
+// *
+// * @param bean
+// *
+// * @return The bean merged to the session or original bean in case a merge was not necessary.
+// */
+// private DTO mergedBean(DTO bean) {
+// DTO mergedBean = getStore().mergedBean(bean);
+// ((AbstractPopupEditor<DTO, AbstractCdmEditorPresenter<DTO, V>>)getView()).updateItemDataSource(mergedBean);
+// return mergedBean;
+//
+// }
+
+ @Override
+ protected
+ final void saveBean(DTO bean){
+ // blank implementation, since this is not needed in this or any sub class
+ // see onEditorSaveEvent() instead
+ }
+
+ @Override
+ protected void deleteBean(DTO bean){
+ CDM cdmEntity = cdmEntity(bean);
+ EntityChangeEvent changeEvent = getStore().deleteBean(cdmEntity, (AbstractView) getView());
+ if(changeEvent != null){
+ viewEventBus.publish(this, changeEvent);
+ }
+
+ }
+
+ /**
+ * @param crud
+ */
+ public void setGrantsForCurrentUser(EnumSet<CRUD> crud) {
+ this.crud = crud;
+
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public ICdmCacher getCache() {
+ return cache;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void addRootEntity(CdmBase entity) {
+ rootEntities.add(entity);
+ }
+
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Collection<CdmBase> getRootEntities() {
+ return rootEntities;
+ }
+
+
+}
BGBM BDI Projects / cdm-vaadin.git / commitdiff