HistgramQNameTest.java

package org.docx4j.model.datastorage;

import static org.junit.Assert.*;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.dom.DOMResult;

import org.docx4j.XmlUtils;
import org.docx4j.model.datastorage.xpathtracker.Histgram;
import org.junit.Test;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

public class HistgramQNameTest {

	@Test
	public void test() {

		Document doc = org.docx4j.XmlUtils.neww3cDomDocument();
		
		Element el = doc.createElement("foo");		
		diagnostics(el);

		// + el.getLocalName() );  // null <---- never use this!
		
		el = doc.createElementNS(null, "bar");
		diagnostics(el);
		
		el = doc.createElementNS("http://foo", "bar");  // you shouldn't do this...
		diagnostics(el);
		el.setPrefix("foo"); // .. unless you do this
		diagnostics(el);
		

		el = doc.createElementNS("http://foo", "foo:bar");
		diagnostics(el);
		el.setPrefix("foo");
		diagnostics(el);
		
	}
	
	
	@Test
	public void testNotNamespaceAware() throws ParserConfigurationException {
		
		DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
		dbf.setNamespaceAware(false);
		
		Document doc = dbf.newDocumentBuilder().newDocument();
		
		Element el = doc.createElement("foo");
		diagnostics(el);
		// el.getLocalName() );  // null <---- never use this!
				
		/* We don't support:
		 * el = doc.createElement("foo:bar"); // ie in not namespace aware parser
		 * diagnostics(el);
		 */
				
		
		el = doc.createElementNS(null, "bar");  // even though not NS aware...
		diagnostics(el);
		
		el = doc.createElementNS("http://foo", "bar");
		diagnostics(el);
		
	}

	@Test
	public void testNamespaceAware() throws ParserConfigurationException {
		
		DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
		dbf.setNamespaceAware(true);
		
		Document doc = dbf.newDocumentBuilder().newDocument();
		
		Element el = doc.createElement("foo");
		diagnostics(el);		
		//  + el.getLocalName() );  // null <---- never use this!
		
		el = doc.createElementNS(null, "bar");
		diagnostics(el);
		
		el = doc.createElementNS("http://foo", "bar");
		diagnostics(el);
		
	}
	
	@Test
	public void testQName() {

        QName qn = new QName("http://foo", "b:ar");  // that is ok! 	:-(	
	}

	@Test
	public void testQName2() {

        QName qn = new QName(null, "ar");  // should be ok
	}
	
	@Test
	public void testMarshall() throws JAXBException {

		CaseData case1 = new CaseData();
		case1.setName("118905");
		
		JAXBContext jaxbContext = JAXBContext.newInstance(CaseData.class);

		System.out.println(XmlUtils.marshaltoString(case1, jaxbContext));
		
		Document d = XmlUtils.marshaltoW3CDomDocument(case1, jaxbContext);

		Element el = d.getDocumentElement();
		diagnostics(el);
	}
	

	@Test
	public void testMarshall2() throws JAXBException, ParserConfigurationException {

		CaseData case1 = new CaseData();
		case1.setName("118905");
		
		JAXBContext jc = JAXBContext.newInstance(CaseData.class);

		DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
		dbf.setNamespaceAware(true);
		
		Marshaller marshaller = jc.createMarshaller();
		
		org.w3c.dom.Document d = dbf.newDocumentBuilder().newDocument();
		marshaller.marshal(case1, d);
		
		Element el = d.getDocumentElement();
		diagnostics(el);
		
	}

	@Test
	public void testMarshall3() throws JAXBException, ParserConfigurationException {

		CaseData case1 = new CaseData();
		case1.setName("118905");
		
		JAXBContext jc = JAXBContext.newInstance(CaseData.class);
		
		Marshaller marshaller = jc.createMarshaller();
		
		DOMResult res = new DOMResult();
		marshaller.marshal(case1, res);
	    Document d = (Document) res.getNode();
		
		Element el = d.getDocumentElement();
		diagnostics(el);
		
	}
	
	
	@XmlRootElement(name="case", namespace="http://gctrack.gao.gov/templates/case-data")
	public static class CaseData {
		
		//<ns2:case xmlns:ns2="http://gctrack.gao.gov/templates/case-data">
	    //<name>118905</name>
		
		String name;

		public String getName() {
			return name;
		}

		@XmlElement
		public void setName(String name) {
			this.name = name;
		}
		
	}

	private static void diagnostics(Element el) {

		//System.out.println("java.version="+System.getProperty("java.version") );
		
		System.out.println("\nclass: " + el.getClass().getName() );	
		
		System.out.println("local name: " + el.getLocalName() );  // null <---- never use this!
		System.out.println("getTagName: " + el.getTagName() );  
		System.out.println("getNodeName: " + el.getNodeName() );
		
		System.out.println("getNamespaceURI(): " + el.getNamespaceURI());
		System.out.println("getPrefix(): " + el.getPrefix());
		
		/* For example:
		 * 
			class: com.sun.org.apache.xerces.internal.dom.ElementNSImpl
			local name: case
			getTagName: ns2:case
			getNodeName: ns2:case
			getNamespaceURI(): http://gctrack.gao.gov/templates/case-data
			getPrefix(): ns2
		 */		
		
		Histgram histgram = new Histgram();
		histgram.update(el.getNamespaceURI(),
						getLocalName(el),
	                		/* qname */ el.getNodeName() );

	}
	
    private static String getLocalName(Node sourceNode) {
    	
    	if (sourceNode.getLocalName()==null) {
    		// eg element was created using createElement() 
    		return sourceNode.getNodeName();
    	
    	} else {
    		return sourceNode.getLocalName();
    	}
    	
    }	
}