inode.java

一个“对象--XML 映射”（Object-Xml Mapping） 的类库。 它的目的是帮助开发者方便、快速的从XML 文件构建出Java 对象

package net.sf.oxmled.model;

import java.util.List;
import java.util.Map;
/**
 * 
 * @author 沈东良 Edward Shen<a href="mailto:[e-mail]">[e-mail]</a>
 * 2007-8-7 下午03:07:35
 *  INode是节点接口。它可以代表一个xml元素，也可以代表整个xml文件，或者一个多层的xml元素。
 *  它与具体的XML操作组件无关。
 */
public interface INode {

	/**
	 * 复制方法
	 */
	public abstract void clone(INode source);

	/**
	 * 复制这个节点，并返回
	 */
	public abstract INode clone();

	/**
	 * @return name
	 */
	public abstract String getName();

	/**
	 * @param name
	 *            要设置的 name
	 */
	public abstract void setName(String name);

	/**
	 * 返回属性集合
	 * @return attributes
	 */
	public abstract Map<String, String> getAttributes();

	/**
	 * @param attributes
	 *            要设置的 attributes
	 */
	public abstract void setAttributes(Map<String, String> attributes);

	/**
	 * 返回所有儿子节点
	 * @return childNodes
	 */
	public abstract List<INode> getChildNodes();

	/**
	 * @param childNodes
	 *            要设置的 childNodes
	 */
	public abstract void setChildNodes(List<INode> childNodes);

	/**
	 * @return parentNode  父亲节点
	 */
	public abstract INode getParentNode();

	/**
	 * @param parentNode
	 *            要设置的 parentNode
	 */
	public abstract void setParentNode(INode parentNode);

	/**
	 * @return text
	 */
	public abstract String getText();

	/**
	 * @param text
	 *            要设置的 text
	 */
	public abstract void setText(String text);

	/**
	 * 是不是根节点，默认不是
	 * @return root
	 */
	public abstract boolean isRoot();

	/**
	 * @param root
	 *            要设置 是否是 根节点
	 */
	public abstract void setRoot(boolean root);

	/**
	 * @return encoding  xml文件的编码
	 */
	public abstract String getEncoding();

	/**
	 * @param encoding
	 *            要设置的 encoding
	 */
	public abstract void setEncoding(String encoding);

	/**
	 * 返回该节点的文本表示。但不显示其子节点和属性。
	 * 
	 */
	public abstract String toString();

	/**
	 * 返回第几个儿子节点
	 * @param index
	 * @return
	 */
	public abstract INode getChild(int index);

	/**
	 * 
	 * @return  儿子节点的总数
	 */
	public abstract int getChildCount();

	/**
	 * 返回此列表中第一次出现的指定元素的索引；如果此列表不包含该元素，则返回 -1。
	 * @param child  要搜索的节点
	 * @return  此列表中第一次出现的指定节点的索引，如果列表不包含该元素，则返回 -1 
	 */
	public abstract int getIndexOfChild(INode child);

	/**
	 * 
	 * @return 这个节点的根节点
	 */
	public abstract INode getRoot();
	/**
	 * 
	 * @return  返回所有后代，不包括自己，也就是不包括根节点。
	 */
	public abstract List<INode> descendant();
	/**
	 * 
	 * @param node  返回与节点数据相同的节点的集合
	 * @return
	 */
	public abstract List<INode> getNodes(INode node);
	/**
	 * 
	 * @param name  xml元素的名字
	 * @return  返回所有有这个xml元素的名字
	 */
	public abstract List<INode> getNodes(String name);
	/**
	 * 
	 * @param node  返回儿子中相同的节点列表
	 * @return
	 */
	public abstract List<INode> getChildNodes(INode node);
	/**
	 * 
	 * @param node
	 * @return
	 */
	public abstract INode getSingleChildNode(INode node);
	/**
	 * 
	 * @param name  XML元素的名字
	 * @return  返回儿子中相同的节点列表
	 */
	public abstract List<INode> getChildNodes(String name);
	/**
	 * 
	 * @param name
	 * @return
	 */
	public abstract INode getSingleChildNode(String name);
	/**
	 * 
	 * @param node  它的儿子节点中包含这样的节点吗？
	 * @return
	 */
	public abstract boolean childContains(INode node);
	/**
	 * 
	 * @param name  xml元素的名字
	 * @return  它的儿子节点中，包括这个名字的元素吗？
	 */
	public abstract boolean childContains(String name);

}