gov.nasa.pds.registry.common.util.xml.XmlDomUtils Maven / Gradle / Ivy

Go to download
package gov.nasa.pds.registry.common.util.xml;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXParseException;


/**
 * Utility class to work with XML DOM model.
 * NOTE: Don't use XML DOM API for big files. 
 * DOM API loads the whole XML file into memory. 
 * 
 * @author karpenko
 *
 */
public class XmlDomUtils
{
    /**
     * Parse XML file and create a DOM model.
     * This method reads the whole XML document into memory.
     * @param dbf Document builder factory
     * @param file XML file to parse
     * @return XML DOM model
     * @throws Exception Generic exception
     */
    public static Document readXml(DocumentBuilderFactory dbf, File file) throws Exception
    {
        DocumentBuilder db = dbf.newDocumentBuilder();
        // Don't print error messages to console.
        db.setErrorHandler(null);
        
        try
        {
            Document doc = db.parse(file);
            return doc;
        }
        catch(SAXParseException ex)
        {
            throw new Exception("Could not parse file " + file.getAbsolutePath() + ". " 
                    + ex.getMessage() + " (line = " + ex.getLineNumber() + ", column = " + ex.getColumnNumber() + ").");
        }
        catch(Exception ex)
        {
            throw new Exception("Could not parse file " + file.getAbsolutePath() + ". " + ex.getMessage());
        }
    }

    
    /**
     * Parse XML file and create a DOM model.
     * This method reads the whole XML document into memory.
     * @param file XML file to parse
     * @return XML DOM model
     * @throws Exception Generic exception
     */
    public static Document readXml(File file) throws Exception
    {
        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
        return readXml(dbf, file);
    }


    /**
     * Parse XML file and create a DOM model.
     * This method reads the whole XML document into memory.
     * @param xmlFile XML file to parse
     * @param xsdFile XSD schema file for XML validation
     * @param eh custom error handler
     * @return XML DOM model
     * @throws Exception Generic exception
     */
    public static Document readXml(File xmlFile, File xsdFile, ErrorHandler eh) throws Exception
    {
        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
        dbf.setValidating(true);
        dbf.setAttribute("http://java.sun.com/xml/jaxp/properties/schemaLanguage", "http://www.w3.org/2001/XMLSchema");
        dbf.setAttribute("http://java.sun.com/xml/jaxp/properties/schemaSource", xsdFile);

        DocumentBuilder db = dbf.newDocumentBuilder();
        db.setErrorHandler(eh);
        
        return db.parse(xmlFile);
    }


    /**
     * Get attribute of a node by name.
     * @param node DOM node
     * @param attributeName attribute name
     * @return attribute value
     */
    public static String getAttribute(Node node, String attributeName)
    {
        if(node == null || node.getAttributes() == null) return null;
        
        Node att = node.getAttributes().getNamedItem(attributeName);
        return att == null ? null : att.getNodeValue().trim();
    }


    /**
     * Get all attributes of a node.
     * @param node DOM node
     * @return attribute map
     */
    public static NamedNodeMap getAttributes(Node node)
    {
        if(node == null || node.getAttributes() == null) return null;
        return node.getAttributes();
    }
    
    
    /**
     * Count child nodes.
     * @param node Parent node object
     * @param name child node name
     * @return node count
     */
    public static int countChildNodes(Node node, String name)
    {
        int count = 0;
        
        NodeList nl = node.getChildNodes();
        
        for(int i = 0; i < nl.getLength(); i++)
        {
            Node n = nl.item(i);
            if(n.getNodeName().equals(name)) count++;
        }
        
        return count;
    }

    
    /**
     * Get first child node.
     * @param node parent node
     * @param name child node name
     * @return a child node
     */
    public static Node getFirstChild(Node node, String name)
    {
        NodeList nl = node.getChildNodes();
        
        for(int i = 0; i < nl.getLength(); i++)
        {
            Node n = nl.item(i);
            if(n.getNodeName().equals(name)) return n;
        }
        
        return null;
    }

    
    /**
     * Get all child nodes.
     * @param node parent node.
     * @param name child node name.
     * @return a list of nodes
     */
    public static List getChildNodes(Node node, String name)
    {
        List list = new ArrayList<>();
        
        NodeList nl = node.getChildNodes();
        
        for(int i = 0; i < nl.getLength(); i++)
        {
            Node n = nl.item(i);
            if(n.getNodeName().equals(name)) list.add(n);
        }
        
        return list;
    }

}