quadbase.reportdesigner.ReportAPI

Class DrillDownReport

java.lang.Object

quadbase.reportdesigner.ReportAPI.QbReport

quadbase.reportdesigner.ReportAPI.DrillDownReport

All Implemented Interfaces:

quadbase.common.util.IAlertable, IExportConstants, IReport, quadbase.reportdesigner.util.IReportPropertiesConstants, IReportTypeConstants

public class DrillDownReport
extends QbReport

This class extends QbReport. It represents a drill-down report which is identical to a QbReport except a few disabled methods.

This class cannot be instantiated directly. A reference to this class can only be obtained through the QbReport methods 'createDrillDownReport(...)' and 'getDrillDownReportAt(...)'

A drill-down report cannot be exported to any format itself. An RPT file of the drill-down is automatically generated (under the DrillDown directory) when the root report is exported to RPT.

Field Summary

Fields inherited from class quadbase.reportdesigner.ReportAPI.QbReport

BOLD, BOLDITALIC, CLASSFILE, CLASSFILESOURCE, DATABASESOURCE, DATAFILE, DATAFILESOURCE, EJBSOURCE, EXCELSOURCE, ITALIC, LANDSCAPE, MEMORYDATASOURCE, MULTIPLEDATASOURCES, OLAPRESULTSET, PLAIN, PORTRAIT, QUADBASEXMLFILESOURCE, QUERYFILE, report, SALESFORCESOURCE, SOAPDATASOURCE, subReports, XMLFILE, XMLFILEQUERYSOURCE

Fields inherited from interface quadbase.reportdesigner.util.IReportTypeConstants

COLUMNAR, CROSSTAB, MAILINGLABELS, MASTERDETAILS, REPORTTYPENAME, SUMMARY, TOTALTYPE

Fields inherited from interface quadbase.reportdesigner.util.IExportConstants

AllowAll, AllowAssembly, AllowCopy, AllowDegradedPrinting, AllowFillIn, AllowModifyAnnotations, AllowModifyContents, AllowPrinting, AllowScreenReaders, BARCODE, CENTER, CSV, DHTML, DHTMLHEADER, EXCEL, EXCEL_OOXML, EXPORTTYPE, FLASH, GIF, HORIZONTAL, HTML, JPEG, LEFT, PAK, PAK_DATA, PDF, PNG, RIGHT, RPT, RPT_DATA, RTF, STL, SVG, TXT, VERTICAL, VIEW, XML_DATA_AND_FORMAT, XML_PURE_DATA, XML_TEMPLATE

Fields inherited from interface quadbase.reportdesigner.util.IReportPropertiesConstants

PROPS_CROSSTAB_COLUMN_BREAK_VALUE_ALIGNED_HORIZONTALLY, PROPS_CROSSTAB_FORMULA_IN_HEADER, PROPS_CROSSTAB_FREE_FORM, PROPS_CROSSTAB_SUBTOTAL_COLUMN_POSITION_LEFT, PROPS_DATA_SORTED, PROPS_ENTERPRISE_SERVER, PROPS_GENERATE_CROSSTAB_FORMULAS, PROPS_GENERATE_CROSSTAB_GRANDTOTAL_COLUMN, PROPS_GENERATE_CROSSTAB_SUBTOTAL_COLUMN, PROPS_LIMIT_EXCEL_CELL_SPLIT, PROPS_MULTIPAGE_EXPORT, PROPS_OPTIMIZE_MEMORY, PROPS_PROMPT_PARAMETER, PROPS_RELATIVE_DOMAIN_PATH, PROPS_REPORT_STYLE, PROPS_SECURITY_LEVEL, PROPS_SIDE_BY_SIDE_LAYOUT, PROPS_TRANSPOSE, PROPS_TRANSPOSED_COLUMN, PROPS_USE_BACKUP_DATA

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DrillDownReport() For internal use only.
protected	DrillDownReport(quadbase.reportdesigner.report.Report r) For internal use only.

Method Summary

Modifier and Type	Method and Description
void	export(int format, java.io.OutputStream out) Exports this QbReport object in the specified format into the specified output stream
void	export(int format, java.lang.String fileName) Export is not supported for drill-down reports.
byte[]	exportReportToByteArray() Export is not supported for drill-down reports.
java.lang.String	exportReportToString() Export is not supported for drill-down reports.

Methods inherited from class quadbase.reportdesigner.ReportAPI.QbReport

addFormula, addScript, applyChartPathToAllCharts, applyTemplate, applyTemplate, applyTemplate, applyTemplate, autoFitColumns, cleanExportedFiles, cleanup, clearReportParameterValues, clearSubReportCache, createCrossTabDrillDownReport, createDrillDownReport, createDrillDownReport, createDrillDownReport, createDrillDownReport, createQbReport, createReport, createReport, createReport, createReport, createReport, createTopNReport, deleteViewFile, draw, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, finalize, getAllAlertIds, getAllAvailPrinters, getAllParameters, getAllParameters, getApplet, getBackgroundColor, getBackgroundImage, getBooleanNULLDataValue, getBottomMargin, getChartPath, getCustomDefinedFunctions, getData, getDataSourceType, getDateTimeNULLDataValue, getDescription, getDHTMLHeader, getDHTMLTopMargin, getDrillDownPath, getDrillDownReport, getDrillDownReport, getDrillDownReportAt, getDrillDownReportAt, getDrillDownReportCount, getDynamicImageURLGenerator, getDynamicReportKeyGenerator, getErrorMessage, getExpandToGroupSectionIndex, getExportedFiles, getFileName, getFileRecordBufferSize, getFixedFieldCrossTabReport, getFontMapping, getFormulaParameters, getFrame, getHTMLParamPage, getHTMLParamPage, getHTMLParamPage, getHTMLParamPage, getHTMLParamPageBlock, getHTMLParamPageBody, getHTMLParamPageBody, getHTMLParamPageBody, getHTMLParamPageBody, getHTMLTarget, getHTMLTitle, getImagePath, getInputData, getInputDataBlockSize, getLeftMargin, getLocale, getMaxCharForRecordFile, getMaxFieldSize, getMaxRecordInMemory, getMinPageHeight, getNULLDataValue, getNumericNULLDataValue, getOrientation, getPageBufferSize, getPageFooter, getPageHeader, getPageHeight, getPageWidth, getPagingThreshold, getParameterPage, getParameterPage, getParameterPage, getParamInput, getParent, getPixelPerInchForExport, getQueryParameters, getQueryTimeout, getReportChartObjectAt, getReportChartObjectAt, getReportChartObjectCount, getReportChartObjects, getReportChartObjects, getReportChartObjects, getReportFooter, getReportHeader, getReportImageAt, getReportImageCount, getReportImages, getReportImages, getReportInfo, getReportInfo, getReportObj, getReportType, getRichTextFonts, getRightMargin, getScriptReportNameForExpandAndCollapse, getSecurityLevel, getSecurityQueryParameterMap, getServletContext, getStringNULLDataValue, getSubReportAt, getSubReportCount, getSubReportPath, getSubReports, getSubReports, getTable, getTableOfContentsObject, getTempDirectory, getTimeZone, getTopMargin, getTotalPageBufferSize, getTotalPages, getTotalSections, getTriggeredAlertDetails, getTriggeredAlertIds, getUpdateVersion, getVersion, importFontMapping, initDrillDownTree, initDrillDownTree, isAdjustFont, isAnimationOnForExpandAndCollapse, isDefaultToExpandAllForDHTML, isDHTMLTopMarginRepeatOnEveryPage, isDynamicExport, isEmbeddedScriptWithInThePageForDHTML, isEspressManagerUsed, isExpandAndCollapseOptionForDHTML, isExportToMultiPages, isForDeploy, isForExportOnly, isHeadTagIncluded, isHttpsDynamicExport, isKeepDataSourceOrder, isMultiPageExp, isPromptForParamValues, isSubReport, isUsing16ColorsForRTF, isUsingIE55DHTMLRendering, loadFile, pack, pack, pack, pack, parseProperties, preloadChartObjects, print, print, print, print, print, print, print, print, printUsingAwtPrint, promptFormulaParameters, refresh, refreshWithOriginalData, refreshWithOriginalData, refreshWithSubReportsOriginalData, removeSubReportAt, resetColumnWrap, saveAs, setAdjustFont, setAllDataRegistryLocation, setAnimationOnForExpandAndCollapse, setApplet, setApplyExcelFormat, setAutoClearSubReportCache, setBackgroundColor, setBackgroundImage, setBooleanNULLDataValue, setBottomMargin, setCenterDHTMLReport, setChartExportHTMLParameters, setChartPath, setColumnWrap, setConnectURLForServer, setCustomDefinedFunctions, setDataRegistryLocation, setDateTimeNULLDataValue, setDebugMode, setDebugMode, setDHTMLBrowserMargin, setDHTMLTopMargin, setDHTMLTopMarginRepeatOnEveryPage, setDisplayRow, setDrawBeforeExport, setDrillDownConnection, setDrillDownDatabaseInfo, setDrillDownPath, setDrillDownPath, setDrillDownReportHashtable, setDynamicExport, setDynamicExport, setDynamicExport, setDynamicImageURLGenerator, setDynamicReportKeyGenerator, setEmbeddedScriptWithInThePageForDHTML, setEspressManagerUsed, setExcelExportFitCell, setExpandAndCollapseOptionForDHTML, setExpandAndCollapseOptionForDHTML, setExportDelimiter, setExportEncoding, setExportNewlineDelimiter, setExportNewlineDelimiter, setExportToMultiPages, setExportToSingleWPagination, setExternalStyleSheetName, setFileName, setFileRecordBufferSize, setFitGroupOnPage, setFontMapping, setFontMapping, setFontMapping, setForDeploy, setForExportOnly, setFormulaScriptParamValue, setFrame, setHeadTagIncluded, setHTMLCharset, setHTMLLinksProvider, setHTMLTarget, setHTMLTitle, setHttpsDynamicExport, setHttpsDynamicExport, setImagePath, setInputDataBlockSize, setInternalStyleSheetName, setKeepDataSourceOrder, setLeftMargin, setLimitSubReportQueryExecution, setLocale, setMaxCharForRecordFile, setMaxFieldSize, setMaxRecordInMemory, setMultiPageExp, setNULLDataValue, setNumericNULLDataValue, setOrientation, setPageBufferSize, setPageFooter, setPageHeader, setPageHeight, setPageWidth, setPagingThreshold, setPaperSize, setParameterValues, setParameterValues, setParameterValues, setParameterValues, setParameterValues, setParent, setPdfEncryptionStrength, setPixelPerInchForExport, setPromptForParamValues, setQueryTimeout, setReportFooter, setReportHeader, setReportObjectForSubReports, setRichTextFonts, setRightMargin, setRTFEncoding, setScriptReportNameForExpandAndCollapse, setSecurityLevel, setSecurityLevel, setSecurityQueryParameterMap, setServerAddress, setServerHosts, setServerPortNumber, setServletContext, setServletDirectory, setServletRunner, setSFDrillDownDatabaseInfo, setSnapToGrid, setStringCustomizer, setStringNULLDataValue, setSubReportCache, setSubReportFormulaParameter, setSubReportParameters, setSubReportPath, setSubReports, setSubReportsQueryParameter, setTempDirectory, setTimeZone, setTopMargin, setTotalPageBufferSize, setUseSingleTableForDistinctParamValue, setUseStyleSheet, setUsing16ColorsForRTF, setUsingIE55DHTMLRendering, setXMLEncoding, sortByColumn, sortByMultiColumn, unpack, unpack, updateDataSource, useHttp, useServlet, useSingleTableForDistinctParamValue, useSubReportCache

Methods inherited from class java.lang.Object

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

Constructor Detail

DrillDownReport

protected DrillDownReport()

For internal use only. Create an empty DrillDownReport object

DrillDownReport

protected DrillDownReport(quadbase.reportdesigner.report.Report r)

For internal use only. Create a DrillDownReport object with the given report

Method Detail

export

public void export(int format,
                   java.lang.String fileName)
            throws java.lang.Exception

Export is not supported for drill-down reports. This method will throw an IllegalArgumentException.

Overrides:

export in class QbReport

Parameters:

format - See the class IExportConstants for possible values.

fileName - name of file to export to

Throws:

java.lang.Exception

export

public void export(int format,
                   java.io.OutputStream out)
            throws java.lang.Exception

Description copied from class: QbReport

Exports this QbReport object in the specified format into the specified output stream

Overrides:

export in class QbReport

Parameters:

format - format of the exported report. See the class IExportConstants for possible values.

out - OutputStream to export the QbReport.

Throws:

java.lang.Exception

exportReportToByteArray

public byte[] exportReportToByteArray()
                               throws java.lang.Exception

Export is not supported for drill-down reports. This method will throw an IllegalArgumentException.

Overrides:

exportReportToByteArray in class QbReport

Returns:

byte array

Throws:

java.lang.Exception

exportReportToString

public java.lang.String exportReportToString()
                                      throws java.lang.Exception

Export is not supported for drill-down reports. This method will throw an IllegalArgumentException.

Overrides:

exportReportToString in class QbReport

Returns:

The report data in String format

Throws:

java.lang.Exception

See Also:

Parameter: ReportData