KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > oracle > toplink > essentials > queryframework > ColumnResult


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the "License"). You may not use this file except
5  * in compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * glassfish/bootstrap/legal/CDDLv1.0.txt or
9  * https://glassfish.dev.java.net/public/CDDLv1.0.html.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * HEADER in each file and include the License file at
15  * glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
16  * add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your
18  * own identifying information: Portions Copyright [yyyy]
19  * [name of copyright owner]
20  */
21 // Copyright (c) 1998, 2005, Oracle. All rights reserved.
22 package oracle.toplink.essentials.queryframework;
23
24 import oracle.toplink.essentials.internal.localization.ExceptionLocalization;
25 import oracle.toplink.essentials.sessions.DatabaseRecord;
26
27 /**
28  * <p><b>Purpose</b>:
29  * Concrete class to represent the ColumnResult structure as defined by
30  * the EJB 3.0 Persistence specification. This class is a subcompent of the
31  * EntityResult
32  *
33  * @see EntityResult
34  * @author Gordon Yorke
35  * @since TopLink Java Essentials
36  */
37
38 public class ColumnResult extends SQLResult{
39     
40     /** Stores the Columns name from the result set */
41     protected String JavaDoc columnName;
42     
43     public ColumnResult(String JavaDoc column){
44         this.columnName = column;
45         if (this.columnName == null){
46             throw new IllegalArgumentException JavaDoc(ExceptionLocalization.buildMessage("null_value_for_column_result"));
47         }
48     }
49     
50     public String JavaDoc getColumnName(){
51         return this.columnName;
52     }
53     
54     /**
55      * INTERNAL:
56      * This method is a convience method for extracting values from Results
57      */
58     public Object JavaDoc getValueFromRecord(DatabaseRecord record, ResultSetMappingQuery query){
59         return record.get(this.columnName);
60     }
61     
62     public boolean isColumnResult(){
63         return true;
64     }
65     
66 }
67
Popular Tags