net.datenwerke.rs.base.service.datasources.table.impl

Interface TableDataSource

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

TableDBDataSource

public interface TableDataSource
extends java.io.Closeable

Provides an interface for a table based data source.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalColumnSpecs(java.util.List<AdditionalColumnSpec> additionalColumns)
void	addQueryComment(java.lang.String comment)
void	applyColumnConfiguration(java.util.List<Column> columnList)
void	applyConfig(TableDatasourceConfig config)
void	applyParameters(ParameterSet paramterSet)
void	cancelStatement()
void	close()
void	countRows() Sets a flag that tells the datasource to not execute the report as it is, but to only count the rows.
void	distinct(boolean enableDistinct)
DatasourceContainerProvider	getDatasourceContainerProvider()
java.lang.Object	getFieldValue(int pos) If DataSource is not "open" open will be called and cursor will be moved to first "row"
ParameterSet	getParameters()
TableDefinition	getPlainTableDefinition()
TableDefinition	getTableDefinition() If DataSource is not "open" open will be called
boolean	isOpen()
void	limit(int number)
boolean	next() If DataSource is not "open" open will be called
void	open()
void	open(java.lang.String executorToken)
void	paged(int offset, int length)
void	setIgnoreAnyColumnConfiguration(boolean b)
void	setPreFilter(FilterBlock rootBlock)

Method Detail

countRows

void countRows()

Sets a flag that tells the datasource to not execute the report as it is, but to only count the rows.

getDatasourceContainerProvider

DatasourceContainerProvider getDatasourceContainerProvider()

applyParameters

void applyParameters(ParameterSet paramterSet)

applyColumnConfiguration

void applyColumnConfiguration(java.util.List<Column> columnList)

limit

void limit(int number)

distinct

void distinct(boolean enableDistinct)

paged

void paged(int offset,
           int length)

next

boolean next()
      throws ReportExecutorException

If DataSource is not "open" open will be called

Throws:

ReportExecutorException

getFieldValue

java.lang.Object getFieldValue(int pos)
                        throws ReportExecutorException

If DataSource is not "open" open will be called and cursor will be moved to first "row"

Throws:

ReportExecutorException

getTableDefinition

TableDefinition getTableDefinition()
                            throws ReportExecutorException

If DataSource is not "open" open will be called

Throws:

ReportExecutorException

getPlainTableDefinition

TableDefinition getPlainTableDefinition()

open

void open()
   throws ReportExecutorException

Throws:

ReportExecutorException

open

void open(java.lang.String executorToken)
   throws ReportExecutorException

Throws:

ReportExecutorException

isOpen

boolean isOpen()

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

setPreFilter

void setPreFilter(FilterBlock rootBlock)

addAdditionalColumnSpecs

void addAdditionalColumnSpecs(java.util.List<AdditionalColumnSpec> additionalColumns)

setIgnoreAnyColumnConfiguration

void setIgnoreAnyColumnConfiguration(boolean b)

getParameters

ParameterSet getParameters()

applyConfig

void applyConfig(TableDatasourceConfig config)

cancelStatement

void cancelStatement()

addQueryComment

void addQueryComment(java.lang.String comment)