Package org.orbisgis.data.jdbc

Class JdbcTable<T extends ResultSet>

java.lang.Object

org.orbisgis.data.jdbc.resultset.DefaultResultSet

org.orbisgis.data.jdbc.JdbcTable<T>

All Implemented Interfaces:

groovy.lang.GroovyObject, AutoCloseable, Iterable<T>, ResultSet, Wrapper, org.orbisgis.data.api.dataset.IDataSet<T>, org.orbisgis.data.api.dataset.IJdbcTable<T>, org.orbisgis.data.api.dataset.IMatrix<T>, org.orbisgis.data.api.dataset.ITable<T,T>, org.orbisgis.data.api.dsl.IBuilderResult, org.orbisgis.data.api.dsl.IFilterBuilder, org.orbisgis.data.api.dsl.IQueryBuilder

Direct Known Subclasses:

JdbcSpatialTable

public abstract class JdbcTable<T extends ResultSet>
extends DefaultResultSet
implements org.orbisgis.data.api.dataset.IJdbcTable<T>, groovy.lang.GroovyObject

Contains the methods which are in common to all the IJdbcTable subclasses. Implements the GroovyObject to simplify the methods calling (i.e. .tableLocation instead of .getTableLocation() ).

Author:

Sylvain Palominos (Lab-STICC UBS 2019 / Chaire GEOTERA 2020)

Field Summary

Fields

Modifier and Type	Field	Description
protected ResultSet	resultSet	Cached resultSet

Fields inherited from interface org.orbisgis.data.api.dataset.IJdbcTable

META_PROPERTY, QUERY_LOCATION

Fields inherited from interface java.sql.ResultSet

CLOSE_CURSORS_AT_COMMIT, CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, HOLD_CURSORS_OVER_COMMIT, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE

Constructor Summary

Constructors

Constructor	Description
JdbcTable(org.h2gis.utilities.dbtypes.DBTypes dataBaseType, org.orbisgis.data.api.datasource.IJdbcDataSource jdbcDataSource, org.h2gis.utilities.TableLocation tableLocation, Statement statement, List<Object> params, String baseQuery)	Main constructor.

Method Summary

Modifier and Type	Method	Description
Object	asType(Class<?> clazz)
org.orbisgis.data.api.dsl.IFilterBuilder	columns(String... columns)
void	eachRow(groovy.lang.Closure<Object> closure)
org.orbisgis.data.api.dsl.IBuilderResult	filter(groovy.lang.GString filter)
org.orbisgis.data.api.dsl.IBuilderResult	filter(String filter)
org.orbisgis.data.api.dsl.IBuilderResult	filter(String filter, List<Object> params)
Map<String,Object>	firstRow()
void	forEach(Consumer<? super T> action)
Object	get(int column)
Object	get(String column)
String	getBaseQuery()	Return the base query for the creation of the ResultSet.
int	getColumnCount()
Collection<String>	getColumnNames()
Map<String,String>	getColumnNamesTypes()
String	getColumnType(String columnName)
org.h2gis.utilities.dbtypes.DBTypes	getDbType()
List<Object>	getFirstRow()
org.orbisgis.data.api.datasource.IJdbcDataSource	getJdbcDataSource()	Return the parent DataSource.
groovy.lang.MetaClass	getMetaClass()
ResultSetMetaData	getMetaData()
List<Object>	getParams()
protected String	getQuery(String... columns)
protected ResultSet	getResultSet()	Return the contained ResultSet.
protected ResultSet	getResultSetLimit(int limit)	Return the ResultSet with a limit.
org.orbisgis.data.api.dsl.IResultSetProperties	getResultSetProperties()
int	getRowCount()
org.orbisgis.data.api.dataset.IJdbcSpatialTable<org.orbisgis.data.api.dataset.IStreamSpatialResultSet>	getSpatialTable()
Statement	getStatement()
JdbcTableSummary	getSummary()
org.orbisgis.data.api.dataset.IJdbcTable<? extends org.orbisgis.data.api.dataset.IStreamResultSet>	getTable()
org.h2gis.utilities.TableLocation	getTableLocation()
Collection<String>	getUniqueValues(String column)
boolean	isEmpty()
boolean	isLinked()
boolean	isSpatial()
boolean	isTemporary()
boolean	reload()
String	save(String filePath, boolean deleteFile)
String	save(String filePath, String encoding)
String	save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource, boolean deleteTable)
String	save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource, boolean deleteTable, int batchSize)
String	save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource, int batchSize)
String	save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource, String outputTableName, boolean deleteTable)
String	save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource, String outputTableName, boolean deleteTable, int batchSize)
void	setMetaClass(groovy.lang.MetaClass metaClass)
void	setResultSetProperties(org.orbisgis.data.api.dsl.IResultSetProperties properties)

Methods inherited from class org.orbisgis.data.jdbc.resultset.DefaultResultSet

absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, close, deleteRow, findColumn, first, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimal, getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getConcurrency, getCursorName, getDate, getDate, getDate, getDate, getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getHoldability, getInt, getInt, getLong, getLong, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getRef, getRef, getRow, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getURL, getURL, getWarnings, insertRow, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, isWrapperFor, last, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, unwrap, updateArray, updateArray, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateClob, updateClob, updateClob, updateClob, updateClob, updateClob, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNString, updateNString, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateRef, updateRef, updateRow, updateRowId, updateRowId, updateShort, updateShort, updateSQLXML, updateSQLXML, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, wasNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface groovy.lang.GroovyObject

getProperty, invokeMethod, setProperty

Methods inherited from interface org.orbisgis.data.api.dsl.IBuilderResult

toString

Methods inherited from interface org.orbisgis.data.api.dataset.IDataSet

toString

Methods inherited from interface org.orbisgis.data.api.dataset.IJdbcTable

getLocation, getName

Methods inherited from interface org.orbisgis.data.api.dataset.ITable

first, getBigDecimal, getBigDecimal, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getDate, getDate, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getNDim, getObject, getObject, getObject, getObject, getRow, getShort, getShort, getSize, getString, getString, getTime, getTime, getTimestamp, getTimestamp, isFirst, isLast, last, next, previous, save, save, stream

Methods inherited from interface java.lang.Iterable

iterator, spliterator

Methods inherited from interface java.sql.ResultSet

absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, close, deleteRow, findColumn, first, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimal, getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getConcurrency, getCursorName, getDate, getDate, getDate, getDate, getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getHoldability, getInt, getInt, getLong, getLong, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getRef, getRef, getRow, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getURL, getURL, getWarnings, insertRow, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, last, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, updateArray, updateArray, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateClob, updateClob, updateClob, updateClob, updateClob, updateClob, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNString, updateNString, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateObject, updateObject, updateObject, updateObject, updateRef, updateRef, updateRow, updateRowId, updateRowId, updateShort, updateShort, updateSQLXML, updateSQLXML, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, wasNull

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Detail

resultSet

protected ResultSet resultSet

Cached resultSet

Constructor Detail

JdbcTable

public JdbcTable(org.h2gis.utilities.dbtypes.DBTypes dataBaseType,
                 org.orbisgis.data.api.datasource.IJdbcDataSource jdbcDataSource,
                 org.h2gis.utilities.TableLocation tableLocation,
                 Statement statement,
                 List<Object> params,
                 String baseQuery)

Main constructor.

Parameters:

dataBaseType - Type of the DataBase where this table comes from.

tableLocation - TableLocation that identify the represented table.

baseQuery - Query for the creation of the ResultSet.

statement - PreparedStatement used to request the database.

params - Map containing the parameters for the query.

jdbcDataSource - DataSource to use for the creation of the resultSet.

Method Detail

getBaseQuery

public String getBaseQuery()

Return the base query for the creation of the ResultSet.

Returns:

The base query.

reload

public boolean reload()
               throws SQLException

Specified by:

reload in interface org.orbisgis.data.api.dataset.IDataSet<T extends ResultSet>

Throws:

SQLException

getResultSet

protected ResultSet getResultSet()
                          throws SQLException

Description copied from class: DefaultResultSet

Return the contained ResultSet.

Specified by:

getResultSet in class DefaultResultSet

Returns:

The table ResultSet.

Throws:

SQLException

getResultSetLimit

protected ResultSet getResultSetLimit(int limit)
                               throws SQLException

Return the ResultSet with a limit.

Parameters:

limit - Limit of the result set.

Returns:

The ResultSet with a limit.

Throws:

SQLException

getMetaData

public ResultSetMetaData getMetaData()
                              throws SQLException

Specified by:

getMetaData in interface org.orbisgis.data.api.dataset.IDataSet<T extends ResultSet>

Specified by:

getMetaData in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

Specified by:

getMetaData in interface ResultSet

Overrides:

getMetaData in class DefaultResultSet

Throws:

SQLException

getJdbcDataSource

public org.orbisgis.data.api.datasource.IJdbcDataSource getJdbcDataSource()

Return the parent DataSource.

Returns:

The parent DataSource.

getTableLocation

public org.h2gis.utilities.TableLocation getTableLocation()

Specified by:

getTableLocation in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

getDbType

public org.h2gis.utilities.dbtypes.DBTypes getDbType()

Specified by:

getDbType in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

isSpatial

public boolean isSpatial()

Specified by:

isSpatial in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

isLinked

public boolean isLinked()

Specified by:

isLinked in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

isTemporary

public boolean isTemporary()

Specified by:

isTemporary in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

getColumnNames

public Collection<String> getColumnNames()
                                  throws Exception

Specified by:

getColumnNames in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

getColumnNamesTypes

public Map<String,String> getColumnNamesTypes()
                                             throws Exception

Specified by:

getColumnNamesTypes in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

getColumnType

public String getColumnType(String columnName)
                     throws SQLException

Specified by:

getColumnType in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

SQLException

getColumnCount

public int getColumnCount()
                   throws SQLException

Specified by:

getColumnCount in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

SQLException

getRowCount

public int getRowCount()
                throws SQLException

Specified by:

getRowCount in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

SQLException

getUniqueValues

public Collection<String> getUniqueValues(String column)
                                   throws Exception

Specified by:

getUniqueValues in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

firstRow

public Map<String,Object> firstRow()
                                  throws Exception

Specified by:

firstRow in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

save

public String save(String filePath,
                   boolean deleteFile)
            throws Exception

Specified by:

save in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

save

public String save(String filePath,
                   String encoding)
            throws Exception

Specified by:

save in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

save

public String save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource,
                   boolean deleteTable)
            throws Exception

Specified by:

save in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

save

public String save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource,
                   String outputTableName,
                   boolean deleteTable)
            throws Exception

Specified by:

save in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

save

public String save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource,
                   int batchSize)
            throws Exception

Specified by:

save in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

save

public String save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource,
                   String outputTableName,
                   boolean deleteTable,
                   int batchSize)
            throws Exception

Specified by:

save in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

save

public String save(org.orbisgis.data.api.datasource.IJdbcDataSource dataSource,
                   boolean deleteTable,
                   int batchSize)
            throws Exception

Specified by:

save in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

getQuery

protected String getQuery(String... columns)

filter

public org.orbisgis.data.api.dsl.IBuilderResult filter(String filter)

Specified by:

filter in interface org.orbisgis.data.api.dsl.IFilterBuilder

filter

public org.orbisgis.data.api.dsl.IBuilderResult filter(groovy.lang.GString filter)

Specified by:

filter in interface org.orbisgis.data.api.dsl.IFilterBuilder

filter

public org.orbisgis.data.api.dsl.IBuilderResult filter(String filter,
                                                       List<Object> params)

Specified by:

filter in interface org.orbisgis.data.api.dsl.IFilterBuilder

columns

public org.orbisgis.data.api.dsl.IFilterBuilder columns(String... columns)

Specified by:

columns in interface org.orbisgis.data.api.dsl.IQueryBuilder

getTable

public org.orbisgis.data.api.dataset.IJdbcTable<? extends org.orbisgis.data.api.dataset.IStreamResultSet> getTable()
                                                                                                            throws Exception

Specified by:

getTable in interface org.orbisgis.data.api.dsl.IBuilderResult

Throws:

Exception

getSpatialTable

public org.orbisgis.data.api.dataset.IJdbcSpatialTable<org.orbisgis.data.api.dataset.IStreamSpatialResultSet> getSpatialTable()
                                                                                                                       throws Exception

Specified by:

getSpatialTable in interface org.orbisgis.data.api.dsl.IBuilderResult

Throws:

Exception

getFirstRow

public List<Object> getFirstRow()
                         throws Exception

Specified by:

getFirstRow in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

getStatement

public Statement getStatement()

Specified by:

getStatement in interface ResultSet

asType

public Object asType(Class<?> clazz)
              throws Exception

Specified by:

asType in interface org.orbisgis.data.api.dsl.IBuilderResult

Specified by:

asType in interface org.orbisgis.data.api.dataset.IDataSet<T extends ResultSet>

Throws:

Exception

getSummary

public JdbcTableSummary getSummary()
                            throws Exception

Specified by:

getSummary in interface org.orbisgis.data.api.dataset.IDataSet<T extends ResultSet>

Specified by:

getSummary in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

Throws:

Exception

getParams

public List<Object> getParams()

Specified by:

getParams in interface org.orbisgis.data.api.dsl.IBuilderResult

Specified by:

getParams in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

setResultSetProperties

public void setResultSetProperties(org.orbisgis.data.api.dsl.IResultSetProperties properties)

Specified by:

setResultSetProperties in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

getResultSetProperties

public org.orbisgis.data.api.dsl.IResultSetProperties getResultSetProperties()

Specified by:

getResultSetProperties in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

eachRow

public void eachRow(groovy.lang.Closure<Object> closure)

Specified by:

eachRow in interface org.orbisgis.data.api.dsl.IBuilderResult

Specified by:

eachRow in interface org.orbisgis.data.api.dataset.IJdbcTable<T extends ResultSet>

Specified by:

eachRow in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

forEach

public void forEach(Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T extends ResultSet>

isEmpty

public boolean isEmpty()
                throws Exception

Specified by:

isEmpty in interface org.orbisgis.data.api.dataset.IDataSet<T extends ResultSet>

Throws:

Exception

get

public Object get(int column)
           throws Exception

Specified by:

get in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception

get

public Object get(String column)
           throws Exception

Specified by:

get in interface org.orbisgis.data.api.dataset.ITable<T extends ResultSet,T extends ResultSet>

Throws:

Exception