org.pentaho.reporting.engine.classic.core.modules.misc.datafactory.sequence

Class SequenceDataFactory

java.lang.Object

org.pentaho.reporting.engine.classic.core.AbstractDataFactory

org.pentaho.reporting.engine.classic.core.modules.misc.datafactory.sequence.SequenceDataFactory

All Implemented Interfaces:

Serializable, Cloneable, DataFactory, DataFactoryDesignTimeSupport, DataFactoryMetaProvider

public class SequenceDataFactory
extends AbstractDataFactory

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.pentaho.reporting.engine.classic.core.DataFactoryDesignTimeSupport

DESIGN_TIME

Fields inherited from interface org.pentaho.reporting.engine.classic.core.DataFactory

QUERY_LIMIT, QUERY_SORT, QUERY_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
SequenceDataFactory()

Method Summary

Modifier and Type	Method and Description
void	addSequence(String query, Sequence sequence)
SequenceDataFactory	clone()
void	close() Closes the data factory and frees all resources held by this instance.
String[]	getQueryNames() Returns all known query-names.
Sequence	getSequence(String name)
boolean	isQueryExecutable(String query, DataRow parameters) Checks whether the query would be executable by this datafactory.
TableModel	queryData(String query, DataRow parameters) Queries a datasource.

Methods inherited from class org.pentaho.reporting.engine.classic.core.AbstractDataFactory

cancelRunningQuery, derive, getConfiguration, getContextKey, getDataFactoryContext, getDisplayConnectionName, getLocale, getMetaData, getQueryHash, getReferencedFields, getResourceBundleFactory, getResourceManager, initialize, queryDesignTimeStructure

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceDataFactory

public SequenceDataFactory()

Method Detail

addSequence

public void addSequence(String query,
                        Sequence sequence)

queryData

public TableModel queryData(String query,
                            DataRow parameters)
                     throws ReportDataFactoryException

Description copied from interface: DataFactory

Queries a datasource. The string 'query' defines the name of the query. The Parameterset given here may contain more data than actually needed for the query.

The parameter-dataset may change between two calls, do not assume anything, and do not hold references to the parameter-dataset or the position of the columns in the dataset.

Parameters:

query - the query string, never null.

parameters - the parameters for the query, never null.

Returns:

the result of the query as table model.

Throws:

ReportDataFactoryException - if an error occured while performing the query.

close

public void close()

Description copied from interface: DataFactory

Closes the data factory and frees all resources held by this instance.

isQueryExecutable

public boolean isQueryExecutable(String query,
                                 DataRow parameters)

Description copied from interface: DataFactory

Checks whether the query would be executable by this datafactory. This performs a rough check, not a full query.

Parameters:

query - the query, never null.

parameters - the parameters, never null.

Returns:

true, if the query would be executable, false if the query is not recognized.

getQueryNames

public String[] getQueryNames()

Description copied from interface: DataFactory

Returns all known query-names. A data-factory may accept more than the query-names returned here.

Returns:

the known query names.

clone

public SequenceDataFactory clone()

Specified by:

clone in interface DataFactory

Overrides:

clone in class AbstractDataFactory

getSequence

public Sequence getSequence(String name)