Package org.pentaho.reporting.engine.classic.core

Class ExternalDataFactory

java.lang.Object

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

org.pentaho.reporting.engine.classic.core.ExternalDataFactory

All Implemented Interfaces:

Serializable, Cloneable, DataFactory, DataFactoryDesignTimeSupport, DataFactoryMetaProvider

public class ExternalDataFactory
extends AbstractDataFactory

A datafactory that allows to use a tablemodel passed in as a parameter as primary report-datasource.

Author:

Thomas Morgner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.pentaho.reporting.engine.classic.core.AbstractDataFactory

AbstractDataFactory.DataRowWrapper

Field Summary

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

QUERY_LIMIT, QUERY_SORT, QUERY_TIMEOUT

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

DESIGN_TIME

Constructor Summary

Constructors

Constructor	Description
ExternalDataFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the data factory and frees all resources held by this instance.
DataFactory	derive()	Returns a copy of the data factory that is not affected by its anchestor and holds no connection to the anchestor anymore.
String[]	getQueryNames()	Returns all known query-names.
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

calculateQueryLimit, calculateQueryTimeOut, cancelRunningQuery, clone, getConfiguration, getContextKey, getDataFactoryContext, getDisplayConnectionName, getLocale, getMetaData, getQueryHash, getReferencedFields, getResourceBundleFactory, getResourceManager, initialize, queryDesignTimeStructure

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalDataFactory

public ExternalDataFactory()

Method Detail

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.

derive

public DataFactory derive()

Description copied from interface: DataFactory

Returns a copy of the data factory that is not affected by its anchestor and holds no connection to the anchestor anymore. A data-factory will be derived at the beginning of the report processing.

Specified by:

derive in interface DataFactory

Overrides:

derive in class AbstractDataFactory

Returns:

a copy of the data factory.

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.