View Javadoc

1   /*
2   $Id: GroovyRowResult.java,v 1.1 2005/02/23 22:09:15 glaforge Exp $
3   
4   Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5   
6   Redistribution and use of this software and associated documentation
7   ("Software"), with or without modification, are permitted provided
8   that the following conditions are met:
9   
10  1. Redistributions of source code must retain copyright
11     statements and notices.  Redistributions must also contain a
12     copy of this document.
13  
14  2. Redistributions in binary form must reproduce the
15     above copyright notice, this list of conditions and the
16     following disclaimer in the documentation and/or other
17     materials provided with the distribution.
18  
19  3. The name "groovy" must not be used to endorse or promote
20     products derived from this Software without prior written
21     permission of The Codehaus.  For written permission,
22     please contact info@codehaus.org.
23  
24  4. Products derived from this Software may not be called "groovy"
25     nor may "groovy" appear in their names without prior written
26     permission of The Codehaus. "groovy" is a registered
27     trademark of The Codehaus.
28  
29  5. Due credit should be given to The Codehaus -
30     http://groovy.codehaus.org/
31  
32  THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
33  ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
34  NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
35  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
36  THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
37  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
43  OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  */
46  package groovy.sql;
47  
48  import groovy.lang.GroovyObjectSupport;
49  import groovy.lang.MissingPropertyException;
50  
51  import java.util.Iterator;
52  import java.util.LinkedHashMap;
53  
54  /***
55  * Represents an extent of objects.
56  * It's used in the oneRow method to be able to access the result
57  * of a SQL query by the name of the column, or by the column number.
58  * 
59  * @Author Jean-Louis Berliet
60  * @version $Revision: 1.1 $
61  */
62  public class GroovyRowResult extends GroovyObjectSupport {
63  
64     private LinkedHashMap result;
65  
66     public GroovyRowResult(LinkedHashMap result) {
67         this.result = result;
68     }
69  
70     /***
71      * Retrieve the value of the property by its name    * 
72      * @param property is the name of the property to look at
73      * @return the value of the property
74      */
75     public Object getProperty(String property) {
76         try {
77             Object value = result.get(property);
78             if (value==null) {
79             	   // with some databases/drivers, the columns names are stored uppercase.
80                 value = result.get(property.toUpperCase());
81                 if (value==null) 
82                     throw new MissingPropertyException(property, GroovyRowResult.class);
83             }
84             return(value); 
85         }
86         catch (Exception e) {
87             throw new MissingPropertyException(property, GroovyRowResult.class, e);
88         }
89     }
90  
91     /***
92      * Retrieve the value of the property by its index.
93      * A negative index will count backwards from the last column.
94      * @param index is the number of the column to look at
95      * @return the value of the property
96      */
97    public Object getAt(int index) {
98         try {
99             // a negative index will count backwards from the last column.
100            if (index<0) 
101                index += result.size();
102            Iterator it = result.values().iterator();
103            int i = 0;
104            Object obj = null;
105            while ( (obj==null) && (it.hasNext())  ) {
106                if (i==index)
107                    obj = it.next();
108                else
109                    it.next();
110                i++;
111            }
112            return(obj); 
113        }
114        catch (Exception e) {
115            throw new MissingPropertyException(Integer.toString(index), GroovyRowResult.class, e);
116        }
117    }
118   
119   public String toString() {
120   	return(result.toString() );
121   }
122   
123 }