Package mil.nga.geopackage.user

Class UserCursor<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

java.lang.Object

android.database.CursorWrapper

mil.nga.geopackage.db.CursorResult

mil.nga.geopackage.user.UserCursor<TColumn,TTable,TRow>

Type Parameters:

TColumn - column type

TTable - table type

TRow - row type

All Implemented Interfaces:

Cursor, Closeable, AutoCloseable, Iterable<TRow>, Result, UserCoreResult<TColumn,TTable,TRow>

Direct Known Subclasses:

AttributesCursor, FeatureCursor, TileCursor, UserCustomCursor

public abstract class UserCursor<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>
extends CursorResult
implements UserCoreResult<TColumn,TTable,TRow>

Abstract User Cursor

Field Summary

Fields inherited from interface android.database.Cursor

FIELD_TYPE_BLOB, FIELD_TYPE_FLOAT, FIELD_TYPE_INTEGER, FIELD_TYPE_NULL, FIELD_TYPE_STRING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserCursor(TTable table, Cursor cursor)	Constructor
protected	UserCursor(TTable table, String[] columns, Cursor cursor)	Constructor
protected	UserCursor(TTable table, UserColumns<TColumn> columns, Cursor cursor)	Constructor

Method Summary

Modifier and Type	Method	Description
void	close()
protected abstract UserInvalidCursor<TColumn,TTable,TRow,? extends UserCursor<TColumn,TTable,TRow>,? extends UserDao<TColumn,TTable,TRow,? extends UserCursor<TColumn,TTable,TRow>>>	createInvalidCursor(UserDao dao, UserCursor cursor, List<Integer> invalidPositions, List<TColumn> blobColumns)	Create an invalid cursor
protected void	enableInvalidRequery(UserDao<TColumn,TTable,TRow,? extends UserCursor<TColumn,TTable,TRow>> dao)	Enable requery attempt of invalid rows after iterating through original query rows.
UserColumns<TColumn>	getColumns()
int	getCount()
long	getId()
List<Integer>	getInvalidPositions()	Get the invalid positions found when retrieving rows
UserQuery	getQuery()	Get the user query
TRow	getRow()
String[]	getSelectionArgs()
String	getSql()
TTable	getTable()
String	getTableName()
Object	getValue(int index)
Object	getValue(int index, GeoPackageDataType dataType)
Object	getValue(String columnName)
Object	getValue(TColumn column)
boolean	hasInvalidPositions()	Determine if invalid positions were found when retrieving rows or if all are invalid (null)
Iterable<Long>	ids()
boolean	isUseBindings()	Get the cursor SQLite connection origination as bindings or standard
Iterator<TRow>	iterator()
boolean	moveToNext()
static void	readBlobValue(UserDao dao, UserCoreResult result, UserRow row, UserColumn column)	Read the blob column value in chunks
void	setColumns(UserColumns<TColumn> columns)	Set the columns
void	setQuery(UserQuery query)	Set the user query
void	setTable(TTable table)	Set the table
void	setUseBindings(boolean useBindings)	Set the cursor SQLite connection origination as bindings or standard

Methods inherited from class mil.nga.geopackage.db.CursorResult

wasNull

Methods inherited from class android.database.CursorWrapper

copyStringToBuffer, deactivate, getBlob, getColumnCount, getColumnIndex, getColumnIndexOrThrow, getColumnName, getColumnNames, getDouble, getExtras, getFloat, getInt, getLong, getNotificationUri, getNotificationUris, getPosition, getShort, getString, getType, getWantsAllOnMoveCalls, getWrappedCursor, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, isNull, move, moveToFirst, moveToLast, moveToPosition, moveToPrevious, registerContentObserver, registerDataSetObserver, requery, respond, setExtras, setNotificationUri, setNotificationUris, unregisterContentObserver, unregisterDataSetObserver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface mil.nga.geopackage.db.Result

getBlob, getColumnCount, getColumnIndex, getDouble, getFloat, getInt, getLong, getPosition, getShort, getString, getType, moveToFirst, moveToPosition, wasNull

Methods inherited from interface mil.nga.geopackage.user.UserCoreResult

getRow

Constructor Details

UserCursor

protected UserCursor(TTable table,
 Cursor cursor)

Constructor

Parameters:

table - table

cursor - cursor

UserCursor

protected UserCursor(TTable table,
 String[] columns,
 Cursor cursor)

Constructor

Parameters:

table - table

columns - columns

cursor - cursor

Since:

3.5.0

UserCursor

protected UserCursor(TTable table,
 UserColumns<TColumn> columns,
 Cursor cursor)

Constructor

Parameters:

table - table

columns - columns

cursor - cursor

Since:

3.5.0

Method Details

getValue

public Object getValue(TColumn column)

Specified by:

getValue in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

getValue

public Object getValue(int index)

Specified by:

getValue in interface Result

Specified by:

getValue in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

Overrides:

getValue in class CursorResult

getValue

public Object getValue(String columnName)

Specified by:

getValue in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

getId

public long getId()

Specified by:

getId in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

setTable

public void setTable(TTable table)

Set the table

Parameters:

table - table

Since:

3.2.0

getTable

public TTable getTable()

Specified by:

getTable in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

getTableName

public String getTableName()

Specified by:

getTableName in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

setColumns

public void setColumns(UserColumns<TColumn> columns)

Set the columns

Parameters:

columns - columns

Since:

3.5.0

getColumns

public UserColumns<TColumn> getColumns()

Specified by:

getColumns in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

getInvalidPositions

public List<Integer> getInvalidPositions()

Get the invalid positions found when retrieving rows

Returns:

invalid positions, empty if none, null if all invalid

Since:

2.0.0

hasInvalidPositions

public boolean hasInvalidPositions()

Determine if invalid positions were found when retrieving rows or if all are invalid (null)

Returns:

true if invalid positions

Since:

2.0.0

getCount

public int getCount()

Specified by:

getCount in interface Cursor

Specified by:

getCount in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

Overrides:

getCount in class CursorWrapper

moveToNext

public boolean moveToNext()

Specified by:

moveToNext in interface Cursor

Specified by:

moveToNext in interface Result

Overrides:

moveToNext in class CursorWrapper

getRow

public TRow getRow()

Specified by:

getRow in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

getValue

public Object getValue(int index,
 GeoPackageDataType dataType)

Specified by:

getValue in interface Result

Overrides:

getValue in class CursorResult

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Cursor

Specified by:

close in interface Result

Overrides:

close in class CursorWrapper

setQuery

public void setQuery(UserQuery query)

Set the user query

Parameters:

query - user query

Since:

2.0.0

getQuery

public UserQuery getQuery()

Get the user query

Returns:

user query

Since:

2.0.0

setUseBindings

public void setUseBindings(boolean useBindings)

Set the cursor SQLite connection origination as bindings or standard

Parameters:

useBindings - true if bindings connection, false if standard

Since:

6.2.1

isUseBindings

public boolean isUseBindings()

Get the cursor SQLite connection origination as bindings or standard

Returns:

true if bindings connection, false if standard

Since:

6.2.1

enableInvalidRequery

protected void enableInvalidRequery(UserDao<TColumn,TTable,TRow,? extends UserCursor<TColumn,TTable,TRow>> dao)

Enable requery attempt of invalid rows after iterating through original query rows. Only supported for moveToNext() and getRow() usage.

Parameters:

dao - data access object used to perform requery

Since:

2.0.0

createInvalidCursor

protected abstract UserInvalidCursor<TColumn,TTable,TRow,? extends UserCursor<TColumn,TTable,TRow>,? extends UserDao<TColumn,TTable,TRow,? extends UserCursor<TColumn,TTable,TRow>>> createInvalidCursor(UserDao dao,
 UserCursor cursor,
 List<Integer> invalidPositions,
 List<TColumn> blobColumns)

Create an invalid cursor

Parameters:

dao - data access object

cursor - user cursor

invalidPositions - invalid positions

blobColumns - blob columns

Returns:

invalid cursor

readBlobValue

public static void readBlobValue(UserDao dao,
 UserCoreResult result,
 UserRow row,
 UserColumn column)

Read the blob column value in chunks

Parameters:

dao - user dao

result - user core result

row - user row

column - user blob column

iterator

public Iterator<TRow> iterator()

Specified by:

iterator in interface Iterable<TColumn extends UserColumn>

getSql

public String getSql()

Specified by:

getSql in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

getSelectionArgs

public String[] getSelectionArgs()

Specified by:

getSelectionArgs in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>

ids

public Iterable<Long> ids()

Specified by:

ids in interface UserCoreResult<TColumn extends UserColumn,TTable extends UserTable<TColumn>,TRow extends UserRow<TColumn,TTable>>