panda.tool.codegen.EntityGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of panda-tool Show documentation
Panda Tool contains some commonly used tools and source code generator for Panda Mvc. Can generate Entity/Query/Dao/Action class, Freemarker (HTML) template file.
There is a newer version: 1.5.3
Show newest version
package panda.tool.codegen;

import java.io.Serializable;
import java.util.Calendar;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;

import freemarker.template.Configuration;
import freemarker.template.Template;

import panda.dao.DaoTypes;
import panda.dao.entity.Entities;
import panda.dao.entity.annotation.Column;
import panda.dao.entity.annotation.Comment;
import panda.dao.entity.annotation.FK;
import panda.dao.entity.annotation.ForeignKeys;
import panda.dao.entity.annotation.Id;
import panda.dao.entity.annotation.Index;
import panda.dao.entity.annotation.Indexes;
import panda.dao.entity.annotation.Join;
import panda.dao.entity.annotation.JoinColumn;
import panda.dao.entity.annotation.Joins;
import panda.dao.entity.annotation.PK;
import panda.dao.entity.annotation.Table;
import panda.dao.query.BooleanCondition;
import panda.dao.query.ComparableCondition;
import panda.dao.query.DataQuery;
import panda.dao.query.ObjectCondition;
import panda.dao.query.Query;
import panda.dao.query.StringCondition;
import panda.lang.Arrays;
import panda.lang.Classes;
import panda.lang.Collections;
import panda.lang.Objects;
import panda.lang.Strings;
import panda.mvc.annotation.Validate;
import panda.mvc.annotation.Validates;
import panda.mvc.validator.Validators;
import panda.tool.codegen.bean.Entity;
import panda.tool.codegen.bean.EntityProperty;
import panda.tool.codegen.bean.Module;

/**
 * entity source generator
 */
public class EntityGenerator extends AbstractCodeGenerator {
	/**
	 * @param args arguments
	 */
	public static void main(String[] args) {
		new EntityGenerator().execute(args);
	}

	//---------------------------------------------------------------------------------------
	// properties
	//---------------------------------------------------------------------------------------
	protected Template tplEntityBean;
	protected Template tplEntityQuery;

	protected int cntEntity = 0;

	@Override
	protected void loadTemplates(Configuration cfg) throws Exception {
		tplEntityBean = cfg.getTemplate("entity/EntityBean.java.ftl");
		tplEntityQuery = cfg.getTemplate("entity/EntityQuery.java.ftl");
	}
	
	@Override
	protected void processModule(Module module) throws Exception {
		for (Entity entity : module.getEntityList()) {
			if (Boolean.TRUE.equals(entity.getGenerate())) {
				print2("Processing entity - " + entity.getName());

				if (entity.getPrimaryKeyList().size() < 1) {
					throw new IllegalArgumentException("missing primary key: " + entity.getName());
				}

				processJavaEntity(module, entity);

				cntEntity++;
			}
		}
	}

	@Override
	protected void postProcess() throws Exception {
		print0(cntModule + " modules processed, " + cntFile + " files of " + cntEntity + " entities generated successfully.");
	}

	protected void prepareImportList(Collection ps, Set imports) {
		for (EntityProperty p : ps) {
			String type = p.getFullJavaType();
			if (type.endsWith("[]")) {
				type = type.substring(0, type.length() - 2);
			}
			addImportType(imports, type);
		}
	}

	private void addFieldCondition(Set imports, EntityProperty p) {
		if ("boolean".equals(p.getFieldKind())) {
			imports.add(BooleanCondition.class.getName());
		}
		else if ("date".equals(p.getFieldKind())
				|| "number".equals(p.getFieldKind())) {
			imports.add(ComparableCondition.class.getName());
		}
		else if ("string".equals(p.getFieldKind())) {
			imports.add(StringCondition.class.getName());
		}
		else {
			imports.add(ObjectCondition.class.getName());
		}
	}

	private boolean isObjectField(EntityProperty p) {
		if ("boolean".equals(p.getFieldKind())
				|| "date".equals(p.getFieldKind())
				|| "number".equals(p.getFieldKind())
				|| "string".equals(p.getFieldKind())) {
			return false;
		}
		return true;
	}
	
	protected Set setJavaEntityQueryImportList(Map wrapper, Entity entity) {
		Set imports = new TreeSet();

		Set ps = new HashSet();
		for (EntityProperty p : entity.getPropertyList()) {
			if (p.isDbColumn() || p.isJoinColumn()) {
				if (!"bin".equals(p.getFieldKind())) {
					ps.add(p);
				}
				addFieldCondition(imports, p);
			}
		}
//		for (EntityProperty p : entity.getJoinColumnList()) {
//			if (!"bin".equals(p.getFieldKind())) {
//				ps.add(p);
//			}
//			addFieldCondition(imports, p);
//		}
		for (EntityProperty p : ps) {
			if ((p.isDbColumn() || p.isJoinColumn()) && !isObjectField(p)) {
				String type = p.getFullJavaType();
				if (type.endsWith("[]")) {
					type = type.substring(0, type.length() - 2);
				}
				if (!Strings.contains(type, '<')) {
					addImportType(imports, type);
				}
			}
		}

		imports.add(entity.getName());
		if (Collections.isNotEmpty(entity.getJoinMap())) {
			imports.add(Query.class.getName());
		}
		imports.add(DataQuery.class.getName());
		imports.add(Entities.class.getName());
		if (Strings.isNotEmpty(entity.getBaseQueryClass())) {
			imports.add(entity.getBaseQueryClass());
		}

		setImports(wrapper, imports);
		
		return imports;
	}

	protected void setJavaEntityBeanImportList(Map wrapper, Entity entity) {
		Set imports = new TreeSet();

		prepareImportList(entity.getPropertyList(), imports);

		imports.add(Serializable.class.getName());
		if (Strings.isEmpty(entity.getBaseBeanClass())) {
			imports.add(Serializable.class.getName());
		}
		else {
			imports.add(entity.getBaseBeanClass());
		}

		if (Arrays.isNotEmpty(entity.getBaseInterfaces())) {
			imports.addAll(Arrays.asList(entity.getBaseInterfaces()));
		}

		if (Strings.isNotEmpty(entity.getComment())) {
			if (!Comment.class.getSimpleName().equals(entity.getSimpleName())) {
				imports.add(Comment.class.getName());
			}
		}
		if (Strings.isNotEmpty(entity.getTable())) {
			imports.add(Table.class.getName());
		}
		if (Strings.isNotEmpty(entity.getIdentity())) {
			imports.add(Id.class.getName());
		}
		if (entity.getPrimaryKeyList().size() > 1 
				|| entity.getPrimaryKeyList().get(0) != entity.getIdentityProperty()) {
			imports.add(PK.class.getName());
		}
		if (!entity.getJoinMap().isEmpty()) {
			imports.add(Joins.class.getName());
			imports.add(Join.class.getName());
			imports.add(JoinColumn.class.getName());
		}
		if (!entity.getForeignKeyMap().isEmpty()) {
			imports.add(ForeignKeys.class.getName());
			imports.add(FK.class.getName());
		}
		if (!entity.getUniqueKeyMap().isEmpty()) {
			imports.add(Indexes.class.getName());
			imports.add(Index.class.getName());
		}
		if (!entity.getColumnList().isEmpty()) {
			imports.add(Column.class.getName());
			for (EntityProperty p : entity.getColumnList()) {
				if (Strings.isNotEmpty(p.getComment())) {
					if (!Comment.class.getSimpleName().equals(entity.getSimpleName())) {
						imports.add(Comment.class.getName());
					}
				}
				if (Strings.isNotEmpty(p.getJdbcType())) {
					imports.add(DaoTypes.class.getName());
				}
			}
		}

		imports.add(Objects.class.getName());

		for (EntityProperty p : entity.getPropertyList()) {
			if (Collections.isNotEmpty(p.getValidatorList())
					|| (p.isDbColumn() && !"String".equals(p.getType()))) {
				imports.add(Validators.class.getName());
				imports.add(Validates.class.getName());
				imports.add(Validate.class.getName());
				break;
			}
		}

		setImports(wrapper, imports);
	}

	protected Map getWrapper(Module module, Entity entity) {
		Map wrapper = new HashMap();
		
		if ("true".equals(module.getProps().getProperty("source.datetime"))) {
			wrapper.put("date", Calendar.getInstance().getTime());
		}
		wrapper.put("module", module);
		wrapper.put("props", module.getProps());
		wrapper.put("entity", entity);
		wrapper.put("gen", this);
		
		return wrapper;
	}
	
	protected void processJavaEntity(Module module, Entity entity) throws Exception {
		Map wrapper = getWrapper(module, entity);

		String pkg = Classes.getPackageName(entity.getBaseBeanClass());
		
		checkLicense(module, pkg);
		
		setJavaEntityBeanImportList(wrapper, entity);
		processTpl(entity.getPackage(), entity.getSimpleName() + ".java", 
			wrapper, tplEntityBean, true);

		setJavaEntityQueryImportList(wrapper, entity);
		processTpl(entity.getQueryPackage(), entity.getQuerySimpleName() + ".java", 
			wrapper, tplEntityQuery);
	}

	protected void setImports(Map wrapper, Object imports) {
		wrapper.put("imports", imports);
	}

	public String annoComment(Entity entity) {
		if (!Comment.class.getSimpleName().equals(entity.getSimpleName())) {
			return Comment.class.getSimpleName();
		}
		return Comment.class.getName();
	}

}