sapphire.report

Class BaseJavaReport

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.report.BaseJavaReport

All Implemented Interfaces:

com.labvantage.sapphire.report.ReportConstants

Direct Known Subclasses:

QCBatchRunFile

public abstract class BaseJavaReport
extends com.labvantage.sapphire.BaseCustom
implements com.labvantage.sapphire.report.ReportConstants

This is the ancestor class for all Java-based reports. These classes should be registered against a corresponding report sdi The following is an OOB Java report class that accepts a 'keyid1' QCBatchId and generates an excel file with each of the samples from QCBatcItems. public class QCBatchRunFile extends BaseJavaReport { private HashMap paramsMap; public void init( String reportid, String reportVersionid, HashMap paramsMap, ConnectionInfo connectionInfo ) { // Remember the params. We will need this later this.paramsMap = paramsMap; } public String getLogicalFileName( String defaultFileName ) { // This file always returns a .xslx file - but will allow an alternative filename to be provided return defaultFileName.endsWith( ".xlsx" ) ? defaultFileName : "sequence.xlsx"; } public String[] getReportParameters() { return new String[] { "keyid1" }; } public void runReport( OutputStream outputStream ) throws SapphireException { // Load the sampleids from qcbatchitem String qcbatchid = (String)paramsMap.get( "keyid1" ); SafeSQL safeSQL = new SafeSQL(); DataSet ds = getQueryProcessor().getPreparedSqlDataSet( "select distinct keyid1 from sdidata where s_qcbatchid=" + safeSQL.addVar( qcbatchid ), safeSQL.getValues() ); // Use the utility method to create a poi workbook String[] titles = { "QCBatch Samples" }; String[] columnids = { "keyid1" }; XSSFWorkbook workbook = getXSSFWorkBookFromDataSet( "Sequence File", ds, Arrays.asList( titles ), Arrays.asList( columnids ), true ); // Use the poi API to stream the report back try { ByteArrayOutputStream outByteStream = new ByteArrayOutputStream(); workbook.write( outByteStream ); byte[] outArray = outByteStream.toByteArray(); outByteStream.close(); outputStream.write( outArray ); } catch ( IOException e ) { throw new SapphireException( "Unable to stream the report back" ); } } }

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseCustom

FAILURE, logger, logName, SUCCESS

Fields inherited from interface com.labvantage.sapphire.report.ReportConstants

DISPLAY_TYPE_CSV, DISPLAY_TYPE_DOC, DISPLAY_TYPE_DOCX, DISPLAY_TYPE_HTML, DISPLAY_TYPE_PDF, DISPLAY_TYPE_RTF, DISPLAY_TYPE_XLS, DISPLAY_TYPE_XLSX, REPORTTYPE_BO, REPORTTYPE_EMBEDDEDJASPER, REPORTTYPE_JASPER, REPORTTYPE_JAVA, REPORTTYPE_NWA, REPORTTYPE_TALEND

Constructor Summary

Constructors

Constructor and Description
BaseJavaReport()

Method Summary

Modifier and Type	Method and Description
void	adjustPrintOptions(PrintReportOptions options) Prior to sending the output file to a printer, you can override this method to adjust the print options if needed.
boolean	canPrint()
protected java.lang.ClassLoader	getClassLoader()
abstract java.lang.String	getLogicalFileName(java.lang.String defaultFileName) Return the logical name of the file.
java.lang.String	getMimeType(java.lang.String filename) LabVantage will try to assign a mimi-type for known filetypes.
java.lang.String[]	getReportParameters()
protected XSSFWorkbook	getXSSFWorkBookFromDataSet(java.lang.String sheetTitle, DataSet ds, java.util.List<java.lang.String> titles, java.util.List<java.lang.String> columnIds, boolean autoSizeColumns) Utility function to quickly create a POI workbook from a DataSet.
abstract void	init(java.lang.String reportid, java.lang.String reportVersionid, java.util.HashMap paramsMap, ConnectionInfo connectionInfo) In this oiverride you can retain this information needed downstream, such as the report parameters
abstract void	runReport(java.io.OutputStream outputStream) Send the contents of the report to this output stream to be sent to a browser or to a file
void	sendToPrinter(java.lang.String printerName, java.io.File file, PrintReportOptions options) LabVantage knows how to print various file types, include excel, word, pdf, text and images.
void	setClassLoader(java.lang.ClassLoader classLoader)

Methods inherited from class com.labvantage.sapphire.BaseCustom

getAccessorErrorIds, getAccessorErrorMsgs, getActionProcessor, getConfigurationProcessor, getConnectionid, getConnectionId, getConnectionProcessor, getDAMProcessor, getDepartmentList, getHttpProcessor, getQueryProcessor, getRakFile, getSDCProcessor, getSDIProcessor, getSequenceProcessor, getTranslationProcessor, setConnectionId, setLanguage, setRakFile

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseJavaReport

public BaseJavaReport()

Method Detail

getReportParameters

public java.lang.String[] getReportParameters()

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

getClassLoader

protected java.lang.ClassLoader getClassLoader()

init

public abstract void init(java.lang.String reportid,
                          java.lang.String reportVersionid,
                          java.util.HashMap paramsMap,
                          ConnectionInfo connectionInfo)
                   throws SapphireException

In this oiverride you can retain this information needed downstream, such as the report parameters

Parameters:

reportid -

reportVersionid -

paramsMap -

connectionInfo -

Throws:

SapphireException

getLogicalFileName

public abstract java.lang.String getLogicalFileName(java.lang.String defaultFileName)

Return the logical name of the file. This will be used when attaching to an email, downloading in a browser or when generating a temporary file

Parameters:

defaultFileName -

Returns:

runReport

public abstract void runReport(java.io.OutputStream outputStream)
                        throws SapphireException

Send the contents of the report to this output stream to be sent to a browser or to a file

Parameters:

outputStream -

Throws:

SapphireException

getMimeType

public java.lang.String getMimeType(java.lang.String filename)

LabVantage will try to assign a mimi-type for known filetypes. This method can be overridden if required to provide an alternative

Parameters:

filename -

Returns:

adjustPrintOptions

public void adjustPrintOptions(PrintReportOptions options)

Prior to sending the output file to a printer, you can override this method to adjust the print options if needed.

Parameters:

options -

sendToPrinter

public void sendToPrinter(java.lang.String printerName,
                          java.io.File file,
                          PrintReportOptions options)

LabVantage knows how to print various file types, include excel, word, pdf, text and images. If custom print handling is required then set the options.PrintOption mode to PrintReportOptions.PRINTMODE_CUSTOM and override this method

Parameters:

printerName -

file -

options -

getXSSFWorkBookFromDataSet

protected XSSFWorkbook getXSSFWorkBookFromDataSet(java.lang.String sheetTitle,
                                                  DataSet ds,
                                                  java.util.List<java.lang.String> titles,
                                                  java.util.List<java.lang.String> columnIds,
                                                  boolean autoSizeColumns)

Utility function to quickly create a POI workbook from a DataSet.

Parameters:

sheetTitle - Name of the sheet

ds - Dataset to be transformed

titles - Optional list of titles to each column to be displayed in the first row. If provided, the number of titles must match the nubmer of columns to export. Note that any column in the dataset prefixed with "_" will be ignored.

columnIds - Optional list of columns to export. Note that any column in the dataset prefixed with "_" will be ignored

autoSizeColumns - After the data has been loaded, this option allows the width of the spreadsheet columns to be auto-sized

Returns:

canPrint

public boolean canPrint()