|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Interface (Role) for a Factory class that can generate a Report. The resulting report should be able to be stored in a file and the file name returned to the caller. This filename can then be passed to a UI in order to display the finished report. Alternately, the report can be returned as an encoded String, ready to pass on the client UI for rendering.
| Field Summary | |
static java.lang.String |
ROLE |
| Method Summary | |
java.lang.String |
getReportEncoded(java.lang.String fileType)Prepare the report and return it as a base64 encoded string, suitable for serialization via JMS (or anything else) to a client, saving in a database, etc. |
java.util.Set |
getSupportedFileTypes()Return a set of strings, where each string represents the file-type extension of a type of file supported by this implementation. |
java.util.Set |
getSupportedOptions()Once the report type is set, getSupportedOptions can be called to determine what options (if any) this type of report supports with this implementation. |
void |
saveReport(java.lang.String fileName, java.lang.String fileType)Produce the report and save it as the specified file. |
void |
setData(ReportData theData)Pass the data from which the chart is produced. |
void |
setOption(java.lang.String optionName, java.lang.Object option)Set a specific report-specific or implementation-specific option. |
void |
setReportFormat(java.lang.String fileName)Specify the report format file, the file that (for this implementation) lays out what a report should look like. |
| Field Detail |
public static final java.lang.String ROLE
| Method Detail |
public java.util.Set getSupportedFileTypes()
public void setReportFormat(java.lang.String fileName)
throws ReportException
fileName - A full pathname to a report template file. The format of this file depends on the implementation.ReportException - If the file cannot be used for some reason or is not in the correct format for this implementationpublic java.util.Set getSupportedOptions()
public void setOption(java.lang.String optionName,
java.lang.Object option)
throws ReportException
optionName - The name of the implementation-specific optionoption - The value to set the option toReportException
public void setData(ReportData theData)
throws ReportException
theData - A ReportData object containing the report data to be reported on.ReportException
public void saveReport(java.lang.String fileName,
java.lang.String fileType)
throws ReportException
fileName - Name of the file in which to save the reportfileType - Valid file type (supported by this implementation)ReportException
public java.lang.String getReportEncoded(java.lang.String fileType)
throws ReportException
fileType - The type of the file encoding to be used, represented as a file extensionReportException - If the report cannot be produced or an error occurrs in the implementation.
|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||