SQLiteQuery.java revision 65a8883f0e605bb8a73a692987b47ce5da632e72
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.database.sqlite; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.database.CursorWindow; 206a353876178ca2fe4bc61f128130067d2c2574d1Brad Fitzpatrickimport android.os.SystemClock; 214df2423a947bcd3f024cc3d3a1a315a8dc428598The Android Open Source Projectimport android.util.Log; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * A SQLite program that represents a query that reads the resulting rows into a CursorWindow. 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class is used by SQLiteCursor and isn't useful itself. 26f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * 27f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * SQLiteQuery is not internally synchronized so code using a SQLiteQuery from multiple 28f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * threads should perform its own synchronization when using the SQLiteQuery. 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class SQLiteQuery extends SQLiteProgram { 314df2423a947bcd3f024cc3d3a1a315a8dc428598The Android Open Source Project private static final String TAG = "Cursor"; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The index of the unbound OFFSET parameter */ 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mOffsetIndex; 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Args to bind on requery */ 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private String[] mBindArgs; 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mClosed = false; 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a persistent query object. 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param db The database that this query object is associated with 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param query The SQL string for this query. 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param offsetIndex The 1-based index to the OFFSET parameter, 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ SQLiteQuery(SQLiteDatabase db, String query, int offsetIndex, String[] bindArgs) { 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super(db, query); 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mOffsetIndex = offsetIndex; 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs = bindArgs; 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5665a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * Constructor used to create new instance to replace a given instance of this class. 5765a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * This constructor is used when the current Query object is now associated with a different 5865a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * {@link SQLiteDatabase} object. 5965a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * 6065a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * @param db The database that this query object is associated with 6165a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * @param query the instance of {@link SQLiteQuery} to be replaced 6265a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori */ 6365a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori /* package */ SQLiteQuery(SQLiteDatabase db, SQLiteQuery query) { 6465a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori this(db, query.mSql, 0, query.mBindArgs); 6565a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori } 6665a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori 6765a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori /** 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Reads rows into a buffer. This method acquires the database lock. 69722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick * 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param window The window to fill into 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return number of total rows in the query 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 73722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick /* package */ int fillWindow(CursorWindow window, 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int maxRead, int lastPos) { 756a353876178ca2fe4bc61f128130067d2c2574d1Brad Fitzpatrick long timeStart = SystemClock.uptimeMillis(); 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDatabase.lock(); 77722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick mDatabase.logTimeStat(mSql, timeStart, SQLiteDatabase.GET_LOCK_LOG_PREFIX); 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project acquireReference(); 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project window.acquireReference(); 82722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // if the start pos is not equal to 0, then most likely window is 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // too small for the data set, loading by another thread 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // is not safe in this situation. the native code will ignore maxRead 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int numRows = native_fill_window(window, window.getStartPosition(), mOffsetIndex, 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project maxRead, lastPos); 8712311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor mDatabase.logTimeStat(mSql, timeStart); 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return numRows; 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (IllegalStateException e){ 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // simply ignore it 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return 0; 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLiteDatabaseCorruptException e) { 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDatabase.onCorruption(); 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw e; 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 96722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick window.releaseReference(); 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project releaseReference(); 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDatabase.unlock(); 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the column count for the statement. Only valid on query based 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * statements. The database must be locked 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when calling this method. 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The number of column in the statement's result set. 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ int columnCountLocked() { 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project acquireReference(); 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return native_column_count(); 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project releaseReference(); 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieves the column name for the given column index. The database must be locked 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when calling this method. 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param columnIndex the index of the column to get the name for 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The requested column's name 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ String columnNameLocked(int columnIndex) { 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project acquireReference(); 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return native_column_name(columnIndex); 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project releaseReference(); 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 1385a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori return "SQLiteQuery: " + mSql; 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void close() { 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.close(); 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mClosed = true; 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called by SQLiteCursor when it is requeried. 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ void requery() { 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mBindArgs != null) { 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int len = mBindArgs.length; 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < len; i++) { 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.bindString(i + 1, mBindArgs[i]); 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLiteMisuseException e) { 1585a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori StringBuilder errMsg = new StringBuilder("mSql " + mSql); 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < len; i++) { 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project errMsg.append(" "); 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project errMsg.append(mBindArgs[i]); 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project errMsg.append(" "); 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IllegalStateException leakProgram = new IllegalStateException( 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project errMsg.toString(), e); 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw leakProgram; 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void bindNull(int index) { 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs[index - 1] = null; 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mClosed) super.bindNull(index); 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void bindLong(int index, long value) { 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs[index - 1] = Long.toString(value); 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mClosed) super.bindLong(index, value); 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void bindDouble(int index, double value) { 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs[index - 1] = Double.toString(value); 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mClosed) super.bindDouble(index, value); 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void bindString(int index, String value) { 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs[index - 1] = value; 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mClosed) super.bindString(index, value); 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final native int native_fill_window(CursorWindow window, 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int startPos, int offsetParam, int maxRead, int lastPos); 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final native int native_column_count(); 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final native String native_column_name(int columnIndex); 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 202