KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > tools > upgrade > transform > elements > BaseElement


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23
24 /*
25  * Element.java
26  *
27  * Created on August 4, 2003, 2:04 PM
28  */

29
30 package com.sun.enterprise.tools.upgrade.transform.elements;
31
32 /**
33  *
34  * @author prakash
35  */

36 import org.w3c.dom.Document JavaDoc;
37 import org.w3c.dom.Element JavaDoc;
38 import org.w3c.dom.NodeList JavaDoc;
39 import org.w3c.dom.Node JavaDoc;
40 import org.w3c.dom.Attr JavaDoc;
41 import org.w3c.dom.NamedNodeMap JavaDoc;
42 import com.sun.enterprise.tools.upgrade.transform.ElementToObjectMapper;
43 import com.sun.enterprise.util.i18n.StringManager;
44 import com.sun.enterprise.tools.upgrade.logging.*;
45 import java.util.logging.*;
46 import java.io.File JavaDoc;
47 import com.sun.enterprise.tools.upgrade.transform.AttributeExtracter;
48
49 import com.sun.enterprise.tools.upgrade.common.CommonInfoModel;
50
51 public class BaseElement {
52     
53     protected StringManager stringManager = StringManager.getManager("com.sun.enterprise.tools.upgrade.transform");
54     protected Logger logger = com.sun.enterprise.tools.upgrade.common.CommonInfoModel.getDefaultLogger();
55     protected static CommonInfoModel commonInfoModel;
56     
57     /** Creates a new instance of Element */
58     public BaseElement() {
59     }
60     
61     public void transform(Element JavaDoc element, Element JavaDoc parentSource, Element JavaDoc parentResult){
62         NodeList JavaDoc childNodes = element.getChildNodes();
63         logger.log(Level.FINE, stringManager.getString("upgrade.transform.baseelemnt.transformingMSG"),element.getTagName());
64         for(int index=0; index < childNodes.getLength(); index++){
65             Node JavaDoc aNode = childNodes.item(index);
66             try{
67                 if(aNode.getNodeType() == Node.ELEMENT_NODE){
68                     BaseElement baseElement = ElementToObjectMapper.getMapper().getElementObject(aNode.getNodeName());
69                     baseElement.transform((Element JavaDoc)aNode, element, parentResult);
70                 }
71             }catch(Exception JavaDoc ex){
72                 // ****** LOG MESSAGE *************
73
ex.printStackTrace();
74                 logger.log(Level.WARNING, stringManager.getString("upgrade.transform.baseelement.transformexception"),new String JavaDoc[]{element.getTagName(),ex.getMessage()});
75                 logger.log(Level.WARNING, stringManager.getString("upgrade.transform.baseelement.transformexception"), ex);
76             }
77         }
78     }
79     protected void transferAttributes(Element JavaDoc source, Element JavaDoc result, java.util.List JavaDoc nonTransferList){
80         boolean debug = false;
81         NamedNodeMap JavaDoc sourceAttrNodeMap = source.getAttributes();
82          if(sourceAttrNodeMap == null) return;
83         
84         NamedNodeMap JavaDoc resultAttrNodeMap = result.getAttributes();
85          
86          
87          for(int index=0; index < sourceAttrNodeMap.getLength(); index++){
88              Node JavaDoc sourceAttrNode = sourceAttrNodeMap.item(index);
89              if(!this.canTransferAttribute(sourceAttrNode.getNodeName(), nonTransferList)) continue;
90              if(!isValidAttributeToTransfer(sourceAttrNode.getNodeName(),getAttributeListForElement(result.getTagName()))) continue;
91              if(resultAttrNodeMap == null){
92                  Attr JavaDoc addAttr = result.getOwnerDocument().createAttribute(sourceAttrNode.getNodeName());
93                  addAttr.setValue(sourceAttrNode.getNodeValue());
94                  result.setAttributeNode(addAttr);
95              }else{
96                  Node JavaDoc resultAttrNode = resultAttrNodeMap.getNamedItem(sourceAttrNode.getNodeName());
97                  if(resultAttrNode != null){
98                      resultAttrNode.setNodeValue(sourceAttrNode.getNodeValue());
99                      //result.setAttributeNode((Attr)resultAttrNode);
100
}else {
101                      Attr JavaDoc addAttr = result.getOwnerDocument().createAttribute(sourceAttrNode.getNodeName());
102                      addAttr.setValue(sourceAttrNode.getNodeValue());
103                      result.setAttributeNode(addAttr);
104                  }
105              }
106          }
107     }
108     private boolean canTransferAttribute(String JavaDoc attr, java.util.List JavaDoc attrList){
109         if(attrList == null || attrList.isEmpty())
110             return true;
111         for(java.util.Iterator JavaDoc it = attrList.iterator(); it.hasNext(); ){
112             if(it.next().equals(attr))
113                 return false;
114         }
115         return true;
116     }
117     public static void setCommonInfoModel(CommonInfoModel cim){
118         commonInfoModel = cim;
119     }
120     /*
121      * Returns the key mapped in mapper for the element
122      * This key is used for comparing source and target elements
123      * Returns NULL if no key is mapped. This is quite common for elements that have only child elements but no attributes to transfer
124      */

125     protected String JavaDoc getKeyToCompare(String JavaDoc elementTagName){
126         return ElementToObjectMapper.getMapper().getKeyForElement(elementTagName);
127     }
128     protected java.util.List JavaDoc getInsertElementStructure(Element JavaDoc element, Element JavaDoc parentEle){
129         // Sub classes can override this method to return a different list if needed.
130
// parentEle is not used in this method. But sub classes can use it to make certain decision on structure
131
return ElementToObjectMapper.getMapper().getInsertElementStructure(element.getTagName());
132     }
133     public void appendElementToParent(Element JavaDoc parentEle, Element JavaDoc element){
134         java.util.List JavaDoc eleStructureList = this.getInsertElementStructure(element,parentEle);
135         if(eleStructureList == null){
136             // insert the element at the end
137
parentEle.appendChild(element);
138             return;
139         }
140         if(eleStructureList.isEmpty()){
141             // insert the element in the beginning.
142
parentEle.insertBefore(element, parentEle.getFirstChild());
143             return;
144         }
145         String JavaDoc insertBeforeElementName = null;
146         Node JavaDoc insertBeforeNode = null;
147         for(int eleIndex =0; eleIndex < eleStructureList.size(); eleIndex++){
148             insertBeforeElementName = (String JavaDoc)eleStructureList.get(eleIndex);
149             Node JavaDoc lNode=parentEle.getFirstChild();
150             while (lNode != null) {
151                 if (lNode instanceof Element JavaDoc) {
152                     Element JavaDoc lElement=(Element JavaDoc)lNode;
153                     if (lElement.getNodeName().equals(insertBeforeElementName)) {
154                         // if match is found, break and insert
155
insertBeforeNode = lNode;
156                         break;
157                     }
158                 }
159                 // go to next sibling in order
160
lNode=lNode.getNextSibling();
161             }
162             if(insertBeforeNode != null){
163                 break;
164             }
165         }
166         // if match is not found, node will be place at the end
167
parentEle.insertBefore(element,insertBeforeNode);
168     }
169     protected boolean isValidAttributeToTransfer(String JavaDoc attrName, java.util.List JavaDoc attrList){
170         for(java.util.Iterator JavaDoc it = attrList.iterator(); it.hasNext();){
171             if(((String JavaDoc)it.next()).equals(attrName)){
172                 return true;
173             }
174         }
175         return false;
176     }
177     protected java.util.List JavaDoc getAttributeListForElement(String JavaDoc elementName){
178         //String dtdFileName = this.commonInfoModel.getTargetInstallDir()+File.separator+"lib"+File.separator+"dtds"+File.separator+"sun-domain_1_1.dtd";
179
// Domain dtd changed for AS9.0
180
String JavaDoc dtdFileName = this.commonInfoModel.getTargetInstallDir()+File.separator+"lib"+File.separator+"dtds"+File.separator+"sun-domain_1_2.dtd";
181         return AttributeExtracter.getExtracter(dtdFileName).getAttributeList(elementName);
182     }
183 }
184
Popular Tags