org.ioc.commons.utils.XMLUtil Maven / Gradle / Ivy

Go to download
package org.ioc.commons.utils;

import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.UnsupportedEncodingException;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Array;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.text.NumberFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Text;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;

/**
 * Class for parsing a XML to a bean and vice versa.
 * 
 * Instructions for using xml2bean:
 * 
 * Create a bean having attributes with the same name of the tags and generate
 * getters & setters of it.
 * 
 * An XML like:
 * 
 *  * {@code
 * 
 * 	
 * 		FOO1
 * 		bar1
 * 		baz1
 * 	
 * 	
 * 		FOO2
 * 		bar2
 * 		baz2
 * 	
 * 
 * }
 * 
 * 
 * will require two beans like this:
 * 
 *  * {@code
 * 	public class Workareas {
 * 	private List workareas = new ArrayList();
 * 
 * 	public List getWorkareas() {
 * 		return workareas;
 * 	}
 * 
 * 	public void setWorkareas(List workareas) {
 * 		this.workareas = workareas;
 * 	}
 * }
 * 
 * public class Workarea {
 * 	private WorkareaType type;
 * 	private String id;
 * 	private String name;
 * 	
 * 	// Getters & Setters of attributes
 * }
 * 
 * public enum WorkareaType {
 * 	FOO1, FOO2;
 * }
 * }
 * 
 * 
 * @author Jesús Lunar Pérez
 */
public class XMLUtil {
	/**
	 * Logger for this class
	 */
	private static final FormatterLogger logger = FormatterLogger.getLogger(XMLUtil.class);

	public static class XMLUtilException extends Exception {

		/**
		 * Serial number
		 */
		private static final long serialVersionUID = 5118145977808353316L;

		public XMLUtilException(String message) {
			super(message);
		}

		public XMLUtilException(String message, Throwable cause) {
			super(message, cause);
		}
	}

	private XMLUtil() {
		// Static use only
	}

	private static String dateTimeFormat = "dd/MM/yyyy HH:mm:ss";
	private static String dateFormat = "dd/MM/yyyy";
	private static NumberFormat numberFormat = null;

	public static interface XMLNewBeanFactory {
		public Object getNewInstance(String nombreTag, String defaultPackageName);
	}

	public static interface XMLProcessingVisitor {
		String visit(String nodeText, Class parameterType);
	}

	@Target(ElementType.TYPE)
	@Retention(RetentionPolicy.RUNTIME)
	public static @interface XMLUtilTagName {
		String value();
	}

	/**
	 * Used to mark bean fields which we want to convert them into XML
	 * attributes instead of child nodes.
	 * 
	 * ONLY valid for primtive types.
	 * 
	 * @author Jesús Lunar Pérez
	 * 
	 */
	@Target(ElementType.FIELD)
	@Retention(RetentionPolicy.RUNTIME)
	public static @interface Attribute {
	}

	public static void xml2Bean(Element tag, Object bean, boolean log) throws IllegalArgumentException,
			IllegalAccessException, InvocationTargetException, InstantiationException, XMLUtilException,
			ClassNotFoundException, SecurityException, NoSuchFieldException {
		xml2Bean(tag, bean, log, (XMLProcessingVisitor) null);
	}

	public static void xml2Bean(Element tag, Object bean, boolean log,
			XMLProcessingVisitor xmlCalcOperationOnProcessingVisitor) throws IllegalArgumentException,
			IllegalAccessException, InvocationTargetException, InstantiationException, ClassNotFoundException,
			SecurityException, NoSuchFieldException, XMLUtilException {
		xml2Bean(tag, bean, log, (XMLNewBeanFactory) null, xmlCalcOperationOnProcessingVisitor);
	}

	public static void xml2Bean(Element tag, Object bean, boolean log, XMLNewBeanFactory newBeanFactory)
			throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, InstantiationException,
			XMLUtilException, ClassNotFoundException, SecurityException, NoSuchFieldException {
		xml2Bean(tag, bean, log, newBeanFactory, null);
	}

	public static void xml2Bean(Element tag, Object bean, boolean log, XMLNewBeanFactory newBeanFactory,
			XMLProcessingVisitor xmlCalcOperationOnProcessingVisitor) throws IllegalArgumentException,
			IllegalAccessException, InvocationTargetException, InstantiationException, XMLUtilException,
			ClassNotFoundException, SecurityException, NoSuchFieldException {
		StringBuffer logb = new StringBuffer();
		xml2Bean(tag, bean, log, logb, newBeanFactory, xmlCalcOperationOnProcessingVisitor);
		if (log) {
			logger.info(logb.toString());
		}
	}

	public static void xml2Bean(Element tag, Object bean, int level, Package parentPackage, boolean log)
			throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, InstantiationException,
			XMLUtilException, ClassNotFoundException, SecurityException, NoSuchFieldException {
		xml2Bean(tag, bean, 1, parentPackage, log, null);
	}

	public static void xml2Bean(Element tag, Object bean, int level, Package parentPackage, boolean log,
			XMLNewBeanFactory newBeanFactory) throws IllegalArgumentException, IllegalAccessException,
			InvocationTargetException, InstantiationException, XMLUtilException, ClassNotFoundException,
			SecurityException, NoSuchFieldException {
		StringBuffer logb = new StringBuffer();
		xml2Bean(tag, bean, level, parentPackage, log, logb, newBeanFactory, null);
		if (log) {
			logger.info(logb.toString());
		}
	}

	protected static void xml2Bean(Element tag, Object bean, boolean log, StringBuffer logb,
			XMLNewBeanFactory newBeanFactory) throws IllegalArgumentException, IllegalAccessException,
			InvocationTargetException, InstantiationException, XMLUtilException, ClassNotFoundException,
			SecurityException, NoSuchFieldException {
		xml2Bean(tag, bean, log, logb, newBeanFactory, (XMLProcessingVisitor) null);
	}

	protected static void xml2Bean(Element tag, Object bean, boolean log, StringBuffer logb,
			XMLNewBeanFactory newBeanFactory, XMLProcessingVisitor xmlCalcOperationOnProcessingVisitor)
			throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, InstantiationException,
			XMLUtilException, ClassNotFoundException, SecurityException, NoSuchFieldException {
		xml2Bean(tag, bean, 1, bean.getClass().getPackage(), log, logb, newBeanFactory,
				xmlCalcOperationOnProcessingVisitor);
	}

	@SuppressWarnings("unchecked")
	protected static void xml2Bean(Element tag, Object bean, int level, Package parentPackage, boolean log,
			StringBuffer logb, XMLNewBeanFactory newBeanFactory, XMLProcessingVisitor processingVisitor)
			throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, InstantiationException,
			XMLUtilException, ClassNotFoundException, SecurityException, NoSuchFieldException {

		StringBuffer tabs = new StringBuffer();

		for (int n = 0; n < level; n++) {
			tabs.append("\t");
		}

		boolean isList = bean instanceof List;
		NodeList tagChildList = tag.getChildNodes();
		if (log) {
			logb.append(
					tabs + "<" + tag.getTagName() + "> "
							+ (isList ? "(list)" : "(bean) children=" + tagChildList.getLength())).append('\n');
		}

		/**
		 * Rellenamos los atributos
		 */
		NamedNodeMap attributes = tag.getAttributes();
		setAttributes(bean, attributes, level, log, logb, processingVisitor);

		if (!isList) {

			/**
			 * Rellenamos los tags hijo
			 */
			setTagChildren(bean, tagChildList, level, parentPackage, log, logb, newBeanFactory, processingVisitor);
		} else {
			List