GeoPackageCoreConnection (GeoPackage Core 3.5.0 API)

java.lang.Object
- mil.nga.geopackage.db.GeoPackageCoreConnection

All Implemented Interfaces:

Closeable, AutoCloseable
```
public abstract class GeoPackageCoreConnection
extends Object
implements Closeable
```
GeoPackage Connection used to define common functionality within different connection types

Author:

osbornb

Field Summary

Fields
Modifier and Type Field and Description

protected ConnectionSource connectionSource
Connection source

Fields
Modifier and Type	Field and Description
`protected ConnectionSource`	`connectionSource` Connection source

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GeoPackageCoreConnection(ConnectionSource connectionSource)` Constructor
`protected`	`GeoPackageCoreConnection(GeoPackageCoreConnection connection)` Copy Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(String tableName, String columnName, String columnDef)` Add a new column to the table
`abstract void`	`beginTransaction()` Begin a transaction
`void`	`close()`
`boolean`	`columnExists(String tableName, String columnName)` Check if the table column exists
`abstract void`	`commit()` Commit changes on the connection
`abstract int`	`count(String table, String where, String[] args)` Get a count of results
`abstract int`	`delete(String table, String whereClause, String[] whereArgs)` Convenience method for deleting rows in the database.
`boolean`	`enableForeignKeys()` If foreign keys is disabled and there are no foreign key violations, enables foreign key checks, else logs violations
`void`	`endAndBeginTransaction()` End a transaction as successful and begin a new transaction
`void`	`endTransaction()` End a transaction successfully
`abstract void`	`endTransaction(boolean successful)` End a transaction
`abstract void`	`execSQL(String sql)` Execute the sql
`void`	`failTransaction()` Fail a transaction
`List<List<Object>>`	`foreignKeyCheck()` Perform a foreign key check
`List<List<Object>>`	`foreignKeyCheck(String tableName)` Perform a foreign key check
`boolean`	`foreignKeys()` Query for the foreign keys value
`boolean`	`foreignKeys(boolean on)` Change the foreign keys state
`String`	`getApplicationId()` Get the application id
`ConnectionSource`	`getConnectionSource()` Get a connection source
`int`	`getUserVersion()` Get the user version
`abstract boolean`	`inTransaction()` Determine if currently within a transaction
`abstract Integer`	`max(String table, String column, String where, String[] args)` Get the max result of the column
`abstract Integer`	`min(String table, String column, String where, String[] args)` Get the min result of the column
`List<List<Object>>`	`queryResults(String sql, String[] args)` Query for values
`List<List<Object>>`	`queryResults(String sql, String[] args, GeoPackageDataType[] dataTypes)` Query for values
`abstract List<List<Object>>`	`queryResults(String sql, String[] args, GeoPackageDataType[] dataTypes, Integer limit)` Query for values up to the limit
`List<List<Object>>`	`queryResults(String sql, String[] args, Integer limit)` Query for values
`List<Object>`	`querySingleColumnResults(String sql, String[] args)` Query for values from the first column
`List<Object>`	`querySingleColumnResults(String sql, String[] args, GeoPackageDataType dataType)` Query for values from the first column
`List<Object>`	`querySingleColumnResults(String sql, String[] args, int column)` Query for values from a single column
`List<Object>`	`querySingleColumnResults(String sql, String[] args, int column, GeoPackageDataType dataType)` Query for values from a single column
`abstract List<Object>`	`querySingleColumnResults(String sql, String[] args, int column, GeoPackageDataType dataType, Integer limit)` Query for values from a single column up to the limit
`List<Object>`	`querySingleColumnResults(String sql, String[] args, int column, Integer limit)` Query for values from a single column up to the limit
`<T> List<T>`	`querySingleColumnTypedResults(String sql, String[] args)` Query for values from the first column
`<T> List<T>`	`querySingleColumnTypedResults(String sql, String[] args, GeoPackageDataType dataType)` Query for typed values from the first column
`<T> List<T>`	`querySingleColumnTypedResults(String sql, String[] args, int column)` Query for typed values from a single column
`<T> List<T>`	`querySingleColumnTypedResults(String sql, String[] args, int column, GeoPackageDataType dataType)` Query for typed values from a single column
`<T> List<T>`	`querySingleColumnTypedResults(String sql, String[] args, int column, GeoPackageDataType dataType, Integer limit)` Query for typed values from a single column up to the limit
`<T> List<T>`	`querySingleColumnTypedResults(String sql, String[] args, int column, Integer limit)` Query for typed values from a single column up to the limit
`Object`	`querySingleResult(String sql, String[] args)` Query the SQL for a single result object in the first column
`Object`	`querySingleResult(String sql, String[] args, GeoPackageDataType dataType)` Query the SQL for a single result object in the first column with the expected data type
`Object`	`querySingleResult(String sql, String[] args, int column)` Query the SQL for a single result object
`abstract Object`	`querySingleResult(String sql, String[] args, int column, GeoPackageDataType dataType)` Query the SQL for a single result object with the expected data type
`List<Object>`	`querySingleRowResults(String sql, String[] args)` Query for values in a single (first) row
`List<Object>`	`querySingleRowResults(String sql, String[] args, GeoPackageDataType[] dataTypes)` Query for values in a single (first) row
`<T> List<T>`	`querySingleRowTypedResults(String sql, String[] args)` Query for typed values in a single (first) row
`<T> List<T>`	`querySingleRowTypedResults(String sql, String[] args, GeoPackageDataType[] dataTypes)` Query for typed values in a single (first) row
`<T> T`	`querySingleTypedResult(String sql, String[] args)` Query the SQL for a single result typed object in the first column
`<T> T`	`querySingleTypedResult(String sql, String[] args, GeoPackageDataType dataType)` Query the SQL for a single result typed object in the first column with the expected data type
`<T> T`	`querySingleTypedResult(String sql, String[] args, int column)` Query the SQL for a single result typed object
`<T> T`	`querySingleTypedResult(String sql, String[] args, int column, GeoPackageDataType dataType)` Query the SQL for a single result typed object with the expected data type
`<T> List<List<T>>`	`queryTypedResults(String sql, String[] args)` Query for typed values
`<T> List<List<T>>`	`queryTypedResults(String sql, String[] args, GeoPackageDataType[] dataTypes)` Query for typed values
`<T> List<List<T>>`	`queryTypedResults(String sql, String[] args, GeoPackageDataType[] dataTypes, Integer limit)` Query for typed values up to the limit
`<T> List<List<T>>`	`queryTypedResults(String sql, String[] args, Integer limit)` Query for typed values
`void`	`setApplicationId()` Set the GeoPackage application id
`void`	`setApplicationId(String applicationId)` Set the GeoPackage application id
`void`	`setUserVersion()` Set the GeoPackage user version
`void`	`setUserVersion(int userVersion)` Set the user version
`boolean`	`tableExists(String tableName)` Check if the table exists

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

connectionSource

protected final ConnectionSource connectionSource

Connection source

Constructor Detail
- GeoPackageCoreConnection
```
protected GeoPackageCoreConnection(ConnectionSource connectionSource)
```
  Constructor
  
  Parameters:
  
  connectionSource - connection source
- GeoPackageCoreConnection
```
protected GeoPackageCoreConnection(GeoPackageCoreConnection connection)
```
  Copy Constructor
  
  Parameters:
  
  connection - connection
  
  Since:
  
  3.4.0

Method Detail

getConnectionSource
```
public ConnectionSource getConnectionSource()
```
Get a connection source

Returns:

connection source

execSQL
```
public abstract void execSQL(String sql)
```
Execute the sql

Parameters:

sql - sql statement

beginTransaction
```
public abstract void beginTransaction()
```
Begin a transaction

Since:

3.3.0

endTransaction
```
public void endTransaction()
```
End a transaction successfully

Since:

3.3.0

failTransaction
```
public void failTransaction()
```
Fail a transaction

Since:

3.3.0

endTransaction
```
public abstract void endTransaction(boolean successful)
```
End a transaction

Parameters:

successful - true if the transaction was successful, false to rollback or not commit

Since:

3.3.0

endAndBeginTransaction
```
public void endAndBeginTransaction()
```
End a transaction as successful and begin a new transaction

Since:

3.3.0

commit
```
public abstract void commit()
```
Commit changes on the connection

Since:

3.3.0

inTransaction
```
public abstract boolean inTransaction()
```
Determine if currently within a transaction

Returns:

true if in transaction

Since:

3.3.0

enableForeignKeys
```
public boolean enableForeignKeys()
```
If foreign keys is disabled and there are no foreign key violations, enables foreign key checks, else logs violations

Returns:

true if enabled or already enabled, false if foreign key violations and not enabled

Since:

3.3.0

foreignKeys
```
public boolean foreignKeys()
```
Query for the foreign keys value

Returns:

true if enabled, false if disabled

Since:

3.3.0

foreignKeys
```
public boolean foreignKeys(boolean on)
```
Change the foreign keys state

Parameters:

on - true to turn on, false to turn off

Returns:

previous foreign keys value

Since:

3.3.0

foreignKeyCheck
```
public List<List<Object>> foreignKeyCheck()
```
Perform a foreign key check

Returns:

empty list if valid or violation errors, 4 column values for each violation. see SQLite PRAGMA foreign_key_check

Since:

3.3.0

foreignKeyCheck
```
public List<List<Object>> foreignKeyCheck(String tableName)
```
Perform a foreign key check

Parameters:

tableName - table name

Returns:

empty list if valid or violation errors, 4 column values for each violation. see SQLite PRAGMA foreign_key_check

Since:

3.3.0

delete

public abstract int delete(String table,
                           String whereClause,
                           String[] whereArgs)

Convenience method for deleting rows in the database.

Parameters:: table - table name; whereClause - where clause; whereArgs - where arguments
Returns:: rows deleted

count

public abstract int count(String table,
                          String where,
                          String[] args)

Get a count of results

Parameters:: table - table name; where - where clause; args - arguments
Returns:: count

min

public abstract Integer min(String table,
                            String column,
                            String where,
                            String[] args)

Get the min result of the column

Parameters:: table - table name; column - column name; where - where clause; args - where arguments
Returns:: min or null
Since:: 1.1.1

max

public abstract Integer max(String table,
                            String column,
                            String where,
                            String[] args)

Get the max result of the column

Parameters:: table - table name; column - column name; where - where clause; args - where arguments
Returns:: max or null
Since:: 1.1.1

close
```
public void close()
```
Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

tableExists
```
public boolean tableExists(String tableName)
```
Check if the table exists

Parameters:

tableName - table name

Returns:

true if exists

columnExists
```
public boolean columnExists(String tableName,
                            String columnName)
```
Check if the table column exists

Parameters:

tableName - table name

columnName - column name

Returns:

true if column exists

Since:

1.1.8

addColumn

public void addColumn(String tableName,
                      String columnName,
                      String columnDef)

Add a new column to the table

Parameters:: tableName - table name; columnName - column name; columnDef - column definition
Since:: 1.1.8

querySingleResult
```
public Object querySingleResult(String sql,
                                String[] args)
```
Query the SQL for a single result object in the first column

Parameters:

sql - sql statement

args - sql arguments

Returns:

single result object

Since:

3.1.0

querySingleTypedResult
```
public <T> T querySingleTypedResult(String sql,
                                    String[] args)
```
Query the SQL for a single result typed object in the first column

Type Parameters:

T - result value type

Parameters:

sql - sql statement

args - sql arguments

Returns:

single result object

Since:

3.1.0

querySingleResult

public Object querySingleResult(String sql,
                                String[] args,
                                GeoPackageDataType dataType)

Query the SQL for a single result object in the first column with the expected data type

Parameters:: sql - sql statement; args - sql arguments; dataType - GeoPackage data type
Returns:: single result object
Since:: 3.1.0

querySingleTypedResult
```
public <T> T querySingleTypedResult(String sql,
                                    String[] args,
                                    GeoPackageDataType dataType)
```
Query the SQL for a single result typed object in the first column with the expected data type

Type Parameters:

T - result value type

Parameters:

sql - sql statement

args - sql arguments

dataType - GeoPackage data type

Returns:

single result object

Since:

3.1.0

querySingleResult

public Object querySingleResult(String sql,
                                String[] args,
                                int column)

Query the SQL for a single result object

Parameters:: sql - sql statement; args - arguments; column - column index
Returns:: result, null if no result
Since:: 3.1.0

querySingleTypedResult
```
public <T> T querySingleTypedResult(String sql,
                                    String[] args,
                                    int column)
```
Query the SQL for a single result typed object

Type Parameters:

T - result value type

Parameters:

sql - sql statement

args - arguments

column - column index

Returns:

result, null if no result

Since:

3.1.0

querySingleResult

public abstract Object querySingleResult(String sql,
                                         String[] args,
                                         int column,
                                         GeoPackageDataType dataType)

Query the SQL for a single result object with the expected data type

Parameters:: sql - sql statement; args - arguments; column - column index; dataType - GeoPackage data type
Returns:: result, null if no result
Since:: 3.1.0

querySingleTypedResult

public <T> T querySingleTypedResult(String sql,
                                    String[] args,
                                    int column,
                                    GeoPackageDataType dataType)

Query the SQL for a single result typed object with the expected data type

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; column - column index; dataType - GeoPackage data type
Returns:: result, null if no result
Since:: 3.1.0

querySingleColumnResults

public List<Object> querySingleColumnResults(String sql,
                                             String[] args)

Query for values from the first column

Parameters:: sql - sql statement; args - sql arguments
Returns:: single column values
Since:: 3.1.0

querySingleColumnTypedResults
```
public <T> List<T> querySingleColumnTypedResults(String sql,
                                                 String[] args)
```
Query for values from the first column

Type Parameters:

T - result value type

Parameters:

sql - sql statement

args - sql arguments

Returns:

single column values

Since:

3.1.0

querySingleColumnResults

public List<Object> querySingleColumnResults(String sql,
                                             String[] args,
                                             GeoPackageDataType dataType)

Query for values from the first column

Parameters:: sql - sql statement; args - arguments; dataType - GeoPackage data type
Returns:: single column results
Since:: 3.1.0

querySingleColumnTypedResults

public <T> List<T> querySingleColumnTypedResults(String sql,
                                                 String[] args,
                                                 GeoPackageDataType dataType)

Query for typed values from the first column

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; dataType - GeoPackage data type
Returns:: single column results
Since:: 3.1.0

querySingleColumnResults

public List<Object> querySingleColumnResults(String sql,
                                             String[] args,
                                             int column)

Query for values from a single column

Parameters:: sql - sql statement; args - arguments; column - column index
Returns:: single column results
Since:: 3.1.0

querySingleColumnTypedResults

public <T> List<T> querySingleColumnTypedResults(String sql,
                                                 String[] args,
                                                 int column)

Query for typed values from a single column

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; column - column index
Returns:: single column results
Since:: 3.1.0

querySingleColumnResults

public List<Object> querySingleColumnResults(String sql,
                                             String[] args,
                                             int column,
                                             GeoPackageDataType dataType)

Query for values from a single column

Parameters:: sql - sql statement; args - arguments; column - column index; dataType - GeoPackage data type
Returns:: single column results
Since:: 3.1.0

querySingleColumnTypedResults

public <T> List<T> querySingleColumnTypedResults(String sql,
                                                 String[] args,
                                                 int column,
                                                 GeoPackageDataType dataType)

Query for typed values from a single column

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; column - column index; dataType - GeoPackage data type
Returns:: single column results
Since:: 3.1.0

querySingleColumnResults

public List<Object> querySingleColumnResults(String sql,
                                             String[] args,
                                             int column,
                                             Integer limit)

Query for values from a single column up to the limit

Parameters:: sql - sql statement; args - arguments; limit - result row limit; column - column index
Returns:: single column results
Since:: 3.1.0

querySingleColumnTypedResults

public <T> List<T> querySingleColumnTypedResults(String sql,
                                                 String[] args,
                                                 int column,
                                                 Integer limit)

Query for typed values from a single column up to the limit

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; limit - result row limit; column - column index
Returns:: single column results
Since:: 3.1.0

querySingleColumnResults

public abstract List<Object> querySingleColumnResults(String sql,
                                                      String[] args,
                                                      int column,
                                                      GeoPackageDataType dataType,
                                                      Integer limit)

Query for values from a single column up to the limit

Parameters:: sql - sql statement; args - arguments; column - column index; dataType - GeoPackage data type; limit - result row limit
Returns:: single column results
Since:: 3.1.0

querySingleColumnTypedResults

public <T> List<T> querySingleColumnTypedResults(String sql,
                                                 String[] args,
                                                 int column,
                                                 GeoPackageDataType dataType,
                                                 Integer limit)

Query for typed values from a single column up to the limit

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; column - column index; dataType - GeoPackage data type; limit - result row limit
Returns:: single column results
Since:: 3.1.0

queryResults

public List<List<Object>> queryResults(String sql,
                                       String[] args)

Query for values

Parameters:: sql - sql statement; args - arguments
Returns:: results
Since:: 3.1.0

queryTypedResults

public <T> List<List<T>> queryTypedResults(String sql,
                                           String[] args)

Query for typed values

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments
Returns:: results
Since:: 3.1.0

queryResults

public List<List<Object>> queryResults(String sql,
                                       String[] args,
                                       GeoPackageDataType[] dataTypes)

Query for values

Parameters:: sql - sql statement; args - arguments; dataTypes - column data types
Returns:: results
Since:: 3.1.0

queryTypedResults

public <T> List<List<T>> queryTypedResults(String sql,
                                           String[] args,
                                           GeoPackageDataType[] dataTypes)

Query for typed values

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; dataTypes - column data types
Returns:: results
Since:: 3.1.0

querySingleRowResults

public List<Object> querySingleRowResults(String sql,
                                          String[] args)

Query for values in a single (first) row

Parameters:: sql - sql statement; args - arguments
Returns:: single row results
Since:: 3.1.0

querySingleRowTypedResults
```
public <T> List<T> querySingleRowTypedResults(String sql,
                                              String[] args)
```
Query for typed values in a single (first) row

Type Parameters:

T - result value type

Parameters:

sql - sql statement

args - arguments

Returns:

single row results

Since:

3.1.0

querySingleRowResults

public List<Object> querySingleRowResults(String sql,
                                          String[] args,
                                          GeoPackageDataType[] dataTypes)

Query for values in a single (first) row

Parameters:: sql - sql statement; args - arguments; dataTypes - column data types
Returns:: single row results
Since:: 3.1.0

querySingleRowTypedResults

public <T> List<T> querySingleRowTypedResults(String sql,
                                              String[] args,
                                              GeoPackageDataType[] dataTypes)

Query for typed values in a single (first) row

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; dataTypes - column data types
Returns:: single row results
Since:: 3.1.0

queryResults

public List<List<Object>> queryResults(String sql,
                                       String[] args,
                                       Integer limit)

Query for values

Parameters:: sql - sql statement; args - arguments; limit - result row limit
Returns:: results
Since:: 3.1.0

queryTypedResults

public <T> List<List<T>> queryTypedResults(String sql,
                                           String[] args,
                                           Integer limit)

Query for typed values

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; limit - result row limit
Returns:: results
Since:: 3.1.0

queryResults

public abstract List<List<Object>> queryResults(String sql,
                                                String[] args,
                                                GeoPackageDataType[] dataTypes,
                                                Integer limit)

Query for values up to the limit

Parameters:: sql - sql statement; args - arguments; dataTypes - column data types; limit - result row limit
Returns:: results
Since:: 3.1.0

queryTypedResults

public <T> List<List<T>> queryTypedResults(String sql,
                                           String[] args,
                                           GeoPackageDataType[] dataTypes,
                                           Integer limit)

Query for typed values up to the limit

Type Parameters:: T - result value type
Parameters:: sql - sql statement; args - arguments; dataTypes - column data types; limit - result row limit
Returns:: results
Since:: 3.1.0

setApplicationId
```
public void setApplicationId()
```
Set the GeoPackage application id

setApplicationId
```
public void setApplicationId(String applicationId)
```
Set the GeoPackage application id

Parameters:

applicationId - application id

Since:

1.2.1

getApplicationId
```
public String getApplicationId()
```
Get the application id

Returns:

application id

Since:

1.2.1

setUserVersion
```
public void setUserVersion()
```
Set the GeoPackage user version

Since:

1.2.1

setUserVersion
```
public void setUserVersion(int userVersion)
```
Set the user version

Parameters:

userVersion - user version

Since:

1.2.1

getUserVersion
```
public int getUserVersion()
```
Get the user version

Returns:

user version

Since:

1.2.1

Class GeoPackageCoreConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

connectionSource

Constructor Detail

GeoPackageCoreConnection

GeoPackageCoreConnection

Method Detail

getConnectionSource

execSQL

beginTransaction

endTransaction

failTransaction

endTransaction

endAndBeginTransaction

commit

inTransaction

enableForeignKeys

foreignKeys

foreignKeys

foreignKeyCheck

foreignKeyCheck

delete

count

min

max

close

tableExists

columnExists

addColumn

querySingleResult

querySingleTypedResult

querySingleResult

querySingleTypedResult

querySingleResult

querySingleTypedResult

querySingleResult

querySingleTypedResult

querySingleColumnResults

querySingleColumnTypedResults

querySingleColumnResults

querySingleColumnTypedResults

querySingleColumnResults

querySingleColumnTypedResults

querySingleColumnResults

querySingleColumnTypedResults

querySingleColumnResults

querySingleColumnTypedResults

querySingleColumnResults

querySingleColumnTypedResults

queryResults

queryTypedResults

queryResults

queryTypedResults

querySingleRowResults

querySingleRowTypedResults

querySingleRowResults

querySingleRowTypedResults

queryResults

queryTypedResults

queryResults

queryTypedResults

setApplicationId

setApplicationId

getApplicationId

setUserVersion

setUserVersion

getUserVersion