View Javadoc
1   /**
2    * Redistribution and use of this software and associated documentation ("Software"), with or
3    * without modification, are permitted provided that the following conditions are met:
4    *
5    * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6    * must also contain a copy of this document.
7    *
8    * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9    * conditions and the following disclaimer in the documentation and/or other materials provided with
10   * the distribution.
11   *
12   * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13   * without prior written permission of Intalio, Inc. For written permission, please contact
14   * info@exolab.org.
15   *
16   * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17   * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18   * Intalio, Inc.
19   *
20   * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21   *
22   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29   * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   *
31   * Copyright 1999-2002 (C) Intalio, Inc. All Rights Reserved.
32   *
33   * $Id$
34   */
35  
36  package org.exolab.castor.xml.schema.reader;
37  
38  // -- imported classes and packages
39  import org.exolab.castor.xml.AttributeSet;
40  import org.exolab.castor.xml.Namespaces;
41  import org.exolab.castor.xml.XMLException;
42  import org.exolab.castor.xml.schema.SchemaContext;
43  
44  /**
45   * A class for Skipping unknown elements during unmarshalling
46   * 
47   * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
48   * @version $Revision$ $Date: 2005-12-13 14:58:48 -0700 (Tue, 13 Dec 2005) $
49   **/
50  public class UnknownUnmarshaller extends ComponentReader {
51  
52  
53    // --------------------/
54    // - Member Variables -/
55    // --------------------/
56  
57    /**
58     * The name of the element we are "unmarshalling"
59     **/
60    String name;
61  
62    // ----------------/
63    // - Constructors -/
64    // ----------------/
65  
66    public UnknownUnmarshaller(final SchemaContext schemaContext, final String name) {
67      super(schemaContext);
68      this.name = name;
69    } // -- UnknownUnmarshaller
70  
71    // -----------/
72    // - Methods -/
73    // -----------/
74  
75    /**
76     * Returns the name of the element that this ComponentReader handles
77     * 
78     * @return the name of the element that this ComponentReader handles
79     **/
80    public String elementName() {
81      return name;
82    } // -- elementName
83  
84    /**
85     * Sets the name of the element that this UnknownUnmarshaller handles
86     * 
87     * @param name the name of the element that this unmarshaller handles
88     **/
89    public void elementName(String name) {
90      this.name = name;
91    } // -- elementName
92  
93    /**
94     * Returns the Object created by this ComponentReader
95     * 
96     * @return the Object created by this ComponentReader
97     **/
98    public Object getObject() {
99      return null;
100   } // -- getObject
101 
102   /**
103    * Signals the start of an element with the given name.
104    *
105    * @param name the NCName of the element. It is an error if the name is a QName (ie. contains a
106    *        prefix).
107    * @param namespace the namespace of the element. This may be null. Note: A null namespace is not
108    *        the same as the default namespace unless the default namespace is also null.
109    * @param atts the AttributeSet containing the attributes associated with the element.
110    * @param nsDecls the namespace declarations being declared for this element. This may be null.
111    **/
112   public void startElement(String name, String namespace, AttributeSet atts, Namespaces nsDecls)
113       throws XMLException {
114     // -- do nothing, this method is overwritten by subclasses
115 
116   } // -- startElement
117 
118   /**
119    * Signals to end of the element with the given name.
120    *
121    * @param name the NCName of the element. It is an error if the name is a QName (ie. contains a
122    *        prefix).
123    * @param namespace the namespace of the element.
124    **/
125   public void endElement(String name, String namespace) throws XMLException {
126     // -- do nothing, this method is overwritten by subclasses
127   } // -- endElement
128 
129   public void characters(char[] ch, int start, int length) throws XMLException {} // -- characters
130 
131 } // -- UnknownUnmarshaller