package com.vci.client.uif.engine.client.compare.dataloader;

import java.util.List;
import java.util.Map;

import com.vci.client.uif.engine.client.compare.dialog.treenode.TreeNodeObject;

/**
 * <p>数据加载接口</p>
 * 
 * 系统中一个完整的树节点时有与父节点的关系对象及节点主对象组成<br>
 * 
 * 通常的 对于系统中的业务对象，即为主对象，与父之间的链接关系即为节点关系对象<br>
 * 
 * @author VCI-STGK006
 *
 */
public interface DataLoader <M, R> {
	
	/**
	 * 在执行其它接口方法之前调用，
	 * 预先加载数据到本地内存。
	 *
	 * 解决大数据量是查询性能较慢的问题。
	 */
	public void loading();
	
	/**
	 * <p>得到所有根节点</p>
	 * 
	 * 使用根节点对象调用getKey(Object) 方法返回值即为Map的key<br>
	 * @return
	 */
	public Map<String, M> getRoots();
	
	/**
	 * <p>得到对象的唯一标示</p>
	 * 
	 * 在左右两侧树进行绘制时，通过该方法的返回值确定两侧节点是否在同一行<br>
	 * 
	 * @param object 可能是节点主对象，也可能是关系对象
	 * @return 返回该对象的唯一标识
	 */
	public String getKey(Object object);
	
	/**
	 * <p>根据父节点对象，得到与所有子对象的关系对象</P>
	 * 
	 * @param key 父节点主对象的唯一标识
	 * @param parent 父节点对象
	 * @return
	 */
	public List<R> getLinksByParent(String parentKey, TreeNodeObject parent);
	
	/**
	 * <p>根据关系对象得到子节点的唯一标识</p>
	 * @param r
	 * @return
	 */
	public String getChildKeyByLink(R r);
	
	/**
	 * <p>通过对象唯一标识获得主对象</p>
	 * 
	 * @param key 通过getKey(Object)方法得到的对象的唯一标识
	 * @return
	 */
	public M getObject(String key);
	
	/**
	 * <p>通过父节点，得到所有子节点对象</p>
	 * 
	 * 使用根节点对象调用getKey(Object) 方法返回值即为Map的key<br>
	 * 
	 * @param key 父节点主对象的唯一标识
	 * @param parent 父节点对象
	 * @return
	 */
	public Map<String, M> getChildren(String parentKey, TreeNodeObject parent);
	
	/**
	 * 通过父节点及子节点得到关系对象
	 * 
	 * @param parentKey 父节点主对象的唯一标识
	 * @param parent 父节点对象
	 * @param object 子对象
	 * @return
	 */
	public R getChildLink(String parentKey, TreeNodeObject parent, M object);
}