Clover Coverage Report - Implementation 2.0.0-SNAPSHOT
Coverage timestamp: Wed Dec 31 1969 19:00:00 EST
Overview   Package   File
    FRAMES   NO FRAMES     
../../../../../../img/srcFileCovDistChart0.png 0% of files have more coverage
62   195   22   6.2
18   125   0.35   5
10     2.2  
2    
 
  RouteNodeUtils       Line # 38 59 0% 21 86 0% 0.0
  RouteNodeUtils.RouteNodeSorter       Line # 158 3 0% 1 4 0% 0.0
 
No Tests
 
1    /*
2    * Copyright 2007-2008 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10    * Unless required by applicable law or agreed to in writing, software
11    * distributed under the License is distributed on an "AS IS" BASIS,
12    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13    * See the License for the specific language governing permissions and
14    * limitations under the License.
15    */
16    package org.kuali.rice.kew.engine.node;
17   
18    import org.apache.commons.lang.StringUtils;
19    import org.kuali.rice.core.api.exception.RiceRuntimeException;
20    import org.kuali.rice.kew.doctype.bo.DocumentType;
21    import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
22    import org.kuali.rice.kew.rule.xmlrouting.XPathHelper;
23    import org.w3c.dom.Document;
24    import org.xml.sax.InputSource;
25   
26    import javax.xml.parsers.DocumentBuilder;
27    import javax.xml.parsers.DocumentBuilderFactory;
28    import java.io.StringReader;
29    import java.util.*;
30   
31    /**
32    * A simple class for performing operations on RouteNode. In particular, this class provides some
33    * convenience methods for processing custom RouteNode XML content fragments.
34    *
35    * @author Kuali Rice Team (rice.collab@kuali.org)
36    *
37    */
 
38    public final class RouteNodeUtils {
39   
 
40  0 toggle private RouteNodeUtils() {
41  0 throw new UnsupportedOperationException("do not call");
42    }
43   
44    /**
45    * Searches a RouteNode's "contentFragment" (it's XML definition) for an XML element with
46    * the given name and returns it's value.
47    *
48    * <p>For example, in a node with the following definition:
49    *
50    * <pre><routeNode name="...">
51    * ...
52    * <myCustomProperty>propertyValue</myCustomProperty>
53    * </routeNode></pre>
54    *
55    * <p>An invocation of getValueOfCustomProperty(routeNode, "myCustomProperty") would return
56    * "propertyValue".
57    *
58    * @param routeNode RouteNode to examine
59    * @param propertyName name of the XML element to search for
60    *
61    * @return the value of the XML element, or null if it could not be located
62    */
 
63  0 toggle public static String getValueOfCustomProperty(RouteNode routeNode, String propertyName) {
64  0 String contentFragment = routeNode.getContentFragment();
65  0 String elementValue = null;
66  0 if (!StringUtils.isBlank(contentFragment)) {
67  0 try {
68  0 DocumentBuilder db = DocumentBuilderFactory.newInstance().newDocumentBuilder();
69  0 Document document = db.parse(new InputSource(new StringReader(contentFragment)));
70  0 elementValue = XPathHelper.newXPath().evaluate("//" + propertyName, document);
71    } catch (Exception e) {
72  0 throw new RiceRuntimeException("Error when attempting to parse Document Type content fragment for property name: " + propertyName, e);
73    }
74    }
75  0 return elementValue;
76    }
77   
 
78  0 toggle public static List<RouteNodeInstance> getFlattenedNodeInstances(DocumentRouteHeaderValue document, boolean includeProcesses) {
79  0 List<RouteNodeInstance> nodeInstances = new ArrayList<RouteNodeInstance>();
80  0 Set<Long> visitedNodeInstanceIds = new HashSet<Long>();
81  0 for (RouteNodeInstance initialNodeInstance : document.getInitialRouteNodeInstances())
82    {
83  0 flattenNodeInstanceGraph(nodeInstances, visitedNodeInstanceIds, initialNodeInstance, includeProcesses);
84    }
85  0 return nodeInstances;
86    }
87   
 
88  0 toggle private static void flattenNodeInstanceGraph(List<RouteNodeInstance> nodeInstances, Set<Long> visitedNodeInstanceIds, RouteNodeInstance nodeInstance, boolean includeProcesses) {
89  0 if (visitedNodeInstanceIds.contains(nodeInstance.getRouteNodeInstanceId())) {
90  0 return;
91    }
92  0 if (includeProcesses && nodeInstance.getProcess() != null) {
93  0 flattenNodeInstanceGraph(nodeInstances, visitedNodeInstanceIds, nodeInstance.getProcess(), includeProcesses);
94    }
95  0 visitedNodeInstanceIds.add(nodeInstance.getRouteNodeInstanceId());
96  0 nodeInstances.add(nodeInstance);
97  0 for (RouteNodeInstance nextNodeInstance : nodeInstance.getNextNodeInstances())
98    {
99  0 flattenNodeInstanceGraph(nodeInstances, visitedNodeInstanceIds, nextNodeInstance, includeProcesses);
100    }
101    }
102   
 
103  0 toggle public static List<RouteNode> getFlattenedNodes(DocumentType documentType, boolean climbHierarchy) {
104  0 List<RouteNode> nodes = new ArrayList<RouteNode>();
105  0 if (!documentType.isRouteInherited() || climbHierarchy) {
106  0 for (Object o : documentType.getProcesses())
107    {
108  0 Process process = (Process) o;
109  0 nodes.addAll(getFlattenedNodes(process));
110    }
111    }
112  0 Collections.sort(nodes, new RouteNodeSorter());
113  0 return nodes;
114    }
115   
 
116  0 toggle public static List<RouteNode> getFlattenedNodes(Process process) {
117  0 Map<String, RouteNode> nodesMap = new HashMap<String, RouteNode>();
118  0 if (process.getInitialRouteNode() != null) {
119  0 flattenNodeGraph(nodesMap, process.getInitialRouteNode());
120  0 List<RouteNode> nodes = new ArrayList<RouteNode>(nodesMap.values());
121  0 Collections.sort(nodes, new RouteNodeSorter());
122  0 return nodes;
123    } else {
124  0 List<RouteNode> nodes = new ArrayList<RouteNode>();
125  0 nodes.add(new RouteNode());
126  0 return nodes;
127    }
128   
129    }
130   
131    /**
132    * Recursively walks the node graph and builds up the map. Uses a map because we will
133    * end up walking through duplicates, as is the case with Join nodes.
134    * @param nodes map
135    * @param node graph
136    */
 
137  0 toggle private static void flattenNodeGraph(Map<String, RouteNode> nodes, RouteNode node) {
138  0 if (node != null) {
139  0 if (nodes.containsKey(node.getRouteNodeName())) {
140  0 return;
141    }
142  0 nodes.put(node.getRouteNodeName(), node);
143  0 for (RouteNode nextNode : node.getNextNodes())
144    {
145  0 flattenNodeGraph(nodes, nextNode);
146    }
147    } else {
148  0 return;
149    }
150    }
151   
152    /**
153    * Sorts by RouteNodeId or the order the nodes will be evaluated in *roughly*. This is
154    * for display purposes when rendering a flattened list of nodes.
155    *
156    * @author Kuali Rice Team (rice.collab@kuali.org)
157    */
 
158    private static class RouteNodeSorter implements Comparator {
 
159  0 toggle public int compare(Object arg0, Object arg1) {
160  0 RouteNode rn1 = (RouteNode)arg0;
161  0 RouteNode rn2 = (RouteNode)arg1;
162  0 return rn1.getRouteNodeId().compareTo(rn2.getRouteNodeId());
163    }
164    }
165   
 
166  0 toggle public static List<RouteNodeInstance> getActiveNodeInstances(DocumentRouteHeaderValue document) {
167  0 List<RouteNodeInstance> flattenedNodeInstances = getFlattenedNodeInstances(document, true);
168  0 List<RouteNodeInstance> activeNodeInstances = new ArrayList<RouteNodeInstance>();
169  0 for (RouteNodeInstance nodeInstance : flattenedNodeInstances)
170    {
171  0 if (nodeInstance.isActive())
172    {
173  0 activeNodeInstances.add(nodeInstance);
174    }
175    }
176  0 return activeNodeInstances;
177    }
178   
 
179  0 toggle public static RouteNodeInstance findRouteNodeInstanceById(Long nodeInstanceId, DocumentRouteHeaderValue document) {
180  0 List<RouteNodeInstance> flattenedNodeInstances = getFlattenedNodeInstances(document, true);
181  0 RouteNodeInstance niRet = null;
182  0 for (RouteNodeInstance nodeInstance : flattenedNodeInstances)
183    {
184  0 if (nodeInstanceId.equals(nodeInstance.getRouteNodeInstanceId()))
185    {
186  0 niRet = nodeInstance;
187  0 break;
188    }
189    }
190  0 return niRet;
191    }
192   
193   
194   
195    }
 
CloverReport generated by Clover Code Coverage v3.0.2
Wed Apr 13 2011 04:19:36 EDT.		   Clover: Open Source License registered to University of Arizona.