All Downloads are FREE. Search and download functionalities are using the official Maven repository.

cn.dreampie.common.entity.Entity Maven / Gradle / Ivy

Go to download

Resty common tools

There is a newer version: 1.3.0.RELEASE
Show newest version
package cn.dreampie.common.entity;

import cn.dreampie.common.entity.exception.EntityException;
import cn.dreampie.common.util.json.Jsoner;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

/**
 * Created by ice on 14-12-31.
 */
public abstract class Entity {

  private Map attrs = new CaseInsensitiveMap();
  /**
   * Flag of attr has been modified. update need this flag
   */
  private Map modifyAttrs = new CaseInsensitiveMap();

  /**
   * Return attribute Map.
   * Danger! The update method will ignore the attribute if you change it directly.
   * You must use set method to change attribute that update method can handle it.
   */
  public Map getAttrs() {
    return attrs;
  }

  /**
   * Set attributes with other entity.
   *
   * @param entity the Model
   * @return this Model
   */
  public M setAttrs(M entity) {
    return (M) setAttrs(entity.getAttrs());
  }

  /**
   * Set attributes with Map.
   *
   * @param attrs attributes of this entity
   * @return this Model
   */
  public M setAttrs(Map attrs) {
    for (Map.Entry e : attrs.entrySet())
      set(e.getKey(), e.getValue());
    return (M) this;
  }

  /**
   * 获取更新的属性列表
   *
   * @return Map
   */
  public Map getModifyAttrs() {
    return modifyAttrs;
  }

  /**
   * check method for to json
   *
   * @return boolean
   */
  public boolean checkMethod() {
    return false;
  }

  /**
   * 判断数据库是否拥有该列
   *
   * @param attr 属性名
   * @return boolean
   */
  public abstract boolean hasColumn(String attr);

  /**
   * 获取改数据库列对应的java类型
   *
   * @param attr 属性名
   * @return class
   */
  public abstract Class getColumnType(String attr);

  /**
   * Set attribute to entity.
   *
   * @param attr  the attribute name of the entity
   * @param value the value of the attribute
   * @return this entity
   * @throws cn.dreampie.common.entity.exception.EntityException if the attribute is not exists of the entity
   */
  public M set(String attr, Object value) {
    if (hasColumn(attr)) {
      attrs.put(attr, value);
      modifyAttrs.put(attr, value);  // Add modify flag, update() need this flag.
      return (M) this;
    }
    throw new EntityException("The attribute name is not exists: " + attr);
  }

  /**
   * 初始化属性 不会添加到modify
   *
   * @param attr
   * @param value
   * @return
   */
  public M init(String attr, Object value) {
    attrs.put(attr, value);
    return (M) this;
  }

  public M initAttrs(Map attrs) {
    for (Map.Entry e : attrs.entrySet()) {
      init(e.getKey(), e.getValue());
    }
    return (M) this;
  }

  public M initAttrs(M entity) {
    return (M) initAttrs(entity.getAttrs());
  }

  /**
   * Put key value pair to the entity when the key is not attribute of the entity.
   *
   * @param attr  属性名称
   * @param value 属性值
   * @return 当前entity对象
   */
  public M put(String attr, Object value) {
    if (hasColumn(attr)) {
      modifyAttrs.put(attr, value);
    }
    attrs.put(attr, value);
    return (M) this;
  }

  public M putAttrs(Map attrs) {
    for (Map.Entry e : attrs.entrySet()) {
      put(e.getKey(), e.getValue());
    }
    return (M) this;
  }

  /**
   * Set attrs value with entity.
   *
   * @param entity the entity
   */
  public M putAttrs(M entity) {
    return (M) putAttrs(entity.getAttrs());
  }

  /**
   * Get attr of any sql type
   */
  public  T get(String attr) {
    return (T) attrs.get(attr);
  }

  /**
   * Parse attr to any type
   */
  public  T get(String attr, Class clazz) {
    Object value = attrs.get(attr);
    if (clazz.isAssignableFrom(value.getClass())) {
      return (T) value;
    } else {
      return Jsoner.toObject(Jsoner.toJSON(value), clazz);
    }
  }

  /**
   * Get attr of any sql type. Returns defaultValue if null.
   */
  public  T get(String attr, Object defaultValue) {
    Object result = get(attr);
    return (T) (result != null ? result : defaultValue);
  }

  /**
   * Get attr for clazz. Returns defaultValue if null.
   */
  public  T get(String attr, Class clazz, Object defaultValue) {
    Object result = get(attr, clazz);
    return (T) (result != null ? result : defaultValue);
  }


  /**
   * Remove attribute of this entity.
   *
   * @param attr the attr name of the entity
   */
  public M remove(String attr) {
    attrs.remove(attr);
    return (M) this;
  }

  /**
   * Remove attrs of this entity.
   *
   * @param attrs the attr name of the entity
   */
  public M remove(String... attrs) {
    if (attrs != null)
      for (String c : attrs)
        this.attrs.remove(c);
    return (M) this;
  }

  /**
   * Remove attrs if it is null.
   */
  public M removeNull() {
    for (java.util.Iterator> it = attrs.entrySet().iterator(); it.hasNext(); ) {
      Map.Entry e = it.next();
      if (e.getValue() == null) {
        it.remove();
      }
    }
    return (M) this;
  }

  /**
   * Keep attrs of this entity and remove other attrs.
   *
   * @param attrs the attr name of the entity
   */
  public M keep(String... attrs) {
    if (attrs != null && attrs.length > 0) {
      Map newAttrs = new HashMap(attrs.length);
      for (String c : attrs) {
        if (this.attrs.containsKey(c)) { // prevent put null value to the newAttrs
          newAttrs.put(c, this.attrs.get(c));
        }
      }
      this.attrs.clear();
      this.attrs.putAll(newAttrs);
    } else {
      this.attrs.clear();
    }
    return (M) this;
  }

  /**
   * Keep attr of this entity and remove other attrs.
   *
   * @param attr the attr name of the entity
   */
  public M keep(String attr) {
    if (attrs.containsKey(attr)) {  // prevent put null value to the newAttrs
      Object keepIt = attrs.get(attr);
      attrs.clear();
      attrs.put(attr, keepIt);
    } else
      attrs.clear();
    return (M) this;
  }

  /**
   * Remove all attrs of this entity.
   */
  public M clearAttrs() {
    attrs.clear();
    return (M) this;
  }

  public M clearModifyAttrs() {
    modifyAttrs.clear();
    return (M) this;
  }

  public M reSetAttrs(Map attrs) {
    this.attrs = attrs;
    return (M) this;
  }

  public M reSetModifyAttrs(Map modifyAttrs) {
    this.modifyAttrs = modifyAttrs;
    return (M) this;
  }

  /**
   * Return attr name of this record.
   */
  public String[] getAttrNames() {
    Set attrNameSet = attrs.keySet();
    return attrNameSet.toArray(new String[attrNameSet.size()]);
  }

  /**
   * Return attr values of this record.
   */
  public Object[] getAttrValues() {
    Collection attrValueCollection = attrs.values();
    return attrValueCollection.toArray(new Object[attrValueCollection.size()]);
  }


  /**
   * Return attribute name of this entity.
   */
  public String[] getModifyAttrNames() {
    Set attrNameSet = modifyAttrs.keySet();
    return attrNameSet.toArray(new String[attrNameSet.size()]);
  }

  /**
   * Return attribute values of this entity.
   */
  public Object[] getModifyAttrValues() {
    Collection attrValueCollection = modifyAttrs.values();
    return attrValueCollection.toArray(new Object[attrValueCollection.size()]);
  }


  public String toString() {
    return toJson();
  }

  /**
   * Return json string of this record.
   */
  public String toJson() {
    return Jsoner.toJSON(attrs);
  }

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy