sapphire.report

Class QCBatchRunFile

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.report.BaseJavaReport

sapphire.report.QCBatchRunFile

All Implemented Interfaces:

com.labvantage.sapphire.report.ReportConstants

public class QCBatchRunFile
extends BaseJavaReport

Java Report class to output list of sampleids from QCBatch.

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
QCBatchRunFile()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLogicalFileName(java.lang.String defaultFileName) Return the logical name of the file.
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.
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
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

Methods inherited from class sapphire.report.BaseJavaReport

adjustPrintOptions, canPrint, getClassLoader, getMimeType, sendToPrinter, setClassLoader

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

QCBatchRunFile

public QCBatchRunFile()

Method Detail

init

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

Description copied from class: BaseJavaReport

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

Specified by:

init in class BaseJavaReport

getLogicalFileName

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

Description copied from class: BaseJavaReport

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

Specified by:

getLogicalFileName in class BaseJavaReport

Returns:

getReportParameters

public java.lang.String[] getReportParameters()

Overrides:

getReportParameters in class BaseJavaReport

runReport

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

Description copied from class: BaseJavaReport

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

Specified by:

runReport in class BaseJavaReport

Throws:

SapphireException

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)

Description copied from class: BaseJavaReport

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

Overrides:

getXSSFWorkBookFromDataSet in class BaseJavaReport

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: