001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: * Free Software Foundation, Inc.
023: * 59 Temple Place, Suite 330
024: * Boston, MA 02111-1307 USA
025: *
026: * @author Scott Ferguson
027: */
028:
029: package com.caucho.amber;
030:
031: import java.lang.reflect.InvocationTargetException;
032: import java.lang.reflect.Method;
033: import java.sql.ResultSet;
034: import java.sql.SQLException;
035: import java.util.List;
036: import java.util.Map;
037:
038: /**
039: * Represents an Amber query
040: */
041: public interface AmberQuery {
042: /**
043: * Initialize with the connection.
044: */
045: public void init(com.caucho.amber.manager.AmberConnection aConn);
046:
047: /**
048: * Returns the query string.
049: */
050: public String getQueryString();
051:
052: /**
053: * Sets the argument with a string
054: */
055: public void setString(int index, String v);
056:
057: /**
058: * Sets the argument with a byte
059: */
060: public void setByte(int index, byte v);
061:
062: /**
063: * Sets the argument with a short
064: */
065: public void setShort(int index, short v);
066:
067: /**
068: * Sets the argument with an integer
069: */
070: public void setInt(int index, int v);
071:
072: /**
073: * Sets the argument with a long
074: */
075: public void setLong(int index, long v);
076:
077: /**
078: * Sets the argument with a double
079: */
080: public void setDouble(int index, double v);
081:
082: /**
083: * Sets the argument with a double
084: */
085: public void setFloat(int index, float v);
086:
087: /**
088: * Sets the argument with a timestamp
089: */
090: public void setTimestamp(int index, java.sql.Timestamp v);
091:
092: /**
093: * Sets the argument with a date
094: */
095: public void setDate(int index, java.sql.Date v);
096:
097: /**
098: * Sets the argument with an object.
099: */
100: public void setObject(int index, Object v);
101:
102: /**
103: * Sets the argument with an null.
104: */
105: public void setNull(int index, int type);
106:
107: /**
108: * Sets the first result.
109: */
110: public void setFirstResult(int index);
111:
112: /**
113: * Sets the maximum number of results.
114: */
115: public void setMaxResults(int index);
116:
117: /**
118: * Executes the query returning a result set.
119: */
120: public ResultSet executeQuery() throws SQLException;
121:
122: /**
123: * Executes the query as an update, returning the rows changed.
124: */
125: public int executeUpdate() throws SQLException;
126:
127: /**
128: * Sets the cache max age.
129: */
130: public void setCacheMaxAge(long ms);
131:
132: /**
133: * Execute the query, returning a single value
134: */
135: public Object getSingleResult() throws SQLException;
136:
137: /**
138: * Execute the query, returning a list.
139: */
140: public List<Object> list() throws SQLException;
141:
142: /**
143: * Execute the query, filling a list.
144: */
145: public void list(List<Object> list) throws SQLException;
146:
147: /**
148: * Execute the query, filling a map.
149: */
150: public void list(Map<Object, Object> map, Method methodGetMapKey)
151: throws SQLException, IllegalAccessException,
152: InvocationTargetException;
153:
154: /**
155: * Sets the load on query.
156: */
157: public void setLoadOnQuery(boolean isLoad);
158: }
|