DaoEntity.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package  org.turro.jpa.entity;
 
import java.io.Serializable;
import java.lang.reflect.ParameterizedType;
import java.util.ArrayList;
import java.util.List;
import javax.persistence.Id;
import org.turro.string.Strings;
import org.turro.entities.Entities;
import org.turro.entities.IElephantEntity;
import org.turro.jpa.Dao;
import org.turro.json.Jsons;
import org.turro.log.SystemLogType;
import org.turro.log.SystemLogger;
import org.turro.reflection.Beans;
import org.turro.reflection.stub.Stubs;
 
public abstract class DaoEntity<T extends IDaoEntity, ID extends Serializable> {
 
  private final Class<T> persistentClass;
  private Dao dao;
  protected T entity;
  protected ID id;
  protected List<String> messages = new ArrayList<>();
 
  public DaoEntity() {
    this.persistentClass = (Class<T>) ((ParameterizedType) getClass()
            .getGenericSuperclass()).getActualTypeArguments()[0];
  }
 
  public DaoEntity(Class<T> persistentClass) {
    this.persistentClass = persistentClass;
  }
 
  public DaoEntity(T entity) {
    this.entity = entity;
    this.persistentClass = (Class<T>) entity.getClass();
  }
 
  public Dao getDao() {
    if(dao == null) {
      dao = createDao();
    }
    return dao;
  }
 
  public T getEntity() {
    return entity;
  }
  
  public IElephantEntity getIee() {
    return Entities.getController(entity);
  }
  
  protected abstract Dao createDao();
  protected abstract boolean shouldLog();
 
  @SuppressWarnings("unchecked")
  public T find(ID id) {
    this.id = id;
    entity = getDao().find(persistentClass, id);
    return entity;
  }
 
  @SuppressWarnings("unchecked")
  public T save() {
    initOperation();
    if(entity != null && canSave()) {
      entity.prepareSave();
      entity = getDao().saveObject(entity);
      logEntity(SystemLogType.LOG_INFO, entity, "saved", dataEntity(entity));
    }
    return entity;
  }
 
  public boolean delete() {
    initOperation();
    if(entity != null && canDelete()) {
      entity.prepareDelete();
      logEntity(SystemLogType.LOG_INFO, entity, "deleted",  dataEntity(entity));
      getDao().deleteObject(entity);
      return true;
    }
    return false;
  }
 
  public ID getId() {
    if(entity == null) {
      id = null;
    } else if(id == null) {
      id = (ID) Beans.of(entity).silentGetter(f -> f.isAnnotationPresent(Id.class));
    }
    return id;
  }
 
  public List<String> getMessages() {
    return messages;
  }
  
  protected void logEntity(SystemLogType logType, Object entity, String action, String data) {
    if(shouldLog()) {
      SystemLogger.type(logType).entity(entity).comment(action).object(data).log();
    }
  }
  
  protected String dataEntity(Object entity) {
    String entityData = Stubs.json(entity);
    if(Jsons.isEmpty(entityData)) {
      entityData = new XMLSerializer(entity).data();
    }
    return entityData;
  }
 
  public boolean canDelete() {
    return !entity.isNew();
  }
 
  public boolean canSave() {
    return !entity.isEmpty();
  }
 
  protected void initOperation() {
    messages.clear();
  }
  
  protected void addMessage(String message) {
    messages.add(message);
  }
  
  @Override
  public boolean equals(Object obj) {
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass() && entity.getClass() != obj.getClass()) {
      return false;
    }
    if(obj.equals(entity)) {
      return true;
    }
    if(obj instanceof DaoEntity && ((DaoEntity) obj).getEntity().equals(entity)) {
      return true;
    }
    return (getId() == null && obj == null) || 
           (getId() != null && (obj instanceof DaoEntity) && getId().equals(((DaoEntity) obj).getId()));
  }
 
  @Override
  public int hashCode() {
    return getId() == null ? 0 : getId().hashCode();
  }
 
  public static Object getEntityId(Object entity) {
    if(entity != null) {
      return Beans.of(entity).silentGetter(f -> f.isAnnotationPresent(Id.class));
    }
    return null;
  }
 
  public static boolean isNewId(Object id) {
    if(id instanceof String) {
      return Strings.isBlank((String) id);
    } else if(id instanceof Long) {
      return ((Long) id) == 0L;
    }
    return true;
  }
  
}