com.logicbus.models.servant.DefaultArgument Maven / Gradle / Ivy

Go to download
package com.logicbus.models.servant;

import java.util.Map;

import org.w3c.dom.Element;

import com.anysoft.util.BaseException;
import com.anysoft.util.DefaultProperties;
import com.anysoft.util.Factory;
import com.anysoft.util.JsonTools;
import com.anysoft.util.Properties;
import com.anysoft.util.PropertiesConstants;
import com.anysoft.util.Settings;
import com.anysoft.util.XmlElementProperties;
import com.logicbus.backend.Context;
import com.logicbus.backend.ServantException;
import com.logicbus.backend.message.Message;
/**
 * Argument的缺省实现
 * 
 * @author duanyy
 * 
 * @since 1.2.5.4
 * 
 * @version 1.2.8 [20140912 duanyy]
 * - JsonSerializer中Map参数化
 * 
 * @version 1.4.0 [20141117 duanyy] 

 * - 抛弃MessageDoc 

 * 
 * @version 1.6.4.29 [20160126 duanyy] 

 * - 清除Servant体系中处于deprecated的方法 

 */
public class DefaultArgument implements Argument{
	/**
	 * 参数ID
	 */
	protected String id;
	
	/**
	 * 获取Id
	 * @return Id
	 */
	public String getId(){return id;}
	
	/**
	 * 缺省值
	 */
	protected String defaultValue;
	
	/**
	 * 获取缺省值
	 * @return 缺省值
	 */
	public String getDefaultValue(){return defaultValue;}
	
	/**
	 * 是否可选
	 */
	protected boolean isOption;
	
	/**
	 * 是否可选
	 * @return 是否可选
	 */
	public boolean isOption(){return isOption;}
	
	/**
	 * 是否需要缓存
	 * @since 1.0.8
	 * 
	 */
	protected boolean isCached = false;
	
	/**
	 * 是否需要缓存
	 * @return 是否需要缓存
	 * 
	 * @since 1.0.8
	 */
	public boolean isCached(){return isCached;}
	
	/**
	 * 参数getter
	 */
	protected String getter ="Default";
	
	/**
	 * 获取getter
	 * @return getter的类名
	 */
	public String getGetter(){return getter;}
	
	/**
	 * getter的参数
	 */
	protected String getterParameters;
	
	/**
	 * 获取gettter的参数
	 * @return gettter的参数
	 */
	public String getGetterParameters(){return getterParameters;}
	
	/**
	 * getter的参数列表
	 */
	protected Properties parameters = null;
	
	/**
	 * 获取getter的参数列表
	 * @return 参数列表
	 */
	public Properties getParameter(){
		if (parameters != null){
			return parameters;
		}
		if (getterParameters == null || getterParameters.length() <= 0){
			return null;
		}
		parameters = new DefaultProperties();
		parameters.loadFromString(getterParameters);
		return parameters;
	}
	
	/**
	 * getter的实例
	 */
	protected Getter theGetter = null;
	
	/**
	 * 获取参数值
	 * @param ctx 上下文
	 * 
	 * @since 1.4.0
	 */
	public String getValue(Context ctx) {
		if (theGetter == null){
			Settings settings = Settings.get();
			ClassLoader cl = (ClassLoader)settings.get("classLoader");
			TheFactory factory = new TheFactory(cl);
			theGetter = factory.newInstance(getter,getParameter());
		}
		return theGetter.getValue(this, ctx);
	}
	
	
	/**
	 * 获取参数值
	 * @param msg 服务消息
	 * @param ctx 上下文
	 * @return 参数值
	 * 
	 * @since 1.0.8
	 * 
	 */
	public String getValue(Message msg,Context ctx)throws ServantException{
		if (theGetter == null){
			Settings settings = Settings.get();
			ClassLoader cl = (ClassLoader)settings.get("classLoader");
			TheFactory factory = new TheFactory(cl);
			theGetter = factory.newInstance(getter,getParameter());
		}

		return theGetter.getValue(this, msg, ctx);
	}	
	
	/**
	 * 从另外的实例中复制数据
	 * @param argu
	 * 
	 * @since 1.2.4.4
	 */
	public void copyFrom(DefaultArgument argu){
		id = argu.id;
		defaultValue = argu.defaultValue;
		isOption = argu.isOption;
		getter = argu.getter;
		getterParameters = argu.getterParameters;
		isCached = argu.isCached;
	}
	
	
	public void toXML(Element e) {
		e.setAttribute("id", id);
		e.setAttribute("defaultValue", defaultValue);
		e.setAttribute("isOption", isOption?"true":"false");
		e.setAttribute("getter", getter);
		e.setAttribute("parameters", getterParameters);
		// since 1.0.8
		e.setAttribute("isCached", isCached ? "true" : "false");
	}

	
	public void fromXML(Element e) {
		XmlElementProperties props = new XmlElementProperties(e,null);
		
		id = PropertiesConstants.getString(props, "id", "");
		defaultValue = PropertiesConstants.getString(props, "defaultValue", "");
		isOption = PropertiesConstants.getBoolean(props, "isOption", true);
		getter = PropertiesConstants.getString(props,"getter","Default");
		// 1.2.0 修正笔误
		getterParameters = PropertiesConstants.getString(props,"parameters","");
		
		// since 1.0.8
		isCached = PropertiesConstants.getBoolean(props, "isCached", false);
	}

	
	public void toJson(Map json) {
		JsonTools.setString(json, "id", id);
		JsonTools.setString(json, "defaultValue",defaultValue);
		JsonTools.setBoolean(json, "isOption",isOption);
		JsonTools.setString(json, "getter",getter);
		JsonTools.setString(json, "parameters",getterParameters);
		// since 1.0.8
		JsonTools.setBoolean(json, "isCached", isCached);
	}

	
	public void fromJson(Map json) {
		id = JsonTools.getString(json, "id","");
		defaultValue = JsonTools.getString(json, "defaultValue","");
		isOption = JsonTools.getBoolean(json, "isOption",true);
		getter = JsonTools.getString(json, "getter","Default");
		getterParameters = JsonTools.getString(json, "parameters","");
		// since 1.0.8
		isCached = JsonTools.getBoolean(json, "isCached", false);
	}

	/**
	 * Factory of getter
	 * @author duanyy
	 *
	 */
	public static class TheFactory extends Factory{
		public TheFactory(ClassLoader cl){
			super(cl);
		}
		
		
		public String getClassName(String _module) throws BaseException{
			if (_module.indexOf(".") < 0){
				return "com.logicbus.models.servant.getter." + _module;
			}
			return _module;
		}		
	}
}