View Javadoc
1 /* 2 * $Header: /home/cvs/jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/digester/XMLBeanInfoDigester.java,v 1.3 2003/01/07 22:32:57 rdonkin Exp $ 3 * $Revision: 1.3 $ 4 * $Date: 2003/01/07 22:32:57 $ 5 * 6 * ==================================================================== 7 * 8 * The Apache Software License, Version 1.1 9 * 10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights 11 * reserved. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in 22 * the documentation and/or other materials provided with the 23 * distribution. 24 * 25 * 3. The end-user documentation included with the redistribution, if 26 * any, must include the following acknowlegement: 27 * "This product includes software developed by the 28 * Apache Software Foundation (http://www.apache.org/)." 29 * Alternately, this acknowlegement may appear in the software itself, 30 * if and wherever such third-party acknowlegements normally appear. 31 * 32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software 33 * Foundation" must not be used to endorse or promote products derived 34 * from this software without prior written permission. For written 35 * permission, please contact apache@apache.org. 36 * 37 * 5. Products derived from this software may not be called "Apache" 38 * nor may "Apache" appear in their names without prior written 39 * permission of the Apache Group. 40 * 41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 52 * SUCH DAMAGE. 53 * ==================================================================== 54 * 55 * This software consists of voluntary contributions made by many 56 * individuals on behalf of the Apache Software Foundation. For more 57 * information on the Apache Software Foundation, please see 58 * <http://www.apache.org/>;. 59 * 60 * $Id: XMLBeanInfoDigester.java,v 1.3 2003/01/07 22:32:57 rdonkin Exp $ 61 */ 62 package org.apache.commons.betwixt.digester; 63 64 import java.util.HashSet; 65 import java.util.Set; 66 67 import javax.xml.parsers.SAXParser; 68 69 import org.apache.commons.betwixt.XMLIntrospector; 70 import org.apache.commons.digester.Digester; 71 import org.apache.commons.logging.Log; 72 import org.apache.commons.logging.LogFactory; 73 import org.xml.sax.XMLReader; 74 75 /*** <p><code>XMLBeanInfoDigester</code> is a digester of XML files 76 * containing XMLBeanInfo definitions for a JavaBean.</p> 77 * 78 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a> 79 * @version $Revision: 1.3 $ 80 */ 81 public class XMLBeanInfoDigester extends Digester { 82 83 /*** Logger */ 84 private static final Log log = LogFactory.getLog( XMLBeanInfoDigester.class ); 85 86 /*** the beans class for this XML descriptor */ 87 private Class beanClass; 88 89 /*** should attributes or elements be used for primitive types */ 90 private boolean attributesForPrimitives; 91 92 /*** the set of property names processed so far */ 93 private Set processedPropertyNameSet = new HashSet(); 94 95 /*** the introspector that is using me */ 96 private XMLIntrospector introspector; 97 98 /*** 99 * Construct a new XMLBeanInfoDigester with default properties. 100 */ 101 public XMLBeanInfoDigester() { 102 } 103 104 /*** 105 * Construct a new XMLBeanInfoDigester, allowing a SAXParser to be passed in. This 106 * allows XMLBeanInfoDigester to be used in environments which are unfriendly to 107 * JAXP1.1 (such as WebLogic 6.0). Thanks for the request to change go to 108 * James House (james@interobjective.com). This may help in places where 109 * you are able to load JAXP 1.1 classes yourself. 110 * 111 * @param parser the <code>SAXParser</code> to be used to parse the xml 112 */ 113 public XMLBeanInfoDigester(SAXParser parser) { 114 super(parser); 115 } 116 117 /*** 118 * Construct a new XMLBeanInfoDigester, allowing an XMLReader to be passed in. This 119 * allows XMLBeanInfoDigester to be used in environments which are unfriendly to 120 * JAXP1.1 (such as WebLogic 6.0). Note that if you use this option you 121 * have to configure namespace and validation support yourself, as these 122 * properties only affect the SAXParser and emtpy constructor. 123 * 124 * @param reader the <code>XMLReader</code> to be used to parse the xml 125 */ 126 public XMLBeanInfoDigester(XMLReader reader) { 127 super(reader); 128 } 129 130 /*** 131 * Gets the class of the bean whose .betwixt file is being processed 132 * 133 * @return the beans class for this XML descriptor 134 */ 135 public Class getBeanClass() { 136 return beanClass; 137 } 138 139 /*** 140 * Sets the beans class for this XML descriptor 141 * 142 * @param beanClass the <code>Class</code> of the bean being processed 143 */ 144 public void setBeanClass(Class beanClass) { 145 this.beanClass = beanClass; 146 } 147 148 149 /*** 150 * Gets the property names already processed 151 * 152 * @return the set of property names that have been processed so far 153 */ 154 public Set getProcessedPropertyNameSet() { 155 return processedPropertyNameSet; 156 } 157 158 /*** 159 * Should attributes (or elements) be used for primitive types? 160 * @return true if primitive properties should be written as attributes in the xml 161 */ 162 public boolean isAttributesForPrimitives() { 163 return attributesForPrimitives; 164 } 165 166 /*** 167 * Set whether attributes (or elements) should be used for primitive types. 168 * @param attributesForPrimitives pass true if primitive properties should be 169 * written as attributes 170 */ 171 public void setAttributesForPrimitives(boolean attributesForPrimitives) { 172 this.attributesForPrimitives = attributesForPrimitives; 173 if ( introspector != null ) { 174 introspector.setAttributesForPrimitives( attributesForPrimitives ); 175 } 176 } 177 178 /*** 179 * Gets the XMLIntrospector that's using this digester. 180 * 181 * @return the introspector that is using me 182 */ 183 public XMLIntrospector getXMLIntrospector() { 184 return introspector; 185 } 186 187 /*** 188 * Sets the introspector that is using me 189 * @param introspector the <code>XMLIntrospector</code> that using this for .betwixt 190 * digestion 191 */ 192 public void setXMLIntrospector(XMLIntrospector introspector) { 193 this.introspector = introspector; 194 } 195 196 // Implementation methods 197 //------------------------------------------------------------------------- 198 /*** Reset configure for new digestion */ 199 protected void configure() { 200 if (! configured) { 201 configured = true; 202 203 // add the various rules 204 205 addRule( "info", new InfoRule() ); 206 addRule( "*/element", new ElementRule() ); 207 addRule( "*/attribute", new AttributeRule() ); 208 addRule( "*/hide", new HideRule() ); 209 addRule( "*/addDefaults", new AddDefaultsRule() ); 210 } 211 212 // now initialize 213 attributesForPrimitives = true; 214 processedPropertyNameSet.clear(); 215 } 216 217 }

This page was automatically generated by Maven