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 2000-2003 (C) Intalio, Inc. All Rights Reserved.
32   *
33   * $Id$
34   */
35  package org.exolab.castor.types;
36  
37  import org.exolab.castor.mapping.FieldDescriptor;
38  import org.exolab.castor.mapping.ValidityException;
39  import org.exolab.castor.xml.NodeType;
40  import org.exolab.castor.xml.XMLFieldDescriptor;
41  import org.exolab.castor.xml.XMLFieldHandler;
42  import org.exolab.castor.xml.util.XMLFieldDescriptorImpl;
43  
44  /**
45   * The Century Descriptor
46   * 
47   * @author <a href="kvisco@intalio.com">Keith Visco</a>
48   * @version $Revision$ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $
49   * @see TimeDurationDescriptor
50   * @deprecated since Castor 1.0.6 since this type is not in any recommendation.
51   */
52  public class CenturyDescriptor extends BaseDescriptor {
53  
54    /** The name of the XML element. */
55    private static final String XML_NAME = "century";
56    /** Our field descriptor. */
57    private static final XMLFieldDescriptorImpl CONTENT_DESCRIPTOR;
58    /** Our field descriptor array. Lists the fields we describe. */
59    private static final FieldDescriptor[] FIELDS;
60  
61    static {
62      CONTENT_DESCRIPTOR =
63          new XMLFieldDescriptorImpl(String.class, "content", "content", NodeType.Text);
64      CONTENT_DESCRIPTOR.setHandler(new CenturyDescriptor().new CenturyFieldHandler());
65      FIELDS = new FieldDescriptor[1];
66      FIELDS[0] = CONTENT_DESCRIPTOR;
67    }
68  
69    // ----------------/
70    // - Constructors -/
71    // ----------------/
72  
73    public CenturyDescriptor() {
74      super(XML_NAME, Century.class);
75    } // --CenturyDescriptor
76  
77    // ------------------/
78    // - Public Methods -/
79    // ------------------/
80  
81    /**
82     * Returns the XMLFieldDescriptor for the member that should be marshalled as text content.
83     *
84     * @return the XMLFieldDescriptor for the member that should be marshalled as text content.
85     */
86    public XMLFieldDescriptor getContentDescriptor() {
87      return CONTENT_DESCRIPTOR;
88    } // getContentDescriptor
89  
90    /**
91     * Returns a list of fields represented by this descriptor.
92     *
93     * @return A list of fields
94     */
95    public FieldDescriptor[] getFields() {
96      return FIELDS;
97    } // -- getFields
98  
99    /**
100    * A specialized FieldHandler for the XML Schema Century related types
101    *
102    * @author <a href="blandin@intalio.com">Arnaud Blandin</a>
103    * @version $Revision$ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $
104    */
105   class CenturyFieldHandler extends XMLFieldHandler {
106 
107     // ----------------/
108     // - Constructors -/
109     // ----------------/
110 
111     /**
112      * Creates a new TimeFieldHandler
113      */
114     public CenturyFieldHandler() {
115       super();
116     } // -- CenturyFieldHandler
117 
118     // ------------------/
119     // - Public Methods -/
120     // ------------------/
121 
122     /**
123      * Returns the value of the field associated with this descriptor from the given target object.
124      *
125      * @param target the object to get the value from
126      * @return the value of the field associated with this descriptor from the given target object.
127      */
128     public Object getValue(Object target) throws java.lang.IllegalStateException {
129       // -- check for Century class -- add later
130       Century century = (Century) target;
131       return century.toString();
132     } // -- getValue
133 
134     /**
135      * Sets the value of the field associated with this descriptor.
136      * 
137      * @param target the object in which to set the value
138      * @param value the value of the field
139      */
140     public void setValue(Object target, Object value) throws java.lang.IllegalStateException {
141       if (!(target instanceof Century)) {
142         // -- throw exception
143       }
144 
145       Century centuryTarget = (Century) target;
146 
147       if (value == null) {
148         /// do something
149       }
150 
151       // -- update current instance of century with new century
152       try {
153         Century temp = Century.parseCentury(value.toString());
154         centuryTarget.setCentury(temp.getCentury());
155       } catch (java.text.ParseException ex) {
156         // ignore for now
157       }
158     } // -- setValue
159 
160     public void resetValue(Object target) throws java.lang.IllegalStateException {
161       // Nothing to do?
162     }
163 
164     /**
165      * Checks the field's validity. Returns successfully if the field can be stored, is valid, etc,
166      * throws an exception otherwise.
167      *
168      * @param object The object
169      * @throws ValidityException The field is invalid, is required and null, or any other validity
170      *         violation
171      * @throws IllegalStateException The Java object has changed and is no longer supported by this
172      *         handler, or the handler is not compatiable with the Java object
173      */
174     public void checkValidity(Object object) throws ValidityException, IllegalStateException {
175       // nothing to do?
176     } // -- checkValidity
177 
178     /**
179      * Creates a new instance of the object described by this field.
180      *
181      * @param parent The object for which the field is created
182      * @return A new instance of the field's value
183      * @throws IllegalStateException This field is a simple type and cannot be instantiated
184      */
185     public Object newInstance(Object parent) throws IllegalStateException {
186       return new Century();
187     } // -- newInstance
188 
189   } // -- CenturyFieldHandler
190 
191 } // -- CenturyDescriptor