org.docx4j.model.datastorage.DomToXPathMap Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of docx4j-core Show documentation

docx4j is a library which helps you to work with the Office Open XML file format as used in docx documents, pptx presentations, and xlsx spreadsheets.

There is a newer version: 11.4.11

Show newest version

package org.docx4j.model.datastorage;

import java.util.HashMap;
import java.util.Map;
import java.util.Stack;

import org.docx4j.model.datastorage.xpathtracker.Histgram;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

public class DomToXPathMap {
	
	private static Logger log = LoggerFactory.getLogger(DomToXPathMap.class);	
		
    private final Stack histgrams = new Stack();

    private Document document;
    
    private Map pathMap = null; 
    
    
    public Map getPathMap() {
		return pathMap;
	}

	/**
     * count the number of child nodes; used for pre-calculation
     * of (1) repeat xpaths, and (2) certain simple conditions.
     * 
     * By default, an entry counts the number of children which
     * are the same element as the first element child, since this
     * is what we need for repeats.
     * 
     * If there are elements with different names, the count
     * is put in the map with PREFIX_ALL_NODES prefix.
     * 
     * @since 3.3.6
     */
    private Map countMap = null; 
    
    public static final String PREFIX_ALL_NODES = "_all_";
    
    public Map getCountMap() {
		return countMap;
	}

	public DomToXPathMap(Document document) {
    	this.document = document;
    }
    
    public void map() {

        histgrams.clear();
        histgrams.push(new Histgram());
        
        pathMap = new HashMap(); 
        countMap = new HashMap(); 
        
        walkTree(document);
    }

    private String getLocalName(Node sourceNode) {
    	
    	if (sourceNode.getLocalName()==null) {
    		// eg element was created using createElement() 
    		return sourceNode.getNodeName();
    	
    	} else {
    		return sourceNode.getLocalName();
    	}
    	
    }
	
	public void walkTree( Node sourceNode ) {
			    	
//    	log.debug("node type" + sourceNode.getNodeType());
    	
        switch (sourceNode.getNodeType() ) {

	    	case Node.DOCUMENT_NODE: // type 9
        	case Node.DOCUMENT_FRAGMENT_NODE: // type 11
        
//        		log.debug("DOCUMENT:" + w3CDomNodeToString(sourceNode) );
//        		if (sourceNode.getChildNodes().getLength()==0) {
//        			log.debug("..no children!");
//        		}
        		
                // recurse on each child
                NodeList nodes = sourceNode.getChildNodes();
                if (nodes != null) {
                    for (int i=0; i");
//                    break;
//
//                case Node.COMMENT_NODE:
//                    writer.write(indentLevel + "");
//                    writer.write(lineSeparator);
//                    break;
//
//                case Node.PROCESSING_INSTRUCTION_NODE:
//                    writer.write("");
//                    writer.write(lineSeparator);
//                    break;
//
//                case Node.ENTITY_REFERENCE_NODE:
//                    writer.write("&" + node.getNodeName() + ";");
//                    break;
//
//                case Node.DOCUMENT_TYPE_NODE:
//                    DocumentType docType = (DocumentType)node;
//                    writer.write("");
//                    writer.write(lineSeparator);
//                    break;
        }
        

    }
	
    /**
     * Gets the XPath to the current element.
     */
    public String getXPath() {
        StringBuilder buf = new StringBuilder();
        for (Histgram h : histgrams) {
            h.appendPath(buf);
        }
        return buf.toString();
    }
    
}