SQLiteQuery.java revision 6a353876178ca2fe4bc61f128130067d2c2574d1
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. 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class SQLiteQuery extends SQLiteProgram { 284df2423a947bcd3f024cc3d3a1a315a8dc428598The Android Open Source Project private static final String TAG = "Cursor"; 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The index of the unbound OFFSET parameter */ 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mOffsetIndex; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Args to bind on requery */ 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private String[] mBindArgs; 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mClosed = false; 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a persistent query object. 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param db The database that this query object is associated with 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param query The SQL string for this query. 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param offsetIndex The 1-based index to the OFFSET parameter, 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ SQLiteQuery(SQLiteDatabase db, String query, int offsetIndex, String[] bindArgs) { 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super(db, query); 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mOffsetIndex = offsetIndex; 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs = bindArgs; 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Reads rows into a buffer. This method acquires the database lock. 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param window The window to fill into 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return number of total rows in the query 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ int fillWindow(CursorWindow window, 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int maxRead, int lastPos) { 606a353876178ca2fe4bc61f128130067d2c2574d1Brad Fitzpatrick long timeStart = SystemClock.uptimeMillis(); 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDatabase.lock(); 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project acquireReference(); 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project window.acquireReference(); 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // if the start pos is not equal to 0, then most likely window is 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // too small for the data set, loading by another thread 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // is not safe in this situation. the native code will ignore maxRead 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int numRows = native_fill_window(window, window.getStartPosition(), mOffsetIndex, 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project maxRead, lastPos); 724df2423a947bcd3f024cc3d3a1a315a8dc428598The Android Open Source Project 734df2423a947bcd3f024cc3d3a1a315a8dc428598The Android Open Source Project // Logging 744df2423a947bcd3f024cc3d3a1a315a8dc428598The Android Open Source Project if (SQLiteDebug.DEBUG_SQL_STATEMENTS) { 755a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori Log.d(TAG, "fillWindow(): " + mSql); 764df2423a947bcd3f024cc3d3a1a315a8dc428598The Android Open Source Project } 7712311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor mDatabase.logTimeStat(mSql, timeStart); 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return numRows; 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (IllegalStateException e){ 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // simply ignore it 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return 0; 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLiteDatabaseCorruptException e) { 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDatabase.onCorruption(); 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw e; 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project window.releaseReference(); 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project releaseReference(); 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDatabase.unlock(); 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the column count for the statement. Only valid on query based 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * statements. The database must be locked 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when calling this method. 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The number of column in the statement's result set. 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ int columnCountLocked() { 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project acquireReference(); 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return native_column_count(); 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project releaseReference(); 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieves the column name for the given column index. The database must be locked 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when calling this method. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param columnIndex the index of the column to get the name for 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The requested column's name 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ String columnNameLocked(int columnIndex) { 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project acquireReference(); 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return native_column_name(columnIndex); 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project releaseReference(); 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 1285a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori return "SQLiteQuery: " + mSql; 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void close() { 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.close(); 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mClosed = true; 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called by SQLiteCursor when it is requeried. 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ void requery() { 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mBindArgs != null) { 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int len = mBindArgs.length; 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < len; i++) { 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.bindString(i + 1, mBindArgs[i]); 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLiteMisuseException e) { 1485a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori StringBuilder errMsg = new StringBuilder("mSql " + mSql); 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < len; i++) { 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project errMsg.append(" "); 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project errMsg.append(mBindArgs[i]); 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project errMsg.append(" "); 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IllegalStateException leakProgram = new IllegalStateException( 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project errMsg.toString(), e); 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw leakProgram; 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void bindNull(int index) { 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs[index - 1] = null; 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mClosed) super.bindNull(index); 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void bindLong(int index, long value) { 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs[index - 1] = Long.toString(value); 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mClosed) super.bindLong(index, value); 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void bindDouble(int index, double value) { 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs[index - 1] = Double.toString(value); 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mClosed) super.bindDouble(index, value); 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void bindString(int index, String value) { 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBindArgs[index - 1] = value; 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mClosed) super.bindString(index, value); 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final native int native_fill_window(CursorWindow window, 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int startPos, int offsetParam, int maxRead, int lastPos); 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final native int native_column_count(); 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final native String native_column_name(int columnIndex); 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 192