|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataFactory
Creates a tablemodel on request. If the returned tablemodel is a CloseableTableModel
the tablemodel must remain open until the DataFactory remains open. The TableModel should not be disposed until the
data-factory has been closed.
Field Summary | |
---|---|
static String |
QUERY_LIMIT
An internal query parameter that holds the maximum number of rows a query should return. |
static String |
QUERY_TIMEOUT
An internal query parameter that holds the query timeout value. |
Method Summary | |
---|---|
void |
cancelRunningQuery()
Attempts to cancel the query process that is generating the data for this data factory. |
Object |
clone()
|
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. |
void |
initialize(org.pentaho.reporting.libraries.base.config.Configuration configuration,
org.pentaho.reporting.libraries.resourceloader.ResourceManager resourceManager,
org.pentaho.reporting.libraries.resourceloader.ResourceKey contextKey,
ResourceBundleFactory resourceBundleFactory)
Initializes the data factory and provides new context information. |
boolean |
isQueryExecutable(String query,
DataRow parameters)
Checks whether the query would be executable by this datafactory. |
void |
open()
Deprecated. Write your datafactories so that connections are opened on their first use. This method will go away in the next major release. |
TableModel |
queryData(String query,
DataRow parameters)
Queries a datasource. |
Field Detail |
---|
static final String QUERY_LIMIT
static final String QUERY_TIMEOUT
Method Detail |
---|
void initialize(org.pentaho.reporting.libraries.base.config.Configuration configuration, org.pentaho.reporting.libraries.resourceloader.ResourceManager resourceManager, org.pentaho.reporting.libraries.resourceloader.ResourceKey contextKey, ResourceBundleFactory resourceBundleFactory) throws ReportDataFactoryException
configuration
- the current report configuration.resourceManager
- the report's resource manager.contextKey
- the report's context key to access resources relative to the report location.resourceBundleFactory
- the report's resource-bundle factory to access localization information.
ReportDataFactoryException
TableModel queryData(String query, DataRow parameters) throws ReportDataFactoryException
query
- the query string, never null.parameters
- the parameters for the query, never null.
ReportDataFactoryException
- if an error occured while performing the query.DataFactory derive()
void open() throws ReportDataFactoryException
ReportDataFactoryException
- if an error occured while opening the datafactory resources.void close()
boolean isQueryExecutable(String query, DataRow parameters)
query
- the query, never null.parameters
- the parameters, never null.
String[] getQueryNames()
void cancelRunningQuery()
Object clone()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |