Coverage Report - org.kuali.student.common.search.service.impl.SearchBeanDefinitionParser
 
Classes in this File Line Coverage Branch Coverage Complexity
SearchBeanDefinitionParser
0%
0/117
0%
0/118
9.778
 
 1   
 /**
 2   
  * Copyright 2010 The Kuali Foundation Licensed under the
 3   
  * Educational Community License, Version 2.0 (the "License"); you may
 4   
  * not use this file except in compliance with the License. You may
 5   
  * obtain a copy of the License at
 6   
  *
 7   
  * http://www.osedu.org/licenses/ECL-2.0
 8   
  *
 9   
  * Unless required by applicable law or agreed to in writing,
 10   
  * software distributed under the License is distributed on an "AS IS"
 11   
  * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 12   
  * or implied. See the License for the specific language governing
 13   
  * permissions and limitations under the License.
 14   
  */
 15   
 
 16   
 package org.kuali.student.common.search.service.impl;
 17   
 
 18   
 import java.util.HashSet;
 19   
 import java.util.List;
 20   
 
 21   
 import javax.xml.parsers.DocumentBuilder;
 22   
 import javax.xml.parsers.DocumentBuilderFactory;
 23   
 
 24   
 import org.apache.log4j.Logger;
 25   
 import org.kuali.student.common.dictionary.old.dto.FieldDescriptor;
 26   
 import org.kuali.student.common.search.dto.ComparisonParamInfo;
 27   
 import org.kuali.student.common.search.dto.CrossSearchTypeInfo;
 28   
 import org.kuali.student.common.search.dto.JoinComparisonInfo;
 29   
 import org.kuali.student.common.search.dto.JoinCriteriaInfo;
 30   
 import org.kuali.student.common.search.dto.JoinResultMappingInfo;
 31   
 import org.kuali.student.common.search.dto.QueryParamInfo;
 32   
 import org.kuali.student.common.search.dto.ResultColumnInfo;
 33   
 import org.kuali.student.common.search.dto.SearchCriteriaTypeInfo;
 34   
 import org.kuali.student.common.search.dto.SearchResultTypeInfo;
 35   
 import org.kuali.student.common.search.dto.SearchTypeInfo;
 36   
 import org.kuali.student.common.search.dto.SubSearchInfo;
 37   
 import org.kuali.student.common.search.dto.SubSearchParamMappingInfo;
 38   
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 39   
 import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
 40   
 import org.springframework.beans.factory.xml.ParserContext;
 41   
 import org.w3c.dom.Attr;
 42   
 import org.w3c.dom.Document;
 43   
 import org.w3c.dom.Element;
 44   
 import org.w3c.dom.Node;
 45   
 
 46  0 
 public class SearchBeanDefinitionParser extends
 47   
                 AbstractSingleBeanDefinitionParser {
 48  0 
     private static final Logger logger = Logger.getLogger(SearchBeanDefinitionParser.class);
 49   
 
 50   
         @Override
 51   
         protected Class<?> getBeanClass(Element element) {
 52   
 
 53  0 
                 if (element.getLocalName().equals("fieldDescriptor")) {
 54  0 
                         return FieldDescriptor.class;
 55   
                 }
 56  0 
                 if (element.getLocalName().equals("searchCriteriaTypeInfo")) {
 57  0 
                         return SearchCriteriaTypeInfo.class;
 58   
                 }
 59  0 
                 if (element.getLocalName().equals("queryParam")) {
 60  0 
                         return QueryParamInfo.class;
 61   
                 }
 62  0 
                 if (element.getLocalName().equals("searchType")) {
 63  0 
                         return SearchTypeInfo.class;
 64   
                 }
 65  0 
                 if (element.getLocalName().equals("resultColumn")) {
 66  0 
                         return ResultColumnInfo.class;
 67   
                 }
 68  0 
                 if (element.getLocalName().equals("searchResultTypeInfo")) {
 69  0 
                         return SearchResultTypeInfo.class;
 70   
                 }
 71   
 
 72   
 
 73  0 
                 if (element.getLocalName().equals("crossSearchType")) {
 74  0 
                         return CrossSearchTypeInfo.class;
 75   
                 }
 76  0 
                 if (element.getLocalName().equals("subSearch")) {
 77  0 
                         return SubSearchInfo.class;
 78   
                 }
 79  0 
                 if (element.getLocalName().equals("subSearchParamMappings")) {
 80  0 
                         return SubSearchParamMappingInfo.class;
 81   
                 }
 82  0 
                 if (element.getLocalName().equals("joinCriteria")) {
 83  0 
                         return JoinCriteriaInfo.class;
 84   
                 }
 85  0 
                 if (element.getLocalName().equals("comparison")) {
 86  0 
                         return JoinComparisonInfo.class;
 87   
                 }
 88  0 
                 if (element.getLocalName().equals("leftHandSide")) {
 89  0 
                         return ComparisonParamInfo.class;
 90   
                 }
 91  0 
                 if (element.getLocalName().equals("rightHandSide")) {
 92  0 
                         return ComparisonParamInfo.class;
 93   
                 }
 94  0 
                 if (element.getLocalName().equals("joinResultMapping")) {
 95  0 
                         return JoinResultMappingInfo.class;
 96   
                 }
 97   
 
 98  0 
                 return super.getBeanClass(element);
 99   
         }
 100   
 
 101   
         @Override
 102   
         protected void doParse(Element element, ParserContext pc, BeanDefinitionBuilder builder) {
 103   
                 //Set the key
 104  0 
                 if(!"fieldDescriptor".equals(element.getLocalName())&&element.hasAttribute("id")){
 105  0 
                         builder.addPropertyValue("key", element.getAttributes().getNamedItem("id").getTextContent());
 106   
                 }
 107   
 
 108  0 
                 if("fieldDescriptor".equals(element.getLocalName())&&element.hasAttribute("parent")){
 109  0 
                         builder.setParentName(element.getAttributes().getNamedItem("parent").getTextContent());
 110   
                 }
 111   
 
 112   
                 //Set optional if its a queryParam
 113  0 
                 if("queryParam".equals(element.getLocalName())&&element.hasAttribute("optional")){
 114  0 
                         builder.addPropertyValue("optional", "true".equals(element.getAttribute("optional"))?true:false);
 115   
                 }
 116   
 
 117   
             //Copy Attributes
 118  0 
             if(element.hasAttributes()){
 119  0 
                     for(int i = 0;i<element.getAttributes().getLength();i++){
 120  0 
                         Attr attr = (Attr) element.getAttributes().item(i);
 121  0 
                         if("abstract".equals(attr.getName())){
 122  0 
                                 builder.setAbstract(true);
 123  0 
                         }else if(!"id".equals(attr.getName())&&!"parent".equals(attr.getName())){
 124  0 
                                 String fieldName = resolveFieldName(element.getLocalName(),attr.getName());
 125  0 
                                 builder.addPropertyValue(fieldName, attr.getValue());
 126   
                         }
 127   
                     }
 128   
             }
 129   
 
 130   
 
 131  0 
                 HashSet<String> visitedNodes = new HashSet<String>();
 132   
                 //Parse the children
 133  0 
                 for(int i = 0;i<element.getChildNodes().getLength();i++){
 134  0 
                         Node node = element.getChildNodes().item(i);
 135   
 
 136  0 
                         if(Node.ELEMENT_NODE == node.getNodeType()){
 137  0 
                     String localName=node.getLocalName();
 138  0 
                     if(!visitedNodes.contains(localName)){
 139  0 
                                         if(isWrappedList(node.getLocalName())){
 140  0 
                                                 List<?> refList = pc.getDelegate().parseListElement((Element) node, pc.getContainingBeanDefinition());
 141  0 
                                                 builder.addPropertyValue(node.getLocalName(),refList);
 142  0 
                                         }else if(isUnwrappedList(node.getLocalName())){
 143  0 
                                     Element childList=getChildList(element,node.getLocalName());
 144  0 
                                 visitedNodes.add(node.getLocalName());
 145  0 
                             List<?> refList = pc.getDelegate().parseListElement(childList, pc.getContainingBeanDefinition());
 146  0 
                             if(refList!=null&&!refList.isEmpty()){
 147  0 
                                     String fieldName=resolveFieldName(element.getLocalName(),node.getLocalName());
 148  0 
                                     builder.addPropertyValue(fieldName,refList);
 149   
                             }
 150  0 
                                         }else{
 151  0 
                                                 Element childElement = getFirstChildElement(node);
 152  0 
                                                 if(childElement!=null){
 153  0 
                                                         if("ref".equals(childElement.getLocalName())){
 154  0 
                                                                 Object childBean = pc.getDelegate().parsePropertySubElement(childElement, pc.getContainingBeanDefinition());
 155  0 
                                                                 builder.addPropertyValue(node.getLocalName(), childBean);
 156  0 
                                                         }else{
 157  0 
                                                                 Object childBean = pc.getDelegate().parsePropertySubElement((Element)node, pc.getContainingBeanDefinition());
 158  0 
                                                                 builder.addPropertyValue(node.getLocalName(), childBean);
 159  0 
                                                         }
 160   
                                                 }else{
 161  0 
                                                         if(("ref".equals(node.getLocalName())&&"queryParam".equals(element.getLocalName()))){
 162  0 
                                                                 Object childBean = pc.getDelegate().parsePropertySubElement((Element)node, pc.getContainingBeanDefinition());
 163  0 
                                                                 builder.addPropertyValue("fieldDescriptor", childBean);
 164  0 
                                                         }else if("leftHandSide".equals(node.getLocalName())
 165   
                                                                         ||"rightHandSide".equals(node.getLocalName())
 166   
                                                                         ||"joinCriteria".equals(node.getLocalName())){
 167  0 
                                                                 Object childBean = pc.getDelegate().parsePropertySubElement((Element)node, pc.getContainingBeanDefinition());
 168  0 
                                                                 builder.addPropertyValue(node.getLocalName(), childBean);
 169  0 
                                                         }else{
 170  0 
                                                                 builder.addPropertyValue(node.getLocalName(), node.getTextContent());
 171   
                                                         }
 172   
                                                 }
 173   
                                         }
 174   
                     }
 175   
                         }
 176   
                 }
 177  0 
         }
 178   
 
 179   
         private boolean isUnwrappedList(String localName) {
 180  0 
                 return localName.equals("subSearchParamMappings")||
 181   
                localName.equals("comparison")||
 182   
                localName.equals("subSearch")||
 183   
                localName.equals("joinResultMapping");
 184   
         }
 185   
 
 186   
     //This is called to resolve tag names to field names based on the element and parent element local names
 187   
         private String resolveFieldName(String parentName, String nodeName) {
 188  0 
                 if("comparison".equals(nodeName)){
 189  0 
                         return "comparisons";
 190   
                 }
 191  0 
                 if("subSearch".equals(nodeName)){
 192  0 
                         return "subSearches";
 193   
                 }
 194  0 
                 if("joinResultMapping".equals(nodeName)){
 195  0 
                         return "joinResultMappings";
 196   
                 }
 197  0 
                 if("joinCriteria".equals(parentName)&&"type".equals(nodeName)){
 198  0 
                         return "joinType";
 199   
                 }
 200   
 
 201  0 
                 return nodeName;
 202   
         }
 203   
 
 204   
     //This builds up a list of the child nodes so that the spring parseListElement can be used
 205   
     //it also translates <fooRef> elements into straight spring <ref> elements
 206   
     private Element getChildList(Element element, String localName) {
 207   
             try{
 208   
                     //Create a new document to contain our list of elements
 209  0 
                     DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
 210  0 
                     DocumentBuilder builder = dbf.newDocumentBuilder();
 211  0 
                     Document doc = builder.newDocument();
 212   
 
 213  0 
                     Element root = doc.createElement("listRoot");
 214   
 
 215  0 
                 for(int i = 0;i<element.getChildNodes().getLength();i++){
 216  0 
                     Node node = element.getChildNodes().item(i);
 217  0 
                     if(Node.ELEMENT_NODE == node.getNodeType() && localName.equals(node.getLocalName())){
 218   
 
 219   
                             //Copy the node from the spring config to our list
 220  0 
                             Node copied = doc.importNode(node, true);
 221  0 
                             root.appendChild(copied);
 222   
                     }
 223  0 
                     if(Node.ELEMENT_NODE == node.getNodeType() && (localName+"Ref").equals(node.getLocalName())){
 224   
 
 225   
                             //Create a new spring ref element and copy the bean attribute
 226  0 
                             Element ref = doc.createElement("ref");
 227  0 
                             ref.setAttribute("bean", ((Element)node).getAttribute("bean"));
 228  0 
                             root.appendChild(ref);
 229   
                     }
 230   
                 }
 231   
 
 232  0 
                     return root;
 233  0 
             }catch(Exception e){
 234  0 
                     logger.error("Exception occured: ", e);
 235   
             }
 236  0 
             return null;
 237   
         }
 238   
 
 239   
         private Element getFirstChildElement(Node node) {
 240  0 
                 for(int i = 0;i<node.getChildNodes().getLength();i++){
 241  0 
                         Node childNode = node.getChildNodes().item(i);
 242  0 
                         if(Node.ELEMENT_NODE == childNode.getNodeType()){
 243  0 
                                 return (Element) childNode;
 244   
                         }
 245   
                 }
 246   
 
 247  0 
                 return null;
 248   
         }
 249   
 
 250   
         private boolean isWrappedList(String localName) {
 251  0 
                 return localName.equals("queryParams")||
 252   
                            localName.equals("resultColumns");
 253   
         }
 254   
 
 255   
         @Override
 256   
         protected String getParentName(Element element) {
 257  0 
                 if(element.hasAttribute("parent")){
 258  0 
             return element.getAttribute("parent");
 259   
                 }
 260  0 
                 return super.getParentName(element);
 261   
         }
 262   
 
 263   
         @Override
 264   
         protected boolean shouldGenerateIdAsFallback() {
 265  0 
                 return true;
 266   
         }
 267   
 }
Report generated by Cobertura 1.9.4.1 on 5/23/12 7:16 AM.