| it.businesslogic.ireport.FieldsProvider
All known Subclasses: it.businesslogic.ireport.data.HQLFieldsProvider, it.businesslogic.ireport.data.XMLFieldsProvider, it.businesslogic.ireport.data.MDXFieldsProvider, it.businesslogic.ireport.data.EJBQLFieldsProvider, it.businesslogic.ireport.data.SQLFieldsProvider, it.businesslogic.ireport.examples.queryexecuter.CSVFieldsProvider,
FieldsProvider | public interface FieldsProvider (Code) | | author: gtoffoli |
designQuery | public String designQuery(IReportConnection con, String query, ReportQueryDialog reportQueryDialog) throws JRException, UnsupportedOperationException(Code) | | This method is used to run a query designer for the specific language.
Parameters: con - the IReportConnection active in iReport. Parameters: query - the query to modify Parameters: reportQueryDialog - the parent reportQueryDialog. It can be used to get all (sub)dataset informationswith reportQueryDialog.getSubDataset(); |
getEditorComponent | public FieldsProviderEditor getEditorComponent(ReportQueryDialog reportQueryDialog)(Code) | | The component that will stay on the right of the query panel. To listen for query changes, the component must implement
the interface FieldsProviderEditor. The component will be visible only when a queryCahnged is succesfully executed.
The component can store the reference to the report query dialog in which it will appear.
The editor can
|
getFields | public JRField[] getFields(IReportConnection con, JRDataset reportDataset, Map parameters) throws JRException, UnsupportedOperationException(Code) | | Returns the fields that are available from a query of a specific language
The provider can use the passed in report to extract some additional
configuration information such as report properties.
The IReportConnection object can be used to execute the query.
Parameters: con - the IReportConnection active in iReport. Parameters: the - JRDataset that will be filled using the data source created by this provider.The passed in report can be null. That means that no compiled report is available yet. Parameters: parameters - map containing the interpreted default value of each parameter a non null fields array. If there are no fields then an empty array must be returned. throws: UnsupportedOperationException - is the method is not supported throws: JRException - if an error occurs. |
hasEditorComponent | public boolean hasEditorComponent()(Code) | | Returns true if the FieldsProvider can run an own editor
|
hasQueryDesigner | public boolean hasQueryDesigner()(Code) | | Returns true if the FieldsProvider can run an own query designer
|
supportsAutomaticQueryExecution | public boolean supportsAutomaticQueryExecution()(Code) | | Returns true if the getFields can be run in a backgroiund thread each time the user changes the query.
This approach can not be valid for fieldsProviders that require much time to return the list of fields.
|
supportsGetFieldsOperation | public boolean supportsGetFieldsOperation()(Code) | | Returns true if the provider supports the
FieldsProvider.getFields(IReportConnection,JRDataset,Map) getFields
operation. By returning true in this method the data source provider indicates
that it is able to introspect the data source and discover the available fields.
true if the getFields() operation is supported. |
|
|