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-2003 (C) Intalio, Inc. All Rights Reserved.
42   *
43   * $Id: MappingTool.java 6026 2006-06-28 07:24:40Z wguttmn $
44   */
45  package org.exolab.castor.tools;
46  
47  import java.lang.reflect.Array;
48  
49  import org.castor.xml.JavaNaming;
50  import org.exolab.castor.mapping.loader.AbstractMappingLoader;
51  
52  /**
53   * Extend mapping loader to give us access to the findAccessor method.
54   */
55  public final class MappingToolMappingLoader {
56      /**
57       * The {@link JavaNaming} implementation to use.
58       * @since 1.1.3
59       */
60      private JavaNaming _javaNaming;
61  
62      /**
63       * A MappingToolMappingLoader needs a javaNaming to be set.
64       * @param javaNaming the {@link JavaNaming} implementation to use
65       */
66      public MappingToolMappingLoader(final JavaNaming javaNaming) {
67          _javaNaming = javaNaming;
68      }
69  
70      /**
71       * Returns true if the get method returns an array.
72       * This method is used for greater compatability with
73       * generated descriptors.
74       * @param clazz the Class to find an accessor in
75       * @param fieldName the field for which an accessor is sought
76       * @param type the returning type of the accessor
77       * @return if get method returns an array.
78      **/
79      public boolean returnsArray(final Class clazz, final String fieldName, final Class type) {
80          try {
81              Class array = null;
82              if (type.isArray()) {
83                  array = type;
84              } else {
85                  array = Array.newInstance(type, 0).getClass();
86              }
87              //-- getMethod
88              String method = _javaNaming.getGetMethodNameForField(fieldName);
89              boolean isGet = true;
90              if (AbstractMappingLoader.findAccessor(clazz, method, array, isGet) != null) {
91                  return true;
92              }
93          } catch (Exception ex) {
94              // nothing to do
95          }
96          return false;
97      }
98      
99      /**
100      * Checks if any accessor for a certain field exists.
101      * @param clazz the Class to search in
102      * @param fieldName the field to search an accessor for
103      * @param type the return type the accessor should have
104      * @return true if a matching accessor could be found
105      */
106     public boolean canFindAccessors(final Class clazz, final String fieldName, final Class type) {
107         try {
108             String methodName = null;
109 
110             //-- getMethod
111             methodName = _javaNaming.getGetMethodNameForField(fieldName);
112             boolean isGet = true;
113             if (AbstractMappingLoader.findAccessor(clazz, methodName, type, isGet) != null) {
114                 return true;
115             }
116                 
117             //-- setMethod and/or addMethod
118             isGet = false;
119             methodName = _javaNaming.getSetMethodNameForField(fieldName);
120             if (AbstractMappingLoader.findAccessor(clazz, methodName, type, isGet) != null) {
121                 return true;
122             }
123             methodName = _javaNaming.getAddMethodNameForField(fieldName);
124             if (AbstractMappingLoader.findAccessor(clazz, methodName, type, isGet) != null) {
125                 return true;                
126             }
127         } catch (Exception ex) {
128             // nothing to do
129         }
130         return false;
131     }
132 }