net.sf.reportengine.in

Class SqlTableInput

java.lang.Object

net.sf.reportengine.in.AbstractTableInput

net.sf.reportengine.in.SqlTableInput

All Implemented Interfaces:

ColumnMetadataHolder, TableInput

public class SqlTableInput
extends AbstractTableInput
implements ColumnMetadataHolder

Report Input implementation for database queries
There are two ways of setting up this data provider :
Use case 1: providing database url, driver class , user and password
Use case 2: providing a connection

Since:

0.2

Author:

dragos balan (dragos dot balan at gmail dot com)

Field Summary

Fields inherited from class net.sf.reportengine.in.AbstractTableInput

DEFAULT_COLUMN_HEADER

Constructor Summary

Constructors

Constructor and Description
SqlTableInput(String dbConnString, String driverClass, String dbUser, String dbPassword, String sqlStatement) this is the preferred way to construct this provider

Method Summary

Modifier and Type	Method and Description
void	close() Closes the input meaning : "the reading session it's done !"
List<ColumnMetadata>	getColumnMetadata() getter for columns metadata (column label/header, horizontal alignment, etc.)
String	getDbConnString()
String	getDbDriverClass()
String	getDbPassword()
String	getDbUser()
String	getSqlStatement()
boolean	hasAllResourcesClosed() debug method which returns true if all sql resources have been released
boolean	hasMoreRows() returns true if there are more rows to read
List<Object>	nextRow() returns the next row
void	open() opens the Input in order to start reading from it

Methods inherited from class net.sf.reportengine.in.AbstractTableInput

getStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlTableInput

public SqlTableInput(String dbConnString,
                     String driverClass,
                     String dbUser,
                     String dbPassword,
                     String sqlStatement)

this is the preferred way to construct this provider

Parameters:

dbConnString - the database connection string

driverClass - the driver fully qualified class name

dbUser - the database user

dbPassword - database password

Method Detail

open

public void open()

opens the Input in order to start reading from it

Specified by:

open in interface TableInput

Overrides:

open in class AbstractTableInput

close

public void close()

Closes the input meaning : "the reading session it's done !"

Specified by:

close in interface TableInput

Overrides:

close in class AbstractTableInput

nextRow

public List<Object> nextRow()

returns the next row

Specified by:

nextRow in interface TableInput

Returns:

an array of data objects

hasMoreRows

public boolean hasMoreRows()

returns true if there are more rows to read

Specified by:

hasMoreRows in interface TableInput

Returns:

true if the input has more rows to return

getDbConnString

public String getDbConnString()

Returns:

Returns the dbConnString.

getDbDriverClass

public String getDbDriverClass()

Returns:

Returns the dbDriverClass.

getDbPassword

public String getDbPassword()

Returns:

Returns the dbPassword.

getDbUser

public String getDbUser()

Returns:

Returns the dbUser.

getSqlStatement

public String getSqlStatement()

Returns:

Returns the sqlStatement.

getColumnMetadata

public List<ColumnMetadata> getColumnMetadata()

Description copied from interface: ColumnMetadataHolder

getter for columns metadata (column label/header, horizontal alignment, etc.)

This is an optional method. If your input doesn't contain any meta data then return an empty array.

Specified by:

getColumnMetadata in interface ColumnMetadataHolder

Returns:

the column meta data if this input supports metadata otherwise an empty array

hasAllResourcesClosed

public boolean hasAllResourcesClosed()
                              throws SQLException

debug method which returns true if all sql resources have been released

Returns:

true if all resources have been closed

Throws:

SQLException