Package fr.opensagres.xdocreport.document.sql

Class SQLDataProvider

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

fr.opensagres.xdocreport.document.sql.SQLDataProvider

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public abstract class SQLDataProvider
extends HashMap<String,Object>

XDocReport support for SQL ResultSet. The implementation of this class

• transform a ResultSet to Map which can be used instead of IContext.
• update the FieldsMetadata with simple and list field from the ResultSet.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
SQLDataProvider(ResultSet rs, fr.opensagres.xdocreport.template.formatter.FieldsMetadata metadata)	SQL Data provider constructor.

Method Summary

Modifier and Type	Method	Description
protected int	getColumnCount(ResultSet rs)	Returns the column count.
protected String	getColumnLabel(ResultSet rs, int column)	Returns the column label name of the given column of the given ResultSet.
protected abstract String	getListName(String tableName, String columnName)	Returns true if the given column of the given table is a field list and false otherwise.
protected String	getTableName(ResultSet rs, int column)	Returns the table name of the given column of the given ResultSet.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

SQLDataProvider

public SQLDataProvider(ResultSet rs,
 fr.opensagres.xdocreport.template.formatter.FieldsMetadata metadata)
                throws SQLException

SQL Data provider constructor.

Parameters:

rs - the SQL ResultSet

metadata - the FieldsMetadata.

Throws:

SQLException

Method Details

getColumnCount

protected int getColumnCount(ResultSet rs)
                      throws SQLException

Returns the column count. Override this method if your JDBC driver cannot support that.

Parameters:

rs -

Returns:

Throws:

SQLException

getTableName

protected String getTableName(ResultSet rs,
 int column)
                       throws SQLException

Returns the table name of the given column of the given ResultSet. Override this method if your JDBC driver cannot support that.

Parameters:

rs -

column -

Returns:

Throws:

SQLException

getColumnLabel

protected String getColumnLabel(ResultSet rs,
 int column)
                         throws SQLException

Returns the column label name of the given column of the given ResultSet. Override this method if your JDBC driver cannot support that.

Parameters:

rs -

column -

Returns:

Throws:

SQLException

getListName

protected abstract String getListName(String tableName,
 String columnName)

Returns true if the given column of the given table is a field list and false otherwise.

Parameters:

tableName -

columnName -

Returns: