net.sf.reportengine.in

Class SqlConnectionTableInput

java.lang.Object

net.sf.reportengine.in.AbstractTableInput

net.sf.reportengine.in.SqlConnectionTableInput

All Implemented Interfaces:

ColumnMetadataHolder, TableInput

public class SqlConnectionTableInput
extends AbstractTableInput
implements ColumnMetadataHolder

Field Summary

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

DEFAULT_COLUMN_HEADER

Constructor Summary

Constructors

Constructor and Description
SqlConnectionTableInput(Connection conn, String sqlStatement) Builds the sql input based on the provided connection which will be managed (closed) externally.
SqlConnectionTableInput(Connection conn, String sqlStatement, boolean closeConnectionWhenDone) Builds the sql input based on the provided connection which will be managed (closed) according to the managedConnection flag.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the input, releases the resources and signals that the reading session is done.
List<ColumnMetadata>	getColumnMetadata() getter for columns metadata (column label/header, horizontal alignment, etc.)
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

SqlConnectionTableInput

public SqlConnectionTableInput(Connection conn,
                               String sqlStatement)

Builds the sql input based on the provided connection which will be managed (closed) externally. If you want to control the lifecycle of the connection you should use the other constructor. Besides the connection you have to provide a query statement using setSqlStatement(String)

Parameters:

conn - the connection provided

SqlConnectionTableInput

public SqlConnectionTableInput(Connection conn,
                               String sqlStatement,
                               boolean closeConnectionWhenDone)

Builds the sql input based on the provided connection which will be managed (closed) according to the managedConnection flag. Besides the connection you have to provide a query statement using setSqlStatement(String)

Parameters:

conn - the connection provided

sqlStatement - the sql statement

managedConnection - if true the connection will be managed (close) by this class

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, releases the resources and signals that the reading session is 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

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