Teamsite DCR java parser

Working with teamsite DCRs is painful. This is my attempt to make it a little bit less painful.

I made this program in order to make it easier to edit and parse teamsite data capture records. I should have done this a long time ago, and actually this is the first step towards freeing myself from OpenDeploy.

Anyway, here is the code for the parser:

<br />package com.dogself.teamsite.parser;<br /><br />import java.io.File;<br />import java.io.FileInputStream;<br />import java.io.FileOutputStream;<br />import java.io.IOException;<br />import java.util.ArrayList;<br />import java.util.List;<br /><br />import org.jdom.Document;<br />import org.jdom.Element;<br />import org.jdom.JDOMException;<br />import org.jdom.input.SAXBuilder;<br />import org.jdom.output.XMLOutputter;<br />import org.jdom.xpath.XPath;<br /><br />/**<br /> * Utility to open interwoven teamsite DCRs, access the values of all the items, and update item values.<br /> * <br /> * Note: replicant support is not yet implemented!<br /> * @author koryakm<br /> *<br /> */<br />public class DCRParser {<br /> private String path;<br /> private Document dom;<br /> <br /> public DCRParser(String path){<br /> this.path = path;<br /> try {<br /> parse();<br /> } catch (JDOMException e) {<br /> e.printStackTrace();<br /> } catch (IOException e) {<br /> e.printStackTrace();<br /> }<br /> }<br /> /**<br /> * return all the values of the given item as text<br /> * @param name = name of the item to get<br /> * @return<br /> * @throws JDOMException <br /> */<br /> @SuppressWarnings("unchecked")<br /> public ArrayList<string> getItemText(String name) throws JDOMException{<br /> XPath xpath = XPath.newInstance("//item[@name='"+name+"']/value"); <br /> ArrayList<string> arr = new ArrayList<string>(); <br /> List<element> nodes = xpath.selectNodes(dom);<br /> for(Element node: nodes){<br /> arr.add(node.getText());<br /> }<br /> return arr;<br /> }<br /> <br /> /**<br /> * Get all of the items named 'name' - returns a collection of DOM elements, you can change their values<br /> * in order to modify the original xml<br /> * @param name<br /> * @return<br /> * @throws JDOMException<br /> */<br /> @SuppressWarnings("unchecked")<br /> public ArrayList<element> getItem(String name) throws JDOMException{<br /> XPath xpath = XPath.newInstance("//item[@name='"+name+"']/value"); <br /> return new ArrayList<element>(xpath.selectNodes(dom));<br /> }<br /> /**<br /> * <br /> * @param xpath<br /> * @return<br /> * @throws JDOMException<br /> */<br /> @SuppressWarnings("unchecked")<br /> public ArrayList<element> getByXPath(String xpath) throws JDOMException{<br /> XPath xp = XPath.newInstance(xpath); <br /> return new ArrayList<element>(xp.selectNodes(dom));<br /> }<br /> <br /> /**<br /> * get an item using a path like this /main/item1/ (sorta like in formAPI)<br /> * @param path<br /> * @return<br /> * @throws JDOMException<br /> */<br /> @SuppressWarnings("unchecked")<br /> public ArrayList<element> getItemByPath(String path) throws JDOMException{<br /> String[] parts = path.split("/");<br /> String exp = "record";<br /> for(String p: parts){<br /> if(p.length()==0) continue;<br /> exp += "/item[@name='"+p+"']/value";<br /> }<br /> XPath xpath = XPath.newInstance(exp); <br /> return new ArrayList<element>(xpath.selectNodes(dom));<br /> }<br /> <br /> /**<br /> * proprietery: get uid of the DCR<br /> * @return<br /> * @throws JDOMException<br /> */<br /> public String getUID() throws JDOMException{<br /> return getItemByPath("/main/uid").get(0).getText();<br /> }<br /> /**<br /> * save this DCR<br /> * @throws IOException<br /> */<br /> public void saveDCR() throws IOException{<br /> saveDCR(path);<br /> }<br /> /**<br /> * save this DCR "as"<br /> * @param path<br /> * @throws IOException<br /> */<br /> public void saveDCR(String path) throws IOException{<br /> File f = new File(path);<br /> if(!f.exists()) f.createNewFile();<br /> FileOutputStream out = new FileOutputStream(f);<br /> XMLOutputter outputter = new XMLOutputter();<br /> try {<br /> outputter.output(dom, out); <br /> }<br /> catch (IOException e) {<br /> e.printStackTrace();<br /> }<br /> }<br /> private void parse() throws JDOMException, IOException{<br /> FileInputStream in = new FileInputStream(path); <br /> SAXBuilder builder = new SAXBuilder(); <br /> dom = builder.build(in); <br /> } <br />}<br />

Note: The code above does not yet truly support replicants, as in, you cant say 'give me the 3rd text field from the 2nd replicant..' unless you can figure out the xpath for it, which somewhat defeats the purpose of having a DCR parser.


Here is a driver class that uses my parser in order to do something silly.

<br />package com.dogself.teamsite.parser;<br /><br />import java.io.File;<br />import java.io.IOException;<br />import java.util.ArrayList;<br />import java.util.Arrays;<br /><br />import org.jdom.Element;<br />import org.jdom.JDOMException;<br /><br />public class Driver {<br /><br /> public Driver(String root) throws JDOMException, IOException{<br /> File[] files = getAllFilesUnderDir(root, true);<br /> for(File f: files){<br /> DCRParser parser = new DCRParser(f.getAbsolutePath());<br /> //get the title element (i know there is only 1)<br /> Element title = parser.getItem("txtTitle").get(0);<br /> String text = title.getText();<br /> //remove all html tags from the title<br /> text = text.replaceAll("<[^>]+>", "");<br /> //fix stupidness<br /> text = text.replaceAll("®", "&reg;");<br /> title.setText(text);<br /> parser.saveDCR();//save changes<br /> System.out.println("fixed title in:"+f.getAbsolutePath());<br /> }<br /> }<br /> public static void main(String[] args) {<br /> try {<br /> Driver d = new Driver("z:/test");<br /> } catch (JDOMException e) {<br /> e.printStackTrace();<br /> } catch (IOException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> @SuppressWarnings("unchecked")<br /> public static File[] getAllFilesUnderDir(String fullpath, boolean recursive) {<br /> ArrayList queue = new ArrayList(10);<br /> ArrayList matched = new ArrayList();<br /> File root = new File(fullpath);<br /> File[] files = root.listFiles();<br /> if (files == null || files.length == 0) {<br /> return new File[] {};<br /> }<br /> queue.addAll(Arrays.asList(files));<br /> for (int j = 0; j < child =" (File)" files =" child.listFiles();"> 0)?((File[]) matched.toArray(new File[] {})):(new File[] {});<br /> }<br />}<br /><br />

in order to use this parser you will need the following libs:
- JDOM
- JAXEN