|
| |
|
| com.jcorporate.expresso.ext.report.ExpressoReport
All known Subclasses: com.jcorporate.expresso.services.html.ReportPage,
| ExpressoReport | | public interface ExpressoReport (Code) | | ExpressoReport is a generic interface for allowing reports to be "printed"
An example usage of an ExpressoReport is the ReportPage object as defined in
com.jcorporate.expresso.services.html.ReportPage. Although the
interfaces provide independence, and thus you can integrate whatever report
engine you wish, eContent has built in integration with
For those that are interested in making their own reports and a report
driver the general idea is this:
- Instantiate the report class via Class.newInstance() [The report must have
a default constructor]
- Set the report parameters
- Set the report's data context
- Prepare an output stream for the report to dump it's data. [Can be
the servlet output stream for all the report cares]
- Call printReport()
author:
Michael Rimov |
| getDefaultValue | | public String getDefaultValue(String parameterName)(Code) | | Retrieve the default parameter value for the given parameter name
Parameters:
parameterName - the name of the parameter. Must be listedin the list of parameter names java.lang.String. The default parameter value. May be null.
throws:
IllegalArgumentException - if the parameter name does not existin the report's parameter list. |
| getParameterNames | | public List getParameterNames()(Code) | | Retrieve a list of parameters that this report supports. This function
may be blank, in which case, there still could be parameters for the report
but the automatic ui functions such as ReportServer won't
present them as options.
java.util.List of Strings. or null if there are no parameters |
| getReportFileExtension | | public String getReportFileExtension()(Code) | | Retrieve the recommended file extension for the report. Return the
value without the '.'. So an example file extension for an Excel
report would be "xls", and XML formatted report would be
"xml" [although if you're using special XML languages, of course
you have the freedom to specify the extension]
java.lang.String in the format specified above. |
| getReportMimeType | | public String getReportMimeType()(Code) | | The report engine driver is most likely going to need to know what kind
of MimeType to expect the report.
java.lang.String Most likely the report should look up the filetype on the MimeTypes table.
See Also: com.jcorporate.expresso.services.dbobj.MimeTypes |
| getTitle | | public String getTitle()(Code) | | Retrieve the title of the report
java.lang.String |
| printReport | | public void printReport(OutputStream os) throws ReportException, java.io.IOException(Code) | | All report objects need to implement the printReport method so that the
framework can manage the report output.
Parameters:
os - The OutputStream for the report to print to.
throws:
ReportException - on error
throws:
IOException - upon IO Error |
| setDataContext | | public void setDataContext(String newDataContext)(Code) | | Sets the data context that the report is to work with.
Parameters:
newDataContext - the new data context |
| setReportCode | | public void setReportCode(String newReportcode)(Code) | | This is the unique identifier for the report. Not necessarily the
Parameters:
newReportcode - the report definition code |
| setReportParameters | | public void setReportParameters(Map parameters)(Code) | | Sets the report parameters. Parameters are keyed by String parameter
names and the values are of type java.lang.String
Parameters:
parameters - a java.util.Map object with the contents as specifiedin the function description. |
|
|
|