View Javadoc
1   /**
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Intalio, Inc.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Intalio, Inc. Exolab is a registered
23   *    trademark of Intalio, Inc.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 1999-2002 (C) Intalio, Inc. All Rights Reserved.
42   *
43   * $Id$
44   */
45  
46  package org.exolab.castor.xml.schema.reader;
47  
48  import org.exolab.castor.xml.XMLException;
49  import org.exolab.castor.xml.schema.SchemaContext;
50  
51  /**
52   * A utility class for Unmarshalling elements with only String content
53   * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
54   * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
55  **/
56  public class CharacterUnmarshaller extends ComponentReader {
57  
58    
59      private StringBuffer sb = null;
60      
61      private String currentName = null;
62  
63      /**
64       * Creates a new StringUnmarshaller.
65       * @param schemaContext the schema context to get some configuration settings from
66      **/
67      public CharacterUnmarshaller(final SchemaContext schemaContext) {
68          super(schemaContext);
69          sb = new StringBuffer();
70      } //-- CharacterUnmarshaller
71      
72      /**
73       * Returns the name of the element that this ComponentReader
74       * handles
75       * @return the name of the element that this ComponentReader
76       * handles
77      **/
78      public String elementName() {
79          return currentName;
80      } //-- elementName
81      
82      /**
83       * Sets the name of the element that this CharacterUnmarshaller handles
84       * @param name the name of the element that this character unmarshaller handles
85      **/
86      public void elementName(String name) {
87          currentName = name;
88      } //-- elementName
89      
90      /**
91       * Returns the Object created by this ComponentReader
92       * @return the Object created by this ComponentReader
93      **/
94      public Object getObject() {
95          return getString();
96      } //-- getObject
97      
98      /**
99       * Returns the set of characters recieved by this CharacterUnmarshaller
100      * as a String
101      * @return the set of characters recieved by this CharacterUnmarshaller
102      * as a String
103     **/
104     public String getString() {
105         return sb.toString();
106     } //-- getString
107     
108     /**
109      * The SAX characters method for recieving characters
110      * @see org.xml.sax.DocumentHandler
111     **/
112     public void characters(char[] ch, int start, int length) 
113         throws XMLException
114     {
115         sb.append(ch, start, length);
116     } //-- characters
117 
118     /**
119      * Clears the current buffer
120     **/
121     public void clear() {
122         sb.setLength(0);    
123     } //-- clear
124     
125 } //-- CharacterUnmarshaller