e.

Report Designer API Java Edition
TM

Release 5

Information in this document is subject to change without notice. Examples provided are fictitious. No part of this document may be reproduced or transmitted in any form, or by any means, electronic or mechanical, for any purpose, in whole or in part, without the express written permission of Actuate Corporation. © 1995 - 2001 by Actuate Corporation. All rights reserved. Printed in the United States of America. Contains information proprietary to: Actuate Corporation 701 Gateway Boulevard South San Francisco, CA 94080 http://www.actuate.com The software described in this manual is provided by Actuate Corporation under an Actuate License agreement. The software may be used only in accordance with the terms of the agreement. Actuate Corporation trademarks and registered trademarks: Actuate, e.Analysis, e.Report, e.Reporting, Live Report Document, Live Report Extension, ReportBlast, ReportCast, Report Encyclopedia, SmartSearch, Transporter, Virtual Report Distribution, and XML Reports. Third party trademarks:
ActiveX, Microsoft, MSN, The Microsoft Network, Windows, Windows NT, Windows 95/98 and/or other Microsoft products are either trademarks or registered trademarks of Microsoft. CT-Library is a trademark of Sybase, Inc. Databeacon is a trademark of InterNetivity Inc. Digital Creations and DCLC, are trademarks of Digital Creations, LC. Graphics Server is a trademark of Bits Per Second, Ltd. and Pinnacle Publishing, Inc. HDK is a registered trademark of Virtual Media Technology Pty Ltd. INFORMIX-ESQL/C is a trademark of Informix Software, Inc. InstallShield is a registered trademark of InstallShield Corporation. Java, ONC, Solaris, SPARC, Sun, and Sun Microsystems are trademarks of Sun Microsystems. LEADTOOLS is a registered trademark of LEAD Technologies, Inc. Netscape, Netscape Communications, Netscape Communicator, Netscape Enterprise Server, Netscape FastTrack Server, and Netscape Navigator are either trademarks or registered trademarks of Netscape Communications Corporation. NobleNet and WinRPC are trademarks of NobleNet, Inc. Oracle Call Interface is a trademark of Oracle Corporation. Progress is a registered trademark of Progress Software Corporation. Sheridan Calendar Widgets is a trademark of Sheridan Software Systems, Inc. SmartHeap is a trademark of MicroQuill Software Publishing, Inc. Tools.h++ is a trademark of Rogue Wave Software, Inc. UNIX is a registered trademark of X/Open Company, Ltd. XPrinter is a trademark of Bristol Technology, Inc. XPAT, created by James Clark, is licensed under the Mozilla license agreement. WinWidgets is a trademark of Simple Software, Inc.

All other brand or product names are trademarks or registered trademarks of their respective companies or organizations. Document No. 010409-2-940304 April 25, 2001

10

9

8

7

6

5

4

3

2

1

Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii
About Actuate e.Reporting Suite 5 . . . . . . About e.Reports Designer API Java Edition About Actuate e.Report Designer product . Online documentation. . . . . . . . . . . . . Using online manuals . . . . . . . . . . . Online help . . . . . . . . . . . . . . . . . Using the Actuate online help system. Typographical conventions . . . . . . . . . . Syntax conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii xviii xviii . .xx . .xx . .xx . .xx . xxii xxiii

Chapter 1

Class hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Hierarchy for all packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Differences between the AWT and SWING API . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2

Serialized objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Class com.actuate.ereport. designer.ACJDesigner . . . . . . . . . . . . . . Class com.actuate.ereport. datasrcmgrs.appdatasrc. AppDataHandler . . Class com.actuate.ereport. datasrcmgrs.asciidatasrc. ASCIIDataHandler . Class com.actuate.ereport. datasrcmgrs.ejbdatasrc. EJBDataHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 . 11 .12 .13

Chapter 3

Class summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Package

com.actuate.ereport. designer.ACJDesigner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
ACJDesigner constructor . . . . . . ACJDesigner.actionPerformed . . . ACJDesigner.addDataSource . . . . ACJDesigner.addExternalFont . . . ACJDesigner.addMruFile . . . . . . ACJDesigner.debugMessage . . . . ACJDesigner.debugMessageLN . . ACJDesigner.getActiveDataSource. ACJDesigner.getClient. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76 .76 .77 .77 .77 .78 .78 .78 .78

i

ACJDesigner.getDataSources . . . . . . . . . ACJDesigner.getDebugMode . . . . . . . . . ACJDesigner.getEngine . . . . . . . . . . . . ACJDesigner.getMruList. . . . . . . . . . . . ACJDesigner.getRegdAppDataHandler . . . ACJDesigner.getRegdASCIIDataHandler . . ACJDesigner.getRegdEJBHandler . . . . . . ACJDesigner.getRegdJDBCHandler . . . . . ACJDesigner.getRegdMetaDataHandler. . . ACJDesigner.getRegdXMLDataHandler. . . ACJDesigner.getRelations . . . . . . . . . . . ACJDesigner.itemStateChanged . . . . . . . ACJDesigner.loadTemplate . . . . . . . . . . ACJDesigner.loadTemplate . . . . . . . . . . ACJDesigner.main . . . . . . . . . . . . . . . ACJDesigner.paintComponent . . . . . . . . ACJDesigner.registerDataSources . . . . . . ACJDesigner.saveTemplate . . . . . . . . . . ACJDesigner.setActiveDataSource . . . . . . ACJDesigner.setAutoQuery . . . . . . . . . . ACJDesigner.setDebugMode . . . . . . . . . ACJDesigner.setDefaultAttachLabel . . . . . ACJDesigner.setDefaultExitMode . . . . . . ACJDesigner.setDefaultGridSnap . . . . . . ACJDesigner.setDefaultHorzGap. . . . . . . ACJDesigner.setDefaultImageRelativePath . ACJDesigner.setDefaultLookAndFeel . . . . ACJDesigner.setDefaultLowercaseQuotes. . ACJDesigner.setDefaultNewTemplate . . . . ACJDesigner.setDefaultPrependSchema. . . ACJDesigner.setDefaultPrintMode . . . . . . ACJDesigner.setdefaultshowgrid. . . . . . . ACJDesigner.setDefaultTemplateEncoding . ACJDesigner.setDocsPath . . . . . . . . . . . ACJDesigner.setHasBeenGenerated . . . . . ACJDesigner.setMruList . . . . . . . . . . . . ACJDesigner.setTemplateFile . . . . . . . . . ACJDesigner.showMenu . . . . . . . . . . . ACJDesigner.stateChanged . . . . . . . . . . ACJDesigner.syncTmplMgr . . . . . . . . . . ACJDesigner.updateDesigner . . . . . . . . . ACJDesigner.updateOutputProperties. . . . ACJDesigner.updateRelations . . . . . . . . ACJDesigner.windowActivated . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

78 79 79 79 79 80 80 80 80 81 81 81 81 82 82 82 82 82 83 83 84 84 84 84 85 85 85 85 86 86 86 86 86 87 87 87 87 88 88 88 88 88 89 89

ACJDesigner.windowClosed . . . ACJDesigner.windowClosing . . ACJDesigner.windowDeactivated ACJDesigner.windowDeiconified ACJDesigner.windowIconified . . ACJDesigner.windowOpened . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

.89 .89 .90 .90 .90 .90

Package

com.actuate.ereport.engine.ACJEngine . . . . . . . . . . . . . . . . . . . . 91
ACJDesigner constructor . . . . . . . ACJEngine.autoConnectDatasource . ACJEngine.debugMessage . . . . . . ACJEngine.debugMessageLN . . . . ACJEngine.disconnect . . . . . . . . . ACJEngine.doesX11GfxExist . . . . . ACJEngine.finalizeEngine . . . . . . ACJEngine.generateReport . . . . . . ACJEngine.getColValue . . . . . . . . ACJEngine.getCommunicationStub . ACJEngine.getData source . . . . . . ACJEngine.getDebugMode . . . . . . ACJEngine.getEvaluater . . . . . . . ACJEngine.getOutputDevice . . . . . ACJEngine.getTargetOutputDevice . ACJEngine.getTemplateManager . . ACJEngine.getTemplateReader. . . . ACJEngine.getTemplateWriter . . . . ACJEngine.getTmplMgr . . . . . . . ACJEngine.newSystem . . . . . . . . ACJEngine.newTemplate . . . . . . . ACJEngine.overrideResolution . . . . ACJEngine.print . . . . . . . . . . . . ACJEngine.printingDone . . . . . . . ACJEngine.readTemplate . . . . . . . ACJEngine.readTemplate . . . . . . . ACJEngine.readTemplate . . . . . . . ACJEngine.resetStub. . . . . . . . . . ACJEngine.setCacheOption. . . . . . ACJEngine.setCommunicationStub . ACJEngine.setDataSource. . . . . . . ACJEngine.setDebugMode . . . . . . ACJEngine.setOutputDevice . . . . . ACJEngine.setResizeFixRatio. . . . . ACJEngine.getResizeFixRatio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96 .97 .97 .97 .98 .98 .98 .98 .99 .99 100 100 100 100 101 101 101 102 102 102 103 103 103 104 104 104 105 105 105 106 106 106 107 107 107

iii

ACJEngine.setTargetOutputDevice. ACJEngine.setTemplateReader . . . ACJEngine.setTemplateWriter . . . ACJEngine.setX11GfxAvailibility . . ACJEngine.updateResolution . . . . ACJEngine.writeTemplate . . . . . . ACJEngine.writeTemplate . . . . . . ACJEngine.writeTemplate . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. 107 . 107 . 108 . 108 . 108 . 108 . 109 . 109

Package

com.actuate.ereport.output.ACJOutputProcessor . . . . . . . . . . . 111
ACJOutputProcessor constructor . . . . . . . ACJOutputProcessor.closeZipEntry . . . . . . ACJOutputProcessor.closeZipStream . . . . . ACJOutputProcessor.debugOutputProps . . . ACJOutputProcessor.generateCSV . . . . . . . ACJOutputProcessor.generateCSV . . . . . . . ACJOutputProcessor.generateCSV . . . . . . . ACJOutputProcessor.generateDHTML . . . . ACJOutputProcessor.generateDHTML . . . . ACJOutputProcessor.generateEMAIL . . . . . ACJOutputProcessor.generateHTML . . . . . ACJOutputProcessor.generateHTML . . . . . ACJOutputProcessor.generateHTML . . . . . ACJOutputProcessor.generateHTML . . . . . ACJOutputProcessor.generateJOI . . . . . . . ACJOutputProcessor.generateJOI . . . . . . . ACJOutputProcessor.generatePDF . . . . . . . ACJOutputProcessor.generatePDF . . . . . . . ACJOutputProcessor.generatePDF . . . . . . . ACJOutputProcessor.generatePDF . . . . . . . ACJOutputProcessor.generatePDF_Ex . . . . . ACJOutputProcessor.generatePDF_Ex . . . . . ACJOutputProcessor.generatePRINTOUT . . ACJOutputProcessor.generatePRINTOUT . . ACJOutputProcessor.generatePRINTOUT . . ACJOutputProcessor.getCSVProperty . . . . . ACJOutputProcessor.getDHTMLDevice. . . . ACJOutputProcessor.getDHTMLProperty . . ACJOutputProcessor.getDocumentationPath . ACJOutputProcessor.getEMAILProperty . . . ACJOutputProcessor.getHTMLProperty . . . ACJOutputProcessor.getJOIProperty. . . . . . ACJOutputProcessor.getOutputFiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 . 118 . 118 . 118 . 118 . 119 . 119 . 120 . 120 . 120 . 121 . 121 . 121 . 122 . 123 . 123 . 123 . 124 . 124 . 125 . 125 . 126 . 126 . 127 . 127 . 128 . 128 . 128 . 129 . 129 . 129 . 130 . 130

iv

. . 139 . . . . . 131 . . 143 v . . . . 131 . . . ACJOutputProcessor. . . . . . . . . ACJOutputProcessor. ACJOutputProcessor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ACJOutputProcessor.prv_setZoom . . . . . . . .setOutputProperty . . ACJOutputProcessor. . . . . . . . . . . .setReportData . . . . . . . . . . . . . . . . . .setReportData . . . 130 . 135 . . . . . . . . . . 138 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ACJOutputProcessor. . 132 . . . . 134 . . .setPrinterResolution . . . . ACJOutputProcessor. . . . . . . ACJOutputProcessor. . . ACJOutputProcessor. . . . . . 131 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .setEMAILProperty . . . . . . . . . . . . . ACJOutputProcessor. . . .setJOISource . . . . . . . . . . . . . . . . . . . . . 132 . . . . . .setJOIURLSource . . . . . ACJOutputProcessor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .prv_getZoom . . . . . . . . . . . . .prv_getPageCount . . 133 . . . . . . 135 . . . . . . . . . . . . . . . . . . .setPRINTERProperty . .getVirtualOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . ACJOutputProcessor. . 134 . . . . . .prv_showTOC. . . . . . . . . . . . . . . . . . . ACJOutputProcessor. . . . . . . 141 . 131 . . . . . . . . . . . . . . . .prv_setBackgroundTOC . . . . . . . . . . . . . . . . . . . . . . . . . 133 . . . . . ACJOutputProcessor. ACJOutputProcessor. . . . . . . . . . . . . ACJOutputProcessor. . . . . . . ACJOutputProcessor. . . . . . . . . . . . . . . ACJOutputProcessor. . . .hasMultipleOutputFiles . ACJOutputProcessor. . . . . . . . . .prv_removeToolbarItem . . . . . . . . . . . . . . . . . .writeZip . ACJOutputProcessor. . . . . . . . . . . . . . . . . . . . . . . ACJOutputProcessor. . . . . . . . . . . . .setJOIFileSource. . . . . . . . . . . . . 134 .setDHTMLProperty . . . . . . . . . . .getPDFProperty . . . . . .prv_showToolbar . . . .prv_setNextPage . . . . . . . . . . . . . . . 132 . . . . ACJOutputProcessor. . . . . . . . . . . . . . . . . . . . . . . . . . 139 . . . . . . . .setHTMLProperty . . . . . . . . . . . . . . . . . . . . . . . . . . 135 . . . .prv_getActivePage . . . . . . . . . . ACJOutputProcessor. . . . . . . . . . . . . . . 133 .prv_updateToolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ACJOutputProcessor. . ACJOutputProcessor. . . . . . . . . . . . . . . . ACJOutputProcessor. . . . ACJOutputProcessor. . . . . . . ACJOutputProcessor. . . . . . . . . . 142 . . . . . . . . . . .writefile . .promptParams . . . . . . . . . . . . . . . . .setCSVProperty . . . . . . . . . . . . . . . ACJOutputProcessor. .prv_setActivePage . . . . . . . . . . . . . 132 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .setDocumentationPath .getPrinterResolution . . . . . . . . . . . . ACJOutputProcessor. . . . . ACJOutputProcessor. . . . . . . . . 134 .setBufferSize. . . . . . . . . . . . . . . . .instantiateZipStream . . 134 . . . . . . . . . . . . . 142 . 139 . . . . . . ACJOutputProcessor. . . . . . . . . . . ACJOutputProcessor. . . . . . . . . . . . . . 132 . . . 140 . . . . . . . . . . . . . . . 136 . . . . 137 . . . 135 . . . . . . . . . . . . . . . . . 137 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .writeZip . . . . . . . ACJOutputProcessor. . . 140 . . . . . ACJOutputProcessor. . . . . . . . . . . . . 134 . ACJOutputProcessor. . . . . . . . . . .setPDFProperty . . . . . . . . . 142 . . .prv_setPrevPage . . . . . . . . . . . . . . . . . . . . . . . .getPRINTERProperty . . . 138 . . . . . . . ACJOutputProcessor. . . . . . . . ACJOutputProcessor. ACJOutputProcessor. . . . . . . . . . . . . . . ACJOutputProcessor. . . . . . . .setJOIProperty. . . . . . . . . . . . . . .refreshReport . . . . . . . . 130 . . . . . . . . . . . . . . .promptParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 . 133 . . . . . . . . . . .ACJOutputProcessor. . . . . . . . . . ACJOutputProcessor. . . . . . . . . . . . 137 . . . . . . . .putNewZipEntry . . . . . . . . . . . . . . . . . . . . .getPreviewDevice. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . .fetchData . . . 160 vi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 . . . . 156 . . . . . . . . . .getIdentifierQuote. . . . . . . . . . . . AppDataHandler. . . . . . . . . . . . . . . . . . . . . . . . AppDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 . . . . . 152 . 157 . . . . . . . . . . . . . . . . . AppDataHandler. . . . . . . . . . . . . . . . . . . . .registerDataSet . . 154 .getStartRecordNumber .getRelations . . . . . . . . . . . AppDataHandler. . . . . . . . . . . . . . . . . .isConnected . . . . . . . . . . . . . AppDataHandler. . . . . . . .setRelations . . . 150 . . . . . . . . . .allowMultipleTableRegistering AppDataHandler. . . . . . . .actuate. . . . . . . . . . . . . . .RegisterTable. . . . . AppDataHandler. . . . . . . . 155 . . . . . . . . . . . . . . . . . . . . . . . .getName . . . . . . . . . AppDataHandler. 150 . 151 . . . . . . . . . . . . . . . AppDataHandler. . . . . . . . . . . . . . . . 153 . . . . . . . . . . . . . AppDataHandler. . . . .sortVector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getQueryTables . . . . . .getQuery . . . . . . . . . . . . . . . .Package com.requiresConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . .getDataType . . 158 . . . . . . . 150 .getQueryResult . . . . . . . . . . . . . . . . . 156 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AppDataHandler. . . . . . . . . . . . . . . . . . . . . . AppDataHandler. . . 157 . . . . . . . . . . . . . . . . . 155 . . . . . . . . . .setQueryDisplay. . . . . . . . . . . . . . . . . . . . . . . . . . . . AppDataHandler. . . . . . . AppDataHandler. . . . . . . . .getTable. . . . . . . . . . . . . . . . .ereport. . . .getTableNames . . .appdatasrc. . . . . . . . .getCatalogName. . AppDataHandler. . . . . . . . .registerQuery . . . . . . . . . . . . . . . . . . . . 153 . . AppDataHandler. . . . . . . . . . . . . . 156 . . . . . . . . . . . . . . . AppDataHandler. . . . . . .setExtraOperators . . . . . . . . . . . . . . . . . . . . . . . . . 152 . . . .registerObjectAsTable. 154 . . . . . . . . . . . . . . . . . . . . . . . AppDataHandler. . . . . . . . . . .setResultSetRange . .getColumnNames . 151 . . . . . . . . . . . AppDataHandler. AppDataHandler. . . . AppDataHandler . . . . . . . . . . . . . . .getTableType . . 155 . . . . . . . . . 159 . . . . . . . . AppDataHandler. . . . . . . . . . . . . . . . .registerUserDefTable . . . . . . .setDebugMode . . . . . AppDataHandler. . . . . . . . . . . . . . AppDataHandler. . . . . . . . . . . . . . . . AppDataHandler. .disconnect . . . . . . . . . . . . . . . . . . . . . . . . . 152 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AppDataHandler. . . . . . . . . . . . . .getDebugMode . . . . . . .isNullable . . . .RegisterTable.getEndRecordNumber . . . .passTableData . . . . . . . . . . . AppDataHandler. AppDataHandler. . . . . . . 154 . . . . . . . . . . . . . . . . 151 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 . . . . . . . . . . . . . . . . . 159 . . . . . . . . . . . . . . . 152 . . . . . . AppDataHandler. . . . . 149 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AppDataHandler. . . . . . 159 . . . . . .getPropertySheet . . . . . . . . . . . . .setTableDefinition . . . . . . AppDataHandler. . . . . . . . . . . 159 . . . . 157 . . . . . . . . . . . . . . . . . 158 . 160 . . . . . . . . . . . . . . . . . . . . . AppDataHandler. AppDataHandler. . . . . . . . .getQueryColumns. . . . . 154 . . . AppDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 . . . . . . . . . . . . . . . . . . . . AppDataHandler. 149 . . . AppDataHandler. . . . . . . . . . AppDataHandler. . . . . . . . . . . . . . . . . . . . . .datasrcmgrs. . . . AppDataHandler. . . . . . . AppDataHandler. . . . . . . . . . . . . . .connect . . . . . . . . . . . . . . . . . . 145 AppDataHandler constructor . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 . . . . 178 . . . . . . . . . . . . . . . . . . . . . . . . . . .setPropertiesFileName . 170 . . . . . . . . . . . . . . . . .connect . . . . EJBDataHandler.getColumnCount . . . . . . . . . getValue . . . . . .getName . . . . . . . . . . . . . . . . . . EJBDataHandler. . . . . . . . . . . . . . . 169 . . ASCIIDataHandler. . . . . . 173 EJBDataHandler constructor . ASCIIDataHandler. . . . . . . . . . . .actuate. . . . . .getPropertySheet . . . . . . . . . . . . . 169 . . . . . . . . . . . . . . . . . .ereport. . . resetCursor . . . . .actuate. . . . . . . . . . . . . . . ASCIIDataHandler. . . . . . . . . . . . EJBDataHandler. . . . . . . . . . . . . . . 167 ASCIIDataHandler constructor . . . EJBDataHandler. . . . . . . . EJBDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . 178 vii . . . . . . .getSourceFileName . . . . . . . . . . . . . . . . . . . . . . . . . . hasNext . 177 . . . . . . . . . . . . . . . . . . . . . . . . . . . .addTableDefinition . . 161 Interface IObjectTable getColumns . . . . . . . 177 . . .asciidatasrc. remove . . . . . . . . . . . . . . . . . . . . . . . . . 171 . . . . . . . . . . . . . 177 . . . . . . . . . .checkIfExists . . . 175 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EJBDataHandler. . . . . . . . . . . . . . . . . . . . . .ereport. . . . . . . . . . . . . . . . . . . . . 171 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .addTableData . . . . . . . . . . . . . . . . . . . . . EJBDataHandler. . . . . . . . . . 169 . . . . . . . . . . . . . . . . . . . . . . Interface Iterator . . . . . . . . . . . . 162 162 162 163 163 164 164 164 165 165 Package com. . . . . . .actuate. . . . . . . . . .ereport. . . . . . . . .getContextFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .appdatasrc . . 170 . . . . . . . . . . . next . . . . . . . . . . . . . . . . . . . . . . . . . . . . .registerObjectsWithEngine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 . . . . . . . . . . . . . . .Interface com. .connect . . . .getRemoteAppName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EJBDataHandler. . EJBDataHandler. . . . . . . ASCIIDataHandler. . . 171 Package com. . . . . . . . . . 177 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iterator. . . . . . . . . . . . . . . . . . . . . . . . 171 . . . . .processMsg . . . . . . . . . . . . . . . . . . . . . . 176 . . . . . . . . . . . . EJBDataHandler. . . . . . . . . .isConnected. . . . . . . . . . .clearSchemaAndData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .connectToRemoteApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 . . . . . . . . . . . . . . ASCIIDataHandler. . . . . . . . . . . . . . . ASCIIDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getPropertiesFileName . . . . . . . . . . . . . . . . . ASCIIDataHandler. . . . . . . . . . . . . . . . . . . . . . . 171 . . 176 . . . . .getProperties . . . . . . . . . . . . . . . . . . . . ASCIIDataHandler. . . . . . . . . . . . ASCIIDataHandler. . . . . . . . . . . . ASCIIDataHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .ejbdatasrc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . EJBDataHandler. . . . . . . . . . . . . .getCurrentPropertiesAsString . . . . . EJBDataHandler. . . .datasrcmgrs. . . . hasColumn . .datasrcmgrs. . . . . . .datasrcmgrs. . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .ereport. . . . . .getDataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EJBDataHandler. .getPrivileges . . . . .getPassword . . . . . . . . . . .getColumnNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 . . . . . . . . . . . . . . . . . . . . . . . . .extractRelations . . . . . . . . . . . . 181 JDBCHandler constructor. . . 196 . . . . . . . . . 189 . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 . . . . 192 . . . . 179 . . . . . . . . . . . . . . 191 . . 194 . . . . . JDBCHandler. . . . . 189 . . . . . . . . . . . . . . . . . .allStoredObjectsCallable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getGrantor . 191 . . . 194 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler . . . . .getName . . . . . . . . .connect . . . . . . .getQueryResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . JDBCHandler. .setContextFactory . . . . . . . . .processRemoteMsg. . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. 195 . . . . . . . . JDBCHandler. . . . 188 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 . . JDBCHandler. . . . . . . . . . . . . . . . 178 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . . .getQueryTables . . . . . . . . . . . . . . . . . . . . . . . .getGrantee . . . . . . . . . EJBDataHandler. . . . 190 . . . . . . . . . . . JDBCHandler. . . . . . . . . . JDBCHandler. . . . . . . . 194 . . . . . . . . .Connect . . . . . . . . . . 192 . . . . . . . . . . 192 . . . . . . . . 196 viii . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 . . JDBCHandler. . . . . . . . . . . . .Connect . . . .actuate.datasrcmgrs. . . . . . . . . . . JDBCHandler. JDBCHandler. . . .EJBDataHandler. . 196 . . . . JDBCHandler. . 178 . .debugMessageLN . . . . . . . . . . . . . . . . . . . . . . . . . .fetchData . . . . . . .Disconnect . . 195 . . . . . . . . . . . . . . . 179 Package com. . . . . . . . . . . . . . . . . . . 194 . . . . . . . . . . . . . . . . . . . 193 . . . . . . . . . . . JDBCHandler.disconnect . . . . . . . . . . . . . . . . . . . . 190 . . . . . . . . .getPropertySheet. . . . . . . . . . . . . . . . . . . . . . .getQueryColumns . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . 191 . . . . . . JDBCHandler.getCatalogName . . .getConnection . . . JDBCHandler. . . . . . . . . . . 189 . . 190 . . . . . . . . JDBCHandler. . . EJBDataHandler. . . . . . . . . . . . JDBCHandler. . . . . .debugMessageLN . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . . 190 . . . . . . . . . . . . . . . JDBCHandler. . . . JDBCHandler.debugMessage . . . . . . . . . . . . . . . . . . . 190 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getCurrentTableSelection . . . 195 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .jdbcdatasrc. . . . . . . .setProperties . . . . . . . .setTableDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .connect . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getDebugMode . . . . . . . . . . . . . . . . . . . . . . . . . . .connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Connect . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . .getQuery . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . .getIdentifierQuote . . . 179 . . . . . . . . . . .requiresConnection.getDriverName . . . . . . . . . . 193 . .getEndRecordNumber . . . . . . . . . . . . . . . JDBCHandler. . . . . . 192 . . . . . . . . . . . . . 193 . . . . . JDBCHandler. . . . . . . . . 193 . . . . . . . . . . . . . . . . . . . EJBDataHandler. . JDBCHandler. . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . .getDefaultValue . . . .

. . . .datasrcmgrs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . JDBCHandler. . . . . . . . MetaDataHandler. . . . . MetaDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . 199 . . . . . . . . . . . 198 . . . . .setUsername . . . . . . . . . . . . . . . . . . . . . . . . . . . .registerQuery . . . . .connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .JDBCHandler. . . . . . . . . . . . JDBCHandler.getTables . . . .clearMetaData . . . . . . . . . . . . . . . . 198 . . . . . . . . . . . . . . . . . . . . . . . .makeSelective . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . .setPrependSchema . . . . . . . . . . . . . . . . . . . . . .metadatasrc. . . . . . JDBCHandler.retrieveTables . . . . . . . . . . . 205 MetaDataHandler constructor . . . . . . . . . . . . . . . . . . . . . . . 199 . . . . . . . . . . . . . . . . . . 201 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getTable.actuate. . . . . . . . . . . . . . . . . . . . . 200 . . . . . . . . . . 197 . . . . . 198 . . . 203 . . . . . . . . . . . . JDBCHandler. 200 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . .getRemarks . . . . . JDBCHandler. . . . . .getStoredObjects. .setProperties . . . . . . . . . 198 . . . . JDBCHandler. .useTables . JDBCHandler.isNullable . . . . 202 . . . .setPassword . . . . . . JDBCHandler. . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 . .getSelectedTables . . . . . 209 209 209 209 210 210 210 211 ix . . . . . . . . . . . . . . . . . . . . . . . . . .setDebugMode . JDBCHandler. . . . 202 . . . . . . 203 . . . . . . . .getRelations . . . .getCatalogName . . . . . . JDBCHandler. . . . . 198 . . . . . . . . . . 197 . . . . . . . . . . . . . . . . . .getStartRecordNumber . . . . . . . . . MetaDataHandler . . . . . . . . . . . . . . . . 197 . . . . . . . . . 200 . . . . . . . . . . . . . . . .getUrl . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . .addTable. . . . . . . . . . . . . . . . . . . . . . . . . .isGrantable . . . . . . . . . . . . .exportAsMetadata MetaDataHandler. . 199 . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . JDBCHandler. . 203 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . 202 . . . . . . . . . . . . . . . . . . . . . .fetchData . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . . . 204 Package com. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . .getSelectiveTableFilter . . . . . . . JDBCHandler. . .requiresConnection . . . . . . . . . . . . .getUsername . . . .getTableNames . . . . . . . . . . . . .isConnected . . . . . . .setResultSetRange . . . . . . . . . . . . . . . . . 197 . . . . . JDBCHandler. . . . . . . . . . JDBCHandler. . . . . . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . . . . . . . . . . JDBCHandler. . . . . 201 . . . . . . . . 201 . . . . . MetaDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getTableCount . . .setUrl . . . . . . .getSOImplementation . . 200 . . . . . . . . . . .setDriver . . . . . . . . . . . . . . 202 . . . . . . . . . . . . . . . . . . . . . . . . JDBCHandler. . . . JDBCHandler. . . . . . . 203 . . . . . . . . . . . . . . . . . . . . . . 201 . . . . . . . . . . . . . . . . . . . .setSelectiveProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .disconnect. . . . . . . . . . .ereport. . . . .supportsStoredObjects . . . . . . . . . . . . . . . . . . JDBCHandler. . . .setLowercaseQuotes . . . . . . . . . . . . 203 . . . . . . .

. . MetaDataHandler. . . . . . . . .getPropertySheet . . . MetaDataHandler. . . . . . . . . . 221 OD_DHTML constructor . . . . . . . . . . . .getDataType . . . . . . . . . . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . 223 . . . .getQueryColumns . . . . MetaDataHandler.getTable . . . . . . . . 219 . . . . . . . MetaDataHandler. . . . . . . . . . . . . . . . . .registerQuery .generate . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . . . . .requiresConnection. MetaDataHandler. . . . . . . . . . . 225 . OD_DHTML. . . . . . . . . . . . . . . . . . .output. . . . . . . . . . . . . . OD_DHTML. . . . . . . .ereport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 . . . . . . MetaDataHandler. . . . 216 . . . . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 . . . . . . . . . OD_DHTML. . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . . . . . . . 213 . . . . . . . . . . . . . . . . . . . . .actuate. . . . . . . . . 225 . . . MetaDataHandler. . . . . . . . . . . . . . . . . . . . 213 . . . . . . MetaDataHandler. . . . . . . . . . . OD_DHTML. . . . . . . . . 226 x . . . . . . . . . . OD_DHTML. . . 216 . . . . . . . . . . . .getImage . . . . . 214 . . . . . . . . . . . . . . 215 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 . . . . . MetaDataHandler. . . MetaDataHandler. . . . . . . . . . 215 . . . . . . . . . . . . . . . . . . . . . . . 217 . . . . . . . . . . . . . . . .setCatalogName . . . . MetaDataHandler. . . . . 215 . . . . . . . . . . . . . . . . .isGrantable . . . . .getTableNames . . . . . . . . . . . . . . . . . . . . . 212 . . . . 217 . . . . . . . . . . .generateReportPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . . . MetaDataHandler. . . . . . . . 223 . . . . . . . .getName . .generateTOCPage . . . . . . . . . . . . .MetaDataHandler. . . . . . . . . .manuallyConstructed MetaDataHandler. . . . . . . . . . . . . .getIdentifierQuote . . 211 . .getRelations . . . 219 . . . . . . . . . .OD_DHTML . . OD_DHTML. . . .setRelations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 . . . . . . . . . . . . . . .getDefaultValue. . . . . . . . . . . . .generateMainFrameSet OD_DHTML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 . . . . . . . . . 218 . . . . . . . . 219 . . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . MetaDataHandler. . . . . . . . .getGrantee. . . . . . . . . MetaDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getColumnNames . . .setResultSetRange . . . . . . . . . . . . . 219 . . . . .getGrantor . . . MetaDataHandler. . . . . . . MetaDataHandler. . . .writeObject . . . . .getRemarks . . . . . . . . . . . . . .getPrivileges . . . . . .readObject . . . . . MetaDataHandler. . . . .getDatasourceName . . . . . . . . . . . . . . . . . . 213 . . . . . . . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . MetaDataHandler. . . . . 216 . . . . . . . 214 . . . . . . . . . . . . . . . .setIdentifierQuote . . 218 . . . . . . . . . . . . . . . . . . . . 218 . . . . . . . . . . . . . . . . . . . . . . . . 212 . . . . . . . . . . . . . . . . . . . . . . MetaDataHandler. . . . . . . . . 226 . . . . . . . . . . . . . . . . . . . . . . 215 . . . . . . . . . . . . . . MetaDataHandler. . . . . MetaDataHandler. .setGenerateOnDemand . . . . . . . . . . . . . . . . . . .isNullable . . . . . . . . . . . . . . . . . . . .getQueryResult . . . . . . . 218 . . . . . . . . . . . . . . . . 226 . . . . . . . . . . . . . . . . .getTableType . . . . . . . . 220 Package com. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getImage . . . . . 214 . . . . . . . . . . . . . . . . .isConnected . . . . . .getQueryTables . . . . . MetaDataHandler. . . . . . . . . 213 . . . . . .getQuery. . . . . .setDatasourceName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . 246 . . . . . . . . . . . . . . . . . . 245 . . . 247 . . . 246 . . . . . . . . TemplateManager. . .connectToDatasource .createControl . .createRuntimeParams . . . . . . . . . . 231 231 233 233 233 234 234 235 Package com. . . . . 244 . . . . . . . . . . . . . . . . .getPageMargins . . . . . . . . . . . . . . . . . . . . .generateTOCPage . 248 . TemplateManager. . . . . . 243 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getParameterIds . . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . . . TemplateManager. . OD_HTML. . . . . . . . 245 . . . . . . TemplateManager. . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .generate . . . 248 . . . . . . .destroyTemplate . . . . . . . . . . . . . . . . . . TemplateManager. . . . . . .generateMainFrameSet . . . . . . . . . . . . . . . . . . TemplateManager. .getImportedSQLQuery TemplateManager. . . . . . . . . . . .getPageHeight . TemplateManager.TemplateManager . . . . . . . . TemplateManager. . . . .ereport. . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . . . . .getFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getSectionId. . . . . . . . . .ereport. . . . 246 .getImage . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .changeID . . . . . . . . . . . . . . . . . . . . . . . . . . .actuate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . 246 . . . . 247 . . . . . . .generateReportPage . . .getResizeToFitContents TemplateManager. . . . . . . . . . . . . . . . . . . . .getImageURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getImage . . . . . 247 . . . 244 . . . . . . . .output. . . . . . . . . . . . . . . . . . . . .collapseTemplate . . . . . . . . . . . . . . . . . . .actuate. . . . . . . . . . . . . . . . .getPageWidth. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 . . . . . . . . . . . . . . . . . . . OD_HTML. . . . . . . . . . . . 245 . . . . . . . . . . . . TemplateManager. TemplateManager. . . . . . . . . . . OD_HTML. . . . . . . . . . . . . TemplateManager. . . . .engine. . . . . . . . . . . . . . . .OD_HTML . . . . . . . . . . . . . . . . . .getORDERBYClause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 . . . TemplateManager. . . . TemplateManager. TemplateManager. . . . . . . . . 249 . . . . . . . . . . . . . . . . . . TemplateManager. . 247 . 244 . .getReportComments . . . . 248 . . . . . . . . . . . . . .getBounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . . TemplateManager. TemplateManager. . . . . . . . . . 243 . . . . . . . OD_HTML. 237 TemplateManager. . . . . . . . . . . . . . . . . . . . . . . . . . .getReportAuthor . . . . . . . . . . .getFillColor . . . . . . 249 xi . . . . . . . . . . . . . 245 .getQueryContents . . . . . . . . . . . . OD_HTML. . 249 . . . . . . . . .getAlignment . . TemplateManager. TemplateManager. . . . . . 245 . . . . . 244 . . . . . . . . . . . . . . . .getFontColor . . . . . . . . . . . . . . . . . . .getFont . . . . . . . . . . . . . . . . . . . .setGenerateOnDemand .getDataField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getParamProperty . . . . . OD_HTML.getLabel . . . TemplateManager. . 244 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getFormula . . . . . . . . . . . . . . . . . . . OD_HTML. . . . . . . . . . . . . . . . . . . . . 229 OD_HTML constructor . 249 .createControl . . . . . . . . TemplateManager. . . . . . . .Package com.getReportTitle. . . . . . . . . . . . . .

. . TemplateManager. . . . 257 . . . . . . . . . . .setParamValue . . . . . . . . . . 250 . . . . . . . . . . . . . .setVisible. . . . . . 251 . . . . . . . . . . .setBounds . . . . . . . . . . . . . .setResizeToFitContents . . . . . 256 . . 256 . . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . 258 Index . . .setFontColor. . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 . . . . TemplateManager. . 259 xii . 255 . . 251 . . .setUnitType . . . . . .hasParameters. . . . . . TemplateManager. . . . . . . . . . . . . . . . . .setReportComments . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . 253 . . . . . . . . . . . . . . . . . . . . . . . . . .setReportTitle . . . . . . . . . . 253 . TemplateManager. . . . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . . . .setPageMargins . . . . . . . . . . . .isLine. . . . . . .getVisible . . . . . . . . . . TemplateManager. . . 257 . . .setAlignment . .getWHEREClause .isLabel . . . . . . . . . . . . TemplateManager. . . . . . . . . . .setFillColor . . . . . . . . . 257 . . . . . . . . . . . . . . .getTextWrap . . . . . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . 250 . . . . . . 256 . . . . . . 250 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . 254 . . 252 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . . . . . 252 . . . .setPageHeight. . . . . . . . . . . . . . 251 . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .setFont . . . . . . . . . . . . . . .setImportedSQLQuery. . . . . 255 . . . . . . . .setFormat .setWallpaper . . . TemplateManager. . . . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . 256 . . . . . . . . . 250 . . . . . . . . . . . . . . . . . . . . . . .setORDERBYClause . . . . . . . . . . . . . . . . . . . 252 . . . . . . . . .setZoneHeight . . . . . . . . . . . . . . . . 252 . . . . . . . . . . . . . . . . . . .isFormula . . . . . . . 250 . . . . . . . . . . . . . . . . . . . . . . . . . .setWallpaper . . . . . . . . . 251 . . . . . . . . . .isChart . . .setTextWrap . . . . . . TemplateManager. . . . . . . . 253 . . . . . . . . TemplateManager. TemplateManager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .setPageWidth . . . . . . . . . . . . . . . . . . . 249 . . . . . . . . . . . . 254 . . . . . .isImageURL . . . . . . .isDataField . . . 251 . . . . . . . . . . . . .setImageURL . . . . 253 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . . . TemplateManager. . . . . . . . TemplateManager. . . . . . . .setWHEREClause. . . . . . . . . . . . . . . . . . . . . . . . . . . . .setLabel . . . . 257 . . . 258 . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . . . . TemplateManager. . . . 256 . . . . . . . . . . . 254 . . . . . . TemplateManager. . .TemplateManager. .getTemplateWidth . . . . . . TemplateManager. TemplateManager. . TemplateManager. . . . . . . . . . . . 249 . . . . . . . . . . . . . . . . . . TemplateManager. TemplateManager. . . . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . .setFormula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .setReportAuthor .setParamProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TemplateManager. 255 . . . . TemplateManager. . 254 . . . . . . . . . . . .hasEmbeddedDatasource TemplateManager. . . . . 254 . . . . . . TemplateManager. . . . . . . . . . .setDataField . . . . . TemplateManager. . . . . . . . . . . . . . . . . . . . . . .

system integrators. securities. nodownload option Supporting standard browsers means there is no need to support installations of plug-ins for hundreds of thousands of users Provides template-based design and display Ability to support a million hits per day per CPU Open security directory integration and page security Compromising information display because of lack of integrated tools Exploding use of web-based content delivery Delivering personalized secure information Introduction xiii . Actuate’s customer list includes commercial banks. telecom.Business customers use Actuate® e.Introduction About Actuate e. insurance. high tech. . Challenge Delivering high resolution information Viewing structured content Actuate solution DHTML provides a fast. financial services.Reporting Suite 5 Actuate is the leading provider of information delivery solutions for e.Business. internet.com.Business sites for information delivery face challenges. and federal government. e.Reporting Suite 5 offers the following solutions. OEMs. Actuate takes web reporting to the next level by providing options for needs as varied as seamless personalized web pages and traditional online and printed reports. and others building e. global 2000.Reporting Suite 5 to develop and deploy high resolution structured content to hundreds of thousands of users. Actuate e.

Challenge Reusing existing integrated content Maintaining data integrity on hard copy Transferring information into other applications

Actuate solution Open server provides access to content from other applications PDF provides high-resolution printed copy XML output provides access to data across applications

Actuate tools and reports do the following:
s s s

Solve complex data access problems. Solve formatting problems that go beyond the scope of other tools. Scale to support hundreds of thousands of users.

The following summary describes the products in Actuate e.Reporting Suite 5. Product name Actuate e.Report Designer Professional Use An object-oriented application used by professional developers of structured content to design, build, and distribute report object designs for delivery on the Web. The Actuate Basic Language and Actuate Foundation Class Library support extensive customization capabilities. Actuate ActiveX Controls embed Actuate reporting functionality into custom applications. Actuate Requester API accesses attributes and values of report parameters, changes the values of report parameters, controls how and when a report is generated, displays and prints reports, and configures report print setup. Access the Requester API using Actuate Basic, Visual Basic, C, or C++. Actuate search extension API supports developing search extensions to transfer data to any third-party productivity or analysis tool.

Actuate SDK (Software Development Kit) included as part of Actuate e.Report Designer Professional

xiv

e.Repor t Designer API Java Edition

Product name

Use Actuate report server API implements common Report Encyclopedia tasks, integrates report server features into existing corporate applications, automates routine or time-consuming tasks, and implements new feature groupings for custom business processes. Access the report server API using C++. Actuate Report Server Security Extension supports the use of third-party security tools. Actuate archive driver supports the use of third-party archiving software and hardware.

Actuate e.Report Designer

An application that complements e.Report Designer Professional and is used by business users to design and distribute a variety of reports. These reports require no programming. This application supports both modifying complex reports and using sophisticated components from libraries. A report development application used by Java developers to design and distribute a variety of reports. 100% Java compliant, the e.Report Designer Java Edition includes both AWT and Swing APIs. A server application that generates Live Report Documents, manages them in the Report Encyclopedia®, and makes them available to users. This product includes Actuate Administrator Desktop, an application for system and network administrators to manage and control one or more Actuate report servers. This product also includes Actuate ReportCast™ that transforms the Report Encyclopedia into a dynamic, secure web site. ReportCast provides the foundation for Channels and seamless integration with other web sites.

Actuate e.Report Designer Java™ Edition

Actuate e.Reporting Server

Introduction

xv

Product name Actuate e.Reporting Server Java™ Edition

Use A server application that generates Live Report Documents developed using the Actuate e.Report Designer Java Edition, manages them in the Report Encyclopedia®, and makes them available to users. This product includes Actuate Administrator Desktop, an application for system and network administrators to manage and control one or more Actuate report servers. This product also includes Actuate ReportCast™ that transforms the Report Encyclopedia into a dynamic, secure web site. ReportCast provides the foundation for Channels and seamless integration with other web sites. A server application designed to work exclusively with Progress databases that generates Live Report Documents, manages them in the Report Encyclopedia®, and makes them available to users. This product includes Actuate Administrator Desktop, an application for system and network administrators to manage and control one or more Actuate report servers. This product also includes Actuate ReportCast™ that transforms the Report Encyclopedia into a dynamic, secure web site. ReportCast provides the foundation for Channels and seamless integration with other web sites. An application that adds two capabilities to the basic e.Reporting Server, open server and page security. Open server supports the use of thirds party report generators with the Actuate e.Reporting Server. Page security supports personalized s viewing of parts of reports for various users

Actuate e.Reporting Server Progress Edition

Actuate Advanced e.Reporting Server

xvi

e.Repor t Designer API Java Edition

Product name Actuate Advanced e.Reporting Server Progress Edition

Use An application designed to work exclusively with Progress databases that adds two capabilities to the basic e.Reporting Server, open server and page security. Open server supports the use of thirds party report generators with the Actuate e.Reporting Server. Page security supports personalized s viewing of parts of reports for various users An application used to transform data from an Actuate e.report into interactive information. Users can view and analyze data to determine relationships and trends. Actuate e.Analysis is an optional product that installs with ReportCast and the e.Reporting Server and extends its functionality. An application used by end users to request, generate, view, and print report documents. The ReportQuery™ capabilities enable seamless transfer of data from an Actuate report to any productivity tool or analysis tool. Application for end users to find, view, and print report documents. The ReportQuery™ capabilities are also part of the Actuate Viewer. Application for end users that works with both Microsoft Internet Explorer and Netscape Navigator to support report viewing and printing on the Web.

Actuate e.Analysis

Actuate End User Desktop

Actuate Viewer

Actuate Live Report Extension (LRX)

Actuate Viewer and Actuate Live Report Extension (LRX) are included with all products except Actuate e.Report Designer Java Edition.

Introduction

xvii

About e.Reports Designer API Java Edition
The Actuate e.Reports Designer API Java Edition reference provides information for using the methods found in the Actuate e.Reports Designer API. The e.Reports Designer API Java Edition includes the following chapters: Introduction. This chapter provides an overview of this guide, the Actuate e.Report Designer Java Edition documentation, and the typographical conventions used. Chapter 1. Class hierarchy. This chapter provides a tutorial for designing sample reports. Chapter 2. Serialized objects. This chapter explains the basic report design process. It introduces templates, the report explorer, zones, report layout, and launching reports. Chapter 3. Class summary. This chapter discusses formatting options, control properties, and web links. Packages com.actuate.ereport. designer.ACJDesigner through com.actuate.ereport. engine.TemplateManager. These chapters describe the classes and methods in the API.

About Actuate e.Report Designer product
Actuate e.Report Designer documentation includes printed manuals, an installation guide, online help, user documentation in PDF format, and release notes. Information about the product that could not be included before the book printing deadline is in the release notes. The Actuate web site, http://www.actuate.com, contains late-breaking news about the product and its features, as well as product update information. To obtain the password necessary to access the portion of the web site available only to customers, telephone Actuate Customer Support. The engineers in Actuate Customer Support can also help you with technical questions about the product according to your service contract. The Customer Support telephone number, fax number, and e-mail information can be found among the printed materials in the product box. Actuate e.Report Designer Java Edition includes a Demofolder that contains numerous report examples. The documentation discusses a number of these sample reports folders.

xviii

e.Repor t Designer API Java Edition

The printed and online documentation includes the following manuals. For information about Installation and upgrading Configuring an EJB sample application with Sun J2EE Configuring an EJB sample application with Silverstream Late-breaking information about the software and documentation Overview of Actuate reporting concepts How to build your first report How to design reports using the graphical user interface Basic data source connection Using the APIs Overview of classes Database reporting Server solutions See the following Installation and upgrading guide Configuring the EJB Sample Application with Sun J2EE 1.2.1 Configuring and running the EJB Sample Application with Silverstream 3.7 Release notes

Designing e.Reports Java Edition

Programming e.Reports Java Edition

Using the Swing and AWT APIs
e.Report Designer API Java Edition

Introduction

xix

Open the introductory . Actuate ReportCast. Online help Actuate products provide both context-sensitive online help about the product and report-specific online help about the report you are viewing. not the topic. The items in the table of contents and the page numbers in the index both contain links to the appropriate topics in the text. we provide HTML help files.Reporting Server. For products without a Windows interface. such as the various versions of Actuate e.Analysis. The window on the right displays the contents of the online help topics.Reporting Suite makes it possible for developers to create customized reportspecific online help.Repor t Designer API Java Edition .Reporting Suite help system. Using the Actuate online help system Use two windows to access and view information in the e. Actuate e. The window on the left displays the table of contents or the index of the online help system. xx e. you access the link by positioning your cursor over the page number. These files can be viewed with standard browsers. In the index.For information about Terminology map Glossary See the following Actuate Glossary Online documentation The information in the printed manuals is also available as online books in Adobe Acrobat PDF format and in the online help system for the Actuate products.Report Designer Java Edition. The HTML files install automatically with the product. Using online manuals The online manuals install automatically with the product. and Actuate e. Actuate e. you can also find those files in the Manuals directory.PDF file to get an overview of the manuals. On the product CD.

For example. you see the introduction to the documentation for the e. The Table of Contents provides an overview of the help file contents.The following illustration shows the result of the search as it appears in the window on the right. The Search tab accesses any word in the help files. and Search. Use these tabs to switch views among the Table of Contents. Index.Choose Contents to view a list of help topics Choose Index to view a list of help topics Choose Search to access any word in help files The tabs at the top of the left window access different views. Use the Index tab to view the topics Select a topic to search the Index Select a topic from the search results To view the topic double-click the topic in the list.Reporting Server product. Introduction xxi . The following two illustrations show an example of the Index and the result of an Index search. The topic displays in the window on the right. in the preceding window.

Use the Search tab to find all instances of a keyword in the help files. where file names are case sensitive Example Dim As String Detail. Typographical conventions The following table describes the typographical conventions used in this guide. The topics containing the keyword appear under Search.Repor t Designer API Java Edition . templates. Double-click a topic in the Search list to display the topic in the right window. Except e.roi xxii e. Report Designer Java Edition. Item Code examples File names Convention Sans serif Initial letter capitalized. The following illustration shows the results of a search for the keyword.

Symbol [] <> {} Description Optional item Argument you must supply Groups two or more mutually exclusive options or arguments Separates mutually exclusive options or arguments in a group Example [Alias<alias name>] <expression to format> {While | Until} | Exit {Do | For | Function | Sub} Introduction xxiii . Separated from main menu item with small arrow Sans serif Example Ctrl+Shift Menu items Submenu items File File➛New User input or user response M*16* Syntax conventions The following table describes the symbols used to present the syntax. No bold.Item Key combination Convention A + sign between the keys means to press both keys at the same time Capitalized.

Repor t Designer API Java Edition .xxiv e.

Chapter 1 Chapter 1 Class hierarchy This chapter contains the following topics: s s Hierarchy for all packages Differences between the AWT and SWING API Chapter 1. Class hierarchy 1 .

java.actuate.OD_DHTML (implements com.ereport.AppDataHandler (implements com.awt.datasrcmgrs.actuate.output.datasrcmgrs.R epor t D esigner API Java Edition .Serializable) class javax.ACJOutputProcessor class java. ejbdatasrc.ereport.ACJEngine class com.awt.actuate.engine.actuate.ereport.io.ereport.swing.ItemListener.actuate.output. java.swing.OD_HTML (implements com.Serializable) class com.ereport.lang.Serializable) class java.Object class com.ereport. javax.IDataSource.jdbcdatasrc.actuate.awt.MetaDataHandler (implements com.actuate. java.actuate.engine.ereport.MetadataAdapter (implements com.ereport.ereport.awt.ActionListener.ereport.engine.Component (implements java.metadatasrc.ereport.Hierarchy for all packages Class hierarchy The following overview summarizes the available classes.output. class java.IDataSource) class com.io.ereport.appdatasrc.engine.actuate.JDBCHandler (implements com.ereport.image.accessibility.event.datasrcmgrs.IMetaData) class com.IDataSource) class com.awt.ACJDesigner (implements java.ereport.awt.engine.actuate.event.io.WindowListener) class com.datasrcmgrs.actuate.output.engine.actuate.datasrcmgrs.IOutputFormat) class com.EJBDataHandler (only in Swing) class com.Accessible) class com. java.MenuContainer.actuate.IOutputFormat) class com.engine.swing.event.Container class javax.actuate.actuate.JPanel (implements javax.ImageObserver.actuate.actuate.ASCIIDataHandler class com.ChangeListener.output. asciidatasrc.event.TemplateManager 2 e.awt.ereport.JComponent (implements java.ereport.designer.ereport.actuate. java.ereport.

AppDataHandler In the SWING API. passTableData and registerDataSet take the second argument as a Vector.actuate.actuate.Report Designer Java Edition API for AWT does not. Memory requirements increase as the size of your data and report increases. Class hierarchy 3 .Report Designer Java Edition API for Swing and for AWT: s The e. s s s s s s The following describes the differences between e.ereport. The e.Report Designer Java Edition API for Swing does not work with JDK 1.datasrcmgrs.Report Designer Java Edition API for AWT is based on the AWT user interface libraries. a Vector extends Collection.Report Designer Java Edition API for Swing supports the EJB data source. The e.appdatasrc. passTableData and registerDataSet take the second argument as a Collection.Report Designer Java Edition API for Swing is based on the Swing user interface libraries. The e.6 and higher.IObjectTable interface com.x.ereport. the e.Report Designer Java Edition API for AWT works with Java 1.2 and higher. Chapter 1.Report Designer Java Edition API for AWT requires a minimum of 32 MB.Report Designer Java Edition API for Swing requires a minimum of 64 MB of RAM to run.datasrcmgrs. e.appdatasrc. Memory requirements increase as the size of your data and report increases.Report Designer Java Edition API for Swing works with JDK 1.1. In Java 2.1.Iterator Differences between the AWT and SWING API The following are the differences between e. The e. The e.Interface Hierarchy The following overview summarizes the public interfaces: interface com.Report Designer Java Edition API for Swing and AWT. In the AWT API. The e.

there are two methods called setPageMargins(). In the SWING API. there is only one method called setPageMargins(). In the SWING API. one of the constructors takes the first argument as a java.Frame. ACJEngine The AWT and SWING API are the same. In the AWT API. 4 e. TemplateManager In the SWING API. there is an additional method getRegdEJBDataHandler().R epor t D esigner API Java Edition . MetaDataHandler The AWT and SWING API are the same.ASCIIDataHandler The AWT and SWING API are the same. EJBDataHandler The class is present only in the SWING API. the left.JFrame. The second method in AWT takes 4 double arguments. top and bottom margins of the page. JDBCDataHandler The AWT and SWING API are the same. In the AWT API. ACJDesigner In the SWING API.awt. one of the constructors takes the first argument as a javax.swing. there is an additional method setDefaultLookAndFeel. right.

PrintJob.ACJOutputProcessor In the SWING API.Panel.print. the generatePRINTOUT() methods return java. the generatePRINTOUT() methods return a java.awt. Chapter 1. In the AWT API. Class hierarchy 5 . getPreviewDevice() returns javax.JPanel.awt. In the SWING API. getPreviewDevice() returns a java. In the AWT API.awt.swing.PrinterJob.

6 e.R epor t D esigner API Java Edition .

Chapter 2. Serialized objects 7 .Chapter 2 Chapter 2 Serialized objects This chapter lists the available serialized objects.

Vector vDSM showMem boolean showMem rels com.swing.ereport.OD_Preview prv bAutoWhere boolean bAutoWhere bAutoOrder boolean bAutoOrder bPrependSchema boolean bPrependSchema bLowercaseQuotes boolean bLowercaseQuotes 8 e. Serialized fields activeIDS com.JTabbedPane tp erwD com. designer.actuate.relationships.ereport.GuiTemplate erwD erw ACJEngine erw vDSM java.actuate.util.ereport.ereport.actuate.actuate.Class com.IDataSource activeIDS tp javax.ACJDesigner Class ACJDesigner implements Serializable.designer.engine.R epor t D esigner API Java Edition .ereport.actuate.designer.output.Relations rels prv com.

String sFileSeparator opd com.swing.JCheckBoxMenuItem cbmiPP oe ACJOutputProcessor oe menuBar javax.ereport.lang.iBlank javax.String sCurrentWorkingDirectory sFileSeparator java.lang.ImageIcon iBlank doPreviewReset boolean doPreviewReset exitMode int exitMode miExit javax.JMenuItem miExit cbmiPP javax.swing.designer. Serialized objects 9 .swing.JMenuBar menuBar mru java.String sDocFile sCurrentWorkingDirectory java.lang.swing.OutputPropDlg opd bProcessingOutput boolean bProcessingOutput doItemStateChanged boolean doItemStateChanged isDesign boolean isDesign Chapter 2.lang.actuate.String[] mru sDocFile java.

Cursor cWait cDefault java.Cursor cDefault 10 e.actuate. cWait java.awt.Frame fr c int c hasBeenGenerated boolean hasBeenGenerated Indicates that the On switching to preview the report has to be refreshed.awt.Repor t Designer API Java Edition .awt.SplashScreenThread st fr java.designer.st com.ereport.

Serialized fields vR java.appdatasrc.util.ereport.Class com.Vector vR bDisplay boolean bDisplay startRecNo int startRecNo endRecNo int endRecNo bAllowMultipleTablesForSameClass boolean bAllowMultipleTablesForSameClass Used for ASCIIDataSource where only one class (GenericTable) is used to register multiple tables. datasrcmgrs. AppDataHandler Class AppDataHandler implements Serializable. Chapter 2.actuate. Serialized objects 11 .

ereport.lang.util.actuate.String propertiesFileName tableName java.Repor t Designer API Java Edition . datasrcmgrs. Serialized fields tableRecords java.lang.String tableName pp com.ereport.util.String fileName propertiesFileName java.datasrcmgrs.asciidatasrc.ereport.datasrcmgrs.asciidatasrc.Vector vPropertiesOfAllTables fp com. ASCIIDataHandler Class ASCIIDataHandler implements Serializable.asciidatasrc.Vector tableRecords fileName java.actuate.Class com.lang.PropertyFileParser pp vPropertiesOfAllTables java.actuate.FileParser fp 12 e.

datasrcmgrs.util. datasrcmgrs.String sContextFactory iRemoteApp com.lang.Hashtable htIC sRemoteAppJNDIName java. Serialized objects 13 .EJBAppRI iRemoteApp Chapter 2.ejbdatasrc.Hashtable htColAccessors htIC java.String sRemoteAppJNDIName sContextFactory java.lang. EJBDataHandler Class EJBDataHandler implements Serializable.ereport.actuate. Serialized fields htColAccessors java.util.Class com.ejbdatasrc.actuate.ereport.

Repor t Designer API Java Edition .14 e.

fields. Chapter 3.Chapter 3 Chapter 3 Class summary The following summary is a list of available classes. Class summary 15 . methods. and variables with their descriptions.

actuate.ereport.actuate.ACJDesigner class com.ereport.ACJDesigner Notification received when a menu item is selected. boolean. ACJOutputProcessor class com. ACJDesigner() Constructor for class com.ACJDesigner An empty constructor. ACJEngine() Constructor for class com. Note that this function should be called only after authentication of login information.actuate. ACJEngine class com.ereport.ACJDesigner Registers a single data source. ACJEngine.output.designer.Repor t Designer API Java Edition .output.ACJOutputProcessor The default constructor.ereport.ereport.ACJOutputProcessor This class provides APIs for generating the report output from the template file.actuate.ereport.ereport.actuate. ACJOutputProcessor() Constructor for class com.designer.actuate.Report Designer Java Edition.actuate.ACJEngine This class forms the heart of the reporting engine. Created for backward compatibility.designer.actuate.engine.ACJEngine The default constructor creates an instance of the report engine and initializes it by calling newSystem() internally.ereport.designer. addDataSource(IDataSource) Method in class com. ACJDesigner(JFrame. 16 e. boolean) Constructor for class com.actuate.ACJDesigner The default constructor.engine.designer.ACJDesigner This class represents the outermost shell of the Template Designer used by e. actionPerformed(ActionEvent) Method in class com.ereport.

ereport.metadatasrc.ejbdatasrc.ereport.jdbcdatasrc.EJBDataHandler Adds a single remote table entry data set that contains all records for a single table. allStoredObjectsCallable() Method in class com. accessories.ACJDesigner Installs any additional fonts required in the font dialog box.actuate. ALIAS Static variable in class com. String) Method in class com.ejbdatasrc.datasrcmgrs. addTableDefinition(String. String[]) Method in class com.ereport.actuate.datasrcmgrs. Vector) Method in class com.JDBCHandler AppDataHandler class com.ereport. including columns.actuate.ACJDesigner Updates the list of MRU files in the menu structure with a filename to be inserted at a specified index.AppDataHandler Allows tables to be registered using the same class. Chapter 3. and so on.actuate.actuate.datasrcmgrs.actuate.jdbcdatasrc. Vector) Method in class com.JDBCHandler allowMultipleTableRegistering(boolean) Method in class com.designer.actuate.ereport. addTable(TableDescriptor. Returns True if successful.AppDataHandler The main class that implements the interface between ACJEngine and an application data source. addTableData(String.actuate.addExternalFont(String) Method in class com.datasrcmgrs.designer. Class summary 17 .appdatasrc.datasrcmgrs.ereport.actuate. False if a hashtable key collision occurs.ereport.EJBDataHandler Adds a single local or remote table entry definition that describes the entire table.ereport.ereport.appdatasrc.MetaDataHandler Sequentially adds one table with all associated columns to the metadata layer. addMruFile(int.datasrcmgrs.datasrcmgrs. Class.

Repor t Designer API Java Edition .actuate.datasrcmgrs.datasrcmgrs.ASCIIDataHandler clearMetaData() Method in class com.AppDataHandler() Constructor for class com.actuate. checkIfExists(String) .ereport.asciidatasrc.output. changeID(Object.TemplateManager Changes the existing control ID to the new ID.ereport. a template with an embedded data source attempts to connect to that data source and updates the active data source reference in the engine.ASCIIDataHandler autoConnectDatasource(boolean) Method in class com.ASCIIDataHandler This class is used to register the extracted ASCII data from a specified data file.ACJOutputProcessor 18 e.Static method in class com.ereport.actuate.asciidatasrc.ereport.output.actuate.actuate.ereport. ASCIIDataHandler() Constructor for class com.ACJEngine If this flag is set to True.ACJOutputProcessor closeZipStream(ZipOutputStream) Static method in class com.ereport.EJBDataHandler closeZipEntry(ZipOutputStream) Static method in class com.engine.datasrcmgrs.appdatasrc.actuate. Object) Method in class com.actuate.ejbdatasrc.datasrcmgrs.actuate.datasrcmgrs.metadatasrc.asciidatasrc.engine.actuate.actuate.ereport. clearSchemaAndData() Method in class com.ereport.datasrcmgrs.MetaDataHandler Removes all tables and all associated columns from the metadata layer.ereport.ereport.AppDataHandler The default constructor ASCIIDataHandler class com.

and zone IDs contained inside the entire template based on a filter criteria specified by boolean variables.appdatasrc.JDBCHandler Connects to the JDBC data source using the driver. It is not implemented for MetaDataHandler because MetaDataHandler does not require an active data source connection.datasrcmgrs.actuate. Class summary 19 .metadatasrc.ASCIIDataHandler This constructor is used internally. boolean.actuate.datasrcmgrs.actuate.actuate. connect() Method in class com. boolean.JDBCHandler Deprecated as of ACJEngine 3.datasrcmgrs. String. An application data source does not require a connection the way a JDBC data source does.actuate.MetaDataHandler This method is required to connect to a data source.ereport.ereport.asciidatasrc.jdbcdatasrc.engine.ereport. boolean. URL.ereport.jdbcdatasrc. username and password. boolean.ereport.0.datasrcmgrs. Chapter 3. boolean) Method in class com.actuate.ASCIIDataHandler Constructor used to initialize the ASCII data source.AppDataHandler Not used. String. connect() Method in class com.datasrcmgrs.asciidatasrc.datasrcmgrs.ereport.actuate.ereport. connect() Method in class com.TemplateManager Returns a set of control IDs. connect(ACJEngine. boolean. connect(ACJEngine.collapseTemplate(boolean. section IDs. Vector) Method in class com. String) Method in class com. boolean. Connect() Method in class com. boolean.

ereport.jdbcdatasrc. String.TemplateManager dbconnection Variable in class com. boolean) Method in class com.TemplateManager Creates a new control with the specified ID and the specified parent. String.ereport.actuate. Connect(Connection. String.ereport.ereport. String.jdbcdatasrc.actuate. Connect(String.actuate. String.engine. connect(String.0.JDBCHandler Deprecated as of ACJEngine 3.ereport.actuate.TemplateManager Attempts to connect to the data source embedded in the template. createRuntimeParams() Method in class com.actuate.jdbcdatasrc.JDBCHandler Deprecated as of ACJEngine 3.ereport.actuate.ereport.engine. Object) Method in class com.datasrcmgrs.ereport. createControl(Object.JDBCHandler Passes an existing connection and specifies whether all tables are to be extracted.engine.TemplateManager Creates a generic control and returns a handle to it.Repor t Designer API Java Edition .datasrcmgrs.actuate.connect(Connection. boolean) Method in class com.JDBCHandler Connects to the JDBC data source.jdbcdatasrc.actuate.ereport.ereport. String.engine. createControl(Object) Method in class com.datasrcmgrs.datasrcmgrs. boolean) Method in class com. boolean) Method in class com. connectToDatasource() Method in class com.actuate.0.datasrcmgrs.JDBCHandler 20 e. connectToRemoteApp(String) Method in class com.ejbdatasrc.datasrcmgrs.jdbcdatasrc.actuate.EJBDataHandler Initializes the system by connecting to the remote EJB application.

jdbcdatasrc.ereport.ereport.actuate.ACJEngine A boolean variable used for internal debugging.datasrcmgrs.ereport. debugMessageLN() Static method in class com.ereport.jdbcdatasrc.actuate.ACJEngine This function is used internally for debugging.JDBCHandler Used internally for debugging.engine.jdbcdatasrc.JDBCHandler Used internally for debugging.datasrcmgrs. debugMessageLN() Static method in class com.DEBUG Variable in class com.ereport.actuate.ereport.actuate.ACJEngine This function is used internally for debugging.ereport. debugMessage(String) Static method in class com.designer.JDBCHandler Used internally for debugging. debugMessageLN(Object) Static method in class com.actuate. Class summary 21 .ACJEngine This function is used internally for debugging.ACJDesigner Used internally.actuate.actuate.engine. Chapter 3. debugMessageLN() Static method in class com.ereport. debugMessageLN(String) Static method in class com.datasrcmgrs.designer. debugMessage(Object) Static method in class com.engine.actuate. debugMessage(String) Static method in class com.ereport.ACJDesigner Used internally.engine.actuate.

destroyTemplate() Method in class com.ACJEngine Used internally.actuate.datasrcmgrs.datasrcmgrs.MetaDataHandler This method is required to disconnect from a data source.actuate.JDBCHandler Deprecated as of ACJEngine 3.ereport.actuate.designer.debugMessageLN(String) Static method in class com.AppDataHandler Not used.ereport.jdbcdatasrc.Repor t Designer API Java Edition .ereport.actuate.ereport.engine.output. An application data source does not require a connection the way a JDBC data source does.engine.jdbcdatasrc.datasrcmgrs.appdatasrc.metadatasrc.actuate.actuate.ereport.0. disconnect() Method in class com. debugOutputProps() Method in class com.actuate.ereport. 22 e. disconnect() Method in class com.ACJOutputProcessor Undocumented feature.actuate. disconnect() Method in class com. disconnect() Method in class com.ACJEngine This method was called internally by the engine in previous releases of ACJEngine. Disconnect() Method in class com.TemplateManager Use this method to cleanly destroy any template that may be loaded into the Template Manager.JDBCHandler Disconnects from the data source.ereport.datasrcmgrs.ereport. It is not implemented for MetaDataHandler because MetaDataHandler does not require an active data source connection.

ACJDesigner driver Variable in class com.jdbcdatasrc.actuate.engine.datasrcmgrs.ereport.metadatasrc. fetchData(String.ACJEngine Returns the availability of the X11 Gfx subsystem when performing internal validations.ereport.EJBDataHandler EJBDataHandler() Constructor for class com.datasrcmgrs.ereport. iStart is currently not used and will be supported in a future version.ejbdatasrc.actuate.JDBCHandler DriverName Variable in class com.appdatasrc.datasrcmgrs.actuate.datasrcmgrs.designer.actuate.datasrcmgrs. Chapter 3.actuate. String.jdbcdatasrc.JDBCHandler fetchData(String.actuate.ereport.JDBCHandler EJBDataHandler class com. int) Method in class com.ereport.datasrcmgrs.ejbdatasrc.jdbcdatasrc.EJBDataHandler exportAsMetadata(Component.actuate. Returns Null.ereport. int.JDBCHandler Returns a result set containing all data for a specified table and column for iCount objects. Vector) Method in class com. IDataSource.actuate. int.ejbdatasrc.datasrcmgrs.EJBDataHandler EJBDataHandler(String) Constructor for class com.datasrcmgrs.doesX11GfxExist() Static method in class com.actuate.actuate. int) Method in class com. DatabaseMetaData.jdbcdatasrc.ereport.ereport.ereport.ereport.datasrcmgrs.actuate.MetaDataHandler extractRelations(Component. String. OutputStream.ereport. doPreviewReset Variable in class com.AppDataHandler Not used. Vector) Static method in class com. Class summary 23 .

generate(VirtualOutput. Properties) Method in class com. Use setCSVProperty() / generateCSV() instead.actuate.ACJOutputProcessor Generates a DHTML report using the properties individually set by the setDHTMLProperty() method.actuate. finalizeEngine() Method in class com.ereport. String.ereport.ereport.MetaDataHandler This function is reserved for future versions of ACJEngine.output.ACJOutputProcessor Deprecated.output.actuate.ACJOutputProcessor Deprecated. generateCSV(Object.output.output.actuate.ACJOutputProcessor Generates a CSV report using the properties individually set by the setCSVProperty() method.actuate. Component.fetchData(String.metadatasrc. int) Method in class com. Use setCSVProperty() / generateCSV() instead.datasrcmgrs.ereport.output.ereport.actuate.actuate.ereport.OD_HTML This is an interface call substituted in place of generateHTML function in OD_Preview so all the parameters specific to generateHTML call are embeded into parameters vector.ACJEngine generate(VirtualOutput.OD_DHTML This is an interface call substituted in place of generateHTML function in OD_Preview so all the parameters specific to generateHTML call are embeded into parameters vector. int. String) Method in class com. ProgressInterface.ereport. generateDHTML() Method in class com. generateCSV(Object. 24 e. generateCSV() Method in class com.output. String.actuate. ProgressInterface.ereport.engine. Component. Properties) Method in class com. String) Method in class com.Repor t Designer API Java Edition .

actuate. Also transmits other properties as set by setEMAILProperty(). boolean) Method in class com.generateDHTML(Object.actuate.output.ereport. Use setHTMLProperty() / generateHTML() instead. Component. boolean.ereport.ACJOutputProcessor Deprecated. boolean) Method in class com.output. generateHTML(Object.actuate. boolean. Component. boolean) Method in class com. boolean. JOI is a raw ACJEngine data file that lets users create report executables. Use setDHTMLProperty() / generateDHTML() instead. Use setHTMLProperty() / generateHTML() instead.ACJOutputProcessor Exports the current report to a JOI file specified by the argument.ACJOutputProcessor Generates a JOI report using the properties individually set by the setJOIProperty() method. generateMainFrameSet(Object) Method in class com. boolean.ereport. generateHTML(Object. boolean.ereport.output. boolean. Component.ACJOutputProcessor Deprecated.ereport.output.ACJOutputProcessor Transmits the listed set of emails to the recipients via an SMTP server. Use setHTMLProperty() / generateHTML() instead.actuate.ACJOutputProcessor Generates an HTML report using the properties individually set by the setHTMLProperty() method. generateEMAIL() Method in class com. boolean. Component. boolean. generateJOI(String) Method in class com.actuate.ACJOutputProcessor Deprecated. Class summary 25 . generateHTML() Method in class com.ereport.output.actuate.ereport.ereport.ereport.actuate.output.OD_HTML Chapter 3.output.ACJOutputProcessor Deprecated.actuate. generateJOI() Method in class com.actuate. boolean) Method in class com. generateHTML(Object. boolean.output.output. boolean. boolean. boolean.

Use setPDFProperty() / generatePDF() instead.output.ereport. Use setPDFProperty() / generatePDF() instead.ACJOutputProcessor Deprecated. boolean) Method in class com.Used to generate the main container page for reports containing TOC. Use setPDFProperty() / generatePDF() instead.ereport.ereport. Component. boolean.OD_DHTML Used to generate the main container page for reports containing TOC.output.ACJOutputProcessor Deprecated.ereport.actuate.ereport. boolean) Method in class com. generatePDF(Object.output.actuate. generateMainFrameSet(Object) Method in class com.ACJOutputProcessor Deprecated.ereport. PrinterJob.output. Use setPRINTERProperty() / generatePRINTOUT() instead.ereport.ACJOutputProcessor Generates a PDF report using the properties individually set by the setPDFProperty() method.ereport. int. int. int) Method in class com.ACJOutputProcessor Deprecated. generatePDF() Method in class com. int. boolean) Method in class com. generatePDF(Object. generatePDF_Ex(Object. Component) Method in class com. generatePRINTOUT(boolean.actuate. Component. generatePDF(Object. Component.output.actuate. generatePRINTOUT() Method in class com. generatePDF_Ex(Object. Use setPDFProperty() / generatePDF() instead.actuate. int.output.output.actuate.ACJOutputProcessor Prints a hard copy of the report using properties individually set by setPRINTERProperty().actuate.actuate. 26 e.ACJOutputProcessor Deprecated.ACJOutputProcessor Deprecated. boolean) Method in class com. Component. int.ereport.actuate.output.output.Repor t Designer API Java Edition . boolean. Use setPDFProperty() / generatePDF() instead.

boolean. Chapter 3.ereport.actuate.engine. Component) Method in class com.actuate.ereport.ACJEngine Generates report and returns the IViewerInterface instance required by ACJOutputProcessor.ereport. getAlignment(Object) Method in class com. PrinterJob.OD_DHTML Writes the Table Of contents if specified to the Html file getActiveDataSource() Method in class com.actuate.output. It calls this method to handle the formatting and writing of controls to the output stream generateReportPage(Object) Method in class com.designer. generateReportPage(Object) Method in class com.OD_HTML Writes the Table Of contents if specified to the Html file generateTOCPage(Object) Method in class com.actuate. getBounds(Object) Method in class com. boolean.output. Use setPrinterProperty() / generatePRINTOUT() instead.actuate.ereport.ACJOutputProcessor Deprecated.actuate.output.generatePRINTOUT(boolean.ereport.ACJDesigner Returns the active selected data source for data extraction.engine. Class summary 27 .OD_HTML Once the generate method successfully creates and instantiates the data stream.actuate.ereport.TemplateManager Returns the text alignment property of the control.ereport.actuate.actuate.output.TemplateManager Returns the width and height of a control. generateReport() Method in class com.ereport.engine. It calls this method to handle the formatting and writing of controls to the output stream generateTOCPage(Object) Method in class com.OD_DHTML Once the generate method successfully creates and instantiates the data stream.ereport.output.

ereport. getColumns() Method in interface com.asciidatasrc.appdatasrc.actuate.JDBCHandler Returns the default catalog associated with the JDBC connection.designer. getCatalogName() Method in class com. String) Method in class com.ereport.actuate.jdbcdatasrc.actuate.datasrcmgrs.getCatalogName() Method in class com.Repor t Designer API Java Edition .appdatasrc.ereport.ACJDesigner Returns an instance of ACJOutputProcessor used by ACJDesigner.ASCIIDataHandler Counts the number of columns having the same data type.AppDataHandler Not used.ereport.metadatasrc.datasrcmgrs.jdbcdatasrc.datasrcmgrs.datasrcmgrs.ereport.JDBCHandler Returns a vector with all the column names of the table name that is passed to the method. Used internally. getColumnNames(String) Method in class com. getClient() Method in class com.datasrcmgrs.actuate.ereport.datasrcmgrs.appdatasrc. getCatalogName() Method in class com.ereport.actuate.IObjectTable This method returns the list of the fields or methods representing columns in a table.ereport.datasrcmgrs.AppDataHandler Returns a vector of column names that have been registered for the specified table name. getColumnCount(Vector. Returns Default Catalog.actuate. getColumnNames(String) Method in class com. 28 e.actuate.actuate.MetaDataHandler Returns the name of the catalog for the data source structure.

output.actuate. getCurrentPropertiesAsString() Method in class com.datasrcmgrs. getCommunicationStub() Method in class com.ereport.engine.datasrcmgrs.actuate.ACJEngine When generating the report.engine.ereport. Class summary 29 .TemplateManager Returns a string in table.ereport.actuate. getDataSource() Method in class com.ereport.metadatasrc.JDBCHandler getContextFactory() Method in class com.jdbcdatasrc.EJBDataHandler getCSVProperty(String) Method in class com.asciidatasrc.getColumnNames(String) Method in class com. data is returned for a specified column in the Current Tuple in the result set structure represented by ITable. getConnection() Method in class com.datasrcmgrs. Object) Method in class com.ereport.datasrcmgrs.ACJEngine Returns an implementation of the IViewerInterface.ASCIIDataHandler getCurrentTableSelection() Method in class com.ereport.actuate.ereport.jdbcdatasrc. Chapter 3.MetaDataHandler Returns the names of all columns for a specified table.actuate.JDBCHandler getDataField(Object) Method in class com.ejbdatasrc.datasrcmgrs.actuate.actuate.actuate.column format.ereport.ereport.ereport.ACJOutputProcessor Attempts to retrieve an individual property used by the CSV output device while generating a CSV report.engine.actuate.actuate.engine.ACJEngine Returns an instance of the active data source implementation that is currently registered with ACJEngine. getColValue(Object.

ereport.MetaDataHandler Returns the data type for a fully qualified column.ACJDesigner Returns the current debugMode status. getDataType(String.actuate.designer.actuate.metadatasrc.datasrcmgrs.ereport. getDebugMode() Static method in class com. getDataSources() Method in class com.engine.datasrcmgrs.AppDataHandler Returns the current debugMode status.actuate.JDBCHandler Returns the current debugMode status. getDebugMode() Static method in class com.Types equivalent data type for the specified column.ereport.actuate.actuate. String) Method in class com.ereport. getDataType(String.datasrcmgrs.AppDataHandler Returns the SQL equivalent of a primitive data type.metadatasrc. 30 e. getDebugMode() Static method in class com.JDBCHandler Returns the java.ACJEngine Returns the current debugMode status. getDataType(String.datasrcmgrs.ereport.ereport.appdatasrc.datasrcmgrs.actuate. getDebugMode() Static method in class com.ereport.ACJDesigner Returns a vector containing all registered data sources.jdbcdatasrc.ereport. String) Method in class com.actuate.getDatasourceName() Method in class com.datasrcmgrs.appdatasrc.MetaDataHandler Returns the name of the data source.Repor t Designer API Java Edition .ereport.sql.jdbcdatasrc.actuate. String) Method in class com.actuate.designer.

getDefaultValue(String.jdbcdatasrc.output.datasrcmgrs.output. Class summary 31 .appdatasrc.actuate.ereport.ACJOutputProcessor Attempts to retrieve an individual property used by the printer output device while printing a report.actuate.metadatasrc. getDriverName() Method in class com.designer.ereport.ereport.datasrcmgrs.output.actuate. getDocumentationPath() Method in class com.actuate.JDBCHandler Returns the default value for the specified fully qualified column.ACJOutputProcessor Attempts to retrieve an individual property to be used by the DHTML output device.ereport.datasrcmgrs.MetaDataHandler Returns the default value for a given column.ereport.actuate.ereport.JDBCHandler Returns the name of the active JDBC driver.datasrcmgrs.jdbcdatasrc. getEndRecordNumber() Method in class com. String) Method in class com. String) Method in class com.AppDataHandler getEndRecordNumber() Method in class com.actuate.ACJOutputProcessor Gets the path to the main documentation file.ereport.jdbcdatasrc.ereport.actuate.ACJOutputProcessor Used internally.actuate.output.datasrcmgrs.ACJDesigner Chapter 3.ereport. getDHTMLProperty(String) Method in class com.actuate.JDBCHandler getEngine() Method in class com.actuate.ereport. getDHTMLDevice() Method in class com. getEMAILProperty(String) Method in class com.getDefaultValue(String.

getGrantee(String.ACJEngine Returns the internal reference of ExprEvaluator that is required to register user-defined functions.actuate.ereport. getFillColor(Object) Method in class com.ereport.engine.ereport.ereport.actuate.datasrcmgrs. which is normally used by Java to define string formatting. getFont(Object) Method in class com.TemplateManager Returns the fill/background color of a control.engine.Repor t Designer API Java Edition .jdbcdatasrc. getEvaluater() Method in class com.TemplateManager Returns a string.engine.jdbcdatasrc.engine.metadatasrc. getFontColor(Object) Method in class com.actuate.datasrcmgrs.engine.ereport.TemplateManager Returns the formula that has been assigned to the specified control. getGrantor(String.actuate.actuate.ereport.actuate. getGrantee(String.ereport.TemplateManager Returns the color used to display the text of this control.actuate. 32 e.JDBCHandler Returns the grantee of privileges for the specified fully qualified column.engine.MetaDataHandler Returns the grantee of privileges for the specified column.actuate. getFormat(Object) Method in class com. which is an enhanced class to describe a font.JDBCHandler Returns the grantor of privileges for the specified fully qualified column. String) Method in class com. String) Method in class com.ereport.actuate.Returns the reference of ACJEngine maintained by the GUI. String) Method in class com.TemplateManager Returns a FontExt object.ereport.datasrcmgrs. getFormula(Object) Method in class com.

ACJOutputProcessor Used internally.actuate.datasrcmgrs.ereport.ereport. getImage(Object.output.output.ereport. long) except that the second argument is an Object representing the index of the image.actuate. Object) Method in class com.datasrcmgrs.actuate. getHTMLProperty(String) Method in class com.output.output.metadatasrc. long) Method in class com.ereport.OD_HTML Similar to getImage(Object. getImage(Object. Chapter 3.ereport.actuate.ereport.OD_HTML This method is used to fetch individual images from the report.OD_DHTML This method is used to fetch individual images from the report.output. Also returns “ ‘ “ when table names have spaces in them. getIdentifierQuote() Method in class com.MetaDataHandler getImage(Object. long) Method in class com.JDBCHandler Returns the identifier quote string for the specified database.datasrcmgrs.actuate.getGrantor(String.ereport.MetaDataHandler Returns the grantor of privileges for the specified column. getIdentifierQuote() Method in class com.ereport.actuate.actuate.metadatasrc.AppDataHandler Returns a " ' " as the delimiter string for special data types such as dates.actuate.appdatasrc. getIdentifierQuote() Method in class com.ereport. Class summary 33 .datasrcmgrs. getHTMLDevice() Method in class com.jdbcdatasrc. String) Method in class com.ACJOutputProcessor Attempts to retrieve an individual property to be used by the HTML output device.actuate.

ereport. getImportedSQLQuery(Object) Method in class com.actuate.ereport.actuate. getImageURL(Object) Method in class com.ereport.ereport.output. getName() Method in class com.ereport. Otherwise. getName() Method in class com.AppDataHandler Identifies the name of this data source.datasrcmgrs. getJOIProperty(String) Method in class com.actuate.actuate.actuate.designer. long) except that the second argument is an Object representing the index of the image.datasrcmgrs.engine.jdbcdatasrc.metadatasrc.ACJOutputProcessor Attempts to retrieve an individual property used by the JOI Handler when generating a JOI report.datasrcmgrs.MetaDataHandler Returns the data source name as MetaDataSource. Object) Method in class com.TemplateManager Returns the string value of this label control.ereport.getImage(Object.TemplateManager Returns the URL of the image referred to in this control.actuate.actuate.engine. 34 e.appdatasrc.actuate.ACJDesigner Returns an array of file names stored in the MRU list.OD_DHTML Similar to getImage(Object. getName() Method in class com. getLabel(Object) Method in class com.JDBCHandler Returns the name of the data source. Returns Application DataSource.Repor t Designer API Java Edition .ereport.engine.output.actuate.ereport.TemplateManager Returns the imported SQL query for the section if already set through setImportedSQLQuery. getMruList() Method in class com.ereport. returns Null.

getOutputFiles() Method in class com.actuate.ereport.TemplateManager Returns an individual property for the specified parameter ID.actuate.getName() Method in class com.actuate.engine.actuate. Chapter 3.ereport.ereport.TemplateManager Returns the current value of the ORDER BY clause in the query of the specified section. String) Method in class com. getPageWidth() Method in class com.engine.ereport.ereport. getOutputDevice() Method in class com.TemplateManager Returns the page width in inches.actuate.jdbcdatasrc.ereport.actuate. getParameterIds() Method in class com.JDBCHandler Returns the password for the active JDBC datasource connection.TemplateManager Returns the page height in inches.ereport.ereport. Class summary 35 .datasrcmgrs.ereport.TemplateManager Returns the page margins as a Bounds structure.datasrcmgrs. getParamProperty(String.actuate.ejbdatasrc.actuate.engine.ereport.output.EJBDataHandler getORDERBYClause(Object) Method in class com.engine.actuate.actuate. getPassword() Method in class com. getPageMargins() Method in class com.ACJEngine This function returns an instance of the actual IPrinter report generation interface implementation.TemplateManager Returns a list of parameter IDs using properties that can be set or retrieved. getPageHeight() Method in class com.engine.engine.engine.ACJOutputProcessor Returns a list of files generated for a structured output.

JDBCHandler Returns a comma-separated list of privileges associated with a column.jdbcdatasrc. getPrivileges(String. All publicly available APIs to control the preview device are available through ACJOutputProcessor. They are only accessible after a call to getPreviewDevice(). A handle of OD_Preview is needed before the preview device can be embedded inside a container such as a frame.ereport.ACJOutputProcessor Returns the current resolution for the printer device only when printer resolution is set through setPrinterResolution.actuate.ereport.ereport.output.MetaDataHandler Returns a comma-separated list of privileges for a column.actuate.getPDFProperty(String) Method in class com.datasrcmgrs.EJBDataHandler getPropertiesFileName() Method in class com.datasrcmgrs.metadatasrc.ASCIIDataHandler 36 e. Otherwise.datasrcmgrs.ereport.output.actuate.ACJOutputProcessor Attempts to retrieve an individual property used by the PDF output device when generating an PDF report. getProperties() Method in class com.asciidatasrc.actuate.ereport. zero is returned. getPreviewDevice() Method in class com.actuate.actuate.output. getPRINTERProperty(String) Method in class com.output.Repor t Designer API Java Edition . String) Method in class com. String) Method in class com.ACJOutputProcessor Returns an instance of the preview device. getPrivileges(String.datasrcmgrs. getPrinterResolution() Method in class com.actuate.ereport. A handle is also needed before the preview device can be controlled through the API in this class.ACJOutputProcessor Attempts to retrieve an individual property used by the printer output device when printing a report.ejbdatasrc.actuate.ereport.ereport.

ereport.actuate.datasrcmgrs.JDBCHandler getQuery(Object) Method in class com.metadatasrc.ereport.ereport.ereport. getPropertySheet() Method in class com.datasrcmgrs. This method is used internally.appdatasrc.datasrcmgrs.ereport.metadatasrc.engine. String) Method in class com.actuate.jdbcdatasrc. Class summary 37 . String) Method in class com. getQuery(Object) Method in class com.MetaDataHandler getQueryContents(Object) Method in class com.ereport.datasrcmgrs.EJBDataHandler Returns the default implementation of the EJBDataSource property sheet.jdbcdatasrc.datasrcmgrs.actuate.AppDataHandler getQueryColumns(Object. Returns Null.getPropertySheet() Method in class com.ereport. getPropertySheet() Method in class com.datasrcmgrs.datasrcmgrs.ereport.appdatasrc.JDBCHandler getQueryColumns(Object.metadatasrc.datasrcmgrs.actuate.MetaDataHandler getQueryColumns(Object.appdatasrc.actuate. getPropertySheet() Method in class com.JDBCHandler Returns an instance of the property sheet.actuate.AppDataHandler Not used.ejbdatasrc.actuate.MetaDataHandler Returns the default implementation of the metadata property sheet. Used internally.actuate.TemplateManager Chapter 3.ereport.ereport.actuate.ereport.AppDataHandler getQuery(Object) Method in class com.jdbcdatasrc. String) Method in class com.actuate.actuate.datasrcmgrs.datasrcmgrs.

WHERE and ORDER BY parts of the section’s query.datasrcmgrs.actuate.datasrcmgrs.ACJDesigner Returns an instance of the registered JDBCHandler data source.ereport.metadatasrc.designer. 38 e.actuate.JDBCHandler getQueryTables(Object) Method in class com. No corresponding set function is available because the SELECT and FROM clauses cannot be modified through the API.ereport.ereport.MetaDataHandler getQueryTables(Object) Method in class com.AppDataHandler getQueryResult(Object.ereport.datasrcmgrs. FROM. String) Method in class com. getRegdJDBCHandler() Method in class com.actuate.designer.jdbcdatasrc.datasrcmgrs.actuate. String) Method in class com.ACJDesigner Returns an instance of the registered ASCIIDataHandler data source.actuate.actuate.ereport.appdatasrc.JDBCHandler getQueryResult(Object.ereport.metadatasrc.ereport.jdbcdatasrc.Repor t Designer API Java Edition .ACJDesigner Returns an instance of the registered AppDataHandler data source.MetaDataHandler getRegdAppDataHandler() Method in class com.AppDataHandler getQueryTables(Object) Method in class com.actuate.ereport.appdatasrc.designer.actuate.ereport.actuate.datasrcmgrs.datasrcmgrs.designer. String) Method in class com.ereport. getRegdEJBHandler() Method in class com.Returns a hashtable with values of the SELECT.actuate.ACJDesigner Returns an instance of the registered EJBHandler data source. getRegdASCIIDataHandler() Method in class com. getQueryResult(Object.

actuate.ereport.actuate. getRelations() Method in class com. String) Method in class com. Not implemented in JDBCHandler. getRegdXMLDataHandler() Method in class com.ereport.ACJDesigner Returns an instance of the registered XMLDataHandler data source.ereport.datasrcmgrs.datasrcmgrs.actuate.ACJDesigner Returns an instance of the registered MetadataHandler data source.ereport.MetaDataHandler Returns a vector of all relations in a string format. String) Method in class com.MetaDataHandler Determines if a column can be granted privileges.datasrcmgrs.datasrcmgrs. getRelations() Method in class com. getRemarks(String.getRegdMetaDataHandler() Method in class com. getRemarks(String.EJBDataHandler Chapter 3.datasrcmgrs.ejbdatasrc.ereport.ereport. Class summary 39 . getRelations() Method in class com.jdbcdatasrc.actuate.actuate.ereport.actuate.designer.actuate.actuate.metadatasrc.AppDataHandler Returns all relations as a vector of strings. getRelations() Method in class com.actuate.metadatasrc.ACJDesigner Returns a vector of relations strings used internally.ereport.JDBCHandler Returns the remarks for the specified fully qualified column.jdbcdatasrc.designer.ereport.JDBCHandler Returns a vector of relations in a string format. getRemoteAppName() Method in class com.designer.datasrcmgrs.appdatasrc.

ereport.actuate.TemplateManager Returns report's Comments property.jdbcdatasrc.asciidatasrc.TemplateManager Returns True if control is set for resizing to fit the contents.actuate.datasrcmgrs.engine.TemplateManager Returns report's Title property. getReportTitle() Method in class com. getResizeToFitContents(Object) Method in class com.datasrcmgrs. False otherwise.TemplateManager Returns the section ID of the section that contains the specified field.actuate.actuate. getSOImplementation() Method in class com.jdbcdatasrc.ASCIIDataHandler 40 e. getSectionId(Object) Method in class com.datasrcmgrs.ereport.ereport.actuate.ereport.engine.TemplateManager Returns report's Author property.engine.actuate. getSelectedTables() Method in class com.engine.actuate.ereport.ereport.actuate.JDBCHandler getSelectiveTableFilter() Method in class com.JDBCHandler Used internally.jdbcdatasrc. getResizeFixRatio() Method in class com.ACJEngine Returns the proportional increment required to fix the resize-to-fit feature for other output devices. getReportComments() Method in class com.JDBCHandler getSourceFileName() Method in class com.engine.datasrcmgrs.actuate.Repor t Designer API Java Edition .actuate.ereport.engine.ereport.ereport.ereport.getReportAuthor() Method in class com.

actuate.datasrcmgrs.metadatasrc. getTableNames() Method in class com.actuate.datasrcmgrs.datasrcmgrs.datasrcmgrs.actuate.actuate. getTable(Hashtable.datasrcmgrs.ereport.jdbcdatasrc.getStartRecordNumber() Method in class com. getTableCount() Method in class com.AppDataHandler Executes the query and returns the result set. getTableNames() Method in class com.JDBCHandler Returns a structure containing stored objects.ereport.datasrcmgrs.ereport.MetaDataHandler Returns the names of all tables in the data source structure.AppDataHandler Returns a list of all table names registered with the data source. Class summary 41 .jdbcdatasrc.actuate.JDBCHandler Returns a vector with all the table names available from the data source.jdbcdatasrc.JDBCHandler getStoredObjects() Method in class com.actuate.appdatasrc.jdbcdatasrc.MetaDataHandler Interface implementation.ereport.appdatasrc.jdbcdatasrc.datasrcmgrs.ereport.datasrcmgrs. Used internally by the engine.ereport. String) Method in class com. String) Method in class com.JDBCHandler getTableNames() Method in class com.appdatasrc. String) Method in class com.metadatasrc. Chapter 3. getTable(Hashtable.datasrcmgrs.ereport.actuate.datasrcmgrs.ereport.JDBCHandler Used internally.actuate. getTable(Hashtable.actuate.ereport.actuate.ereport.AppDataHandler getStartRecordNumber() Method in class com.

engine.datasrcmgrs.actuate.ACJEngine getTemplateManager() Method in class com.datasrcmgrs.engine. Returns Java Class.JDBCHandler A macro for fetching all tables from the active JDBC source. getTableType(String) Method in class com. getTextWrap(Object) Method in class com. getTemplateWidth() Method in class com.jdbcdatasrc. 42 e.actuate.actuate.actuate.engine.engine.appdatasrc.ACJEngine TemplateManager is the main class that lets the user manipulate most aspects of the template.actuate.datasrcmgrs.actuate.Repor t Designer API Java Edition .engine.engine.ACJEngine Returns an instance of the default implementation of ITmplReader that is capable of reading an ASCII/Unicode template structure from a specified input file or stream.ereport.metadatasrc.ereport.ereport.TemplateManager Returns True if the Wrap Text property of the specified control is set.ereport.AppDataHandler Not used.TemplateManager Returns the width of the template in inches. getTemplateReader() Method in class com.ereport.actuate.ereport.actuate.ACJEngine Returns an instance of the default implementation of ITmplWriter that is capable of writing an ASCII/Unicode template structure to a specified output file or stream.ereport. getTableType(String) Method in class com. False otherwise.getTables() Method in class com. getTemplateWriter() Method in class com.actuate.MetaDataHandler getTargetOutputDevice() Method in class com.ereport.ereport.

actuate.TemplateManager Returns True if the control is set to Visible. getValue(Object.actuate.designer.actuate.actuate. False otherwise.ACJDesigner Indicates that the On switching to preview the report has to be refreshed.engine.datasrcmgrs.actuate. getVisible(Object) Method in class com.output.datasrcmgrs.ereport.actuate.jdbcdatasrc. False otherwise.actuate.jdbcdatasrc.ereport.datasrcmgrs.ACJEngine This function returns a reference to the internal TmplMgr instance variable maintained by ACJEngine.appdatasrc. hasColumn(String) Method in interface com. Class summary 43 .actuate. hasBeenGenerated Variable in class com. getUrl() Method in class com.appdatasrc.engine. Used internally.ACJOutputProcessor Returns an instance of the VirtualOutput object.ereport. String) Method in interface com.ereport.engine. which is an instance of this table. getWHEREClause(Object) Method in class com.getTmplMgr() Method in class com.actuate.TemplateManager Returns the current value of the WHERE clause of the specified section's query.ereport. getVirtualOutput() Method in class com. Chapter 3.IObjectTable This method returns True if the column indicated by <col> exists.datasrcmgrs.ereport.ereport.ereport.IObjectTable An implementation of this method returns the value represented by the specified column <colName> in the corresponding object <o>.ereport.JDBCHandler Returns the URL for the JDBC data source. getUsername() Method in class com.JDBCHandler Returns the username for the active JDBC data source connection.

this API returns True.datasrcmgrs.output.ereport.MetaDataHandler Specifies whether the metadata information has been set up by loading from a EMD file.engine.actuate.metadatasrc.appdatasrc.engine.JDBCHandler Returns True if connected to a JDBC data source.Iterator This method returns a boolean indicating whether further traversal in this table is possible.actuate. instantiateZipStream(OutputStream) Static method in class com.engine.ereport.actuate. hasMultipleOutputFiles() Method in class com.TemplateManager Returns True if the control specified by control ID is a chart object.datasrcmgrs.actuate. hasNext() Method in interface com.actuate.TemplateManager Indicates that the loaded template contains an embedded data source.ereport.datasrcmgrs.actuate.ACJOutputProcessor isChart(Object) Method in class com.ereport. isConnected() Method in class com.appdatasrc.actuate.ereport.ereport. False otherwise.Repor t Designer API Java Edition .actuate. 44 e.AppDataHandler Not used.hasEmbeddedDatasource() Method in class com. isConnected() Method in class com.actuate. isConnected() Method in class com.output.ereport.jdbcdatasrc. False otherwise.ACJOutputProcessor If more than a single output file is generated.TemplateManager Indicates that parameters exist in this template that could be resolved. hasParameters() Method in class com.ereport.ereport. An application data source does not require a connection the way a JDBC data source does.datasrcmgrs.

metadatasrc.TemplateManager Returns True if the control specified by control ID is a data field.ereport.engine.ejbdatasrc.engine.datasrcmgrs. String) Method in class com.actuate. isNullable(String.actuate.ereport.EJBDataHandler Notifies the system if the EJB DS connection is active.engine.ereport. False otherwise.ereport.TemplateManager Returns True if the control specified by control ID is a line. False otherwise.engine.datasrcmgrs. isLine(Object) Method in class com.TemplateManager Returns True if the control specified by control ID is a label.jdbcdatasrc. False otherwise.MetaDataHandler Determines whether a column can be granted privileges. False otherwise.ereport.ereport. isLabel(Object) Method in class com. isGrantable(String.actuate.actuate.engine.ereport. False otherwise.actuate.JDBCHandler Indicates whether this column can have privileges granted to it.isConnected() Method in class com.datasrcmgrs. isImageURL(Object) Method in class com. String) Method in class com.actuate.datasrcmgrs.TemplateManager Returns True if the control specified by control ID is a formula. Class summary 45 .actuate. String) Method in class com.actuate.TemplateManager Returns True if the control specified by control ID is an image URL. isDataField(Object) Method in class com. isGrantable(String. isFormula(Object) Method in class com.appdatasrc.ereport.actuate.ereport.AppDataHandler Chapter 3.

designer.actuate. This class implements the interface between ACJEngine and any JDBC data source such as a relational database.jdbcdatasrc. loadTemplate(String.appdatasrc.ACJDesigner Requests the Designer to load a template into the user interface using templateEncoding.jdbcdatasrc.actuate.jdbcdatasrc.designer.ACJDesigner Notification received when the active tab is changed via the menu option. No otherwise. isNullable(String.datasrcmgrs.JDBCHandler Indicates that this column can have a Null value.ereport.JDBCHandler Empty constructor.actuate.ACJDesigner Requests the Designer to load a template into the user interface.actuate.datasrcmgrs. JDBCHandler class com.MetaDataHandler Indicates that the given column can have a Null value.actuate.datasrcmgrs. loadTemplate(String) Method in class com.Repor t Designer API Java Edition .JDBCHandler. iterator() Method in interface com. String) Method in class com. isNullable(String.IObjectTable Returns the iterator that represents this table object.ereport.actuate.ereport.designer.datasrcmgrs. int) Method in class com.ereport.datasrcmgrs.metadatasrc.ereport.actuate.actuate. 46 e.Iterator. itemStateChanged(ItemEvent) Method in class com.actuate.appdatasrc. String) Method in class com.ereport.ereport.ereport.Returns Yes if Null is a valid default value for the specified table or column. Iterator interface com.datasrcmgrs.ereport. JDBCHandler() Constructor for class com.

newSystem() Method in class com.ereport.main(String[]) Static method in class com.actuate.jdbcdatasrc.datasrcmgrs.output.actuate.ereport.actuate.appdatasrc. OD_DHTML() Constructor for class com.ereport.datasrcmgrs.ereport. OD_DHTML class com.ereport.datasrcmgrs.ereport.actuate. MetaDataHandler class com.ereport.actuate.metadatasrc.Iterator An implementation of this method returns the current record and advances the cursor to the next record in the data set.metadatasrc.ereport.output.OD_DHTML Chapter 3.engine. Class summary 47 .ACJEngine This function is called when data in the engine needs to be cleared.engine.datasrcmgrs.actuate.MetaDataHandler Indicates that the metadata has been constructed manually.ereport.metadatasrc.MetaDataHandler.actuate.MetaDataHandler The default constructor.ACJDesigner makeSelective() Method in class com.designer.actuate.OD_DHTML This class is used for generating the output of the report in HTML format.ereport. next() Method in interface com.JDBCHandler manuallyConstructed() Method in class com.actuate.datasrcmgrs. MetaDataHandler() Constructor for class com. This class implements the metadata data source. newTemplate() Method in class com.actuate.ACJEngine This function is called when data in the engine needs to be cleared.

ereport.actuate.actuate.designer.actuate. Object) Method in class com. Object) Method in class com.engine.ereport.ACJDesigner passTableData(String.newInstance() OD_HTML class com.ereport.actuate.ereport.engine.engine.This is an empty constructor that is used for instantiating OD_DHTML using Class.datasrcmgrs.Repor t Designer API Java Edition .ejbdatasrc.ereport.JDBCHandler print() Method in class com.ACJEngine This function is used to update the value of the resolution parameter stored in a template with the resolution value specified by the user.OD_HTML This class is used for generating the output of the report in HTML format.newInstance() overrideResolution(int) Method in class com. OD_HTML() Constructor for class com.ACJEngine This method is internally called to generate the entire report. Collection) Method in class com. printingDone() Method in class com. processMsg(int.ereport.ereport.output.EJBDataHandler processRemoteMsg(int.ejbdatasrc.datasrcmgrs.datasrcmgrs.ereport. password Variable in class com.datasrcmgrs.actuate.actuate. paintComponent(Graphics) Method in class com.OD_HTML This is an empty constructor that is used for instantiating OD_HTML using Class.AppDataHandler Used internally.actuate.ACJEngine Notification received when the report generation process is complete.ereport.EJBDataHandler 48 e.jdbcdatasrc.appdatasrc.actuate.actuate.ereport.actuate.output.

actuate.ACJOutputProcessor Specifies whether the parameter entry dialog displays when the report output is required.actuate.ereport.ACJOutputProcessor Sets the active page to the next page. Possible return values are 50.ereport. prv_removeToolbarItem(String) Method in class com.ACJOutputProcessor Removes a single item from the toolbar in the preview window.output.ACJOutputProcessor Returns the count of available pages in the preview.ereport. 100.ACJOutputProcessor Sets the active page in the preview window.ereport.ACJOutputProcessor Returns the active page in the preview window.output. The next page may be a subpage split of the current page. prv_setNextPage() Method in class com. promptParams(boolean) Method in class com.output. prv_setBackgroundTOC(Color) Method in class com. Chapter 3.actuate. prv_getActivePage() Method in class com.ereport.actuate.actuate.ACJOutputProcessor Sets the background color of the Table of Contents in the preview window.ereport. prv_setActivePage(int) Method in class com.actuate.actuate. 75. and 200.ereport.output.output.ereport.output.promptParams() Method in class com.output.ACJOutputProcessor Returns the zoom factor in the preview device as a percentage value.output. Class summary 49 .ACJOutputProcessor Indicates whether the parameter entry dialog displays when the report output is required.output.ereport. prv_getZoom() Method in class com.actuate.actuate. prv_getPageCount() Method in class com.

ereport.actuate.ACJOutputProcessor Sets the active page to the previous page.ereport.ereport.ACJOutputProcessor readObject(InputStream) Method in class com.output.ACJEngine Reads templates from specified input stream.ACJOutputProcessor Sets the zoom factor in the preview device as a percentage value.ACJOutputProcessor putNewZipEntry(String.actuate. The previous page may be a subpage split of the current page.actuate. prv_showTOC() Method in class com.actuate.output. prv_updateToolbar() Method in class com.output.actuate. prv_setZoom(int) Method in class com. 100. Used when loading a template from a local file is not a viable option.actuate. readTemplate(InputStream) Method in class com.ereport.output.ereport.actuate.prv_setPrevPage() Method in class com.datasrcmgrs.ereport.actuate.ereport.output.metadatasrc.Repor t Designer API Java Edition .MetaDataHandler Reads and parses the metadata from an ASCII input stream into the metadata data structure.ACJOutputProcessor Shows the Table Of Contents panel in the ACJEngine client window.actuate. prv_showToolbar() Method in class com.engine.ereport. Possible values are 50. int) Method in class com.ACJOutputProcessor Shows the toolbar in the preview window. 50 e. 75.engine.ACJEngine Read template from a specified input stream. and 200. readTemplate(InputStream. Used when loading a template from a local file is not a viable option.ereport.output. ZipOutputStream) Static method in class com.

ACJEngine Reads a template from a specified filename using the specified encoding.engine. If True is passed.ereport.actuate.ACJDesigner Registers a vector of data sources for selection via the GUI.appdatasrc.ereport.appdatasrc.ereport.ereport.JDBCHandler 51 Chapter 3.actuate.ereport. registerObjectAsTable(Object.datasrcmgrs. Collection) Method in class com.datasrcmgrs.engine.ereport.actuate. readTemplate(String. registerQuery(Object. refreshReport(boolean) Method in class com.ereport.datasrcmgrs.readTemplate(String) Method in class com.datasrcmgrs.ACJOutputProcessor Re-retrieves the current page. int) Method in class com.actuate. Updates the contents of the Template Manager.actuate. Vector) Method in class com.ASCIIDataHandler Function that registers all the tables with ACJEngine. String) Method in class com.datasrcmgrs.actuate. registerQuery(Object.output.designer.asciidatasrc. the report is regenerated and then the page is retrieved.actuate. String) Method in class com.ereport.appdatasrc.ereport.actuate. registerObjectsWithEngine() Method in class com.jdbcdatasrc. Class summary .actuate. String.AppDataHandler Passes the data objects from your application to ACJEngine.AppDataHandler Predefined Query implementation.AppDataHandler Defines your application object and its structure to ACJEngine in the form of a table.ACJEngine Reads a template from specified filename. registerDataSet(String. registerDataSources(Vector) Method in class com.

datasrcmgrs.AppDataHandler Deprecated.ereport. indicating that the MetaDataHandler does not require a connection. registerUserDefTable(IObjectTable.AppDataHandler Deprecated. requiresConnection() Method in class com. Vector.registerQuery(Object.datasrcmgrs.ejbdatasrc. String) Method in class com.datasrcmgrs.actuate. An application data source does not require a connection the way a JDBC data source does. String) Method in class com. RegisterTable(Vector.ereport.AppDataHandler Defines your application object and its structure to ACJEngine in the form of a table.datasrcmgrs.Repor t Designer API Java Edition .datasrcmgrs.AppDataHandler Not used.metadatasrc.actuate.actuate.datasrcmgrs.EJBDataHandler remove() Method in interface com.metadatasrc.JDBCHandler Indicates that the JDBC data source requires an active connection.ereport.jdbcdatasrc.ereport.ereport.appdatasrc.appdatasrc.actuate.datasrcmgrs.actuate.appdatasrc.MetaDataHandler RegisterTable(IObjectTable.ereport.actuate. Use registerObjectAsTable() instead.appdatasrc.appdatasrc.ereport.MetaDataHandler Always returns False.Iterator 52 e.datasrcmgrs.actuate. String) Method in class com. requiresConnection() Method in class com.ereport.actuate. String.datasrcmgrs. requiresConnection() Method in class com. Use registerUserDefTable() instead. String) Method in class com. requiresConnection() Method in class com.actuate.ereport.

jdbcdatasrc.ereport.actuate.JDBCHandler Fetches all the requested tables from the active JDBC connection.ereport.ACJDesigner Specifies if automatic update is required of the WHERE and/or the ORDER BY clauses based on template contents.This method is never called.ACJEngine retrieveTables() Method in class com.actuate. Class summary 53 . setBounds(Object.designer. Chapter 3.ereport.designer.actuate. boolean) Method in class com. saveTemplate(String.ACJDesigner Selects one of the registered data sources for data extraction.ereport. resetStub() Method in class com. setAutoQuery(boolean.designer.actuate.Iterator Requests the table class to reset the cursor to the starting position of the data set so the data can be fetched again.ereport.ACJDesigner Requests the Designer to save the template to a file using the specified templateEncoding.ereport.ereport. int) Method in class com.actuate.actuate.ACJDesigner Requests the Designer to save the template to a file.engine.actuate.datasrcmgrs.actuate.ereport.datasrcmgrs. resetCursor() Method in interface com. Bounds) Method in class com. setActiveDataSource(IDataSource) Method in class com.engine.appdatasrc.engine.ereport. setAlignment(Object.actuate.TemplateManager Sets the width and height of a control. saveTemplate(String) Method in class com.TemplateManager Sets the text alignment property of the control. int) Method in class com.designer.

output. Object) Method in class com. Object.TemplateManager Sets the value of a field control. String) Method in class com.ereport.MetaDataHandler 54 e.actuate.EJBDataHandler Sets the context factory.ereport. String) Method in class com. setDatasourceName(String) Method in class com.ereport.actuate.ereport.ereport. setCSVProperty(String.metadatasrc.ereport.actuate.Repor t Designer API Java Edition . setContextFactory(String) Method in class com. setCatalogName(String) Method in class com. setCommunicationStub(BaseStub) Method in class com.datasrcmgrs.actuate.ACJEngine Indicates that users must specify the implementation of the data source to be used for data retrieval while generating reports.ejbdatasrc.engine.output.setBufferSize(int) Method in class com.ACJOutputProcessor Sets an individual property used by the CSV output device when generating a CSV report.datasrcmgrs.ereport. Also specifies whether the file should be stored in memory or in a file on disk. The default is 65. setDataSource(IDataSource) Method in class com.actuate.ereport.ACJEngine Sets the internal reference of the IViewerInterface implementation.536 bytes.engine.actuate.datasrcmgrs.actuate.metadatasrc.ereport.actuate.engine.engine.ACJOutputProcessor Sets the buffer size in bytes for delayed filewrites. setCacheOption(boolean.ACJEngine Specifies whether the temporary file is generated by ACJEngine during report generation. setDataField(Object.actuate.MetaDataHandler Sets the name of the catalog for the data source structure to the specified name.

ereport.AppDataHandler Indicates whether console messages are displayed as the QueryProcessor processes the various joins and projects the result set.designer.ereport.actuate. Chapter 3.jdbcdatasrc.ACJDesigner Sets the default value for Snap to Grid while designing templates.Exit action. setDebugMode(boolean) Static method in class com.actuate.ereport.actuate.ereport.designer.actuate.engine.designer.designer.ereport. setDefaultExitMode(int) Method in class com.ereport.JDBCHandler Specifies whether progress or error messages are to be displayed in the console window.ACJEngine Specifies whether progress or error messages are to be displayed in the console window.ereport.ACJDesigner Specifies whether progress or error messages are to be displayed in the console window. setDefaultHorzGap(int) Method in class com. setDebugMode(boolean) Static method in class com.Sets the name of the data source.actuate. setDefaultAttachLabel(boolean) Method in class com. setDebugMode(boolean) Static method in class com.ACJDesigner Sets the default File .actuate.actuate.ACJDesigner Sets the default horizontal gap between two controls that are automatically arranged side by side from the multiple selection arrange menu. setDefaultGridSnap(boolean) Method in class com.designer.appdatasrc.ereport.ACJDesigner Specifies whether a label should be automatically added to the visible group header above the zone in which a data field is dropped.datasrcmgrs.datasrcmgrs. setDebugMode(boolean) Static method in class com.actuate. Class summary 55 .

actuate.ACJOutputProcessor 56 e. setDefaultShowGrid(boolean) Method in class com.ACJDesigner Specifies whether the schema or owner name should be prepended to the table name by default in the FROM clause. as expected by ORACLE8.ereport.designer.ACJDesigner Specifies that if the table or column has lowercase characters embedded in it.designer.actuate.ACJDesigner Deprecated. Currently supported templateEncodings are ACJConstants.Repor t Designer API Java Edition .ereport. Object) Method in class com. ACJConstants.actuate.actuate.ereport. setDefaultLookAndFeel(String) Method in class com.ASCII. Report Designer Java Edition creates a default startup skeleton template.ereport. setDefaultTemplateEncoding(int) Method in class com.erw' then e.ereport.ereport.actuate. setDHTMLProperty(String.ereport.ACJDesigner setDefaultLowercaseQuotes(boolean) Method in class com.designer.ACJDesigner Sets the default template templateEncoding.ereport.designer.output.designer.designer.ACJDesigner Specifies whether the user wishes to generate preview or printer output in landscape format (True) or portrait format (False).designer.ACJDesigner Specifies whether the location is automatically updated as a relative path when the image path is changed for an image control.actuate. the quote identifier is prepended and appended to it by default. setDefaultPrependSchema(boolean) Method in class com. Specifies that if a new template is blank (default = True) or should be read from a file 'startup.ACJDesigner Sets the default value to show the grid while designing templates.UTF8. setDefaultPrintMode(boolean) Method in class com. setDefaultNewTemplate(boolean) Method in class com.actuate.setDefaultImageRelativePath(boolean) Method in class com.actuate.actuate.designer.ereport.

ACJDesigner Specifies the name of the user guide file.actuate.actuate.ereport.ereport. If a specific property is omitted.TemplateManager setFormat(Object. Chapter 3. setFillColor(Object.engine.TemplateManager Sets the fill/background color of a control.engine. String) Method in class com. setFont(Object. Class summary 57 . int.engine.actuate.datasrcmgrs.Attempts to set an individual property used by the DHTML output device while generating an DHTML report. SansSerif.ereport.appdatasrc. setDriver(String) Method in class com.actuate.TemplateManager Sets a string which is normally used by Java to define string formatting.designer.output.ACJOutputProcessor Sets the path to the main documentation file. setDocumentationPath(String) Method in class com. setExtraOperators(Vector) Method in class com.ereport.engine.ereport.datasrcmgrs. Object) Method in class com.ereport.output. and so on. setEMAILProperty(String. String. Color) Method in class com.ACJOutputProcessor Attempts to set an individual property used by the e-mail system while deploying reports.actuate. int) Method in class com.actuate.ereport. Color) Method in class com.JDBCHandler Sets the JDBC driver to the string being passed.AppDataHandler Attempts to register additional operators which can be used in the WHERE clause during query processing. The font name is the font family: Serif.TemplateManager Sets the font to be used to display the text inside a control.actuate. a default value is used.ereport. setDocsPath(String) Method in class com.jdbcdatasrc. setFontColor(Object.ereport.actuate.actuate.

actuate. Object) Method in class com.ereport.actuate. setIdentifierQuote(String) Method in class com.actuate. String) Method in class com.setFormula(Object.ereport.actuate.output. setGenerateOnDemand(boolean.output.output.ereport.designer. String) Method in class com. setJOIProperty(String.ACJDesigner setHTMLProperty(String. String) Method in class com.ACJOutputProcessor Sets the source of report data to specified filename.engine.OD_DHTML This method is used to specify the mode of report generation and the entity requesting for the report.actuate. setGenerateOnDemand(boolean.datasrcmgrs.engine.ereport.TemplateManager Sets the URL of the image referred to in the specified control.engine. String.actuate. Object) Method in class com. Object) Method in class com.ACJOutputProcessor 58 e.output.ereport.actuate.ACJOutputProcessor Attempts to set an individual property used by the HTML output device while generating an HTML report.ereport.output.ereport.actuate.metadatasrc.TemplateManager Sets the formula for a given control.actuate.ereport. setImportedSQLQuery(Object. String) Method in class com.MetaDataHandler setImageURL(Object. setHasBeenGenerated(boolean) Method in class com.OD_HTML This method is used to specify the mode of report generation and the entity requesting for the report.Repor t Designer API Java Edition .ereport.actuate.ereport.TemplateManager Sets the predesigned SQL query to be used by the section. setJOIFileSource(File) Method in class com.

or file:) and internally calls setJOIURLSource or setJOIFileSource. Class summary 59 . Object) Method in class com. setMruList(String[ ]) Method in class com.output. setLowercaseQuotes(boolean) Method in class com.actuate.actuate.JDBCHandler Specifies that if a table or column has lowercase characters embedded in it.output.ereport.actuate. ftp:. setORDERBYClause(Object. setJOISource(String) Method in class com.ereport.TemplateManager Sets the value of the ORDER BY clause of the specified section's query to the given value.designer. String.actuate.ACJOutputProcessor Sets the source of report data to a specified URL.ereport. then the quote identifier is prepended and appended to it.ereport.actuate.actuate. setLabel(Object.ereport.engine.ereport.ereport.output.ACJDesigner Specifies an array of filenames to be stored in the MRU list. setOutputProperty(String.ACJOutputProcessor Wrapper to map the existing client keys to the keys in the template.Attempts to set an individual property used by the JOI Handler while generating an JOI report. String) Method in class com.jdbcdatasrc.datasrcmgrs. setOutputDevice(IPrinter) Method in class com.actuate.ACJOutputProcessor A macro which accepts a string representation of a JOI filename or the location of a JOI filename via a URL (http:.TemplateManager Sets the value of a label control.engine.ACJEngine This function lets a user specify a customized implementation of the IPrinter report generation interface.actuate. setJOIURLSource(URL) Method in class com.ereport. Chapter 3. String) Method in class com.engine.

actuate.ereport.ereport.engine.TemplateManager Sets the page height in inches.TemplateManager Sets the value of parameter specified.engine. right.ACJOutputProcessor Attempts to set an individual property used by the PDF output device while generating a PDF report.datasrcmgrs.datasrcmgrs.output.ereport.actuate. setParamValue(String. setPDFProperty(String. Object) Method in class com. top.actuate.jdbcdatasrc.ACJOutputProcessor 60 e.actuate.engine.actuate.TemplateManager Sets the page width in inches. Object) Method in class com.jdbcdatasrc. setPRINTERProperty(String.ereport.setPageHeight(double) Method in class com.engine.TemplateManager Sets the left. setPageMargins(Bounds) Method in class com.TemplateManager Sets an individual property for the specified parameter ID.ereport. setPrependSchema(boolean) Method in class com.engine. String.actuate. Use with reports that have parameters when you want to bypass the Enter Parameter Values dialog box and specify parameter values through the API.ereport.ereport. Object) Method in class com. and bottom margins of the page using a Bounds structure.JDBCHandler Specifies whether the schema name should be prepended to the table name in the FROM clause as expected by ORACLE.JDBCHandler Sets the password to the string being passed.ereport. setPassword(String) Method in class com. setParamProperty(String.output.Repor t Designer API Java Edition .actuate.actuate.ereport. Object) Method in class com. setPageWidth(double) Method in class com.actuate.

setProperties(Hashtable) Method in class com.ereport. setReportComments(String) Method in class com.actuate.datasrcmgrs.AppDataHandler Sets all relations as a vector of strings. Class summary 61 .actuate.datasrcmgrs.ereport. setReportAuthor(String) Method in class com.appdatasrc. String.engine.actuate. String) Method in class com.JDBCHandler setPropertiesFileName(String) Method in class com.ereport.MetaDataHandler Sets all relations as a vector of strings.datasrcmgrs.TemplateManager Sets the report's Author property. setRelations(Vector) Method in class com.ereport.ereport.Attempts to set an individual property used by the printer output device when printing a report.output.metadatasrc.jdbcdatasrc.ereport.actuate.ereport.ereport. setPrinterResolution(boolean.actuate.engine.EJBDataHandler setProperties(String. setReportData(IViewerInterface) Method in class com.actuate.ejbdatasrc.AppDataHandler Enables or disables the query display. String.asciidatasrc.ACJOutputProcessor Sets and resets the printer resolution.datasrcmgrs.TemplateManager Sets the report's Comments property.actuate.datasrcmgrs.output.datasrcmgrs.actuate.ereport.ereport. setRelations(Vector) Method in class com.appdatasrc.actuate.ACJOutputProcessor Chapter 3. double) Method in class com.actuate.ASCIIDataHandler setQueryDisplay(boolean) Method in class com.

TemplateManager Sets the report's Title property. boolean) Method in class com.appdatasrc.engine.actuate.TemplateManager Allows a control to resize vertically when set to True. int) Method in class com.Sets the raw report data (generated using ACJEngine. setTableDefinition(String.engine. Vector) Method in class com.ereport.datasrcmgrs.actuate.ereport. setReportTitle(String) Method in class com.datasrcmgrs. int) Method in class com.datasrcmgrs.ereport.ereport.MetaDataHandler setSelectiveProperties(int. setReportData(IViewerInterface. setResultSetRange(int.metadatasrc.datasrcmgrs.Repor t Designer API Java Edition .AppDataHandler setResultSetRange(int.JDBCHandler setResultSetRange(int.actuate.actuate. Class.AppDataHandler Used internally.engine.ACJOutputProcessor Sets the report data generated to the ACJEngine client module for output of report.ereport.ereport.ACJEngine Sets the proportional increment required to fix the resize-to-fit feature for other output devices. Component) Method in class com.actuate.datasrcmgrs. int) Method in class com.ejbdatasrc.actuate.output.actuate.ereport.jdbcdatasrc.generateReport()) as the actual data that ACJOutputProcessor uses to generate output. Vector) Method in class com.JDBCHandler setTableDefinition(String.ereport.EJBDataHandler 62 e.actuate.actuate.appdatasrc. setResizeFixRatio(float) Method in class com. Class.actuate. Vector) Method in class com. setResizeToFitContents(Object.datasrcmgrs.ereport.jdbcdatasrc.ereport.

TemplateManager 63 Chapter 3. setTemplateWriter(ITmplWriter) Method in class com. boolean) Method in class com. setTextWrap(Object.ereport.actuate.ACJEngine Specifies a custom implementation of the ITmplWriter interface used to write the contents of a report template to a file or output stream.jdbcdatasrc.jdbcdatasrc.ereport.engine.actuate.ereport.actuate.datasrcmgrs.TemplateManager Sets the control's visibility as specified. Unsets this property if False is passed.actuate.engine.TemplateManager Sets the measurement units to be used. setUrl(String) Method in class com.engine.engine.ACJDesigner When a template is loaded externally it specifies the filename to be used by the GUI when the "SAVE TEMPLATE" option is selected from the menu. boolean) Method in class com.engine.engine.ereport.ereport.actuate. setUsername(String) Method in class com. Class summary .actuate.datasrcmgrs. setVisible(Object.ereport.ereport.JDBCHandler Sets the username to the string being passed. setWallpaper(String) Method in class com. setTemplateReader(ITmplReader) Method in class com.designer.actuate.ereport.ereport. setUnitType(String) Method in class com.engine.actuate.actuate.ereport.ACJEngine setTemplateFile(String) Method in class com.TemplateManager Sets the Word Wrap property of a specified control if True is passed.actuate.setTargetOutputDevice(int) Method in class com.ACJEngine Specifies a custom implementation of the ITmplReader interface used to read the contents of a report template from a file or input stream.JDBCHandler Sets the JDBC URL to the string being passed.

actuate. Used internally.actuate.ereport. String) Method in class com.actuate.ACJDesigner 64 e. The new WHERE clause will overwrite the existing WHERE clause.ereport.actuate.actuate.datasrcmgrs.engine.actuate.ereport.engine.engine. double.TemplateManager Used to set the wallpaper at a specified location. showMem Variable in class com.ereport.appdatasrc.TemplateManager Sets the WHERE clause of the specified section's query.ACJEngine Specifies if the X11 Graphics subsystem is available so font creation and other tasks can be safely carried out. sortVector(Vector) Static method in class com. supportsStoredObjects() Method in class com.jdbcdatasrc.ereport.designer.actuate. setZoneHeight(Object.ereport.designer.ACJDesigner Notification received just before the Designer’s tab is changed.TemplateManager Sets the height of a zone in inches.engine. setWHEREClause(Object.ereport. setWallpaper(String.ACJDesigner showMenu() Method in class com.ereport.AppDataHandler stateChanged(ChangeEvent) Method in class com.datasrcmgrs. double) Method in class com.Repor t Designer API Java Edition .ereport.JDBCHandler syncTmplMgr() Method in class com.ereport.actuate.ACJDesigner Constructs the menu structure used in the menu bar.designer. setX11GfxAvailibility(boolean) Static method in class com.Used to set the wallpaper.actuate. double) Method in class com.actuate.designer.

designer.jdbcdatasrc.actuate. updateResolution() Method in class com.ereport.ereport.ereport.ACJDesigner Used internally.Used internally.JDBCHandler SYSTEM Static variable in class com. This is the main class to access the template in ACJEngine.ACJDesigner Forces the Designer to reflect changes made to the template via the API.actuate.JDBCHandler TABLE Static variable in class com.TemplateManager Used internally.ereport.actuate.ereport.datasrcmgrs. updateOutputProperties() Method in class com.designer.ACJDesigner Updates the preview device with default output properties. updateRelations() Method in class com.ereport.jdbcdatasrc.engine.actuate.actuate.engine. updateDesigner() Method in class com.jdbcdatasrc. Chapter 3.ereport.designer.ereport. SYNONYM Static variable in class com.datasrcmgrs.datasrcmgrs.actuate.actuate.actuate.JDBCHandler Original class implementation.engine. Class summary 65 . tmplMgr Variable in class com.TemplateManager.actuate.ACJEngine Updates the value of the resolution parameter stored in a template with the value of the current screen resolution.ereport. TemplateManager class com.

datasrcmgrs.ereport. VIEW Static variable in class com.JDBCHandler windowActivated(WindowEvent) Method in class com..ACJDesigner windowClosed(WindowEvent) Method in class com.output.designer.ereport.jdbcdatasrc.ereport.ereport.ACJDesigner windowIconified(WindowEvent) Method in class com.actuate. windowDeactivated(WindowEvent) Method in class com.ACJDesigner windowDeiconified(WindowEvent) Method in class com.designer.) API when you know which tables you want to work with in the Template Designer.ereport.JDBCHandler useTables(Vector) Method in class com.ACJOutputProcessor 66 e.actuate.designer.ACJDesigner writefile(ZipOutputStream.actuate.designer.ereport.actuate.designer.actuate.actuate.actuate.ereport.actuate.designer.ACJDesigner windowOpened(WindowEvent) Method in class com.JDBCHandler username Variable in class com.ereport.jdbcdatasrc.url Variable in class com. Can be used in conjunction with the connect(.datasrcmgrs.ACJDesigner Notification received when an attempt is made to close the parent frame.ereport.actuate.JDBCHandler Specifies a domain of tables to work with this..jdbcdatasrc.jdbcdatasrc. Vector) Static method in class com.ereport.actuate.designer.datasrcmgrs.actuate.ereport.ereport.actuate.Repor t Designer API Java Edition .datasrcmgrs.ACJDesigner windowClosing(WindowEvent) Method in class com.

ACJEngine This method attempts to write the contents of the entire template structure maintained by the Template Manager to a specified file using the specified encoding type.ereport.ACJEngine This method attempts to write the contents of the entire template structure maintained by the Template Manager to a specified file using the specified encoding type.ereport. int) Method in class com. OutputStream) Method in class com.output.metadatasrc. writeTemplate(OutputStream) Method in class com.actuate. writeTemplate(String. Class summary 67 . ZipOutputStream) Static method in class com.actuate.ereport. writeTemplate(OutputStream.actuate.actuate.ACJOutputProcessor Chapter 3.ACJEngine This method attempts to write the contents of the entire template structure maintained by the Template Manager to a specified file using the default ANSI encoding type. int) Method in class com.ereport.engine.ACJOutputProcessor writeZip(String.engine.datasrcmgrs.output.engine.actuate.actuate. writeZip(byte[].writeObject(ProgressBox.MetaDataHandler Writes the metadata from the metadata data structure to an ASCII output stream of the appropriate format.ereport.ereport. ZipOutputStream) Static method in class com.

Repor t Designer API Java Edition .68 e.

Package com.actuate. designer.ACJDesigner Package Pa c k a g e c o m .ereport. e r e p o r t . a c t u a t e . A C J D e s i g n e r 69 . d e s i g n e r.

awt.event.awt. the Designer and the Preview.swing.ItemListener.EventListener.JComponent | +--javax.io.awt.Serializable.awt. java.awt. java.Java Edition.Component | +--java.swing.Repor t Designer API Java Edition .event.Object | +--java.ChangeListener.accessibility.awt. and the client output manager ACJOutputProcessor.awt.awt. registered data sources. See also Serialized objects 70 e.awt. java. java.util.WindowListener. java.event.Report Designer .ImageObserver.event. This class represents the outermost shell of the Template Designer used by e.awt.Class ACJDesigner java. java.swing. All designer related public APIs are accessible through this class.Accessible.event.JPanel Implements javax. java.ACJDesigner _____________________________________________________________________ All implemented interfaces javax. It contains a menu bar if executed as an application.MenuContainer.ActionListener. and a tab panel consisting of two tabs.WindowListener public class ACJDesigner extends javax.ActionListener. This class contains important references to the engine.swing.event.image.actuate. java.ChangeListener.designer.Container | +--javax.ereport.lang.JPanel | +--com. java.swing.ItemListener.event. java.event. javax.

getActiveDataSource() Description Notification received when a menu item is selected.swing. Returns the active selected data source for data extraction. boolean isPreview)(javax.addDataSource ACJDesigner . public ACJDesigner(javax.actionPerformed ACJDesigner . ACJEngine erw.Field summary Method Field summary hasBeenGenerated Indicates that the On switching to Preview the report has to be refreshed. Pa c k a g e c o m . e r e p o r t . a c t u a t e .JFrame fResizable. boolean isDesign. This installs any additional fonts if required in the Font dialog box. Method summary Method ACJDesigner . boolean isDesign. Registers a single data source. Updates the list of MRU files in the menu structure with a filename to be inserted at a specified index.addExternalFont ACJDesigner . d e s i g n e r. boolean isPreview) The default constructor. A C J D e s i g n e r 71 .Report Designer API Java Edition.JFrame fResizable.addMruFile ACJDesigner . created for backward compatibility. showMem boolean Type boolean boolean Constructor summary ACJDesigner() An empty constructor.swing. note that this function should be called only after authentication of login information. ACJEngine e.

Repor t Designer API Java Edition . Returns the instance of the registered ASCIIDataHandler data source. Returns the instance of the registered JDBCHandler data source. Notification received when the active tab is changed via the menu option..getRegdMetaDataHandler() ACJDesigner .getEngine() ACJDesigner . ACJDesigner Returns the current debug mode. ACJDesigner.loadTemplate ACJDesigner .getRegdASCIIDataHandler() ACJDesigner . Returns the instance of the registered MetadataHandler data source.getRegdXMLDataHandler() ACJDesigner . Returns the instance of the registered XMLDataHandler data source. 72 e. Used internally.getActiveDataSource() ACJDesigner .getRegdEJBHandler() ACJDesigner .itemStateChanged ACJDesigner . Requests the Designer to load a template into the user interface. used internally. Requests the Designer to load a template into the user interface using the specified encoding 'templateEncoding'.Method ACJDesigner .getDataSources() Description Returns an instance of ACJOutputProcessor used by ACJDesigner.main Returns the reference of ACJEngine maintained by the GUI.getMruList() ACJDesigner.getRegdJDBCHandler() ACJDesigner . Returns a vector containing all registered data sources. Returns a vector of Relations strings. Returns the instance of the registered AppDataHandler data source.getRelations() ACJDesigner . Returns an array of file names stored in the MRU list.loadTemplate ACJDesigner .getRegdAppDat aHandler() ACJDesigner . Returns the instance of the registered EJBHandler data source.getDebugMode() ACJDesigner .

Exit action. a c t u a t e . A C J D e s i g n e r 73 . Selects one of the registered data sources for data extraction. Sets the default horizontal gap between two controls that are automatically arranged side by side. Sets the default File .setDefaultHorzGap ACJDesigner . Requests the Designer to save the template to a file using the specified encoding 'templateEncoding'. Sets the default value for Snap to Grid when designing templates. Specifies whether progress or error messages are to be displayed in the console window.setActiveDataSource ACJDesigner .paintComponent ACJDesigner .saveTemplate ACJDesigner .saveTemplate ACJDesigner . Specifies whether a label should be automatically added to the visible group header above the zone in which a data field is dropped.registerDataSources ACJDesigner . ACJDesigner . Indicates whether it is required to automatically update the WHERE and/or the ORDERBY clauses based on template contents. d e s i g n e r.setDebugMode ACJDesigner .Method ACJDesigner .setDefaultImageRelativePath Description Registers a vector of data sources for selection via the GUI. Requests the Designer to save the template to a file.setDefaultAttachLabel ACJDesigner .setAutoQuery ACJDesigner .setDefaultLookAndFeel Pa c k a g e c o m . e r e p o r t .setDefaultExitMode ACJDesigner . Specifies whether the location is automatically updated as a relative path when the image path is changed for an image control.setDefaultGridSnap ACJDesigner .

Specifies whether the user wishes to generate Preview/Printer output in landscape format (True) or portrait format (False). Specifies that if a new template is Blank (default = True) or should be read from a file 'startup.syncTmplMgr() 74 e. Specifies whether the Schema/Owner name should be prepended to the table name by default in the FROM clause.setDefaultPrintMode ACJDesigner . used internally.setDefaultTemplateEncoding ACJDesigner .showMenu ACJDesigner .Report Designer API Java Edition creates a default startup skeleton template. When a template is loaded externally.setDocsPath ACJDesigner . Used internally.Repor t Designer API Java Edition . as expected by ORACLE8. ACJConstants. ACJDesigner . specifies the filename to be used by the GUI when the Save Template option is selected from the menu.setDefaultPrependSchema ACJDesigner . Deprecated.ASCII.setDefaultNewTemplate Description Specifies that if a table or column has lowercase characters embedded in it. Currently supported templateEncodings are ACJConstants.setMruList ACJDesigner . Sets the default value to show the grid while designing templates. ACJDesigner . Constructs the menu structure used in the menu bar. Notification received just before the Designer's tab is changed.showMenu() ACJDesigner . then the Quote Identifier is prepended and appended to it by default. Sets the default template 'templateEncoding'.setHasBeenGenerated ACJDesigner .UTF8.stateChanged ACJDesigner .erw' then e.Method ACJDesigner . Specifies the name of the user guide file.setDefaultLowercaseQuotes ACJDesigner .setTemplateFile Specifies an array of filenames to be stored in the MRU list.

e r e p o r t .windowOpened Description Forces the Designer to reflect changes made to the template via the API. A C J D e s i g n e r 75 .windowDeiconified ACJDesigner . d e s i g n e r. Updates the preview device with default output properties.windowClosing ACJDesigner .updateRelations() ACJDesigner .updateOutputProperties() ACJDesigner . Notification received when an attempt is made to close the parent frame. Used internally.Method ACJDesigner . Field detail showMem public boolean showMem doPreviewReset public boolean doPreviewReset hasBeenGenerated public boolean hasBeenGenerated Indicates that the On switching to preview the report has to be refreshed.windowIconified ACJDesigner .windowActivated ACJDesigner . Pa c k a g e c o m .updateDesigner() ACJDesigner . a c t u a t e .windowDeactivated ACJDesigner .windowClosed ACJDesigner .

isDesign Specifies whether the Designer tab should be displayed. boolean isDesign. ACJDesigner.Frame.ActionListener Updates the preview device with default output properties. the constructor takes the first argument as a java.event. 76 e. public ACJDesigner(javax. erw A reference to an instance of the engine instantiated by an external wrapper.awt.event. fCloseNotification Handle of the parent frame (can be null).awt.JFrame fResizable. Specified by actionPerformed in interface java. created for backward compatibility.Repor t Designer API Java Edition . Constructs the designer shell using a variety of options which can be embedded within an existing application. In the AWT API.actionPerformed public void actionPerformed(java.swing.awt. This function is called internally by GuiTemplate.ActionEvent ae) Notification received when a menu item is selected.ACJDesigner constructor ACJDesigner public ACJDesigner() An empty constructor. boolean isPreview) The default constructor. isPreview Specifies whether the Preview tab should be displayed. ACJEngine erw.

ACJDesigner. ids An implementation of the IDataSource interface.ereport.ACJDesigner. a c t u a t e . Note that this function should be called only after authentication of login information. See also JDBCHandler.addDataSource public void addDataSource(com.addMruFile public void addMruFile(int fileNo. MetaDataHandler ACJDesigner.engine.lang. AppDataHandler.actuate. s The name of the external font to be added.IDataSource ids) Registers a single data source. d e s i g n e r. This function is called internally by GuiTemplate. Returns A reference to the client output device maintained internally.lang.addExternalFont public void addExternalFont(java. A C J D e s i g n e r 77 . mruFileName The filename to be inserted at the specified index.String s) Installs any additional fonts if required in the Font dialog box. java. e r e p o r t . fileNo Index in the internal array of MRU filenames.String mruFileName) Updates the list of MRU files in the menu structure with a filename to be inserted at a specified index. Pa c k a g e c o m .

debugMessage public static void debugMessage(java.util.String sMsg) Used internally.String sMsg) Used internally.ACJDesigner. Returns A reference to the active implementation of IDataSource used by the designer.getDataSources public java.actuate. ACJDesigner.getClient public ACJOutputProcessor getClient() Returns an instance of ACJOutputProcessor used by ACJDesigner. used internally.ereport.debugMessageLN public static void debugMessageLN(java. 78 e. ACJDesigner.engine.getActiveDataSource public com. ACJDesigner.Vector getDataSources() Returns a vector containing all registered data sources. public static void debugMessageLN() Used internally.lang. ACJDesigner.IDataSource getActiveDataSource() Returns the active selected data source for data extraction.Repor t Designer API Java Edition .lang.

A C J D e s i g n e r 79 .getDebugMode public static boolean getDebugMode() Returns the current debug mode. Returns A reference to the engine maintained internally by the designer. ACJDesigner. a c t u a t e .ACJDesigner.getEngine public ACJEngine getEngine() Returns the reference of ACJEngine maintained by the GUI.lang. ACJDesigner. d e s i g n e r. It is not in the AWT API. ACJDesigner. Returns The array of filenames stored in the MRU list. Pa c k a g e c o m . e r e p o r t . Method is only in the SWING API.String[] getMruList() Returns an array of filenames stored in the MRU list. This function is called internally by GuiTemplate. Returns A reference to the internally maintained instance of AppDataHandler.getRegdAppDataHandler public AppDataHandler getRegdAppDataHandler() Returns an instance of the registered AppDataHandler data source.getMruList public java.

engine.actuate. Returns A reference to the internally maintained instance of EJBHandler. ACJDesigner.getRegdEJBHandler public com.getRegdMetaDataHandler public MetaDataHandler getRegdMetaDataHandler() Returns an instance of the registered MetadataHandler data source. Returns A reference to the internally maintained instance of JDBCHandler.ACJDesigner.Repor t Designer API Java Edition .ereport. Returns A reference to the internally maintained instance of ASCIIDataHandler.IDataSource getRegdEJBHandler() Returns an instance of the registered EJBHandler data source.getRegdASCIIDataHandler public ASCIIDataHandler getRegdASCIIDataHandler() Returns an instance of the registered ASCIIDataHandler data source.getRegdJDBCHandler public JDBCHandler getRegdJDBCHandler() Returns an instance of the registered JDBCHandler data source. ACJDesigner. ACJDesigner. 80 e.

Pa c k a g e c o m . ACJDesigner.awt.ItemEvent ie) Notification received when the active tab is changed via the menu option.event.event.ereport. d e s i g n e r.itemStateChanged public void itemStateChanged(java.getRelations public java. A C J D e s i g n e r 81 .ItemListener. Returns A reference to the internally maintained instance of JDBCHandler.lang. Specified by itemStateChanged in interface java.util. ACJDesigner.actuate. ACJDesigner.getRegdXMLDataHandler public com.Returns A reference to the internally maintained instance of MetaDataHandler. ACJDesigner.IDataSource getRegdXMLDataHandler() Returns an instance of the registered XMLDataHandler data source. Returns A vector of relations stored as strings.loadTemplate public void loadTemplate(java. e r e p o r t .Vector getRelations() Returns a vector of Relations strings used internally.engine. a c t u a t e .awt.String urlORfile) Requests the Designer to load a template into the user interface.

lang.UTF8. either ACJConstants.ASCII or ACJConstants.String[] s) ACJDesigner.lang. templateEncoding A constant.saveTemplate public void saveTemplate(java.String urlORfile) Requests the Designer to save the template to a file.Repor t Designer API Java Edition .loadTemplate public void loadTemplate(java.Graphics g) ACJDesigner.main public static void main(java.util. ACJDesigner.String urlORfile. 82 e.paintComponent public void paintComponent(java.urlORfile The URL or file location where the template can be found.registerDataSources public void registerDataSources(java. int templateEncoding) Requests the Designer to load a template into the user interface using the specified encoding 'templateEncoding'. ACJDesigner.Vector vDSM) Registers a vector of data sources for selection via the GUI. ACJDesigner.lang.awt. urlORfile The URL or file location where the template can be found.

Pa c k a g e c o m . MetaDataHandler ACJDesigner. AppDataHandler. ids An implementation of the IDataSource interface. boolean bAutoOrder) Specifies whether it is required to automatically update the WHERE and/or ORDERBY clauses based on template contents.UTF8.lang. public void saveTemplate(java. ACJDesigner.String urlORfile. See also JDBCHandler. either ACJConstants. e r e p o r t .IDataSource ds) Selects one of the registered data sources for data extraction.actuate.ASCII or ACJConstants.urlORfile The URL or file location where the template is to be stored. A C J D e s i g n e r 83 .ereport.setActiveDataSource public void setActiveDataSource(com.setAutoQuery public void setAutoQuery(boolean bAutoWhere. int templateEncoding) Requests the Designer to save the template to a file using the specified encoding 'templateEncoding'. bAutoOrder Indicates that the ORDERBY clause should be automatically updated based on the grouping criteria. a c t u a t e . templateEncoding A constant. urlORfile The URL or file location where the template is to be stored. d e s i g n e r.engine. bAutoWhere Indicates that the WHERE clause should be automatically updated internally for joins based on table relations.

ACJDesigner. and ACJConstants. showGrid Indicates whether the grid should be displayed.setDefaultAttachLabel public void setDefaultAttachLabel(boolean isLabelAttached) Specifies whether a label should be automatically added to the visible group header above the zone in which a data field is dropped.setDebugMode public static void setDebugMode(boolean b) Specifies whether progress or error messages are to be displayed in the console window.setDefaultExitMode public void setDefaultExitMode(int exitMode) Sets the default File .DISPOSE_WINDOW. ACJDesigner.NONE. 84 e. ACJDesigner. ACJDesigner.Repor t Designer API Java Edition .setDefaultGridSnap public void setDefaultGridSnap(boolean isSnapped) Sets the default value for Snap to Grid when designing templates. isSnapped Indicates whether the controls in the Designer are restricted along grid boundaries. ACJConstants.Exit action.EXIT_JVM. exitMode Any combination of ACJConstants.

then the Quote Identifier is prepended and appended to it by default. bPrependSchema A boolean value indicating whether the table name should be prefixed with the schema.setDefaultLookAndFeel public void setDefaultLookAndFeel(java. A C J D e s i g n e r 85 . e r e p o r t . ACJDesigner.setDefaultHorzGap public void setDefaultHorzGap(int iSpaceInPixels) Sets the default horizontal gap between two controls that are automatically arranged by spacing them side by side.setDefaultImageRelativePath public void setDefaultImageRelativePath(boolean bImageUsesRelativePath) Specifies whether the location is automatically updated as a relative path when the image path is changed for an image control. bImageUsesRelativePath Indicates whether the path for the image should assume a path that is relative to the application codebase.lang.ACJDesigner. ACJDesigner. ACJDesigner.setDefaultLowercaseQuotes public void setDefaultLowercaseQuotes(boolean bLowercaseQuotes) Specifies that if a table or column has lowercase characters embedded in it.String sLookNFeel) This method is used only in the SWING API. a c t u a t e . It is not in the AWT API. d e s i g n e r. Pa c k a g e c o m . iSpaceInPixels Specifies the default pixel width between controls which are arranged horizontally.

Actuate e. ACJDesigner.setDefaultNewTemplate public void setDefaultNewTemplate(boolean isBlankTemplate) Deprecated. as expected by ORACLE8.bPrependSchema A boolean value indicating whether the all-lowercase tablename should be surrounded by quotes.setDefaultTemplateEncoding public void setDefaultTemplateEncoding(int templateEncoding) 86 e. Otherwise.erw'.setDefaultPrependSchema public void setDefaultPrependSchema(boolean bPrependSchema) Specifies whether the schema or owner name should be prepended to the table name by default in the FROM clause. ACJDesigner.Repor t Designer API Java Edition .Report Designer creates a default startup skeleton template. Specifies whether a new template is blank (default = True) or should be read from a file 'startup. ACJDesigner.setdefaultshowgrid public void setDefaultShowGrid(boolean showGrid) Sets the default value to show the grid when designing templates. ACJDesigner. ACJDesigner.setDefaultPrintMode public void setDefaultPrintMode(boolean bLandscape) Specifies whether to generate preview or printer output in landscape format (True) or portrait format (False).

This function is called internally by GuiTemplate. d e s i g n e r. sDoc The filename of the user guide.lang. Currently supported templateEncodings are ACJConstants.String[] ml) Specifies an array of filenames to be stored in the MRU list. ACJDesigner.lang. A C J D e s i g n e r 87 . specifies the filename to be used by the GUI when the Save Template option is selected from the menu. a c t u a t e . ACJDesigner.String urlORfile) When a template is loaded externally.lang. e r e p o r t .setHasBeenGenerated public void setHasBeenGenerated(boolean hasBeenGenerated) ACJDesigner.UTF8.setDocsPath public void setDocsPath(java.Sets the default template 'templateEncoding'. ACJDesigner.String sDoc) Specifies the name of the user guide file. urlORfile The URL or file location where the template can be found.setTemplateFile public void setTemplateFile(java. Pa c k a g e c o m .ASCII and ACJConstants. mruList An array of filenames containing templates.setMruList public void setMruList(java.

swing.showMenu public void showMenu() Constructs the menu structure used in the menu bar.stateChanged public void stateChanged(javax. Specified by stateChanged in interface javax.event.syncTmplMgr public void syncTmplMgr() Used internally. ACJDesigner.event. used internally.ChangeEvent e) Notification received just before the Designer's tab is changed. ACJDesigner.ACJDesigner.updateOutputProperties public void updateOutputProperties() 88 e. Used internally by ACJDesigner. ACJDesigner.ChangeListener ACJDesigner.updateDesigner public void updateDesigner() Forces the Designer to reflect changes made to the template via the API.Repor t Designer API Java Edition .swing.

updateRelations public void updateRelations() Used internally.windowActivated public void windowActivated(java. This notification is used to prompt the user to save the existing template before quitting. d e s i g n e r.awt.ACJDesigner.awt.WindowListener Pa c k a g e c o m .windowClosed public void windowClosed(java.event.WindowListener ACJDesigner.WindowEvent ev) Specified by windowClosed in interface java.awt. e r e p o r t . a c t u a t e . Specified by windowClosing in interface java.WindowListener ACJDesigner.WindowEvent ev) Specified by windowActivated in interface java.event.event.awt.awt.windowClosing public void windowClosing(java.event.awt. A C J D e s i g n e r 89 .event.event.WindowEvent ev) Notification received when an attempt is made to close the parent frame. ACJDesigner.

awt.WindowEvent ev) Specified by windowIconified in interface java.WindowListener Specified by windowOpened in interface java.WindowEvent ev) 90 e.awt.windowIconified public void windowIconified(java.windowDeactivated public void windowDeactivated(java.event.event.WindowEvent ev) Specified by windowDeactivated in interface java.ACJDesigner.event.event.WindowListener ACJDesigner.Repor t Designer API Java Edition .event.WindowListener ACJDesigner.event.event.event.awt.awt.WindowListener ACJDesigner.awt.WindowEvent ev) Specified by windowDeiconified in interface java.windowDeiconified public void windowDeiconified(java.awt.awt.awt.windowOpened public void windowOpened(java.

actuate.Package Package com. e n g i n e. AC J E n i g n e 91 .a c t u a t e. e r e p o r t.ACJEngine Pa ck a g e c o m .ereport. engine.

Repor t Designer API Java Edition . This class contains references of key objects such as the active data source. and a communication stub. which is capable of processing formulae embedded inside the report.ACJEngine _____________________________________________________________________ public class ACJEngine extends java. Constructor summary ACJEngine() The default constructor creates an instance of the report engine and initializes it by calling newSystem() internally.Object | +--com.Class ACJEngine java.actuate.lang. the Expression Evaluator.ereport. Field summary Type boolean Field DEBUG A boolean variable used for internal debugging. which handles the template skeleton structure.Object This class forms the heart of the reporting engine.engine. Users must instantiate this class as the first step in using ACJEngine for data reporting. from which data is extracted for generating reports. which provides an interface for buffered raw report data to be fetched by the output devices. the Template Manager.lang. 92 e.

When generating a report.getDebugMode() ACJEngine . This function is used internally for debugging.finalizeEngine() ACJEngine . returns data for a specified column in the Current Tuple in the result set structure represented by ITable. Returns the availability of the X11 Gfx subsystem while performing internal validations. Description If this flag is set to True. Returns an instance of the actual IPrinter report generation interface implementation.debugMessage ACJEngine .doesX11GfxExist() ACJEngine . e n g i n e.debugMessageLN ACJEngine .getData source() ACJEngine . any template with an embedded data source attempts to connect to that data source and updates the active data source reference in the engine. Returns an implementation of the IViewerInterface. e r e p o r t. Returns an instance of the active data source implementation that is currently registered with ACJEngine.getEvaluater() ACJEngine .getCommunicationStub() ACJEngine .getOutputDevice() Generates the report and returns IViewerInterface instance required by ACJOutputProcessor. Returns the current debugMode status.disconnect() ACJEngine . Pa ck a g e c o m . This function is used internally for debugging.getColValue ACJEngine . This method was called internally by the engine in previous releases of ACJEngine.autoConnectDatasource ACJEngine .generateReport() ACJEngine . Returns the internal reference of ExprEvaluator that is required to register user-defined functions.debugMessageLN() ACJEngine .Method summary Method ACJEngine . This function is used internally for debugging.a c t u a t e. AC J E n i g n e 93 .

printingDone() ACJEngine . This method is called internally to generate the entire report.Repor t Designer API Java Edition . Used in cases where loading a template from a local file is not a viable option.readTemplate 94 e. TemplateManager is the main class that lets the user manipulate most aspects of the template. This function is used to update the value of the resolution parameter stored in a template with the resolution value specified by the user.newTemplate() ACJEngine .Method ACJEngine .getTemplateManager() ACJEngine .getTemplateWriter() ACJEngine . This function returns a reference to the internal TmplMgr instance variable maintained by ACJEngine. This function is called when data in the engine needs to be cleared.overrideResolution(int res) ACJEngine .newSystem() ACJEngine . Returns an instance of the default implementation of ITmplReader that is capable of reading an ASCII/Unicode template structure from a specified input file or stream.getTemplateReader() Description Returns the proportional increment required to fix the resize-to-fit feature for other output devices. Reads the template from the specified InputStream. This function is called when data in the engine needs to be cleared.getTmplMgr() ACJEngine . ACJEngine . Returns an instance of the default implementation of ITmplWriter that is capable of writing an ASCII/Unicode template structure to a specified output file or stream. Notification received when the report generation process is complete.getResizeFixRatio() ACJEngine .getOutputDevice() ACJEngine .print() ACJEngine .

setDataSource ACJEngine .setCacheOption ACJEngine . e n g i n e.Method ACJEngine . Specifies whether progress or error messages are displayed in the console window. Reads a template from the specified filename using the specified encoding and updates the contents of the Template Manager. Sets the internal reference of the IViewerInterface implementation. Specifies whether the temporary file is generated by ACJEngine during report generation and if it should be stored in memory or in a file on disk.setDebugMode ACJEngine . Reads a template from the specified filename.readTemplate ACJEngine .a c t u a t e. AC J E n i g n e 95 . Users must specify the implementation of the data source that is used for data retrieval when generating reports.readTemplate ACJEngine .setCommunicationStub ACJEngine .setResizeFixRatio ACJEngine .readTemplate ACJEngine . Used in cases where loading a template from a local file is not a viable option.setOutputDevice ACJEngine . Specifies a custom implementation of the ITmplReader interface used to read the contents of a report template from a file or input stream.resetStub() ACJEngine . This function lets a user specify a customized implementation of the IPrinter report generation interface. Sets the proportional increment required to fix the resize-to-fit feature for other output devices.setTemplateReader Description Reads a template from the specified InputStream.setTargetOutputDevice ACJEngine . e r e p o r t. Pa ck a g e c o m .

This method attempts to write the contents of the entire template structure maintained by the Template Manager to a specified file using the specified encoding type. Specifies whether the X11 Graphics subsystem is available so font creation and other tasks can be safely carried out.updateResolution() ACJEngine .writeTemplate ACJEngine .Method ACJEngine . This method attempts to write the contents of the entire template structure maintained by the Template Manager to a specified file using the specified encoding type.writeTemplate ACJEngine .Repor t Designer API Java Edition .setX11GfxAvailibility ACJEngine . ACJDesigner constructor ACJEngine public ACJEngine() 96 e.writeTemplate Field detail DEBUG public boolean DEBUG A boolean variable used for internal debugging. ACJEngine . This method attempts to write the contents of the entire template structure maintained by the Template Manager to a specified file using the default ANSI encoding type. This function is used to update the value of the resolution parameter stored in a template with the value of the current screen resolution.setTemplateWriter Description Specifies a custom implementation of the ITmplWriter interface used to write the contents of a report template to a file or output stream.

AC J E n i g n e 97 .lang. a template with an embedded data source attempts to connect to that data source and update the active data source reference in the engine. See also ACJEngine. It is a flagged version of System. e n g i n e.newSystem() ACJEngine..debugMessageLN public static void debugMessageLN(java.println(.autoConnectDatasource public void autoConnectDatasource(boolean bAutoConnect) If this flag is set to True..String sMsg) This function is used internally for debugging.String sMsg) This function is used internally for debugging.a c t u a t e.). sMsg A message to be displayed on the console window public static void debugMessageLN() Pa ck a g e c o m . It allows a debug flag to be used to turn on or off all console messages.. It is a flagged version of System. e r e p o r t..The default constructor creates an instance of the report engine and initializes it by calling newSystem() internally. ACJEngine.lang.print(. ACJEngine.out.out.debugMessage public static void debugMessage(java. It allows a debug flag to be used to turn on or off all console messages.). sMsg A message to be displayed on the console window.

common.Exception This method was called internally by the engine in previous releases of ACJEngine. These calls are useful when working with reports that use parameters. They generate the report only when you request the data from the report.actuate.ereport.. ACJEngine. Alternatively.lang.out.doesX11GfxExist public static boolean doesX11GfxExist() Returns the availability of the X11 Gfx subsystem while performing internal validations.generateReport public com.println(. The following initialization is required before generating a report: 98 e. These calls do not generate the report immediately.IViewerInterface generateReport() throws java. It allows a debug flag to be used to turn on or off all console messages.Throwable ACJEngine.Repor t Designer API Java Edition .This function is used internally for debugging.). ACJEngine. It should not be explicitly called from an external class although the method is defined as public.xx. ACJEngine. It is a flagged version of System.disconnect public void disconnect() throws java. It has been provided only for backward compatibility.. however.Exception Generates a report and returns the IViewerInterface instance required by ACJOutputProcessor. This method is not used in ACJEngine 3.lang.finalizeEngine public void finalizeEngine() throws java.lang. you can call getDATReader(boolean b) or getCommunicationStub().

Object ColumnName) throws java.Exception Returns an implementation of the IViewerInterface.lang.ereport.ereport. Returns An implementation of the IViewerInterface communication stub.engine.getColValue public java. e n g i n e. e r e p o r t.stub.a c t u a t e. java.DefaultReadWriteStub. ACJEngine.getCommunicationStub public com. the parameter values should be set properly. ACJEngine.actuate. It is provided for backward compatibility only. AC J E n i g n e 99 .ereport. 2 ACJEngine should have a valid data source and should be connected to it.common. When generating the report.stub.Object TableId.Object getColValue(java. Abnormal termination usually occurs because of a fatal error. which generates a finished report from a raw report. Pa ck a g e c o m .IViewerInterface getCommunicationStub() throws java.lang.1 The template should be read properly. For normal report generation. the default implementation is com.Exception This function is not used. Returns An implementation of IViewerInterface communication interface Throws An exception occurs if the report generation process is abnormally terminated.lang.lang. data is returned for a specified column in the Current Tuple in the result set structure represented by ITable.engine. the default implementation is com.DefaultReadOnlyStub.actuate. 3 If the template under consideration has any parameters.actuate. For a thin viewer.lang.

ExprEvaluator getEvaluater() Returns the internal reference of ExprEvaluator that is required to register user-defined functions.getDebugMode public static boolean getDebugMode() Returns the current debugMode status.actuate. ACJEngine. Returns An instance of the expression evaluator maintained by ACJEngine. Typically. ACJEngine. This function returns an instance of the actual IPrinter report generation interface implementation. The ExprEvaluator package is responsible for processing complex expressions embedded inside a template.ereport.IPrinter getOutputDevice() This function should not be used.getData source public com.engine.Repor t Designer API Java Edition .engine.IDatasource getDataSource() Returns an instance of the active data source implementation that is currently registered with ACJEngine. 100 e. A report template that is used in generating reports must use fields from this data source only. It is provided only for backward compatibility.engine.getEvaluater public com. ACJEngine.actuate. this function is used when the default output generation mechanism is overridden.ereport.getOutputDevice public com.ereport. Returns A generic instance of the active data source.expreval.actuate.ACJEngine.

When the instance is destroyed.Returns An implementation of the IPrinter interface.actua te. Returns An instance of the Template Manager internally maintained by the engine. Packa ge com. ACJEngine. ACJEngine.getTemplateReader public com. It is provided for backward compatibility only. Returns an instance of the default implementation of ITmplReader that is capable of reading an ASCII/Unicode template structure from a specified input file or stream.engine.getTargetOutputDevice public int getTargetOutputDevice() ACJEngine.actuate.getTemplateManager public TemplateManager getTemplateManager() TemplateManager is the main class that lets the user manipulate most aspects of the template.ere po r t. Returns An instance of the default ITmplReader implementation.ITmplReader getTemplateReader() This API should not be used. you must re-query the engine for the instance of the newly created Template Manager.en gin e.ereport. Note that this instance is destroyed whenever a call to the newSystem() or newTemplate() methods is made.AC JEnig ne 101 . You must get an instance of the Template Manager using this method before you can access the template via the public API.

engine. resets the Expression Evaluator.newSystem public void newSystem() This function is called when all variables in the engine need to be reset. It is provided for backward compatibility only.getTmplMgr public com. Returns A reference to the internal Template Manager instance variable used for manipulating the template structure. It is called internally and must not be called from an external source.ereport. Returns an instance of the default implementation of ITmplWriter that is capable of writing an ASCII/Unicode template structure to a specified output file or stream. ACJEngine. ACJEngine.actuate.Repor t Designer API Java Edition .ITmplWriter getTemplateWriter() This API should not be used. destroys the contents of the entire template structure (including report header/footer. Returns An instance of the default ITmplWriter implementation.actuate. clears dynamic tables. 102 e.ACJEngine. page header/footer.ereport. this function removes the active data source. Internally.engine. and the default section). Its return type has been declared public because it is required from classes in other packages.TmplMgr getTmplMgr() This function returns a reference to the internal Template Manager instance variable maintained by ACJEngine. and resets the instance of the Template Manager maintained by the engine.getTemplateWriter public com.

page header/footer.overrideResolution public void overrideResolution(int res) This function is used to update the value of the resolution parameter stored in a template with the resolution value specified by the user. and notifies the IPrinter implementation for different printing messages.newSystem() ACJEngine. destroys the contents of the entire template structure (including report header/footer. ACJEngine.lang. this function clears dynamic tables. resets the Expression Evaluator. See also ACJEngine. formats the data. fetches a record set from the active Data source. The call to this method should be made after the call to the readTemplate method. It is called internally by the generateReport() API after query parameter values are substituted.AC JEnig ne 103 . and the default section) and resets the instance of the Template Manager maintained by the engine. Packa ge com.en gin e. which autogenerates a query.ere po r t.See also ACJEngine.Exception This method is internally called to generate the entire report.actua te. Internally.newTemplate public void newTemplate() This function is called when all variables in the engine need to be reset.newTemplate() ACJEngine.print public void print() throws java. This method internally calls the print() function in the Template Manager.

String template) throws java.Repor t Designer API Java Edition .readTemplate public void readTemplate(java. Updates the contents of the Template Manager.Exception Reads a template from specified filename using the specified encoding.lang. This function is specifically implemented to clear all stateless variables. int fileMode) throws java. It explicitly frees memory locked by unused objects.Exception Reads a template from specified filename. Abnormal termination usually occurs because of a fatal error. ACJEngine. Any data source embedded in the template is loaded and set as the active data source. ACJEngine. ACJEngine. fileMode Encoding type.UTF8. and ACJConstants.lang. template Path of the template file to be read.Throws An exception occurs whenever the report generation process is abnormally terminated.lang.lang. Permissible values are ACJConstants.ASCII.readTemplate public void readTemplate(java. 104 e. template A valid path indicating a template file containing a template written in an ANSI format.printingDone public void printingDone() Notification received when the report generation process is complete.String template.

resetStub public void resetStub() ACJEngine. Indicates whether the temporary file should be stored in memory Packa ge com. streamMode Encoding type. This function instantiates Template Manager and reads the template. ACJEngine.setCacheOption public void setCacheOption(boolean filecache.io.InputStream template) throws java.ASCII and ACJConstants. template A valid input stream from which a template formatted using ANSI encoding can be loaded.String tempfile) Specifies whether the temporary file is generated by ACJEngine during report generation.lang.ACJEngine.Exception Reads a template from the specified input stream. Any data source embedded inside a template is automatically loaded and set as the active data source. java.AC JEnig ne 105 .InputStream template.actua te.UTF8.io. Used in cases where loading a template from a local file is not a viable option. public void readTemplate(java.readTemplate public void readTemplate(java. Used in cases where loading a template from a local file is not a viable option.lang. template Input stream from which a template is to be read.en gin e. Valid types are ACJConstants.Exception Reads a template from a specified input stream.ere po r t. int streamMode) throws java. template Input stream from which template is to be read. This function instantiates Template Manager and reads the template.lang.

Sets the internal reference of the IViewerInterface implementation.setDataSource public void setDataSource(com. ACJEngine. Keeps data in memory if False is passed. Default action is to store in memory.BaseStub stub) This function was called internally in previous versions of ACJEngine. and MetaDataHandler. ACJEngine.setCommunicationStub public void setCommunicationStub(com. however.Repor t Designer API Java Edition .actuate.Exception Users must specify the implementation of the data source to be used for data retrieval when generating reports. 106 e. AppDataHandler. you should use the file option to save memory.stub.ereport.actuate. ACJEngine. It is no longer used and must not be used from outside ACJEngine. It has only been provided for backward compatibility. filecache Stores temporary files to disk if True is passed.or in a file on disk. If you have a large data set.engine. tempfile Path of a temporary file.engine.setDebugMode public static void setDebugMode(boolean b) Specifies whether progress or error messages are to be displayed in the console window. Valid only if the first parameter is True.lang. b Turns on or off the engine-related debugging messages that appear in the console window. Default implementations of the data source interface (IDataSource) provided are JDBCHandler.IDataSource ds) throws java.ereport.

en gin e.IPrinter ip) This function is not used. It is provided for backward compatibility only.engine.ereport. Packa ge com.ITmplReader it) This API is not used.AC JEnig ne 107 .getResizeFixRatio public float getResizeFixRatio() Returns the proportional increment required to fix the resize-to-fit feature for other output devices. ACJEngine. ACJEngine.actuate. Specifies a custom implementation of the ITmplReader interface used to read the contents of a report template from a file or input stream. This function lets a user specify a customized implementation of the IPrinter report generation interface.ere po r t.setOutputDevice public void setOutputDevice(com.setResizeFixRatio public void setResizeFixRatio(float fResizeFixRatio) Sets the proportional increment required to fix the resize-to-fit feature for other output devices.ACJEngine. ACJEngine.setTemplateReader public void setTemplateReader(com.ereport.setTargetOutputDevice public void setTargetOutputDevice(int iTargetOutputDevice) ACJEngine.actua te. It is provided only for backward compatibility.engine.actuate.

ITmplWriter it) This API is not used. The call to this method should be made after the call to the readTemplate method. ACJEngine. fileMode Encoding type.lang. template Output file name to which template is to be saved.ASCII and ACJConstants.ereport. Permissible values are ACJConstants.lang. ACJEngine.engine.String template. ACJEngine. 108 e. It is provided for backward compatibility only.setX11GfxAvailibility public static void setX11GfxAvailibility(boolean b) Specifies whether the X11 Graphics subsystem is available so font creation and other tasks can be safely carried out.setTemplateWriter public void setTemplateWriter(com. int fileMode) throws java.Repor t Designer API Java Edition .Exception This method attempts to write the contents of the entire template structure maintained by the Template Manager to a specified file using the specified encoding type. Specifies a custom implementation of the ITmplWriter interface used to write the contents of a report template to a file or output stream.UTF8.actuate.updateResolution public void updateResolution() This function is used to update the value of the resolution parameter stored in a template with the value of the current screen resolution.writeTemplate public void writeTemplate(java.ACJEngine.

lang.ASCII and ACJConstants.Exception This method attempts to write the contents of the entire template structure maintained by the Template Manager to a specified file using the default ANSI encoding type.en gin e. int streamMode) throws java.ere po r t. Packa ge com.lang.io.UTF8.AC JEnig ne 109 .OutputStream os.OutputStream os) throws java. os Output stream to which the template is to be saved. os Output stream to which template is to be saved.Exception This method attempts to write the contents of the entire template structure maintained by the Template Manager to a specified file using the specified encoding type. ACJEngine. Permissible values are ACJConstants.writeTemplate public void writeTemplate(java.io.actua te.writeTemplate public void writeTemplate(java.ACJEngine. streamMode Encoding type.

110 e.Repor t Designer API Java Edition .

ereport.erepo r t.Package Package com.ACJOutpu tProcessor 111 . ACJOutputProcessor Pa cka ge com.actuate.actua te. output.ou tput.

You can write your own code to read the template file and generate the report. Use setCSVProperty() / generateCSV() instead.debugOutputProps() ACJOutputProcessor .generateCSV ACJOutputProcessor . Constructor summary ACJOutputProcessor() A default constructor.generateCSV() ACJOutputProcessor .closeZipEntry ACJOutputProcessor .Object | +--com.generateDHTML() Undocumented feature.ACJOutputProcessor _____________________________________________________________________ public class ACJOutputProcessor extends java. You do not need GUI components for generating the report. After setting the raw report data in ACJOutputProcessor. Use setCSVProperty() / generateCSV() instead. Description 112 e.lang. You can set the properties for the output devices using the setXXXProperty methods provided in this class and then call the required generate methods.ereport. Generates a DHTML report using the properties individually set by the setDHTMLProperty() method.lang. Method summary Method ACJOutputProcessor .Object This class provides APIs for generating the report output from the template file. Deprecated.output.Class ACJOutputProcessor java. Deprecated.closeZipStream ACJOutputProcessor .actuate.Repor t Designer API Java Edition . you can generate the output in the required format without having to make use of the designer.generateCSV ACJOutputProcessor . Generates a CSV report using the properties individually set by the setCSVProperty() method.

ACJOutputProcessor .generateEMAIL() ACJOutputProcessor .Use setHTMLProperty() / generateHTML() instead. Generates a PDF report using the properties individually set by the setPDFProperty() method. Use setPRINTERProperty() / generatePRINTOUT() instead.generatePDF ACJOutputProcessor . Deprecated.generatePDF ACJOutputProcessor .generateDHTML ACJOutputProcessor . Prints a hardcopy of the report using properties individually set by setPRINTERProperty().actua te. JOI is a raw ACJEngine data file that lets users create report executables.generateHTML ACJOutputProcessor . Deprecated.generateHTML ACJOutputProcessor .Use setPDFProperty() / generatePDF() instead. Deprecated. Deprecated. Use setPDFProperty() / generatePDF() instead.Use setPDFProperty() / generatePDF() instead. Use setPDFProperty() / generatePDF() instead.generateJOI() ACJOutputProcessor .generateHTML() ACJOutputProcessor . Use setDHTMLProperty() / generateDHTML() instead. Use setPDFProperty() / generatePDF() instead. Deprecated. Deprecated.ou tput.generateHTML ACJOutputProcessor .generatePDF() ACJOutputProcessor .generateJOI Description Deprecated. Deprecated. Generates an HTML report using the properties individually set by the setHTMLProperty() method.generatePDF ACJOutputProcessor . Use setHTMLProperty() / generateHTML() instead. Use setHTMLProperty() / generateHTML() instead. Deprecated. Exports the current report to a JOI file specified by the argument.Method ACJOutputProcessor .generatePRINTOUT() ACJOutputProcessor . Generate a JOI report using the properties individually set by the setJOIProperty() method. Deprecated. Transmits the listed set of e-mails to the recipients via an SMTP server and other properties as set by setEMAILProperty().generatePRINTOUT Pa cka ge com.ACJOutpu tProcessor 113 .generatePDF ACJOutputProcessor .generatePDF_Ex ACJOutputProcessor .erepo r t.

Gets the path to the main documentation file.getJOIProperty ACJOutputProcessor .getOutputFiles() ACJOutputProcessor . Use setPrinterProperty() / generatePRINTOUT() instead.getDocumentationPath() ACJOutputProcessor .getPDFProperty ACJOutputProcessor . Attempts to retrieve an individual property to be used by the DHTML output device.getDHTMLDevice() ACJOutputProcessor .getPreviewDevice() Description Deprecated.generatePRINTOUT ACJOutputProcessor . Returns a list of files generated for a structured output.Repor t Designer API Java Edition . All publicly available APIs to control the preview device are available through ACJOutputProcessor. ACJOutputProcessor . Attempts to retrieve an individual property to be used by the HTML output device. They are only accessible after making a call to getPreviewDevice(). Used internally.getHTMLProperty ACJOutputProcessor . Attempts to retrieve an individual property used by the CSV output device when generating an CSV report.getEMAILProperty ACJOutputProcessor . Used internally. a handle of OD_Preview is needed before the preview device can be embedded inside a container such as a frame or a control.getDHTMLProperty ACJOutputProcessor . A handle is also needed before the preview device can be controlled through the API in this class. Attempts to retrieve an individual property used by the printer output device when printing a report.getCSVProperty ACJOutputProcessor . Attempts to retrieve an individual property used by the PDF output device when generating an PDF report.getDHTMLDevice() ACJOutputProcessor . Returns an instance of the preview device. Attempts to retrieve an individual property used by the printer output device when printing a report. Attempts to retrieve an individual property used by the JOI Handler when generating a JOI report.Method ACJOutputProcessor .getPRINTERProperty 114 e.

If more than a single output file is generated. possible return values are 50.getPRINTERProperty() Description Returns the current resolution for the printer device only when printer resolution is set through setPrinterResolution. Returns the zoom factor in the preview device as a percentage value.erepo r t.getVirtualOutput() ACJOutputProcessor . The previous page can be a subpage split on the current page. ACJOutputProcessor . zero is returned.ACJOutpu tProcessor 115 .promptParams ACJOutputProcessor .Method ACJOutputProcessor .prv_setNextPage() ACJOutputProcessor . 100 and 200.prv_setActivePage(int p) ACJOutputProcessor . Removes a single item from the toolbar in the preview window. Pa cka ge com. Returns the count of available pages in the preview.prv_removeToolbarItem ACJOutputProcessor . possible values are 50.prv_getPageCount() ACJOutputProcessor .prv_setZoom(int z) Indicates whether the Parameter Entry dialog will display when the report output is required. 75. The next page can be a subpage split on the current page.instantiateZipStream() ACJOutputProcessor . Otherwise. 75.ou tput. Sets the zoom factor in the preview device as a percentage value.actua te. Specifies if the Parameter Entry dialog should be displayed when the report output is required. 100 and 200. Sets the active page to the previous page. used internally. Sets the active page in the preview window. Returns the active page in the preview window.prv_setBackgroundTOC ACJOutputProcessor . this API returns True.prv_getActivePage() ACJOutputProcessor . Sets the active page to the next page.prv_setPrevPage() ACJOutputProcessor .hasMultipleOutputFiles() ACJOutputProcessor .instantiateZipStream ACJOutputProcessor .prv_getZoom() ACJOutputProcessor . Sets the background color of the Table of Contents in the preview window. Returns an instance of the VirtualOutput object.

a default value is used. ftp:. the report is regenerated and then the page is retrieved. Re-retrieves the current page. Attempts to set an individual property used by the emailing system when deploying reports.prv_updateToolbar() ACJOutputProcessor . Attempts to set an individual property used by the JOI Handler when generating a JOI report.Repor t Designer API Java Edition .setHTMLProperty ACJOutputProcessor . If True is passed. Shows the toolbar in the preview window.setJOIFileSource ACJOutputProcessor . ACJOutputProcessor . Attempts to set an individual property used by the DHTML output device when generating a DHTML report. Attempts to set an individual property used by the CSV output device when generating an CSV report. the default is 65.setCSVProperty ACJOutputProcessor . Sets the buffer size in bytes for delayed filewrites. or file:). Sets the path to the main documentation file.prv_setBackgroundTOC ACJOutputProcessor .setJOISource 116 e.setBufferSize ACJOutputProcessor . Attempts to set an individual property used by the HTML output device when generating an HTML report.Method ACJOutputProcessor .prv_showToolbar() ACJOutputProcessor .setJOIProperty ACJOutputProcessor .setEMAILProperty Description Shows the Table Of Contents panel in the ACJEngine client window.setDHTMLProperty ACJOutputProcessor . If a property is omitted.putNewZipEntry ACJOutputProcessor . A macro that accepts a string representation of a JOI filename or the location of a JOI filename via a URL (http:.setDocumentationPath ACJOutputProcessor .prv_showTOC() ACJOutputProcessor . Sets the source of report data to a specified filename.536 bytes. Internally calls setJOIURLSource or setJOIFileSource.

Attempts to set an individual property used by the printer output device while printing a report.setPDFProperty ACJOutputProcessor .writeZip ACJOutputProcessor constructor ACJOutputProcessor public ACJOutputProcessor() A default constructor.setJOIURLSource ACJOutputProcessor . ACJOutputProcessor .writeZip ACJOutputProcessor . Pa cka ge com.writefile ACJOutputProcessor . Sets the report data generated to the ACJEngine client module for output of report.setReportData Description Sets the source of report data to a specified URL. Sets the raw report data (generated using ACJEngine.actua te.setOutputProperty ACJOutputProcessor .erepo r t.Method ACJOutputProcessor .setPrinterResolution ACJOutputProcessor .setReportData ACJOutputProcessor .ou tput.generateReport()) as the actual data that ACJOutputProcessor will use to generate output. Attempts to set an individual property used by the PDF output device while generating a PDF report.ACJOutpu tProcessor 117 . Sets and resets the printer resolution. Wrapper to map the existing client keys to the keys in the template.setPRINTERProperty ACJOutputProcessor .

lang.Repor t Designer API Java Edition .closeZipEntry public static void closeZipEntry(java.lang.ZipOutputStream zos) throws java. A runtime exception occurs if there is an error when generating the HTML report. A runtime exception occurs if there is an error when generating the CSV report.lang.Exception Generates a CSV report using the properties individually set by the 'setCSVProperty()' method. 118 e.closeZipStream public static void closeZipStream(java.util.zip. Throws java.generateCSV public void generateCSV() throws java.zip.debugOutputProps public void debugOutputProps() Undocumented feature Throws java.ZipOutputStream zos) throws java.lang.Exception ACJOutputProcessor.RuntimeException.lang. ACJOutputProcessor.util.Exception ACJOutputProcessor.ACJOutputProcessor.RuntimeException.

cSeparator Specifies the separator string. sFilename Filename to which the output should be saved.Component cProgressParent.generateCSV public void generateCSV(java. Exports the current report to a CSV file specified by the given name. cProgressParent An AWT component visible on screen.String cSeparator) Deprecated. cProgressParent An AWT component visible on screen. java.lang. no qualifier is set. If Null is passed.lang.ACJOutpu tProcessor 119 . ACJOutputProcessor internally creates a dummy component.Object sFilename. cTextQual Specifies the text qualifier string.awt.lang.actua te. If Null is passed. cSeparator Specifies the separator string. If Null is passed a comma ( . Pa cka ge com. Use setCSVProperty() / generateCSV() instead.generateCSV public void generateCSV(java. java. If Null is passed a comma ( .lang. java. ACJOutputProcessor.Component cProgressParent.lang. ACJOutputProcessor internally creates a dummy component. Use setCSVProperty() / generateCSV() instead.awt.String cSeparator. java. If Null is passed. java.ACJOutputProcessor. ) is used.Object sFilename.ou tput. ) is used. sFilename Filename to which the output should be saved.String cTextQual) Deprecated.erepo r t. Exports the current report to a CSV file specified by the given name.

boolean preserveColors. boolean isTOC.Exception Transmits the listed set of e-mails to the recipients via an SMTP server with other properties as set by setEMAILProperty(). Use setDHTMLProperty() / generateDHTML() instead. Throws java. Throws java.lang. java.generateDHTML public void generateDHTML(java.RuntimeException. A runtime exception occurs if there is an error when generating the DHTML report. 120 e. A runtime exception occurs if there is an error when generating or sending the report.Object outputDesc.awt.generateEMAIL public void generateEMAIL() throws java. boolean gzip) Deprecated. boolean preserveFonts.ACJOutputProcessor.Component cOffscreenImages.RuntimeException. ACJOutputProcessor. ACJOutputProcessor.lang. boolean useHorSpacing.lang.lang.Exception Generates a DHTML report using the properties individually set by the setDHTMLProperty() method.Repor t Designer API Java Edition .lang.generateDHTML public void generateDHTML() throws java.

If Null is passed. preserveColors Preserves the report's original colors if True is passed. depending on the report type and content. graphs or images are present in the template. Use setHTMLProperty() / generateHTML() instead. boolean preserveFonts.generateHTML public void generateHTML(java.awt. Useful when trying to reduce the size of the output. ACJOutputProcessor creates them internally only if charts.lang.awt.ou tput. java.Object outputDesc.generateHTML public void generateHTML() throws java. preserveFonts Preserves the report's original fonts if True is passed. uses black and white colors for the entire report. cOffscreenImages Any on screen AWT component. creates all text using the default font.generateHTML public void generateHTML(java. Useful when trying to reduce the size of the output.ACJOutpu tProcessor 121 . ACJOutputProcessor.erepo r t.Component cOffscreenImages. ACJOutputProcessor.lang. java.Exception Generates an HTML report using the properties individually set by the setHTMLProperty() method.Component cOffscreenImages. Needed by ACJEngine if charts.lang. boolean preserveColors) Deprecated.ACJOutputProcessor.Object outputDesc. Exports the current report to an HTML file with the given filename. Pa cka ge com. graphs or images are present in the template. Otherwise.actua te. Otherwise. sFilename Filename where output should be saved. Exports optional additional files appended by an ID.

graphs or images are present in the template. boolean gzip) 122 e. preserveFonts Preserves the report's original fonts if True is passed. If Null is passed. preserveColors Preserves the report's original colors if True is passed. Otherwise. preserveColors. depending on the report type and content. Needed by ACJEngine if charts. Useful when trying to reduce the size of the output. sFilename Filename where output should be saved.Object outputDesc.Component cOffscreenImages. Does not generate a Table of Contents if False is passed. Exports optional additional files appended by an ID. ACJOutputProcessor creates them internally only if charts. cOffscreenImages Any on screen AWT component. isTOC Generates a Table of Contents if True is passed.boolean boolean boolean boolean preserveFonts. Exports the current report to an HTML file with the given filename. java. ACJOutputProcessor. creates all text using the default font. Use setHTMLProperty() / generateHTML() instead. boolean useHorSpacing. useHorSpacing. Otherwise. Useful when trying to reduce the size of the output. ignores horizontal spacing between controls.lang. Otherwise. boolean isTOC. graphs or images are present in the template.generateHTML public void generateHTML(java. uses black and white colors for the entire report. boolean preserveFonts.awt.Repor t Designer API Java Edition . useHorSpacing Tries to preserve horizontal spacing between controls if True is passed. isTOC) Deprecated. boolean preserveColors.

generatePDF public void generatePDF() throws java. A runtime exception occurs if there is an error when generating the PDF report. ACJOutputProcessor. Pa cka ge com.erepo r t.RuntimeException.lang.String sFilename) Exports the current report to a JOI file specified by the argument. A runtime exception occurs if there is an error when generating the JOI report. JOI is a raw ACJEngine data file that lets users create report executables. Throws java.lang.generateJOI public void generateJOI() throws java.Exception Generates a PDF report using the properties individually set by the setPDFProperty() method. Use setHTMLProperty() / generateHTML() instead.generateJOI public void generateJOI(java. ACJOutputProcessor. Throws java.lang.lang.lang.RuntimeException.ACJOutpu tProcessor 123 .actua te.Deprecated.ou tput. ACJOutputProcessor.Exception Generates a JOI report using the properties individually set by the setJOIProperty() method.

outputDesc Filename string to which output should be saved.lang.generatePDF public void generatePDF(java. ACJOutputProcessor. Use setPDFProperty() / generatePDF() instead. Needed by ACJEngine if charts. isTOC Specifies whether a Table of Contents is to be generated.ACJOutputProcessor. graphs or images are present in the template. Exports the current report to a PDF file specified by filename. cOffscreenImages Any visible AWT component. graphs or images are present in the template.Object outputDesc. Exports the current report to a PDF file specified by filename. java. ACJEngine generates an instance internally only if charts.Repor t Designer API Java Edition . or an instance of an output stream. cOffscreenImages Any visible AWT component.awt. If Null is passed.awt. graphs or images are present in the template. java. graphs or images are present in the template.Object outputDesc.Component cOffscreenImages) Deprecated. outputDesc Filename string to which output should be saved.lang.generatePDF public void generatePDF(java. Use setPDFProperty() / generatePDF() instead. boolean isTOC) Deprecated. Needed by ACJEngine if charts. or an instance of an output stream. If Null is passed. 124 e.Component cOffscreenImages. ACJEngine generates an instance internally only if charts.

awt. or an instance of an output stream. Exports the current report to a PDF file specified by filename. Use setPDFProperty() / generatePDF() instead. java. boolean isTOC. int maxIds. cOffscreenImages Any visible AWT component. graphs or images are present in the template. If Null is passed. maxPages Every page in a PDF file is represented by an ID. Pa cka ge com. isTOC Specifies whether a Table of Contents is to be generated. int maxPages. Specifies the maximum number of pages required for preallocation.Object outputDesc. Extended API for generating PDF reports.lang.Object outputDesc. outputDesc Filename string to which output should be saved. boolean gzip) Deprecated.awt.generatePDF_Ex public void generatePDF_Ex(java. Needed by ACJEngine if charts. graphs or images are present in the template.generatePDF public void generatePDF(java. Use setPDFProperty() / generatePDF() instead.ou tput.536 bytes. ACJOutputProcessor. The default value is 65. int maxContents) Deprecated.actua te.Component cOffscreenImages. ACJEngine internally generates an instance only if charts.erepo r t. maxIds Every object rendered on a PDF page is represented as an ID.lang. Required for very large reports.ACJOutpu tProcessor 125 .ACJOutputProcessor.Component cOffscreenImages. java.

Specifies the maximum number of contents required for preallocation.PrinterJob. rounded up. In the SWING API. int maxIds. rounded up.Component cOffscreenImages. Required for very large reports. maxContents For an indexed report with a Table of Contents. 126 e. java. ACJOutputProcessor.generatePDF_Ex public void generatePDF_Ex(java.generatePRINTOUT public java. maxIds Every object rendered on a PDF page is represented as an ID. int maxContents.lang. maxPages Every page in a PDF file is represented by an ID. none if False is passed. int maxPages. boolean isTOC) Deprecated.Exception Prints a hard copy of the report using properties individually set by setPRINTERProperty(). rounded up.536 bytes.awt. The default value is 65.Object outputDesc.awt.PrinterJob generatePRINTOUT() throws java. ACJOutputProcessor. Specifies the maximum number of contents required for preallocation. isTOC Generates a Table of Contents if True is passed. the generatePRINTOUT() methods return java. each item in the Table of Contents is stored as a content.lang.awt. Use setPDFProperty() / generatePDF() instead. Extended API for generating PDF reports.print. Specifies the maximum number of pages required for preallocation. each item in the Table of Contents is stored as a content.print.maxContents For an indexed report with a Table of Contents.Repor t Designer API Java Edition .

In the AWT API.erepo r t. boolean preservePrintjob.PrinterJob.awt.awt.print.awt.generatePRINTOUT public java. ACJOutputProcessor. Pa cka ge com. isGui Specifies whether the preview device is showing.PrinterJob. Throws java.awt.awt. the generatePRINTOUT() methods return a java.print.print.PrinterJob generatePRINTOUT(boolean isGui.ACJOutpu tProcessor 127 .PrinterJob pj. if the device is showing. it has a parent frame.awt.lang. boolean silentPrint.ou tput.awt. Use setPrinterProperty() / generatePRINTOUT() instead. boolean preservePrintjob.RuntimeException. Use setPRINTERProperty() / generatePRINTOUT() instead.actua te. In the AWT API. boolean silentPrint) Deprecated. In the AWT API. java.Component bVisibleComponent) Deprecated. java.print.PrinterJob pj.PrintJob. java. the generatePRINTOUT() methods return a java. In the SWING API. the generatePRINTOUT() methods return java. ACJOutputProcessor. the generatePRINTOUT() methods return a java.print.awt.awt.print.generatePRINTOUT public java. Prints a hard copy of the report to the printer specified in the printer specifications/ setup dialog box.PrinterJob generatePRINTOUT(boolean isGui. In the SWING API.awt. the generatePRINTOUT() methods return java.PrintJob. A runtime exception occurs if there is an error when printing the report.PrintJob.

ACJOutputProcessor. OutputStream (OutputStream). ACJOutputProcessor.pj Passes an old instance of a print job for batch printing. silentPrint If True is passed.actuate.ereport. Properties are: FileName (String). sProperty The property to be retrieved. Otherwise. 128 e.Object getCSVProperty(java.getCSVProperty public java.getDHTMLProperty public java.lang.OD_DHTML getDHTMLDevice() Used internally. the dialog box displays before printing. preservePrintjob Indicates whether the PrinterJob should be destroyed or retained for another process. printing occurs without displaying a print dialog box.String sProperty) Attempts to retrieve an individual property used by the CSV output device when generating a CSV report.output. CharacterSeparator (String).lang. ACJOutputProcessor.Repor t Designer API Java Edition .Object getDHTMLProperty(java.String sProperty) Attempts to retrieve an individual property to be used by the DHTML output report.lang.lang. bVisibleComponent The component used to get the print job.getDHTMLDevice public com. and QuoteCharacter (String).

and HorizontalSpacing (Boolean). TableOfContents (Boolean). PreservePageBreaks (Boolean).). Recipients (Vectpr).PDF+HTML+DHTML.String getDocumentationPath() Gets the path to the main documentation file. Properties are: FileName (String). ZipCompressed (Boolean).getHTMLProperty public java.sProperty The property to be retrieved. ACJOutputProcessor. PreserveFonts (Boolean).String sProperty) Attempts to retrieve an individual property used by the printer output device when printing a report. PreserveColors (Boolean). ZipCompressed (Boolean).Object getHTMLProperty(java.lang.getDocumentationPath public java. ReportTypes(Integer . PreservePageBreaks (Boolean). OutputStream (OutputStream).lang.Object getEMAILProperty(java.ACJConstants. VisibleComponent (Component). and FilesToAttach (Vector). Properties are: FileName (String). Subject (String).actua te. and HorizontalSpacing (Boolean).ou tput.lang. PreserveColors (Boolean). VisibleComponent (Component). BufferSize (Integer). PreserveFonts (Boolean).lang. etc.lang.String sProperty) Attempts to retrieve an individual property to be used by the HTML output report. ACJOutputProcessor. Pa cka ge com. Properties are: SMTPServer (String). TableOfContents (Boolean). OutputStream (OutputStream). BufferSize (Integer). ACJOutputProcessor.ACJOutpu tProcessor 129 .erepo r t. SenderEmail (String). sProperty The property to be retrieved.getEMAILProperty public java. sProperty The property to be retrieved. Notes (String).

TableOfContents (Boolean).Repor t Designer API Java Edition .getPDFProperty public java. All publicly available APIs to control the preview device are available through ACJOutputProcessor.getPreviewDevice public javax.lang.Object getJOIProperty(java.lang. MaxItems (Integer). Publicly available APIs are only accessible after making a call to getPreviewDevice(). MaxPages (Integer).Object getPDFProperty(java. for example.String sProperty) Attempts to retrieve an individual property used by the JOI Handler while generating a JOI report. ACJOutputProcessor. sProperty The FileName (String) property to be retrieved.getJOIProperty public java.swing. BufferSize (Integer). ACJOutputProcessor. 130 e. OutputStream (OutputStream).lang.ACJOutputProcessor. such as a frame or panel. and MaxContents (Integer). HTML with Table of Contents or images. VisibleComponent (Component).String sProperty) Attempts to retrieve an individual property used by the PDF output device when generating a PDF report. Properties are: FileName (String).lang. sProperty The property to be retrieved. ZipCompressed (Boolean). ACJOutputProcessor. A handle of OD_Preview is needed before the preview device can be embedded inside a container.JPanel getPreviewDevice() Returns an instance of the preview device.String[] getOutputFiles() Returns a list of files generated for a structured output. The handle is also needed before the preview device can be controlled through the API in this class.lang.getOutputFiles public java.

Pa cka ge com. ACJOutputProcessor.ACJOutpu tProcessor 131 . In the AWT API. Used internally.getPRINTERProperty public java.ou tput.swing.ereport.actuate. getPreviewDevice() returns a java. ACJOutputProcessor. IsGUIVisible (Boolean).In the SWING API. PreservePrinterJob (Boolean).getPrinterResolution public double getPrinterResolution() Returns the current resolution for the printer device only when printer resolution is set through setPrinterResolution.Object getPRINTERProperty(java.JPanel. ACJOutputProcessor. sProperty The property to be retrieved.actua te.VirtualOutput getVirtualOutput() Returns an instance of the VirtualOutput object. getPreviewDevice() returns javax.lang. and SilentPrint (Boolean). Otherwise. zero is returned. VisibleComponent (Component). ACJOutputProcessor. Properties are: PrinterJob (PrintJob).Panel.hasMultipleOutputFiles public boolean hasMultipleOutputFiles() Returns True if more than a single output file is generated.getVirtualOutput public com.String sProperty) Attempts to retrieve an individual property used by the printer output device when printing a report.output.awt.erepo r t.lang.

io.util. returns the total number of pages buffered for the currently selected node in the Table Of Contents. If the report is indexed. ACJOutputProcessor.prv_getActivePage public int prv_getActivePage() Returns the active page in the preview window. ACJOutputProcessor.promptParams public boolean promptParams() Indicates whether the parameter entry dialog displays when the report output is required.zip.ACJOutputProcessor.OutputStream os) throws java.Exception ACJOutputProcessor. 132 e.Repor t Designer API Java Edition .lang.ZipOutputStream instantiateZipStream(java.prv_getPageCount public int prv_getPageCount() Returns the count of available pages in the preview.promptParams public void promptParams(boolean bPromptParams) Specifies whether the parameter entry dialog displays when the report output is required.instantiateZipStream public static java. ACJOutputProcessor.

Printer.actua te.RuntimeException.ACJOutputProcessor. 75. Refresh. ACJOutputProcessor.prv_setActivePage public boolean prv_setActivePage(int p) Sets the active page in the preview window.prv_setBackgroundTOC public void prv_setBackgroundTOC(java.String sName) throws java.Exception Removes a single item from the toolbar in the preview window. ACJOutputProcessor. An error occurs if an attempt is made to remove an icon other than those in the list of removeable items above.lang.prv_removeToolbarItem public void prv_removeToolbarItem(java. Possible return values are 50. TOC.lang. sName A name representing the toolbar item. Permissible values are Export.Color bgClr) Sets the background color of the Table of Contents in the preview window. Navigation.lang. 100.prv_getZoom public int prv_getZoom() Returns the zoom factor in the preview device as a percentage value.ou tput. Throws java.ACJOutpu tProcessor 133 . Zoom. and Margins.awt. ACJOutputProcessor. and 200.erepo r t. Pa cka ge com.

75. ACJOutputProcessor.prv_showTOC public void prv_showTOC() 134 e. ACJOutputProcessor.Repor t Designer API Java Edition .prv_setPrevPage public void prv_setPrevPage() Sets the active page to the previous page.prv_showToolbar public void prv_showToolbar() Shows the toolbar in the preview window. ACJOutputProcessor. The next page may be a subpage split on the current page.prv_setZoom public void prv_setZoom(int z) Sets the zoom factor in the preview device as a percentage value.prv_updateToolbar public void prv_updateToolbar() ACJOutputProcessor. 100 and 200.ACJOutputProcessor. ACJOutputProcessor. Possible values are 50. The previous page may be a subpage split on the current page.prv_setNextPage public void prv_setNextPage() Sets the active page to the next page.

String sProperty. existing report data is used.lang.setBufferSize public void setBufferSize(int bufferSize) Sets the buffer size in bytes for delayed filewrites. java.Object oValue) throws java.putNewZipEntry public static void putNewZipEntry(java.536 bytes.ZipOutputStream zos) throws java.util. Pa cka ge com. If True is passed. ACJOutputProcessor. the report is regenerated.setCSVProperty public void setCSVProperty(java.Shows the Table Of Contents panel in the ACJEngine client window.lang.Exception Attempts to set an individual property used by the CSV output device when generating a CSV report. then the page is retrieved.lang.lang.Exception ACJOutputProcessor.actua te. a default value is used. Otherwise. Setting a higher buffer reduces the time it takes to write a file but increases memory usage.refreshReport public void refreshReport(boolean regenerate) throws java.ou tput.ACJOutpu tProcessor 135 .lang.lang. ACJOutputProcessor.Exception Re-retrieves the current page. The default is 65. regenerate If True is passed.zip.erepo r t. java. ACJOutputProcessor.String filenm. If a property is omitted. the report is regenerated.

PreservePageBreaks (Boolean).lang. An exception is generated if an invalid property. or a Null property is set.String sProperty. oValue The corresponding value for the property to be set. and QuoteCharacter (String).RuntimeException. Ensure that the correct data type is used when setting the value.lang. OutputStream (OutputStream).lang. PreserveFonts (Boolean). Properties are: FileName (String). an invalid data type value. java.RuntimeException. 136 e. Throws java. PreserveColors (Boolean). sProperty The property to be set.Repor t Designer API Java Edition . ACJOutputProcessor. or a Null property is set. CharacterSeparator (String). an invalid data type value. Ensure that the correct data type is used when setting the value. VisibleComponent (Component). Throws java.lang. and HorizontalSpacing (Boolean). TableOfContents (Boolean).lang. If a property is omitted. OutputStream (OutputStream).sProperty The property to be set. Properties are: FileName (String).Object oValue) throws java. ZipCompressed (Boolean). a default value is used.Exception Attempts to set an individual property used by the DHTML output device when generating an DHTML report. oValue The corresponding value for the property to be set. An exception is generated if an invalid property. BufferSize (Integer).setDHTMLProperty public void setDHTMLProperty(java.

Exception Attempts to set an individual property used by the HTML output device while generating an HTML report.String sProperty.ACJConstants. If a specific property is omitted.lang. SenderEmail (String).erepo r t.lang.ou tput. a default value is used. Throws java.lang.lang. Properties are: SMTPServer (String). ACJOutputProcessor.lang. oValue The corresponding value for the property to be set.String sProperty.) and FilesToAttach (Vector).RuntimeException. Pa cka ge com. If a specific property is omitted. a default value is used. ACJOutputProcessor.lang. Subject (String).Object oValue) throws java.PDF+HTML+DHTML etc. java.lang. Recipients (Vector).String sDocPath) Sets the path to the main documentation file. ReportTypes(Integer .setEMAILProperty public void setEMAILProperty(java.ACJOutputProcessor.ACJOutpu tProcessor 137 . an invalid value data type value or a Null property is set. An exception is generated if an invalid property.lang. java.setDocumentationPath public void setDocumentationPath(java.Exception Attempts to set an individual property used by the emailing system while deploying reports. Notes (String).actua te.setHTMLProperty public void setHTMLProperty(java.Object oValue) throws java. sProperty The property to be set. Ensure that the correct data type is used when setting the value.

Exception Sets the source of report data to the specified filename. ACJOutputProcessor.io.lang.lang. Note that loading a JOI file from a file on the local system is handled differently than loading a JOI file from a URL. Throws java.Object oValue) throws java.File JOIFile) throws java. BufferSize (Integer). ZipCompressed (Boolean). Used for report executables.Exception Attempts to set an individual property used by the JOI Handler when generating a JOI report. oValue The corresponding value for the property to be set. An exception is generated if an invalid property. Properties are: FileName (String).setJOIFileSource public void setJOIFileSource(java.setJOIProperty public void setJOIProperty(java. a default value is used. java. and HorizontalSpacing (Boolean). ACJOutputProcessor. an invalid value data type or a Null property is set.lang. TableOfContents (Boolean). If a specific property is omitted. VisibleComponent (Component).sProperty The property to be set. OutputStream (OutputStream). PreserveFonts (Boolean). Ensure that the correct data type is used when setting the value. PreservePageBreaks (Boolean).lang.Repor t Designer API Java Edition . 138 e. sProperty The property FileName (String) to be set.lang.String sProperty.RuntimeException. JOIFile Filename on the file system where the JOI file is located. Be sure to use the appropriate API. PreserveColors (Boolean).

an invalid data type value or a Null property is set.Exception A macro that accepts a string representation of a JOI filename or the location of a JOI filename via a URL (http:.erepo r t.lang.Object oValue) Pa cka ge com. Ensure that the correct data type is used when setting the value. sDATorURL Either a JOI local filename or a JOI file at a URL.ou tput. ACJOutputProcessor.RuntimeException.setJOISource public void setJOISource(java. Internally calls setJOIURLSource or setJOIFileSource. JOIURL URL location of the JOI file. java.lang. ftp:.oValue The corresponding value for the property to be set.ACJOutpu tProcessor 139 . An exception is generated if an invalid property. Note that loading a JOI file from a file on the local system is handled differently than loading a JOI file from a URL.String sJOIorURL) throws java.lang.lang.lang.lang.Exception Sets the source of report data to the specified URL. ACJOutputProcessor.String sOutputDevice.URL JOIURL) throws java. ACJOutputProcessor.lang. or file:). java.String sProperty.actua te.setOutputProperty public void setOutputProperty(java.setJOIURLSource public void setJOIURLSource(java. Throws java. Be sure to use the appropriate API.net. Used for report executables.

sProperty The property to be set.lang. VisibleComponent (Component).lang. An exception is generated if an invalid property. Properties are: PrinterJob (PrinterJob).lang.setPRINTERProperty public void setPRINTERProperty(java. SilentPrint is not available in AWT since the IsGUIVisible option must always be True for the generatePrintout() method to work. MaxPages (Integer).Exception Attempts to set an individual property used by the printer output device when printing a report. VisibleComponent (Component). If a specific property is omitted. IsGUIVisible (Boolean).Exception Attempts to set an individual property used by the PDF output device when generating a PDF report. PreservePrinterJob (Boolean). and MaxContents (Integer). oValue The corresponding value for the property to be set. a default value is used.lang.Object oValue) throws java. java. TableOfContents (Boolean). sProperty The property to be set. ZipCompressed (Boolean). Throws java. ACJOutputProcessor.Wrapper to map the existing client keys to the keys in the template. If a specific property is omitted. 140 e.String sProperty. and SilentPrint (Boolean).lang.RuntimeException.String sProperty. java. a default value used. BufferSize (Integer).lang. Ensure that the correct data type is used when setting the value. an invalid data type value or a Null property is set. OutputStream (OutputStream). ACJOutputProcessor.lang.Object oValue) throws java.Repor t Designer API Java Edition . Properties are: FileName (String). MaxItems (Integer).setPDFProperty public void setPDFProperty(java.

ACJOutputProcessor.ou tput. showDialog Set this parameter to True to enable setting correct resolution.setReportData public boolean setReportData (com.Exception Sets the raw report data generated using ACJEngine.lang. Throws java.ACJOutpu tProcessor 141 . This method is used to force printer resolution to a predefined value. or a Null property is set. This parameter is ignored if showDialog is True.lang.generateReport() as the actual data that ACJOutputProcessor uses to generate output.IViewerInterface ivi) throws java. An exception is generated if an invalid property.RuntimeException. Ensure that the correct data type is used when setting the value. ACJOutputProcessor.ereport. resolution The required value for the printer resolution. when the JVM resolution returned through PrintJob is not correct. double resolution) Sets and resets the printer resolution. a printer resolution dialog displays before printing. an invalid data type value. Pa cka ge com.oValue The corresponding value for the property to be set.erepo r t.common.setPrinterResolution public void setPrinterResolution(boolean showDialog.actua te.actuate. When ShowDialog is True.

ivi Raw ACJEngine report data generated by ACJEngine.zip.lang.writefile public static void writefile(java. Returns True if report data was successfully set to the ACJEngine client module. forces a report generation.Repor t Designer API Java Edition .actuate. java.util.writeZip public static void writeZip(java.generateReport().lang.ereport.String fnm.ZipOutputStream zos) throws java. If report data is not available.ZipOutputStream zos. Pass Null to bypass displaying the dialog box.setReportData public boolean setReportData (com. False otherwise.Component c) throws java.util. java.ACJOutputProcessor. java.awt. c If the report is contains parameters.zip.common.IViewerInterface ivi.Vector filenms) throws java.util.lang. pass Visible to display the Enter Parameter Values dialog box. ACJOutputProcessor.Exception ACJOutputProcessor.lang.Exception Sets the report data generated to the ACJEngine client module for output of report.Exception 142 e.

lang.ereport.util.OD_HTML getHTMLDevice() Used internally. java.erepo r t.actuate.ou tput.actua te.ACJOutputProcessor. Pa cka ge com.writeZip public static void writeZip(byte[] b.output.ZipOutputStream zos) throws java.zip.Exception public com.ACJOutpu tProcessor 143 .

144 e.Repor t Designer API Java Edition .

app data src.actuate.appdatasrc.a ctu ate.Ap pDa taHa nd ler 145 .erep or t. AppDataHandler Package Package co m.d atasrcmgrs. datasrcmgrs.ereport.Package com.

Use this class to define the data structure and to pass the data objects to ACJEngine.ereport.engine.io. Think of your object and its variables and methods as analogous to a database table with columns. java.actuate.lang. com. duplicate column names in different tables are permitted. AppDataSrc uses an object/relational mapping architecture to describe the structure of your object to ACJEngine.Serializable.appdatasrc.actuate.engine. 146 e. A column name must be unique within that table.ereport.ereport.ereport.engine. EJBDataHandler public class AppDataHandler extends com.actuate.datasrcmgrs.IMetaData.This structure makes it possible to convey object oriented information in a relational form to ACJEngine.actuate. Note that each table name must be unique.Class AppDataHandler java. See also Serialized objects Constructor summary AppDataHandler() The default constructor.MetadataAdapter | +--com.IDataSource.ereport.engine. java.engine.actuate.MetadataAdapter Implements com.ereport.actuate.io.Serializable Direct known subclasses ASCIIDataHandler.IDataSource.Object | +--com. This is the main class that implements the interface between ACJEngine and an application data source.AppDataHandler _____________________________________________________________________ All Implemented Interfaces com.Repor t Designer API Java Edition . This relational form can then be used to execute SQL-like queries to generate reports. however.

String sTable.getName() AppDataHandler .getQueryColumns Returns a " ' " as the delimiter string for special data types such as dates. java. Returns Null.Method summary Method AppDataHandler . Not used.fetchData AppDataHandler .connect() AppDataHandler . Returns the current debugMode status.Ap pDa taHa nd ler 147 .allowMultipleTableRegistering AppDataHandler . an application data source does not require a connection the way a JDBC data source does. Returns a vector of column names that have been registered for the specified table name.a ctu ate.getDebugMode() AppDataHandler . Not used. Description Allows multiple tables to be registered using the same class. as well as when table names have spaces in them.erep or t. returns Application DataSource. Package co m. Returns the SQL equivalent of a primitive data type.String sColumn) AppDataHandler .d atasrcmgrs.getQuery AppDataHandler . Not used. Not used.lang. Identifies the name of the data source.app data src.getColumnNames AppDataHandler .disconnect() AppDataHandler . an application data source does not require a connection the way a JDBC data source does.getPropertySheet() AppDataHandler .getDataType (java.lang. Returns Default Catalog.getEndRecordNumber() AppDataHandler .getIdentifierQuote() AppDataHandler . Returns Null.getCatalogName() AppDataHandler . Not used.

Returns Yes if Null is a valid default value for the specified table or column. Not used. Use registerUserDefTable() instead.registerQuery AppDataHandler . Returns Java Class.Repor t Designer API Java Edition . Defines your application object and its structure to ACJEngine in the form of a table.isConnected() AppDataHandler .getStartRecordNumber() AppDataHandler . Returns a list of all table names registered with the data source. Passes the data objects from your application to ACJEngine.registerUserDefTable Description Returns all relations as a vector of strings.getTable AppDataHandler . Used internally.getTableNames() AppDataHandler .registerObjectAsTable AppDataHandler .getQueryTables AppDataHandler . An application data source does not require a connection the way a JDBC data source does. Deprecated.RegisterTable AppDataHandler .isNullable AppDataHandler .getTableType AppDataHandler .registerDataSet AppDataHandler . Predefined query implementation. 148 e. Deprecated.passTableData AppDataHandler .RegisterTable AppDataHandler . Not used.Method AppDataHandler .getRelations() AppDataHandler .getQueryResult AppDataHandler . No otherwise. Use registerObjectAsTable() instead. Executes the query and returns the result set. Defines your application object and its structure to ACJEngine in the form of a table.

Ap pDa taHa nd ler 149 .setQueryDisplay AppDataHandler . Indicates if console messages should be displayed as the QueryProcessor processes the various joins and projects the result set. Used internally.requiresConnection() AppDataHandler .setExtraOperators AppDataHandler .a ctu ate.d atasrcmgrs.sortVector Description An application data source does not require a connection the way a JDBC data source does. Package co m.if true Allows multiple tables to be registered. Sets all relations as a vector of strings. Returns False.setDebugMode AppDataHandler . Enables or disables the query display. AppDataHandler.erep or t. Attempts to register additional operators that can be used in processing the WHERE clause. bAllowMultipleTablesForSameClass .setResultSetRange AppDataHandler .setTableDefinition AppDataHandler .setRelations AppDataHandler .Method AppDataHandler .allowMultipleTableRegistering public void allowMultipleTableRegistering(boolean bAllowMultipleTablesForSameClass) Allows multiple tables to be registered using the same class. AppDataHandler constructor AppDataHandler public AppDataHandler() A default constructor.app data src.

Exception Not used.Repor t Designer API Java Edition .engine. Returns Null. An application data source does not require a connection the way a JDBC data source does. Specified by connect in interface com.String sTable.fetchData public java.Exception Not used.engine.engine. Specified by fetchData in interface com. Specified by disconnect in interface com.ereport.String sColumn.ereport.lang. java. An application data source does not require a connection the way a JDBC data source does.lang.lang.lang.actuate.ereport.Object fetchData(java. int iCount) throws java.actuate.Exception Not used.AppDataHandler.lang.IDataSource 150 e.connect public void connect() throws java.IDataSource AppDataHandler.lang.actuate. int iStart.disconnect public void disconnect() throws java.IDataSource AppDataHandler.

ereport.lang. Date = DATE. long = BIGINT. Time = TIME. short = SMALLINT.actuate. float = REAL.actuate. byte = TINYINT.IDataSource Overrides getColumnNames in class com.engine.ereport.a ctu ate.Vector getColumnNames(java. boolean = BIT.erep or t.ereport.lang.d atasrcmgrs. Overrides getCatalogName in class com.getCatalogName public java.AppDataHandler.String getCatalogName() throws java.MetadataAdapter AppDataHandler.String sColumn) throws java. double = DOUBLE.util. java.String sTable.Exception Returns a vector of column names that have been registered for the specified table name. Image = LONGVARBINARY.lang.Exception Not used. Character = CHAR.getDataType public int getDataType(java. int = INTEGER.Exception Returns the SQL equivalent of a primitive data type. BIGDECIMAL = DECIMAL. String = VARCHAR.app data src.lang.actuate.engine.Ap pDa taHa nd ler 151 .engine.String sTableName) throws java. TimeStamp = TIMESTAMP. Returns Default Catalog.lang. Specified by getColumnNames in interface com.getColumnNames public java. Package co m.MetadataAdapter AppDataHandler.lang.lang.

actuate.IDataSource 152 e.engine.Overrides getDataType in class com.actuate. Specified by getName in interface com.getEndRecordNumber public int getEndRecordNumber() AppDataHandler.engine.MetadataAdapter AppDataHandler.String getName() Identifies the name of the data source. Overrides getIdentifierQuote in class com. Returns Application DataSource.getName public java.engine.lang. AppDataHandler.ereport.ereport.String getIdentifierQuote() Returns a " ' " as the delimiter string for special data types such as dates.lang.Repor t Designer API Java Edition .ereport.getIdentifierQuote public java.getDebugMode public static boolean getDebugMode() Returns the current debugMode status.actuate.MetadataAdapter AppDataHandler. as well as when table names have spaces in them.

engine.ereport.lang.engine.lang.IDataSource AppDataHandler.ereport.getQuery public java.ITable getQueryResult(java.Object queryId.ereport.getQueryColumns public java.actuate.d atasrcmgrs.AppDataHandler.getPropertySheet public com.lang.lang.IPropertySheet getPropertySheet() Not used. Returns Null.Object queryId.Vector getQueryColumns(java.String tableName) throws java.String query) throws java.app data src.engine.util.java.getQueryResult public com.actuate.lang.IDataSource AppDataHandler.Exception Package co m.lang.ereport.Exception Specified by getQueryColumns in interface com.erep or t.ereport.engine.engine.a ctu ate. java.Ap pDa taHa nd ler 153 .actuate.String getQuery(java.actuate.lang.Object queryId) Specified by getQuery in interface com. Specified by getPropertySheet in interface com.actuate.IDataSource AppDataHandler.lang.

154 e.engine.getQueryTables public java.COL1-TABLE2.actuate.Object queryId) throws java.actuate.String sReaders) throws java.engine.util.IDataSource AppDataHandler.actuate.MetadataAdapter AppDataHandler.ITable getTable(java.ereport.lang.COL2.Vector getRelations() throws java.getRelations public java.Specified by getQueryResult in interface com. java.actuate.ereport.ereport.util.Exception Executes the query and returns the result set.getTable public com. RELATIONTYPE.Vector getQueryTables(java.engine.lang.Exception Specified by getQueryTables in interface com.IDataSource AppDataHandler.ereport.Exception Returns all relations as a vector of strings.lang.Repor t Designer API Java Edition . Overrides getRelations in class com.lang.Hashtable htQuery.engine.getStartRecordNumber public int getStartRecordNumber() AppDataHandler.util.lang. The format for each relation is: TABLE1.

erep or t.ereport.getTableNames public java.Exception Not used.engine.Specified by getTable in interface com.IDataSource Overrides getTableNames in class com.lang.Exception Not used.engine.MetadataAdapter AppDataHandler. Returns True.IDataSource AppDataHandler.d atasrcmgrs.lang.isConnected public boolean isConnected() throws java.lang.app data src.lang.ereport. Returns Java Class.Exception Returns a list of all table names registered with the data source.ereport.String sTable) throws java. Overrides getTableType in class com. Package co m.ereport.Ap pDa taHa nd ler 155 . Specified by getTableNames in interface com.actuate.actuate.String getTableType(java.lang.a ctu ate.actuate. An application data source does not require a connection the way a JDBC data source does.getTableType public java.Vector getTableNames() throws java.MetadataAdapter AppDataHandler.engine.engine.actuate.util.

String sColumn) throws java. java. registerDataSet takes the second argument as a vector. tableName The name you have given for the object when calling registerObjectAsTable.util.ereport. java. AppDataHandler. The default implementation of IObjectTable is that of a vector. Overrides isNullable in class com. 156 e.lang.lang.Collection of objects containing the objects you want ACJEngine to query and from which it is to extract the result set.String sTableName. No otherwise.actuate.engine. In the AWT API.actuate.Exception Returns Yes if Null is a valid default value for the specified table or column. data A java.util. passTableData takes the second argument as a vector.Specified by isConnected in interface com.lang.util.String isNullable(java.engine. In the AWT API.String sTable.Collection cAllRecords) Passes the data objects from your application to ACJEngine.lang.lang.lang. java.MetadataAdapter AppDataHandler.String sTableName.registerDataSet public void registerDataSet(java.passTableData public void passTableData(java.Repor t Designer API Java Edition .IDataSource AppDataHandler.Collection cAllRecords) Used internally.isNullable public java.ereport.

actuate.Vector vColsDefn) Defines your application object and its structure to ACJEngine in the form of a table.Ap pDa taHa nd ler 157 . This class must be defined as public or this method fails.Object oInstanceOfClass. java. Specified by registerQuery in interface com.registerQuery public void registerQuery(java.lang. sTableName The name you designate for this class. Package co m. java.lang.registerObjectAsTable public void registerObjectAsTable(java. vColsDefn A vector of class variables or methods to be defined as columns of this table.Object queryId.d atasrcmgrs. AppDataHandler.datasrcmgrs. Parameters oInstanceOfClass An instance of a class you are trying to define as a table.lang. java. Normally used to provide a more user friendly name than the actual class name.appdatasrc. Use registerUserDefTable() instead.ereport.actuate.String sTableName) Deprecated.IDataSource AppDataHandler.String query) throws java.erep or t.RegisterTable public void RegisterTable(com.IObjectTable iot.a ctu ate.lang.String sTableName.util.engine.AppDataHandler.app data src.lang.Exception Predefined query implementation. java.ereport.lang.

Specified by requiresConnection in interface com. java. AppDataHandler.RegisterTable public void RegisterTable(java.datasrcmgrs.util.String sTableName. java.engine.requiresConnection public boolean requiresConnection() An application data source does not require a connection the way a JDBC data source does.appdatasrc. Use registerObjectAsTable() instead. java.String primaryKey) Deprecated.lang.ereport. AppDataHandler.Vector vColsDefn.lang. sTableName The name of the table represented by this IObjectTable implementation. Returns False.actuate.IDataSource 158 e.actuate.lang.IObject Table iot.Repor t Designer API Java Edition .AppDataHandler.Vector vAllRecords.String sTableName) Defines your application object and its structure to ACJEngine in the form of a table.registerUserDefTable public void registerUserDefTable(com.util.ereport. java. iot An implementation of the IObjectTable class to be defined as a table.

ereport.lang. AppDataHandler.a ctu ate.setDebugMode public static void setDebugMode(boolean b) Indicates whether console messages should be displayed as the QueryProcessor processes the various joins and projects the result set.Exception Attempts to register additional operators that can be used in processing the WHERE clause.setExtraOperators public void setExtraOperators(java.setRelations public void setRelations(java.COL2. int endRecordNo) Specified by setResultSetRange in interface com.Vector vR) Sets all relations as a vector of strings.erep or t.actuate.d atasrcmgrs. AppDataHandler.util.Ap pDa taHa nd ler 159 .engine.Vector vOperators) throws java. AppDataHandler. RELATIONTYPE. AppDataHandler. The format for each relation is: TABLE1.app data src.AppDataHandler.setQueryDisplay public void setQueryDisplay(boolean bDisplay) Enables or disables the query display.COL1-TABLE2.setResultSetRange public void setResultSetRange(int startRecordNo.IDataSource Package co m.util.

String sTableName.Vector v) 160 e.Repor t Designer API Java Edition . AppDataHandler. java.Exception Used internally. java.lang.util.Class cTableClass.lang.sortVector public static void sortVector(java.Vector vColsDefn) throws java.lang.setTableDefinition public void setTableDefinition(java.util.AppDataHandler.

appdatasrc 161 .erepor t.Interface com.actuate.ereport.appdatasrc Interface Public interfaces: s s IObjectTable Iterator Interface com.datasrcmgrs. datasrcmgrs.actuate.

lang.Object o. An implementation of this method returns the value represented by the specified column <colName> in the corresponding object <o>.util.String colName) throws java. which is an instance of this table.Repor t Designer API Java Edition .Interface IObjectTable public interface IObjectTable Method Summary Method getColumns() Description This method returns the list of the fields or methods representing the columns in the table. Returns the iterator that represents this table object.Object o. getValue public java. 162 e. False otherwise.lang.lang.String colName) hasColumn(java.lang.lang. java. This method returns True if the column indicated by <col> exists.Object getValue(java.lang.String col) iterator() getColumns public java. java.Exception An implementation of this method returns the value represented by the specified column in the corresponding object. getValue(java.Vector getColumns() This method returns the list of the fields or methods representing the columns in the table. which is an instance of this table.lang.

appdatasrc 163 . Returns boolean True if the column exists.erepor t.actuate.Parameters colName The name of the column whose data value is to be retrieved.Iterator.datasrcmgrs.lang. hasColumn public boolean hasColumn(java. The data must be retrieved from this instance. Interface com. o An instance of this table class.ereport.datasrcmgrs.appdatasrc. iterator public Iterator iterator() Return the Iterator that represents this table object.actuate.String col) This method must return True if the column indicated by <col> exists. False otherwise. Returns Iterator. An instance of com. False otherwise. Parameter col The name of the column to be verified.

An implementation of this method should return the current record and advance the cursor to the next record in the data set.Interface Iterator public interface Iterator Method Summary Method hasNext() next() Description This method returns a boolean indicating whether further traversal in this table is possible.NoSuchElementException An implementation of this method returns the current record and advances the cursor to the next record in the data set. Returns boolean True if there are more records.Repor t Designer API Java Edition . 164 e. remove() resetCursor() hasNext public boolean hasNext() This method returns a boolean indicating whether further traversal in this table is possible.Object next() throws java. False otherwise. This method is never called This method is called to cause the table class to reset the cursor to the starting position of the data set.lang. next public java.util. the data can then be refetched.

NoSuchElementException when the end of the data set is encountered. resetCursor public void resetCursor() This method is called to cause the table class to reset the cursor to the starting position of the data set. Interface com.util. It is presented for compatibility with the class java. remove public void remove() throws java.appdatasrc 165 . Throws java. The data can then be refetched.Iterator.Exception This method is never called.actuate.datasrcmgrs.Returns Object.util.lang. An instance of the table class that has been registered.erepor t.

166 e.Repor t Designer API Java Edition .

ereport.actuate.Package com.erep or t. ASCIIDataHandler Package Packag e co m.asciidatasrc.a ctu ate.d atasrcmgrs.ascii data src. datasrcmgrs.ASCIIDa taHa nd ler 167 .

Serializable public class ASCIIDataHandler extends AppDataHandler This class is used to register the extracted ASCII data from a specified data file.engine.io.ereport.engine. See also Serialized objects Constructor summary ASCIIDataHandler() Method summary Method ASCIIDataHandler .Object | +--com.ereport.IMetaData.actuate.appdatasrc.Repor t Designer API Java Edition .MetadataAdapter | +--com.actuate.connect Constructor used to initialize the ASCII data source.checkIfExists ASCIIDataHandler .asciidatasrc.IDataSource.lang.actuate. This constructor is used internally.datasrcmgrs. datasrcmgrs.Class ASCIIDataHandler java.actuate.engine. Description 168 e.actuate.ereport. AppDataHandler | +--com.connect ASCIIDataHandler .ereport. com. java.ASCIIDataHandler _____________________________________________________________________ All Implemented Interfaces com.ereport. The ASCII data in the data file is described using a property file in a specified format.

setPropertiesFileName Description Function to count the number of columns having the same data type.getPropertiesFileName ASCIIDataHandler .String propertyFileName) throws java.connect public void connect(ACJEngine erw. ASCIIDataHandler constructor ASCIIDataHandler public ASCIIDataHandler() ASCIIDataHandler.lang.Exception Constructor used to initialize the ASCII data source. Function that registers all the tables with ACJEngine.String sName) ASCIIDataHandler.lang.a ctu ate.getSourceFileName() ASCIIDataHandler .d atasrcmgrs.getCurrentPropertiesAsString() ASCIIDataHandler .getPropertiesFileName() ASCIIDataHandler . java.ASCIIDa taHa nd ler 169 .lang.getPropertiesFileName ASCIIDataHandler . erw Packag e co m.lang.checkIfExists public static boolean checkIfExists(java.erep or t.Method ASCIIDataHandler .ascii data src.String fileName. java.

dataType The datatype for which the count is needed.util.connect public void connect(ACJEngine erw.An instance of the ACJEngine engine. This file is generated by the ASCII data wizard. propertyFileName The file containing information required to parse the text file.String dataType) Function to count the number of columns having the same data type. vDataTypes Vector of column data types for a particular table. java.lang.Exception This constructor is used internally.String fileName. ASCIIDataHandler. ASCIIDataHandler.Vector vDataTypes. vPropertiesOfAllTables Vector describing the data in the ASCII data file. erw An instance of the ACJEngine engine.getColumnCount public int getColumnCount(java.lang. fileName The file containing the ASCII text data. sfileName The file containing the ASCII text data.util. java. 170 e.Vector vPropertiesOfAllTables) throws java.lang.Repor t Designer API Java Edition . java.

getSourceFileName public java.String getPropertiesFileName() ASCIIDataHandler.registerObjectsWithEngine public void registerObjectsWithEngine() Function that registers all the tables with ACJEngine.String getCurrentPropertiesAsString() ASCIIDataHandler.getCurrentPropertiesAsString public java.lang.lang.lang. ASCIIDataHandler.Returns Count of the columns that have the specified data type.erep or t.ascii data src.String sPropertiesFile) Packag e co m.getPropertiesFileName public java.d atasrcmgrs.ASCIIDa taHa nd ler 171 .a ctu ate. 0 is used if the specified data type is not present in this table. ASCIIDataHandler.lang.String getSourceFileName() ASCIIDataHandler.setPropertiesFileName public void setPropertiesFileName(java.

Repor t Designer API Java Edition .172 e.

e jbda tasrc. EJBDataHandler Package Pa cka ge com.actua te.actuate.da tasrcmgrs. datasrcmgrs.ejbdatasrc.EJBDa taHa nd ler 173 .Package com.erepo r t.ereport.

It is not in the AWT API. Adds a single local or remote table entry definition that describes the entire table. com.Class EJBDataHandler The class is only in the SWING API.addTableData EJBDataHandler . its columns.Repor t Designer API Java Edition . accessors.engine.datasrcmgrs.Serializable public class EJBDataHandler extends AppDataHandler See also Serialized objects Constructor summary EJBDataHandler() EJBDataHandler(java.MetadataAdapter | +--+--com.String sRemoteAppJNDIName) Method summary Method .actuate.IMetaData.actuate. 174 e. and so on.actuate.EJBDataHandler _____________________________________________________________________ All Implemented Interfaces com.io.lang.engine.addTableDefinition . java.ereport.ereport.ereport.engine.actuate.AppDataHandler | +--com.IDataSource. java.actuate.Object | +--com.ejbdatasrc.addTableDefinition EJBDataHandler .ereport.lang.ereport.appdatasrc.clearSchemaAndData() Description Adds a single remote table entry data set that contains all records for a single table.datasrcmgrs.

Sets the context factory. Returns Application DataSource. Identifies the name of this data source.actua te. An application data source does not require a connection the way a JDBC data source does.processRemoteMsg EJBDataHandler .e jbda tasrc.setTableDefinition Description Initializes the system by connecting to the remote EJB application.processMsg EJBDataHandler . Returns the default implementation of the EJBDataSource property sheet.isConnected() EJBDataHandler .getPropertySheet() EJBDataHandler .setContextFactory() EJBDataHandler .getRemoteAppName() EJBDataHandler . Returns False. EJBDataHandler constructor EJBDataHandler public EJBDataHandler() Pa cka ge com.Method EJBDataHandler .setProperties EJBDataHandler .erepo r t.EJBDa taHa nd ler 175 .getProperties() EJBDataHandler . Used internally.connectToRemoteApp EJBDataHandler .setContextFactory EJBDataHandler .requiresConnection() EJBDataHandler . Notifies the system if the EJB data source connection is active.getName() EJBDataHandler .da tasrcmgrs.

Repor t Designer API Java Edition .util.lang.Exception Adds a single local or remote table entry definition that describes the entire table.lang.connectToRemoteApp public void connectToRemoteApp(java. java.Exception Adds a single remote table entry data set that contains all records for a single table.lang.Exception Initializes the system by connecting to the remote EJB application.String sRemoteAppJNDIName) throws java.clearSchemaAndData public void clearSchemaAndData() EJBDataHandler.String sT.addTableDefinition public void addTableDefinition(java.lang.lang.String sRemoteAppJNDIName) EJBDataHandler.Vector vAllRecords) throws java. EJBDataHandler.addTableData public void addTableData(java. accessors.String[] saCA) throws java. java.String sT.lang. and so on.EJBDataHandler public EJBDataHandler(java. java.lang. 176 e.lang. its columns.lang.Class cT. EJBDataHandler.

Overrides AppDataHandler.e jbda tasrc.getName EJBDataHandler.actuate.getRemoteAppName public java.getProperties public java.engine. Overrides AppDataHandler.ereport.getContextFactory public java.String getRemoteAppName() Pa cka ge com.erepo r t.lang.IPropertySheet getPropertySheet() Returns the default implementation of the EJBDataSource property sheet.util.getPropertySheet EJBDataHandler.lang. Returns Application DataSource.EJBDa taHa nd ler 177 .String getContextFactory() EJBDataHandler.getName public java.lang.getPropertySheet public com.EJBDataHandler.actua te.String getName() Identifies the name of this data source.Hashtable getProperties() EJBDataHandler.da tasrcmgrs.

lang.EJBDataHandler. Overrides AppDataHandler. Returns False.Object oParams) throws java.Object oParams) throws java.isConnected public boolean isConnected() throws java. Overrides AppDataHandler.processMsg public java.requiresConnection 178 e.lang.Object processRemoteMsg(int msgID.RemoteException EJBDataHandler.processRemoteMsg public java.requiresConnection public boolean requiresConnection() An application data source does not require a connection the way a JDBC data source does. java.lang.lang.rmi.isConnected EJBDataHandler.Exception EJBDataHandler.lang.Exception Notifies the system if the EJB data source connection is active.lang.Repor t Designer API Java Edition .Object processMsg(int msgID. java.

lang.erepo r t.String sContextFactory) Sets the context factory.util.e jbda tasrc.setProperties public void setProperties(java.EJBDataHandler.lang.lang.da tasrcmgrs.util.Class cTableClass.Hashtable htIC) EJBDataHandler.Vector vColsDefn) throws java. java.setTableDefinition public void setTableDefinition(java.setTableDefinition Pa cka ge com.actua te.String sTableName.Exception Description copied from class: AppDataHandler Used internally.setContextFactory public void setContextFactory(java.EJBDa taHa nd ler 179 . Overrides AppDataHandler.lang. java. EJBDataHandler.

180 e.Repor t Designer API Java Edition .

jdbcdatasrc. d a t a s r c m g r s .Package com. datasrcmgrs.actuate. e r e p o r t. a c t u a t e. JDBCHandler Package Pa ck a g e c o m .ereport.j d b c d a t a s r c . J D B C H a n d l e r 181 .

actuate.Object | +--com.engine.Connection java.IDataSource.jdbcdatasrc.Driver java.ereport.ereport.lang.IMetaData public class JDBCHandler extends com.lang.MetadataAdapter Implements com.lang.engine.MetadataAdapter | +--com.JDBCHandler _____________________________________________________________________ All Implemented Interfaces com. Field summary Type static int java.IDataSource.actuate.String static int static int static int java. such as a relational database.ereport.ereport.Repor t Designer API Java Edition .Class JDBCHandler java.sql.engine. com.sql.lang.ereport.lang.String static int Method ALIAS dbconnection driver DriverName password SYNONYM SYSTEM TABLE url username VIEW Original Class Implementation 182 e.engine.engine.String java.String java.actuate. This class implements the interface between ACJEngine and any JDBC data source.actuate.actuate.datasrcmgrs.actuate.ereport.

Constructor summary
JDBCHandler() An empty constructor.

Method summary
Method JDBCHandler .allStoredObjectsCallable() JDBCHandler .connect() JDBCHandler .Connect() JDBCHandler .connect JDBCHandler .Connect JDBCHandler .connect JDBCHandler .Connect JDBCHandler .debugMessage JDBCHandler .debugMessageLN() JDBCHandler .debugMessageLN JDBCHandler .disconnect() JDBCHandler .Disconnect() JDBCHandler .extractRelations Connects to the JDBC data source using the driver, URL, username and password. Deprecated as of ACJEngine 3.0. Passes an existing connection and specifies whether all tables are to be extracted. Deprecated as of ACJEngine 3.0. Connects to the JDBC data source. Deprecated as of ACJEngine 3.0. Used internally for debugging. Used internally for debugging. Used internally for debugging. Disconnects from the data source. Deprecated as of ACJEngine 3.0. Description

Pa ck a g e c o m . a c t u a t e. e r e p o r t. d a t a s r c m g r s .j d b c d a t a s r c . J D B C H a n d l e r

183

Method JDBCHandler .fetchData JDBCHandler .getCatalogName() JDBCHandler .getColumnNames JDBCHandler .getConnection() JDBCHandler .getCurrentTableSelection() JDBCHandler .getDataType JDBCHandler .getDebugMode() JDBCHandler .getDefaultValue JDBCHandler .getDriverName() JDBCHandler .getEndRecordNumber() JDBCHandler .getGrantee JDBCHandler .getGrantor JDBCHandler .getIdentifierQuote() JDBCHandler .getName() JDBCHandler .getPassword() JDBCHandler .getPrivileges JDBCHandler .getPropertySheet()

Description Returns a result set containing all data for a specified table and column for iCount objects. iStart is currently not used and will be supported in a future version. Returns the default catalog associated with the JDBC connection Returns a vector with all the column names of the table name that is passed to the method.

Returns the java.sql.Types equivalent data type for the specified column. Returns the current debugMode status. Returns the default value for the specified fully qualified column. Returns the name of the active JDBC driver.

Returns the grantee of privileges for the specified fully qualified column. Returns the grantor of privileges for the specified fully qualified column. Returns the identifier quote string for the specified database. Returns the name of the data source. Returns the password for the active JDBC data source connection. Returns a comma-separated list of privileges associated with a column. Returns an instance of the property sheet. Used internally.

184

e.Repor t Designer API Java Edition

Method JDBCHandler .getQuery JDBCHandler .getQueryTables JDBCHandler .getQueryResult JDBCHandler .getQueryTables JDBCHandler .getRelations() JDBCHandler .getRemarks JDBCHandler .getSelectedTables() JDBCHandler .getSelectiveTableFilter() JDBCHandler .getSOImplementation() JDBCHandler .getStartRecordNumber() JDBCHandler .getStartRecordNumber() JDBCHandler .getTable JDBCHandler .getTableCount() JDBCHandler .getTableNames() JDBCHandler .getTables() JDBCHandler .getUrl() JDBCHandler .getUsername() JDBCHandler .isConnected()

Description

Returns a vector of relations in a string format; not implemented in JDBCHandler. Returns the remarks for the specified fully qualified column.

Used internally.

Returns a structure containing stored objects. Used internally.

Returns a vector with all the table names available from the data source. A macro for fetching all tables from the active JDBC source. Returns the URL for the JDBC data source. Returns the username for the active JDBC data source connection. Returns True if connected to a JDBC data source, False otherwise

Pa ck a g e c o m . a c t u a t e. e r e p o r t. d a t a s r c m g r s .j d b c d a t a s r c . J D B C H a n d l e r

185

Method JDBCHandler .isGrantable JDBCHandler .isNullable JDBCHandler .makeSelective() JDBCHandler .registerQuery JDBCHandler .requiresConnection() JDBCHandler .retrieveTables() JDBCHandler .setDebugMode JDBCHandler .setDriver JDBCHandler .setLowercaseQuotes

Description Indicates if this column can be granted privileges. Indicates that this column can have a Null value.

Indicates that the JDBC data source requires an active connection to work with. Fetches all the requested tables from the active JDBC connection. Specifies whether progress or error messages are to be displayed in the console window. Sets the JDBC driver to the string being passed. Specifies that if the table or column has lowercase characters embedded in it, then the quote identifier is prepended and appended to it. Sets the password to the string being passed. Specifies whether the schema name should be prepended to the table name in the FROM clause, as expected by ORACLE.

JDBCHandler .setPassword JDBCHandler .setPrependSchema JDBCHandler .setProperties JDBCHandler .setResultSetRange JDBCHandler .setSelectiveProperties JDBCHandler .setUrl JDBCHandler .setUsername

Sets the JDBC URL to the string being passed. Sets the username to the string being passed.

186

e.Repor t Designer API Java Edition

Method JDBCHandler. .supportsStoredObjects() JDBCHandler .useTables

Description

Specifies a domain of tables to work with. This method can be used in conjunction with the connect(...) API when you know the tables you want to work with in the Template Designer.

Field detail TABLE
public static final int TABLE ========== ORIGINAL CLASS IMPLEMENTATION =========

VIEW
public static final int VIEW

SYSTEM
public static final int SYSTEM

ALIAS
public static final int ALIAS

SYNONYM
public static final int SYNONYM

driver
public java.sql.Driver driver

DriverName
public java.lang.String DriverName

Pa ck a g e c o m . a c t u a t e. e r e p o r t. d a t a s r c m g r s .j d b c d a t a s r c . J D B C H a n d l e r

187

url
public java.lang.String url

username
public java.lang.String username

password
public java.lang.String password

dbconnection
public java.sql.Connection dbconnection

JDBCHandler constructor
JDBCHandler
public JDBCHandler() An empty constructor.

JDBCHandler.allStoredObjectsCallable
public boolean allStoredObjectsCallable() throws java.lang.Exception

JDBCHandler.Connect
public void Connect() throws java.lang.Exception Deprecated as of ACJEngine 3.0.

188

e.Repor t Designer API Java Edition

Exception Deprecated as of ACJEngine 3.JDBCHandler.String Password.lang. a c t u a t e. and password. d a t a s r c m g r s . JDBCHandler.connect public void connect() throws java. boolean extractTables) Passes an existing connection and specifies whether all tables are to be extracted.engine. boolean extractTables) throws java.String UserName.lang.lang.lang.actuate.j d b c d a t a s r c .ereport.0. Specified by connect in interface com. J D B C H a n d l e r 189 .String Url.0.Connection c.Connect public boolean Connect(java.sql. java.Connection c. JDBCHandler.Connect public void Connect(java.Exception Connects to the JDBC data source using the driver.connect public boolean connect(java.lang. URL. boolean extractTables) Deprecated as of ACJEngine 3. Pa ck a g e c o m .sql.String DriverName.lang. e r e p o r t. java. username.IDataSource JDBCHandler. java.

JDBCHandler.connect
public void connect(java.lang.String DriverName, java.lang.String Url, java.lang.String UserName, java.lang.String Password, boolean extractTables) throws java.lang.Exception Connects to the JDBC data source. First, gets the instance of the driver using RegisterDriver(DriverName.trim()). Once the driver is successfully registered and instantiated, connects to the database using DriverManager.getConnection(JDBC_URL, username and password).

JDBCHandler.debugMessage
public static void debugMessage(java.lang.Object sMsg) Used internally for debugging.

JDBCHandler.debugMessageLN
public static void debugMessageLN(java.lang.Object sMsg) Used internally for debugging.

JDBCHandler.debugMessageLN
public static void debugMessageLN()

JDBCHandler.Disconnect
public void Disconnect() throws java.lang.Exception Deprecated as of ACJEngine 3.0.

190

e.Repor t Designer API Java Edition

JDBCHandler.disconnect
public void disconnect() throws java.lang.Exception Disconnects from the data source.

Specified by
disconnect in interface com.actuate.ereport.engine.IDataSource

JDBCHandler.extractRelations
public java.util.Vector extractRelations(java.awt.Component cProgress, java.sql.DatabaseMetaData dmd, java.util.Vector vTables) throws java.lang.Exception

JDBCHandler.fetchData
public java.lang.Object fetchData(java.lang.String sTable, java.lang.String sColumn, int iStart, int iCount) throws java.lang.Exception Returns a result set containing all data for a specified table and column for iCount objects. iStart is currently not used but will be supported in a future version.

Specified by
fetchData in interface com.actuate.ereport.engine.IDataSource

JDBCHandler.getCatalogName
public java.lang.String getCatalogName() throws java.lang.Exception Returns the default catalog associated with the JDBC connection.
Pa ck a g e c o m . a c t u a t e. e r e p o r t. d a t a s r c m g r s .j d b c d a t a s r c . J D B C H a n d l e r

191

Overrides
getCatalogName in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getColumnNames
public java.util.Vector getColumnNames(java.lang.String TableName) throws java.lang.Exception Returns a vector with all the column names of the table name that is passed to the method.

Specified by
getColumnNames in interface com.actuate.ereport.engine.IDataSource

Overrides
getColumnNames in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getConnection
public java.sql.Connection getConnection()

JDBCHandler.getCurrentTableSelection
public int getCurrentTableSelection()

JDBCHandler.getDataType
public int getDataType(java.lang.String sTable, java.lang.String sColumn) throws java.lang.Exception Returns the java.sql.Type’s equivalent data type for the specified column.

192

e.Repor t Designer API Java Edition

Overrides
getDataType in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getDebugMode
public static boolean getDebugMode() Returns the current debugMode status.

JDBCHandler.getDefaultValue
public java.lang.Object getDefaultValue(java.lang.String sTable, java.lang.String sColumn) throws java.lang.Exception Returns the default value for the specified fully qualified column

Overrides
getDefaultValue in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getDriverName
public java.lang.String getDriverName() Returns the name of the active JDBC driver.

JDBCHandler.getEndRecordNumber
public int getEndRecordNumber()

Pa ck a g e c o m . a c t u a t e. e r e p o r t. d a t a s r c m g r s .j d b c d a t a s r c . J D B C H a n d l e r

193

JDBCHandler.getGrantee
public java.lang.String getGrantee(java.lang.String sTable, java.lang.String sColumn) throws java.lang.Exception Returns the grantee of privileges for the specified fully qualified column.

Overrides
getGrantee in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getGrantor
public java.lang.String getGrantor(java.lang.String sTable, java.lang.String sColumn) throws java.lang.Exception Returns the grantor of privileges for the specified fully qualified column.

Overrides
getGrantor in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getIdentifierQuote
public java.lang.String getIdentifierQuote() Returns the identifier quote string for the specified database.

Overrides
getIdentifierQuote in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getName
public java.lang.String getName() Returns the name of the data source.
194
e.Repor t Designer API Java Edition

Specified by
getName in interface com.actuate.ereport.engine.IDataSource

JDBCHandler.getPassword
public java.lang.String getPassword() Returns the password for the active JDBC data source connection.

JDBCHandler.getPrivileges
public java.lang.String getPrivileges(java.lang.String sTable, java.lang.String sColumn) throws java.lang.Exception Returns a comma separated list of privileges associated with a column.

Overrides
getPrivileges in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getPropertySheet
public com.actuate.ereport.engine.IPropertySheet getPropertySheet() Returns an instance of the property sheet. Used internally.

Specified by
getPropertySheet in interface com.actuate.ereport.engine.IDataSource

JDBCHandler.getQuery
public java.lang.String getQuery(java.lang.Object queryId)

Pa ck a g e c o m . a c t u a t e. e r e p o r t. d a t a s r c m g r s .j d b c d a t a s r c . J D B C H a n d l e r

195

Specified by
getQuery in interface com.actuate.ereport.engine.IDataSource

JDBCHandler.getQueryColumns
public java.util.Vector getQueryColumns(java.lang.Object queryId, java.lang.String tableName) throws java.lang.Exception

Specified by
getQueryColumns in interface com.actuate.ereport.engine.IDataSource

JDBCHandler.getQueryResult
public com.actuate.ereport.engine.ITable getQueryResult(java.lang.Object queryId, java.lang.String query) throws java.lang.Exception

Specified by
getQueryResult in interface com.actuate.ereport.engine.IDataSource

JDBCHandler.getQueryTables
public java.util.Vector getQueryTables(java.lang.Object queryId) throws java.lang.Exception

Specified by
getQueryTables in interface com.actuate.ereport.engine.IDataSource

196

e.Repor t Designer API Java Edition

JDBCHandler.getRelations
public java.util.Vector getRelations() throws java.lang.Exception Returns a vector of relations in a string format. Not implemented in JDBCHandler.

Overrides
getRelations in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getRemarks
public java.lang.String getRemarks(java.lang.String sTable, java.lang.String sColumn) throws java.lang.Exception Returns the remarks for the specified fully qualified column.

Overrides
getRemarks in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getSelectiveTableFilter
public int getSelectiveTableFilter() Used internally.

JDBCHandler.getSelectedTables
public java.util.Vector getSelectedTables()

Pa ck a g e c o m . a c t u a t e. e r e p o r t. d a t a s r c m g r s .j d b c d a t a s r c . J D B C H a n d l e r

197

JDBCHandler.getSOImplementation
public com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCStoredObjectsImpl getSOImplementation()

JDBCHandler.getStartRecordNumber
public int getStartRecordNumber()

JDBCHandler.getStoredObjects
public com.actuate.ereport.engine.IStoredObjects getStoredObjects() throws java.lang.Exception Returns a structure containing stored objects.

Overrides
getStoredObjects in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getTable
public com.actuate.ereport.engine.ITable getTable(java.util.Hashtable ht, java.lang.String readers) throws java.lang.Exception Used internally.

Specified by
getTable in interface com.actuate.ereport.engine.IDataSource

JDBCHandler.getTableCount
public int getTableCount()

198

e.Repor t Designer API Java Edition

JDBCHandler.getTableNames
public java.util.Vector getTableNames() throws java.lang.Exception Returns a vector with all the table names available from the data source.

Specified by
getTableNames in interface com.actuate.ereport.engine.IDataSource

Overrides
getTableNames in class com.actuate.ereport.engine.MetadataAdapter

JDBCHandler.getTables
public java.util.Vector getTables() throws java.lang.Exception A macro for fetching all tables from the active JDBC source.

JDBCHandler.getUrl
public java.lang.String getUrl() Returns the URL for the JDBC data source.

JDBCHandler.getUsername
public java.lang.String getUsername() Returns the use name for the active JDBC data source connection

Pa ck a g e c o m . a c t u a t e. e r e p o r t. d a t a s r c m g r s .j d b c d a t a s r c . J D B C H a n d l e r

199

Overrides isNullable in class com.lang. False otherwise.isConnected public boolean isConnected() throws java.lang.isNullable public java.String sColumn) throws java.String sTable.String sTable.ereport.Exception Indicates whether this column can be granted privileges.actuate. Specified by isConnected in interface com.String isNullable(java.ereport.lang.String sColumn) throws java.makeSelective public void makeSelective() 200 e.engine.actuate. java.lang.lang.actuate.engine.Exception Returns True if connected to a JDBC data source.IDataSource JDBCHandler.lang.MetadataAdapter JDBCHandler.MetadataAdapter JDBCHandler.lang.ereport.Repor t Designer API Java Edition . java.isGrantable public boolean isGrantable(java.JDBCHandler. Overrides isGrantable in class com.engine.Exception Indicates that this column can have a Null value.lang.

d a t a s r c m g r s . a c t u a t e.setDebugMode public static void setDebugMode(boolean b) Specifies whether progress or error messages are to be displayed in the console window.lang. J D B C H a n d l e r 201 .engine. JDBCHandler.ereport.engine.IDataSource JDBCHandler.lang. java.IDataSource JDBCHandler.Object queryId.j d b c d a t a s r c .Vector retrieveTables() Fetches all the requested tables from the active JDBC connection.util.actuate. Specified by requiresConnection in interface com.String query) throws java.retrieveTables public java.actuate. e r e p o r t. Pa ck a g e c o m .Exception Specified by registerQuery in interface com.lang.ereport.requiresConnection public boolean requiresConnection() Indicates that the JDBC data source requires an active connection.JDBCHandler.registerQuery public void registerQuery(java.

setPassword public void setPassword(java.JDBCHandler.String sUrl.lang. java.lang. as expected by ORACLE. JDBCHandler.lang. then the quote identifier is prepended and appended to it. JDBCHandler.String d) Sets the JDBC driver to the string being passed.lang. JDBCHandler.lang.setDriver public void setDriver(java.lang. JDBCHandler.String sDriver.setProperties public void setProperties(java.Repor t Designer API Java Edition .String p) Sets the password to the string being passed.setLowercaseQuotes public void setLowercaseQuotes(boolean bLowercaseQuotes) Specifies that if the table or column has lowercase characters embedded in it. java. java.String sPassword) 202 e.String sUser.setPrependSchema public void setPrependSchema(boolean bPrependSchema) Specifies whether the schema name should be prepended to the table name in the FROM clause.

d a t a s r c m g r s . e r e p o r t.setResultSetRange public void setResultSetRange(int startRecordNo.lang.lang. a c t u a t e.Vector vTables) JDBCHandler.j d b c d a t a s r c .Exception Pa ck a g e c o m .String u) Sets the JDBC URL to the string being passed JDBCHandler.lang.engine.setUsername public void setUsername(java.util. int endRecordNo) Specified by setResultSetRange in interface com.supportsStoredObjects public boolean supportsStoredObjects() throws java. JDBCHandler. java.setSelectiveProperties public void setSelectiveProperties(int iFilter.IDataSource JDBCHandler.actuate.setUrl public void setUrl(java.JDBCHandler. J D B C H a n d l e r 203 .String u) Sets the username to the string being passed.ereport.

. Used internally for debugging.) API when you know which tables you want to work with in the Template Designer. This method can be used in conjunction with the connect(..Repor t Designer API Java Edition .JDBCHandler.util.useTables public void useTables(java. 204 e.Vector v) Specifies a domain of tables to work with.

M e t a D a t a H a n d l e r 205 .metadatasrc. m e ta d a ta s r c . MetaDataHandler Chapter 0 Pa ck a g e c o m . d a t a s r c m gr s. a c t u a t e. datasrcmgrs.actuate.ereport.Package com. e r e p o r t .

Method summary Method MetaDataHandler .actuate.ereport.MetaDataHandler _____________________________________________________________________ All implemented interfaces com.addTable MetaDataHandler .engine.clearMetaData() MetaDataHandler .actuate. MetaDataSrc is a special type of data source used for offline reporting.metadatasrc.ereport.IMetaData public class MetaDataHandler extends com. The class extends the (@link com.datasrcmgrs.actuate.MetadataAdapter Implements com.ereport.engine.actuate.engine.ereport. It is not implemented for MetaDataHandler. com.MetadataAdapter | +--com. and so on. False if a hashtable key collision occurs. since MetaDataHandler does not require an active data source connection. Returns True if successful.actuate. This method is required to connect to a data source. Removes all tables along with all associated columns from the metadata layer.ereport. however.Class MetaDataHandler java.lang.engine.IDataSource.engine. 206 e.ereport.engine. Constructor summary MetaDataHandler() The default constructor.IDataSource.actuate.Object | +--com. This class implements the MetaData data source. storing relations information.actuate.Repor t Designer API Java Edition .MetadataAdapter MetadataAdapter} and implements IDataSource.connect() Description Sequentially adds one table with all associated columns to the metadata layer.ereport.

Returns the data type for a fully qualified column. Returns the grantor of privileges for the specified column. This function is reserved for future versions of ACJEngine. Returns the names of all columns for a specified table.getDefaultValue MetaDataHandler .disconnect() Description This method is required to disconnect from a data source. Pa ck a g e c o m . Returns the default value for a given column. a c t u a t e. Returns the name of the data source.getPropertySheet() MetaDataHandler .getGrantee MetaDataHandler . e r e p o r t . however.getDataType MetaDataHandler .getIdentifierQuote() MetaDataHandler . MetaDataHandler . Returns a comma-separated list of privileges for a column.getPrivileges MetaDataHandler .fetchData MetaDataHandler .getName() MetaDataHandler .M e t a D a t a H a n d l e r 207 .exportAsMetadata MetaDataHandler . Returns the name of the catalog for the data source structure.getQuery MetaDataHandler . It is not implemented for MetaDataHandler.getCatalogName() MetaDataHandler . Used internally.getQueryColumns MetaDataHandler .getGrantor MetaDataHandler .getColumnNames MetaDataHandler . Returns the grantee of privileges for the specified column. m e ta d a ta s r c . since MetaDataHandler does not require an active data source connection.getDatasourceName() MetaDataHandler .Method MetaDataHandler . d a t a s r c m gr s. Returns the default implementation of the metadata property sheet.getQueryResult Returns the data source name as MetaDataSource.

getRemarks MetaDataHandler . Returns the names of all tables in the data source structure. 208 e.manuallyConstructed() MetaDataHandler . Sets all relations as a vector of strings. Sets the name of the catalog for the data source structure to the specified name. indicating that MetaDataHandler does not require a connection.setCatalogName MetaDataHandler .Method MetaDataHandler .getRelations() MetaDataHandler . Reads and parses the metadata from an ASCII input stream into the metadata data structure.setDatasourceName MetaDataHandler . Sets the name of the data source.isGrantable MetaDataHandler . Specifies that the metadata has been constructed manually.requiresConnection() MetaDataHandler . Determines whether a column can be granted privileges.getQueryTables MetaDataHandler . Determines whether a column can be granted privileges. Specifies whether the given column can have a Null value.isConnected() MetaDataHandler .setRelations Description Returns a vector of all relations in a string format.getTable MetaDataHandler .Repor t Designer API Java Edition . Always returns False. Specifies whether the metadata information has been set up by loading from an EMD file.registerQuery MetaDataHandler .getTableNames() MetaDataHandler .setIdentifierQuote MetaDataHandler .isNullable MetaDataHandler . Interface implementation used internally by the engine.readObject MetaDataHandler .getTableType MetaDataHandler .

lang.Exception Pa ck a g e c o m . d a t a s r c m gr s. Returns True if successful. a c t u a t e. MetaDataHandler. MetaDataHandler.actuate.setResultSetRange MetaDataHandler . MetaDataHandler constructor MetaDataHandler public MetaDataHandler() The default constructor.ereport.Vector vColumns) Sequentially adds one table with all associated columns to the metadata layer. False if a hashtable key collision occurs.TableDescriptor td. m e ta d a ta s r c .clearMetaData public void clearMetaData() Removes all tables along with all associated columns from the metadata layer. java.addTable public boolean addTable(com.engine.util. MetaDataHandler.connect public void connect() throws java.writeObject Description Writes the metadata from the metadata data structure to an ASCII output stream of the appropriate format. e r e p o r t .Method MetaDataHandler .M e t a D a t a H a n d l e r 209 .

IDataSource MetaDataHandler. int iStart.disconnect public void disconnect() throws java. Specified by connect in interface com.Exception This function is reserved for future versions of ACJEngine. java. java.Component cProgress.fetchData public java.actuate.Exception MetaDataHandler.This method is required to connect to a data source. however.Object fetchData(java.IDataSource ids. Specified by disconnect in interface com. int iCount) throws java.ereport. com.exportAsMetadata public static void exportAsMetadata(java.util.Repor t Designer API Java Edition .io. It is not implemented for MetaDataHandler.Exception This method is required to disconnect from a data source.String sTable. since the MetaDataHandler doesn't require an active data source connection.engine. 210 e.ereport.lang. java.IDataSource MetaDataHandler.Vector vR) throws java.lang.lang.ereport.engine.String sColumn.actuate.lang. It is not implemented for MetaDataHandler.actuate.lang. however.lang. since the MetaDataHandler does not require an active data source connection.OutputStream os.engine.awt.

String getCatalogName() throws java.MetadataAdapter MetaDataHandler.engine.actuate.getDatasourceName public java.MetadataAdapter MetaDataHandler.IDataSource MetaDataHandler.ereport.actuate.lang.engine.Vector getColumnNames(java. d a t a s r c m gr s.actuate.lang.lang.getColumnNames public java.ereport. m e ta d a ta s r c .M e t a D a t a H a n d l e r 211 .lang. a c t u a t e.ereport.IDataSource Overrides getColumnNames in class com.engine.String getDatasourceName() Returns the name of the data source.util. Overrides getCatalogName in class com.lang.Exception Returns the name of the catalog for the data source structure.actuate.String sTable) throws java. e r e p o r t . Specified by getColumnNames in interface com.ereport.Exception Returns the names of all columns for a specified table.getCatalogName public java. Pa ck a g e c o m .Specified by fetchData in interface com.engine.

lang. java.actuate.String sTable.MetadataAdapter 212 e.lang.engine.String sTable.lang.engine.String sColumn) throws java. Overrides getGrantee in class com.Exception Returns the grantee of privileges for the specified column.String getGrantee(java.lang.engine. Overrides getDefaultValue in class com.Object getDefaultValue(java.Exception Returns the default value for a given column.lang.lang.ereport.Exception Returns the data type for a fully qualified column.MetadataAdapter MetaDataHandler.getGrantee public java.ereport. java.getDataType public int getDataType(java. java.actuate.lang.lang.lang.actuate.String sColumn) throws java.MetaDataHandler.lang.MetadataAdapter MetaDataHandler.ereport.String sColumn) throws java.String sTable. Overrides getDataType in class com.lang.getDefaultValue public java.Repor t Designer API Java Edition .

engine.actuate. Specified by getName in interface com.lang.actuate.engine.String getGrantor(java.MetadataAdapter MetaDataHandler.ereport. java.Exception Returns a comma-separated list of privileges for a column.IDataSource MetaDataHandler.String sTable.lang.getGrantor public java.lang.engine.lang.lang.String getIdentifierQuote() Overrides getIdentifierQuote in class com.getName public java.lang.ereport.MetaDataHandler.actuate. Pa ck a g e c o m .lang.lang. Overrides getGrantor in class com.MetadataAdapter MetaDataHandler. e r e p o r t .M e t a D a t a H a n d l e r 213 .String getPrivileges(java. m e ta d a ta s r c .lang.String sColumn) throws java.Exception Returns the grantor of privileges for the specified column.String sColumn) throws java. d a t a s r c m gr s.getIdentifierQuote public java.getPrivileges public java.String getName() Returns the data source name as MetaDataSource. java. a c t u a t e.ereport.String sTable.lang.

getPropertySheet public com.engine.IDataSource MetaDataHandler.Object queryId) Specified by getQuery in interface com.IPropertySheet getPropertySheet() Returns the default implementation of the metadata property sheet. Specified by getPropertySheet in interface com.engine.actuate. java.lang.engine.lang.ereport.ereport.ereport.lang.ereport.IDataSource MetaDataHandler.Overrides getPrivileges in class com.MetadataAdapter MetaDataHandler.IDataSource 214 e.actuate.actuate.Repor t Designer API Java Edition .getQueryColumns public java.actuate.String getQuery(java. This method is used internally.lang.engine.String tableName) throws java.Object queryId.util.engine.ereport.actuate.lang.getQuery public java.Exception Specified by getQueryColumns in interface com.Vector getQueryColumns(java.

Exception Specified by getQueryResult in interface com.lang.engine.engine. java.Exception Specified by getQueryTables in interface com.lang.engine.lang. RELATIONTYPE.util.getQueryResult public com.lang.String sTable. e r e p o r t .lang.IDataSource MetaDataHandler.ereport.Exception Returns a vector of all relations in a string format. m e ta d a ta s r c .getRelations public java.lang.lang.Exception Determines whether a column can be granted privileges.engine. a c t u a t e.Vector getRelations() throws java. java.IDataSource MetaDataHandler.ITable getQueryResult(java.MetaDataHandler.Vector getQueryTables(java.String query) throws java.String getRemarks(java.getQueryTables public java.lang.COL1-TABLE2.actuate. Overrides getRelations in class com.COL2.actuate.ereport.Object queryId) throws java.ereport.actuate.lang.ereport. The format for each relation is: TABLE1.actuate.MetadataAdapter MetaDataHandler.Object queryId.String sColumn) throws java. d a t a s r c m gr s. Pa ck a g e c o m .util.M e t a D a t a H a n d l e r 215 .lang.getRemarks public java.

ereport.ereport.lang.ereport.String getTableType(java.MetadataAdapter MetaDataHandler.lang.MetadataAdapter 216 e.util.ereport.Vector getTableNames() throws java.getTableType public java.IDataSource MetaDataHandler.actuate.ereport.ITable getTable(java.Exception Overrides getTableType in class com.engine.actuate.util.Exception Returns the names of all tables in the data source structure.lang.Exception Interface implementation used internally by the engine. Specified by getTableNames in interface com.IDataSource Overrides getTableNames in class com. java.engine.String sTable) throws java.engine.engine.actuate.actuate.getTable public com.engine.Overrides getRemarks in class com.MetadataAdapter MetaDataHandler.lang.lang.Hashtable querycontents.String readers) throws java.getTableNames public java.actuate.ereport. Specified by getTable in interface com.actuate.Repor t Designer API Java Edition .lang.engine.

String sTable.engine. Overrides isNullable in class com.engine. d a t a s r c m gr s. Specified by isConnected in interface com. java.isConnected public boolean isConnected() throws java.M e t a D a t a H a n d l e r 217 .Exception Determines whether a column can be granted privileges.lang.engine.lang.lang.isNullable public java. e r e p o r t . a c t u a t e. java.Exception Specifies whether the metadata information has been set up by loading from a EMD file.Exception Specifies whether the given column can have a Null value.actuate.MetadataAdapter MetaDataHandler. Overrides isGrantable in class com.lang.String isNullable(java.actuate.lang.MetaDataHandler.String sColumn) throws java.lang.MetadataAdapter Pa ck a g e c o m .lang. m e ta d a ta s r c .ereport.lang.String sTable.isGrantable public boolean isGrantable(java.actuate.String sColumn) throws java.ereport.ereport.IDataSource MetaDataHandler.

engine.InputStream is) throws java.actuate.ereport.Exception Reads and parses the metadata from an ASCII input stream into the metadata data structure. this flag is internally set when data is loaded from a metadata file.String query) throws java.io.IDataSource 218 e.actuate. MetaDataHandler.requiresConnection public boolean requiresConnection() Always returns False.lang.lang.IDataSource MetaDataHandler.Repor t Designer API Java Edition .Exception Specified by registerQuery in interface com.Object queryId. MetaDataHandler. Specified by requiresConnection in interface com.engine.manuallyConstructed public void manuallyConstructed() Specifies that the metadata has been constructed manually. Usually.lang.MetaDataHandler.ereport. java. indicating that the MetaDataHandler does not require a connection.registerQuery public void registerQuery(java.lang.readObject public boolean readObject(java.

M e t a D a t a H a n d l e r 219 .IDataSource Pa ck a g e c o m .lang. RELATIONTYPE.ereport.setRelations public void setRelations(java.Vector vR) Sets all relations as a vector of strings.util.MetaDataHandler. The format for each relation is: TABLE1.COL2. d a t a s r c m gr s.setIdentifierQuote public void setIdentifierQuote(java.String sQ) MetaDataHandler.String sCatalog) Sets the name of the catalog for the data source structure to the specified name.lang.setResultSetRange public void setResultSetRange(int startRecordNo. e r e p o r t .setDatasourceName public void setDatasourceName(java. a c t u a t e.lang. MetaDataHandler.engine. m e ta d a ta s r c .String dsName) MetaDataHandler.setCatalogName public void setCatalogName(java. int endRecordNo) Specified by setResultSetRange in interface com.actuate. MetaDataHandler.COL1-TABLE2.

OutputStream os) throws java.Exception Writes the metadata from the metadata data structure to an ASCII output stream of the appropriate format. java. Sets the name of the data source.output.io. 220 e.actuate.MetaDataHandler.writeObject public void writeObject(com.Repor t Designer API Java Edition .ereport.lang.ProgressBox pb.

M e t a D a t a H a n d l e r 221 . output. a c t u a t e. e r e p o r t .actuate.ereport. m e ta d a ta s r c . d a t a s r c m gr s.OD_DHTML Pa ck a g e c o m .Package Chapter 0 com.

generateMainFrameSet OD_DHTML.Class OD_DHTML java.IOutputFormat This class is used for generating the output of the report in HTML format.generate Description This is an interface call substituted in place of generateHTML function in OD_Preview so all the parameters specific to generateHTML call are embeded into parameters vector Used to generate the main container page for reports containing TOC.ereport.Object | +--com. Constructor summary OD_DHTML() This is an empty constructor that is used for instantiating OD_DHTML using Class.newInstance() Method summary Method OD_DHTML.lang.actuate.OD_HTML _____________________________________________________________________ All implemented interfaces com. generateTOCPage 222 e. It is an implementation of IOutputFormat It retrieves the list of controls for each page that it recieves from VirtualOutput and renders them.ereport. generateReportPage OD_DHTML.ereport.output.actuate.actuate.output.IOutputFormat public class OD_DHTML extends java.lang. It calls this method to handle the formatting and writing of controls to the output stream Writes the Table Of contents if specified to the Html file OD_DHTML.Object implements com. Once the generate method successfully creates and instantiates the data stream. This class is called from VirtualOutput.output.Repor t Designer API Java Edition .

util. Specified by generate in interface com. com. OD_DHTML.VirtualOutput vo.getImage OD_DHTML.Exception This is an interface call substituted in place of generateHTML function in OD_Preview so all the parameters specific to generateHTML call are embeded into parameters vector. e r e p o r t . d a t a s r c m gr s.newInstance() OD_DHTML.ereport.Object generate(com.ProgressInterface pi.IOutputFormat outputDesc The output destination for html file.Method OD_DHTML.actuate.actuate. Similar to getImage(Object.lang. m e ta d a ta s r c . The possible values are String.output. a c t u a t e. long) except that the second argument is an Object representing the index of the image.Properties properties) throws java.output. This method is used to specify the mode of report generation and the entity requesting for the report.M e t a D a t a H a n d l e r 223 .getImage Description This method is used to fetch individual images from the report. java. OutputStream. Pa ck a g e c o m . In case of output stream non indexed report should be generated.ereport.ereport. setGenerateOnDemand OD_DHTML constructor OD_DHTML public OD_DHTML() This is an empty constructor that is used for instantiatingOD_HTML OD_DHTML using Class.generate public java.output.lang.actuate.

toc If true. whenever the system needs gui support it will try to locate that support or create new component as needed. forceGui If true.Repor t Designer API Java Edition . component For java 1. This must be set to false if OutputStream is used as outputDesc.x. parameters This is a vector which contains following elements 1 Boolean toc 2 Boolean forceGui 3 Boolean preserveFonts 4 Boolean preserveColors 5 Boolean useHorSpacing 6 Boolean gzip whether or not to generate a zipped output 7 Integer bufferSize 8 String charSet 9 String htmlTitle 10 String htmlAuthor 11 Boolean cache 12 Boolean preservePageBreak whether to display the PAGE Hdr/Ftr in the output or not // ROH : (02/29/2000) : Inserted this param 13 String sTargetBrowser the target browser for the output style 14 ZipOutputStream zos 15 Color TOCBackground Background Color for TOC 16 Vector vPages Page numbers for page on demand 17 String pageOnDemandURL The URL of the source which requested for the page on demand 18 int firstPageOnDemand The page that the link "First" is supposed to point to 19 int prevPageOnDemand The page that the link "Prev" is supposed to point to 20 int nextPageOnDemand The page that the link "Next" is supposed to point to 21 int lastPageOnDemand The page that the link "Last" is supposed to point to 224 e.vo The virtual output storage from which data can be extracted.x versions to create an offscreen image a visible component is required this component should work as a ImageObserver the value of component must be passed as null in case you want to generate html output without any window system however in this case no image will be added to the html file. indexed report will be generated else non indexed report will be generated.

lang. OD_DHTML. m e ta d a ta s r c .Exception throws an Exception if it is unable to write to the output.lang. The OutputStream to which the report is being written.lang.lang.generateReportPage public void generateReportPage(java.OD_DHTML.Object outputDesc) throws java.lang. OD_DHTML.generateTOCPage public void generateTOCPage(java. e r e p o r t .lang.Exception Once the generate method successfully creates and instantiates the data stream.lang.Exception Writes the Table Of contents if specified to the Html file Pa ck a g e c o m .M e t a D a t a H a n d l e r 225 . it calls this method to handle the formatting and writing of controls to the output stream. toc . The main page holds the TOC page and the Report Page.Object outputDesc) throws java.Object outputDesc) throws java.Exception Used to generate the main container page for reports containing TOC.boolean toc a boolean indicating whether the table of contents is to be displayed or not Throws java.generateMainFrameSet public void generateMainFrameSet(java. d a t a s r c m gr s. a c t u a t e. Throws a RuntimeException if there is a problem writing the TOC to the OutputStream.

Object outputDesc. The arguments are the Outputstream and the index of the image. OD_DHTML.lang.Object outputDesc. and are accordingly fetched. However this call must only be made after the report has completely been generated otherwise you get a NullPointerException.Exception Similar to getImage(Object. the images are requested by the browser.setGenerateOnDemand public void setGenerateOnDemand(boolean bServerBased. Throws a RuntimeException if it cannot write the Image to the OutputStream OD_DHTML.lang.java.Repor t Designer API Java Edition .lang. When used in Multiple File Serving.lang. ptr The index of the image in the report.lang. Internally calls getImage(Object. long) except that the second argument is an Object representing the index of the image.Object ptr) throws java. java.Exception This method is used to fetch individual images from the report.getImage public void getImage(java.getImage public void getImage(java.lang.Exception if the toc cannot be written OD_DHTML. Should be the OutputStream to which the image is to be written.Throws java. long ptr) throws java.String sRequestorName) 226 e.lang. Object) outputDesc Output Descriptor.

TOC page and images contained in the report are requested for separately. d a t a s r c m gr s. This is used when the report is going to be generated from the server and as such the Report page. a c t u a t e. Boolean used to indicate if the report is being generated from a server based application String specifying the requestor of the report Pa ck a g e c o m .This method is used to specify the mode of report generation and the entity requesting for the report. e r e p o r t .M e t a D a t a H a n d l e r 227 . m e ta d a ta s r c .

Repor t Designer API Java Edition .228 e.

M e t a D a t a H a n d l e r 229 . output.ereport. a c t u a t e. e r e p o r t . d a t a s r c m gr s. m e ta d a ta s r c .Package Chapter 0 com.actuate.OD_HTML Pa ck a g e c o m .

ereport.actuate.Repor t Designer API Java Edition . This class is called from VirtualOutput. It is an implementation of IOutputFormat It retrieves the list of controls for each page that it renders from VirtualOutput and renders them.lang.generate Description This is an interface call substituted in place of generateHTML function in OD_Preview so all the parameters specific to generateHTML call are embeded into parameters vector Used to generate the main container page for reports containing TOC Once the generate method successfully creates and instantiates the data stream.output. Constructor summary OD_HTML() This is an empty constructor that is used for instantiating OD_HTML using Class.Object implements com.IOutputFormat public class OD_HTML extends java. generateReportPage 230 e. It calls this method to handle the formatting and writing of controls to the output stream OD_HTML. are not preserved as HTML doesn't have any support for these properties.lang. size of the control etc. generateMainFrameSet OD_HTML.IOutputFormat This class is used for generating the output of the report in HTML format.Object | +--com.newInstance() Method summary Method OD_HTML.Class OD_HTML java.actuate.output.ereport. Just fonts and colors are preserved if required but other styles such as alignment.ereport. These have been supported in PDF & DHTML.actuate.output.OD_HTML _____________________________________________________________________ All implemented interfaces com.

lang. m e ta d a ta s r c . long) except that the second argument is an Object representing the index of the image.util.actuate.output. This method is used to specify the mode of report generation and the entity requesting for the report.output.actuate. com.M e t a D a t a H a n d l e r 231 . Specified by generate in interface com. setGenerateOnDemand OD_HTML constructor OD_HTML public OD_HTML() This is an empty constructor that is used for instantiating OD_HTML using Class. Similar to getImage(Object.Object generate(com. generateTOCPage OD_HTML.output.Properties properties) throws java.Exception This is an interface call substituted in place of generateHTML function in OD_Preview so all the parameters specific to generateHTML call are embeded into parameters vector.getImage OD_HTML.ProgressInterface pi. e r e p o r t .ereport.ereport.Method OD_HTML.generate public java.lang. a c t u a t e.ereport.IOutputFormat Pa ck a g e c o m .VirtualOutput vo. d a t a s r c m gr s.actuate. java.getImage Description Writes the Table Of contents if specified to the Html file This method is used to fetch individual images from the report.newInstance() OD_HTML. OD_HTML.

parameters This is a vector which contains following elements 1 Boolean toc 2 Boolean forceGui 3 Boolean preserveFonts 4 Boolean preserveColors 5 Boolean useHorSpacing 6 Boolean gzip whether or not to generate a zipped output 7 Integer bufferSize 8 String charSet 9 String htmlTitle 10 String htmlAuthor 11 Boolean cache 12 Boolean preservePageBreak whether to display the PAGE Hdr/Ftr in the output or not 13 ZipOutputStream zos 14 Color TOCBackground Background Color for TOC 15 Vector vPages Page numbers for page on demand 16 String pageOnDemandURL The URL of the source which requested for the page on demand 17 int firstPageOnDemand The page that the link "First" is supposed to point to 18 int prevPageOnDemand The page that the link "Prev" is supposed to point to 232 e. indexed report will be generated else non indexed report will be generated.outputDesc The output destination for html file. component For java 1.Repor t Designer API Java Edition .x. vo The virtual output storage from which data can be extracted. The possible values are String.x versions to create an offscreen image a visible component is required this component should work as a ImageObserver the value of component must be passed as null in case you want to generate html output without any window system however in this case no image will be added to the html file. In case of output stream non indexed report should be generated. This must be set to false if OutputStream is used as outputDesc. whenever the system needs gui support it will try to locate that support or create new component as needed. OutputStream. forceGui If true. toc If true.

Throws a RuntimeException if there is a problem writing the TOC to the OutputStream.generateReportPage public void generateReportPage(java.19 int nextPageOnDemand The page that the link "Next" is supposed to point to 20 int lastPageOnDemand The page that the link "Last" is supposed to point to OD_HTML.Object outputDesc) throws java. a c t u a t e. It calls this method to handle the formatting and writing of controls to the output stream toc .Exception . The main page holds the TOC page and the Report Page.lang. m e ta d a ta s r c .Exception Pa ck a g e c o m .Object outputDesc) throws java. The OutputStream to which the report is being written.lang.generateMainFrameSet public void generateMainFrameSet(java.M e t a D a t a H a n d l e r 233 .lang. OD_HTML.Exception Once the generate method successfully creates and instantiates the data stream. d a t a s r c m gr s.Object outputDesc) throws java.boolean toc a boolean indicating whether the table of contents is to be displayed or not Throws java. OD_HTML.lang.Throws an Exception if it is unable to write to the output.lang.lang. e r e p o r t .Exception Used to generate the main container page for reports containing TOC.generateTOCPage public void generateTOCPage(java.lang.

Object outputDesc.Repor t Designer API Java Edition . However this call must only be made after the report has completely been generated otherwise you get a NullPointerException.lang. Throws a RuntimeException if it cannot write the Image to the OutputStream OD_HTML.getImage public void getImage(java. Internally calls getImage(Object. and are accordingly fetched. The arguments are the Outputstream and the index of the image. ptr The index of the image in the report. Object) outputDesc Output Descriptor. When used in Multiple File Serving.Exception .Exception This method is used to fetch individual images from the report. the images are requested by the browser.lang.Writes the Table Of contents if specified to the Html file Throws java.if the toc cannot be written OD_HTML.lang.lang.lang.Exception Similar to getImage(Object. Should be the OutputStream to which the image is to be written. 234 e.Object outputDesc.getImage public void getImage(java.lang.Object ptr) throws java. java. long ptr) throws java. long) except that the second argument is an Object representing the index of the image.

d a t a s r c m gr s.M e t a D a t a H a n d l e r 235 . m e ta d a ta s r c .setGenerateOnDemand public void setGenerateOnDemand(boolean bServerBased. a c t u a t e. java.lang.String sRequestorName) This method is used to specify the mode of report generation and the entity requesting for the report. This is used when the report is going to be generated from the server and as such the Report page.OD_HTML. e r e p o r t . Boolean used to indicate if the report is being generated from a server based application String specifying the requestor of the report Pa ck a g e c o m . TOC page and images contained in the report are requested for separately.

Repor t Designer API Java Edition .236 e.

actuate. Te m p l a t e M a n a g e r 237 .ereport. e n g i n e . e r e p o r t . a c t u a t e .Package com.TemplateManager Chapter 0 P a c k a g e c o m . engine.

Group.engine.Object | +--com.lang.engine . section IDs.createControl TemplateManager . Creates a generic control and returns a handle to it.TmplMgr Field tmplMgr Used internally Method summary Method TemplateManager .actuate.Repor t Designer API Java Edition . Zone. Each piece of the template has a control ID that uniquely identifies it within the template.createControl Description Changes the control ID specified by the old control ID and replaces it with the new ID. Duplicate control IDs are not allowed. Returns a set of control IDs.actuate. Attempts to connect to the data source embedded inside the template. You can.TemplateManager _____________________________________________________________________ public class TemplateManager extends java. and zone IDs contained inside the entire template based on filter criteria specified by boolean variables. Most aspects of the template can be controlled using this class. and so on.ereport. pass the control ID within double quotation marks as a string constant to refer to a particular control. An ACJEngine template has several logical parts: Section. Most of the methods in this class work a generic object class.Object This is the main class to access the template in ACJEngine. 238 e.connectToDatasource() TemplateManager . Central to accessing these parts is a control ID.Class TemplateManager java.ereport.collapseTemplate TemplateManager . Control. Creates a new control with the specified ID and the specified parent.lang. however.changeID TemplateManager . Field summary Type com.

getPageHeight() TemplateManager .getFormula TemplateManager .getPageMargins() Description Use this method to cleanly destroy any template that may be loaded into the Template Manager.getDataField TemplateManager . Returns the current value of the ORDER BY clause of the specified section's query. Te m p l a t e M a n a g e r 239 . e n g i n e . P a c k a g e c o m . Returns the URL of the image referred to in the control. Returns a FontExt object which is an enhanced class to describe a font. a c t u a t e .getORDERBYClause TemplateManager . Returns a string that is normally used by Java to define string formatting.getFillColor TemplateManager .createRuntimeParams() TemplateManager . Returns a string in Table. Returns the page height in inches. Returns the page margins as a Bounds structure. Returns the fill/background color of a control.destroyTemplate() TemplateManager .getImportedSQLQuery TemplateManager .getImageURL TemplateManager .getFormat TemplateManager .Method TemplateManager .getFont TemplateManager . Returns the formula that has been assigned to the specified control. returns Null. Returns the text alignment property of the control.getLabel TemplateManager . Returns the imported SQL query for the section if already set through setImportedSQLQuery.getFontColor TemplateManager .getBounds TemplateManager . Otherwise. Returns the string value of this label control.Column format.getAlignment TemplateManager . e r e p o r t . Returns the width and height of a control. Returns the color being used to display the text of this control.

Repor t Designer API Java Edition .getTemplateWidth() TemplateManager . TemplateManager .Method TemplateManager . Returns True if control is set to visible. Returns a list of parameter IDs using which properties can be set or retrieved. Indicates whether any parameters exist in this template which can be resolved. False otherwise.getParamProperty TemplateManager . Returns the width of the template in inches. False otherwise. Indicates that the loaded template contains an embedded data source.getReportTitle() TemplateManager . Returns True if control is set for resizing to fit the contents. Returns the current value of the WHERE clause of the specified section's query.getReportComments() TemplateManager . Returns True if the Wrap Text property of the specified control is set. Returns the section ID of the section that contains the specified field. No corresponding set function is available because SELECT and FROM clauses cannot be modified through the API.getTextWrap TemplateManager .getWHEREClause TemplateManager .getVisible TemplateManager . Returns the report's Comments property.hasEmbeddedDatasource() TemplateManager .hasParameters() 240 e. Returns an individual property for the specified parameter ID.getSectionId TemplateManager . Returns the report's Title property.getParameterIds() TemplateManager . Returns the report's Author property.getResizeToFitContents TemplateManager . WHERE and ORDER BY parts of the sections's query. FROM.getQueryContents Description Returns the page width in inches.getReportAuthor() TemplateManager . Returns a Hashtable with values of SELECT. False otherwise.getPageWidth() TemplateManager .

False otherwise.Method TemplateManager .setAlignment TemplateManager . False otherwise.setFillColor TemplateManager .isFormula TemplateManager . Sets the font used to display the text inside the control. False otherwise.setImportedSQLQuery Description Returns True if the control specified by the control ID is a chart object. e n g i n e . False otherwise. Sets the fill/background color of a control. The font name is the font family: Serif.setFont TemplateManager . Sets the formula for the given control. False otherwise.setBounds TemplateManager .isLabel TemplateManager . a c t u a t e .setFormat TemplateManager . Returns True if the control specified by the control ID is a data field. e r e p o r t . Returns True if the control specified by the control ID is a line.isDataField TemplateManager . Sets the text alignment property of the control. P a c k a g e c o m .setImageURL TemplateManager . Sets the width and height of a control.setFormula TemplateManager . which is normally used by Java to define string formatting.isImageURL TemplateManager . Sets the value of a field control. Sets the predesigned SQL query to be used by the section.isChart TemplateManager . Returns True if the control specified by the control ID is an image URL. Sets the URL of the image referred to in this control. False otherwise. Te m p l a t e M a n a g e r 241 .setFontColor TemplateManager .isLine TemplateManager . Returns True if the control specified by the control ID is a label. SansSerif. and so on.setDataField TemplateManager . Sets a string. Returns True if the control specified by the control ID is a formula.

Sets an individual property for the specified parameter ID.setPageMargins TemplateManager . Allows the control to resize vertically when set to True.setUnitType TemplateManager . Used to set the wallpaper at a specified location. top.setParamProperty TemplateManager . Sets the page width in inches. Sets the report's Comments property.setLabel TemplateManager .setWallpaper TemplateManager . Sets the page height in inches. right. Sets the report's Author property. Sets the Word Wrap property of the specified control if True is passed. 242 e.Method TemplateManager .setPageHeight TemplateManager . and bottom margins of the page using a Bounds structure.setPageWidth TemplateManager . Sets the control's visibility as specified. Used to set the wallpaper which is tiled. Sets the report's Title property.setReportComments TemplateManager .setORDERBYClause TemplateManager .Repor t Designer API Java Edition . Sets the left.setReportTitle TemplateManager . Set the measurement units to be used.setParamValue TemplateManager . Used to bypass the Enter Parameter Values dialog box and specify parameter values through the API instead. Sets the value of the ORDER BY clause of the specified section's query with given value.setTextWrap TemplateManager . Sets the value of the parameter specified.setVisible TemplateManager . unsets it if False is passed.setReportAuthor TemplateManager .setWallpaper Description Sets the value of a label control.setResizeToFitContents TemplateManager .

Field detail tmplMgr public com. TemplateManager. boolean IncGrpFtrs.String changeID(java.setWHEREClause TemplateManager . boolean IncPgHdr.ereport. P a c k a g e c o m . e r e p o r t . a c t u a t e .Object NewId) Changes the old control ID to the new ID. and zone IDs contained inside the entire template based on a filter criteria specified by boolean variables. boolean IncGrpHdrs. section IDs.TmplMgr tmplMgr Used internally. e n g i n e .Method TemplateManager . boolean IncPgFtr.lang.changeID public java. Te m p l a t e M a n a g e r 243 . TemplateManager. Sets the height of a zone in inches.collapseTemplate public java. boolean IncDetail.setZoneHeight Description Sets the WHERE clause of the specified section's query. The new WHERE clause overwrites the existing WHERE clause.Vector collapseTemplate(boolean IncRpHdr.Object OldId. java. boolean IncRpFtr) Returns a set of control IDs.lang.actuate. boolean IncSections.lang.engine.util. boolean IncFields.

createControl public java. java.Object newID.Object createControl(java. label.lang.lang.connectToDatasource public void connectToDatasource() throws java.Exception Attempts to connect to the data source embedded inside the template.lang. and so on.lang.Repor t Designer API Java Edition . 244 e.Object id) Creates a generic control and returns a handle to it.createControl public java.destroyTemplate public void destroyTemplate() Use this method to cleanly destroy any template that may be loaded into the Template Manager.lang.Object createControl(java. TemplateManager.Object parentID) Creates a new control with specified ID and the specified parent.createRuntimeParams public boolean createRuntimeParams() TemplateManager. TemplateManager.TemplateManager.lang. TemplateManager. Users should first create a generic control and then set its type: data field.

e n g i n e . TOP = 16. RIGHT = 2. LEFT = 1.actuate.getFont public com.lang.Object a) Returns a string in Table.Object Id) Returns the text alignment property of the control. Possible return values are: NONE = 0.Column format.Object Id) Returns the width and height of a control. TemplateManager. BOTTOMCENTER = ( HORIZONTALCENTER | BOTTOM ). BOTTOMLEFT = ( LEFT | BOTTOM ).lang.TemplateManager. TemplateManager.lib.lang. TemplateManager.getDataField public java. TemplateManager. BOTTOMRIGHT = ( RIGHT | BOTTOM ). Te m p l a t e M a n a g e r 245 .lang.lang.FontExt getFont(java. CENTER = ( VERTICALCENTER | HORIZONTALCENTER ). TOPRIGHT = ( RIGHT | TOP ). HORIZONTALCENTER = 64. BOTTOM = 8.String getDataField(java.getBounds public com. TOPLEFT (TOP | LEFT).Object Id) P a c k a g e c o m .ereport.getFillColor public java. e r e p o r t .ereport.engine.Object Id) Returns the fill/background color of a control.lang.Color getFillColor(java.Bounds getBounds(java. a c t u a t e .getAlignment public int getAlignment(java.common.awt.actuate. VERTICALCENTER = 32. TOPCENTER = ( HORIZONTALCENTER | TOP ).

Repor t Designer API Java Edition .String getFormat(java. TemplateManager.getFontColor public java.Object Id) Returns a string normally used by Java to define string formatting.Color getFontColor(java.Object a) Returns the formula that has been assigned to the specified control.getFormula public java.String getImportedSQLQuery(java.Object sectionId) Returns the imported SQL query for the section if already set through setImportedSQLQuery.getImageURL public java.lang. TemplateManager.awt.getFormat public java. TemplateManager. TemplateManager.Returns a FontExt object. FontExt not only provides more information than the regular Font class.String getFormula(java. returns Null.lang.Object Id) Returns the color used to display the text of this control. but is also designed to provide a Java platform-independent way to deal with fonts.lang.lang.getImportedSQLQuery public java.lang. which is an enhanced class to describe a font.Object Id) Returns the URL of the image referred to in this control.lang.lang. 246 e. Otherwise. TemplateManager.lang.String getImageURL(java.lang.

lang. P a c k a g e c o m .String getLabel(java.getPageWidth public double getPageWidth() Returns the page width in inches.Object SectionId) Returns the current value of the ORDER BY clause of the specified section's query.getPageMargins public com. TemplateManager.actuate.lang.Bounds getPageMargins() Returns the page margins as a Bounds structure. TemplateManager. a c t u a t e . e n g i n e . e r e p o r t .getORDERBYClause public java.lib.getLabel public java. See also Bounds TemplateManager.lang.Object Id) Returns the string value of this label control.String getORDERBYClause(java. TemplateManager.ereport. Te m p l a t e M a n a g e r 247 .getPageHeight public double getPageHeight() Returns the page height in inches.lang.TemplateManager.engine.

Acceptable values are Description.setORDERBYClause() respectively.Exception Returns a hashtable with values of SELECT.String[] getParameterIds() Returns a list of parameter IDs using properties that can be set or retrieved.lang. java. sParamID The ID of the parameter for which a property should be retrieved.lang. Type.getParamProperty public java. FROM.lang.getQueryContents public java.getReportAuthor public java.setWHEREClause() and TemplateManager.getParameterIds public java.lang.lang. Value. sProperty The name of the property. WHERE and ORDER BY parts of the sections's query.TemplateManager. TemplateManager.RuntimeException Returns an individual property for the specified parameter ID. For WHERE and ORDER BY clauses. TemplateManager.String getReportAuthor() Returns the report's Author property.Hashtable getQueryContents(java.Object getParamProperty(java.util.String sParamID. use TemplateManager. TemplateManager.lang.Object sectionId) throws java.lang.Repor t Designer API Java Edition .lang.String sProperty) throws java. and Format. No corresponding set function is available because SELECT and FROM clauses cannot be modified through the API. 248 e.

getSectionId public java. Te m p l a t e M a n a g e r 249 .lang. otherwise.getReportTitle public java.lang. TemplateManager. e r e p o r t .Object Id) P a c k a g e c o m . TemplateManager.lang.getTemplateWidth public double getTemplateWidth() Returns the width of the template in inches.getReportComments public java.Object FieldId) Returns the section ID of the section that contains the specified field. e n g i n e .lang.lang. TemplateManager.Object Id) Returns True if the control is set for resizing to fit the contents. a c t u a t e . TemplateManager. False.getResizeToFitContents public boolean getResizeToFitContents(java.String getSectionId(java.getTextWrap public boolean getTextWrap(java.String getReportComments() Returns the report's Comments property.lang. This method is valid only for controls inside the zones.TemplateManager. TemplateManager.String getReportTitle() Returns the report's Title property.

Returns True if the wrap text property of specified control is set. TemplateManager. TemplateManager.lang. 250 e.getWHEREClause public java.lang.hasEmbeddedDatasource public boolean hasEmbeddedDatasource() Indicates that the loaded template contains an embedded data source.String getWHEREClause(java.hasParameters public boolean hasParameters() Indicates whether any parameters exist in this template that can be resolved.Object Id) Returns the current value of the WHERE clause of the specified section's query.lang.Object Id) Returns True if the control is set to visible.Object Id) Returns True if the control specified by the control ID is a chart object. False otherwise.getVisible public boolean getVisible(java. False otherwise.Repor t Designer API Java Edition . TemplateManager.isChart public boolean isChart(java. TemplateManager.lang. TemplateManager. False otherwise.

Object Id) Returns True if the control specified by the control ID is a formula.Object Id) Returns True if the control specified by the control ID is a data field. False otherwise. TemplateManager. TemplateManager.isImageURL public boolean isImageURL(java.isDataField public boolean isDataField(java. TemplateManager. P a c k a g e c o m . a c t u a t e .isFormula public boolean isFormula(java.lang.isLine public boolean isLine(java.lang.lang.Object Id) Returns True if the control specified by the control ID is a label.lang. False otherwise.isLabel public boolean isLabel(java. False otherwise. e n g i n e .Object Id) Returns True if the control specified by the control ID is an image URL.lang.Object Id) Returns True if the control specified by the control ID is a line.TemplateManager. TemplateManager. False otherwise. Te m p l a t e M a n a g e r 251 . e r e p o r t . False otherwise.

actuate.Object Id. LEFT = 1. TOPLEFT (TOP | LEFT). TOPRIGHT = ( RIGHT | TOP ). TOP = 16. and CENTER = ( VERTICALCENTER | HORIZONTALCENTER ).Object FieldId.lang. java. HORIZONTALCENTER = 64.setFillColor public void setFillColor(java. Possible return values are: NONE = 0. com. BOTTOMCENTER = ( HORIZONTALCENTER | BOTTOM ). java.Color c) Sets the fill/background color of a control.awt. TemplateManager. TOPCENTER = ( HORIZONTALCENTER | TOP ).setAlignment public void setAlignment(java.lib.lang.Object Id.Object SectionId.String Colname) Sets the value of a field control.lang.setDataField public void setDataField(java.lang.Bounds rect) Sets the width and height of a control. int val) Sets the text alignment property of the control.Object d. BOTTOMRIGHT = ( RIGHT | BOTTOM ).Repor t Designer API Java Edition . 252 e.ereport. TemplateManager.engine. RIGHT = 2.setBounds public void setBounds(java. VERTICALCENTER = 32.TemplateManager.lang. BOTTOM = 8. java.lang. TemplateManager. BOTTOMLEFT = ( LEFT | BOTTOM ).

P a c k a g e c o m . SansSerif.setFont public void setFont(java.lang. TemplateManager.lang. e r e p o r t . The font name is the font family: Serif.lang. a c t u a t e .Object Id.String formula.TemplateManager.String format) Sets a string which is normally used by Java to define string formatting.lang. Styles include Plain.lang. java.setFormat public void setFormat(java. must be a valid zone contained within the control's section. formula A formula string. e n g i n e .Object resetZone) Sets the formula for a given control.setFontColor public void setFontColor(java. and Italic. TemplateManager. java. java.lang.Object Id. Te m p l a t e M a n a g e r 253 .awt.String FontName. Id The identifier of a control. java.Color c) TemplateManager. and so on. int size) Sets the font used to display the text inside the control. Rest Criteria.setFormula public void setFormula(java. int Style.lang.Object Id. java.Object Id.lang. Bold.

setPageHeight public void setPageHeight(double h) Sets the page height in inches. java. java.Object sectionId. TemplateManager.lang.String colssort) Sets the value of the ORDER BY clause of the specified section's query with given value.TemplateManager.lang. java. When setting the query through this API.lang.Object FieldId.lang.Object FieldId.lang. TemplateManager. TemplateManager.String label) Sets the value of a label control.lang. TemplateManager. java.setLabel public void setLabel(java.lang.setImportedSQLQuery public void setImportedSQLQuery(java.lang.Object SectionId.setImageURL public void setImageURL(java.Repor t Designer API Java Edition .setORDERBYClause public void setORDERBYClause(java. make sure that the fields used in the template will be provided in the result set of this query.String query) Sets the predesigned SQL query to be used by the section. 254 e.String url) Sets the URL of the image referred to in this control.

TemplateManager. corresponding acceptable class types are String.Object oValue) throws java. double right. double bottom) Sets the left. top. double top.actuate. TemplateManager.ereport. sProperty The names of property acceptable values are: Description.setPageMargins public void setPageMargins(com.setPageWidth public void setPageWidth(double w) Sets the page width in inches. and Object.lib. Te m p l a t e M a n a g e r 255 . e n g i n e .lang. java. right. oValue The value of the property.String sParamID.TemplateManager. and Format. right. e r e p o r t .String sProperty.Bounds m) Sets the left.RuntimeException Sets an individual property for the specified parameter ID. and bottom margins of the page using a Bounds structure The following addtional syntax is available in the AWT API: public void setPageMargins(double left. top.lang. String. P a c k a g e c o m . Type.engine. and bottom margins of the page. java. sParamID The ID of the parameter for which a property is to be set.setParamProperty public void setParamProperty(java. a c t u a t e . Value.lang.lang.

TemplateManager. boolean val) Allows the control to resize vertically when set to True. 256 e.Object sDefValue) Sets the value of the parameter specified.lang. TemplateManager.lang.lang. TemplateManager.lang.lang.String sName.setReportComments public void setReportComments(java.String sTitle) Sets the report's Title property. Used to bypass the Enter Parameter Values dialog box and instead specify parameter values through the API. Default value is False. This value can be set only for controls inside the zones.String sComments) Sets the report's Comments property. TemplateManager.setParamValue public boolean setParamValue(java.Repor t Designer API Java Edition . java.Object Id.setReportAuthor public void setReportAuthor(java.String sAuthor) Sets the report's Author property.lang. TemplateManager.setReportTitle public void setReportTitle(java.setResizeToFitContents public void setResizeToFitContents(java.

setWallpaper public void setWallpaper(java. from the margin. from the margin.String URL. double topOffset) Used to set the wallpaper at a specified location. e n g i n e .Object Id.lang. TopOffset is the top offset. TemplateManager.lang.lang.Object Id.String URL) Used to set the wallpaper which is tiled. boolean val) Sets the Word Wrap property of the specified control if True is passed.setVisible public void setVisible(java.lang. TemplateManager. Te m p l a t e M a n a g e r 257 .setWallpaper public void setWallpaper(java. for the watermark double. e r e p o r t . double leftOffset. URL The file URL for the watermark image.setUnitType public void setUnitType(java. TemplateManager. P a c k a g e c o m .String sUnits) Sets the measurement units to be used. boolean val) Sets the control's visibility as specified.lang.TemplateManager. for the watermark. a c t u a t e . TemplateManager.setTextWrap public void setTextWrap(java. Double leftOffset is the left offset. unsets it if False is passed.

double h) Sets the height of a zone in inches.Object Id.Object Id. TemplateManager.Repor t Designer API Java Edition .setWHEREClause public void setWHEREClause(java.setZoneHeight public void setZoneHeight(java.lang. 258 e. The new WHERE clause overwrites the existing WHERE clause.URL The file URL for the wallpaper image. TemplateManager.lang. java.String filterexpr) Sets the WHERE clause of the specified section's query.lang.

Swing usage 4 ACJOutputProcessor class 112 AWT vs.Reporting Server Progress Edition xvii alignment getting text 245 setting text 252 allowMultipleTableRegistering method 149 allStoredObjectsCallable method 188 analysis tools (third-party) xiv ANSI encoding 105. xvi CharacterSeparator property 136 charts 250 checkIfExists method 169 classes alphabetical listing of 15 hierarchy summarized 2 clearMetaData method 209 clearSchemaAndData method 176 clients mapping to template keys 139 Index 259 . 3 applications 146 getting data source for 79. Swing usage 3 serialized objects listed 11 application programming interfaces xiv. 152 ASCII data sources extracting from 168 getting registered 80 initializing 169 ASCIIDataHandler class 168 AWT vs. Swing usage 4 serialized objects listed 8 ACJEngine class 92 AWT vs. 109 ANSI formats 104 API. 256 autoConnectDatasource method 97 automating reporting tasks xv AWT API 3 B background colors getting for controls 245 setting for contents page 133 setting for controls 252 Bold parameter 253 buffers setting file 135 BufferSize property setDHTMLProperty method 136 setHTMLProperty method 138 setPDFProperty method 140 C caching options 105 changeID method 243 changing active tab 81 control IDs 243 channels xv. Swing usage 5 actionPerformed method 76 active page 133 getting 132 setting as next 134 setting as previous 134 active tab 81 Actuate LRX xvii Actuate product summary xiv Actuate web site xviii addDataSource method 77 addExternalFont method 77 addMruFile method 77 addTable method 209 addTableData method 176 addTableDefinition method 176 Advanced e.Index A ACJDesigner class 70 AWT vs. Swing usage 4 serialized objects listed 12 Author property 248.Reporting Server xvi Advanced e. See application programming interfaces AppDataHandler class 146 AWT vs.

189 connect method AppDataHandler 150 ASCIIDataHandler 169. 244 setting JDBC 189. 200 connectToDatasource method 244 connectToRemoteApp method 176 console messages displaying 84. 97. 215 setting privileges 200. 219 testing for null values in 156. 231 containers embedding preview devices 130 contents page displaying 134 setting backgrounds 133 context factories 179 control IDs 238 changing 243 controls creating 244 getting formulas assigned to 246 getting height and width 245 getting labels for 247 getting visible 250 resizing 249 setting default gap 85 setting dimensions of 252 setting formulas for 253 setting labels for 254 setting visibility of 257 testing for labels 251 counting report pages 132 createControl method 244 createRuntimeParams method 244 creating controls 244 EJB tables 176 CSV reports 118 getting properties for 128 setting properties for 135 current page retrieving 135 D data 146 retrieving 106 setting raw report 141 data context 179 260 e.Repor t Designer API Java Edition . 217 Comments property getting 249 setting 256 communication stubs getting 99 resetting 105 Connect method 188. 211 lowercase characters in 85. 192. 209 OD_DHTML 222. 212.closeZipEntry method 118 closeZipStream method 118 collapseTemplate method 243 colors getting font 246 getting for controls 245 setting background 133 setting for controls 252 column names 146 getting 151. 217 setting relationships to tables 159. 215. 200. 96 ACJOutputProcessor 117 AppDataHandler 149 ASCIIDataHandler 169 EJBDataHandler 174. 106. 159. 170 JDBCHandler 189. 212 getting from templates 245 getting privileges for 213 getting relationships to tables 154. 190 testing connections 178. 201 constructors ACJDesigner 71. 190 MetaDataHandler 209 connecting to data sources 97. 195. 202 columns counting 170 getting assigned privileges 194. 213 getting data types for 192 getting default values 193. 175 JDBCHandler 188 MetaDataHandler 206. 223 OD_HTML 230. 76 ACJEngine 92.

97.data extraction getting selected data source for 78 selecting data sources for 83 specifying ASCII files for 168 specifying JDBC data sources for 189 data fields adding labels 84 setting values for 252 testing for 251 data objects 156 data source interfaces 106 data sources connecting to 97. 200 testing for in templates 250 data types getting 151. 192 getting columns with same 170 getting delimiter strings for 152 getting for meta-information 212 databases xvii. 189. 79. 212 DefaultReadOnlyStub interface 99 DefaultReadWriteStub interface 99 deleting templates 244 delimiters 152 Demo folder xviii deploying reports 137 designer shell 76 Designer tab 70 changed-state notification for 88 enabling 76 destroyTemplate method 244 DHTML reports generating 120 getting properties for 128 setting properties for 136 directory paths getting main documentation 129 setting documentation 137 setting for default images 85 Disconnect method 190 disconnect method ACJEngine 98 AppDataHandler 150 JDBCHandler 191 MetaDataHandler 210 displaying console messages 84. 105 registering 77. 100 getting selected 78 getting tables from 155. 190. 193 returning 79 setting 84. 194. 80. 82 selecting 83 setting catalogs for 219 setting current 106 testing connections 178. 211 getting registered 78. 201 contents pages 134 grids 86 online documentation xx queries 159 toolbars 134 documentation getting paths for 129 online xx setting file names for 87 setting paths for 137 syntax conventions xxiii typographical conventions xxii doesX11GfxExist method 98 Index 261 . 216 implementing for metadata 206 initializing ASCII 169 loading 104. 199. 106. 106 DEBUG variable 96 debugMessage method ACJDesigner 78 ACJEngine 97 JDBCHandler 190 debugMessageLN method ACJDesigner 78 ACJEngine 97 JDBCHandler 190 debugOutputProps method 118 default values 193. 177. 159. 81. 152. 182 getting identifier QUOTE strings 194 datasets 156 dates getting delimiters for 152 debug mode getting current status of 100. 244 disconnecting from JDBC 191 getting 213 getting catalogs for 211 getting names 152.

119 262 e.Report Designer Professional xiv e.Report Designer Java Edition xv. 103 error messages displaying 84.doPreviewReset field 75 duplicate identifiers 238 duplicate names 146 E e. 201 examples xviii executing queries 154 exportAsMetadata method 210 expressions 100 ExprEvaluator package 100 external fonts 77 extractRelations method 191 F F1 key xx fetchData method AppDataHandler 150 JDBCHandler 191 MetaDataHandler 210 fields. 106. Swing usage 4 serialized objects listed 13 email getting properties for 129 setting properties for 137 transmitting 120 embedding preview devices 130 encoding setting default template 86 encoding types reading templates 104. 105 writing templates 108. xviii e.Reporting Server xv e. 109 End User Desktop xvii engine 92 accessing templates 238 creating reporting 96 getting GUI maintained 79 resetting 102.Report Designer overview xviii e.Reporting Server Progress Edition xvi e.Reporting Server Java Edition xvi e. See data fields.Report Designer xv e.Analysis application xvii e.Reporting Suite xiii product summary xiv EJB data sources creating tables 176 getting name 177 getting property sheets for 177 getting registered 80 setting context factory for 179 testing connections 178 EJBDataHandler class 174 AWT vs.Repor t Designer API Java Edition . serialized fields file buffers 135 file caches 105 FileName property setCSVProperty method 136 setDHTMLProperty method 136 setHTMLProperty method 138 setJOIProperty method 138 setPDFProperty method 140 FilesToAttach property 137 fill color getting 245 setting 252 finalizeEngine method 98 Font dialogs adding external fonts 77 FontExt object 246 fonts creating 108 getting 246 getting colors for 246 setting text 253 formatting strings 253 formulas setting 253 testing for 251 freeing memory 104 functions registering user-defined 100 G generate method OD_DHTML 223 OD_HTML 231 generateCSV method 118.

230 JOI formats 123 PDF formats 123 generating result sets 154 getActiveDataSource method 78 getAlignment method 245 getBounds method 245 getCatalogName method AppDataHandler 151 JDBCHandler 191 MetaDataHandler 211 getClient method 78 getColumnCount method 170 getColumnNames method AppDataHandler 151 JDBCHandler 192 MetaDataHandler 211 getColValue method 99 getCommunicationStub method 99 getConnection method 192 getContextFactory method 177 getCSVProperty method 128 getCurrentPropertiesAsString method 171 getCurrentTableSelection method 192 getDataField method 245 getDataSource method 100 getDatasourceName method 211 getDataSources method 78 getDataType method AppDataHandler 151 JDBCHandler 192 MetaDataHandler 212 getDebugMode method ACJDesigner 79 ACJEngine 100 AppDataHandler 152 JDBCHandler 193 getDefaultValue method JDBCHandler 193 MetaDataHandler 212 getDHTMLDevice method 128 getDHTMLProperty method 128 getDocumentationPath method 129 getDriverName method 193 getEMAILProperty method 129 getEndRecordNumber method AppDataHandler 152 JDBCHandler 193 getEngine method 79 getEvaluater method 100 getFillColor method 245 getFont method 245 getFontColor method 246 getFormat method 246 getFormula method 246 getGrantee method JDBCHandler 194 MetaDataHandler 212 getGrantor method JDBCHandler 194 MetaDataHandler 213 getHTMLProperty method 129 getIdentifierQuote method AppDataHandler 152 JDBCHandler 194 MetaDataHandler 213 getImage method OD_DHTML 226 OD_HTML 234 getImageURL method 246 getImportedSQLQuery method 246 getJOIProperty method 130 Index 263 . 127 generateReport method 98 generateReportPage method OD_DHTML 225 OD_HTML 233 generateTOCPage method OD_DHTML 225 OD_HTML 233 generating reports 98. 222 HTML formats 121.generateDHTML method 120 generateEMAIL method 120 generateHTML method 121. 142 CSV formats 118 DHTML formats 120. 125 generatePDF_Ex method 125. 126 generatePRINTOUT method 126. 103. 124. 122 generateJOI method 123 generateMainFrameSet method OD_DHTML 225 OD_HTML 233 generatePDF method 123.

getLabel method 247 getMruList method 79 getName method AppDataHandler 152 EJBDataHandler 177 JDBCHandler 194 MetaDataHandler 213 getORDERBYClause method 247 getOutputDevice method 100 getOutputFiles method 130 getPageHeight method 247 getPageMargins method 247 getPageWidth method 247 getParameterIds method 248 getParamProperty method 248 getPassword method 195 getPDFProperty method 130 getPreviewDevice method 130 getPRINTERProperty method 131 getPrinterResolution method 131 getPrivileges method 195 MetaDataHandler 213 getProperties method 177 getPropertiesFileName method 171 getPropertySheet method AppDataHandler 153 EJBDataHandler 177 JDBCHandler 195 MetaDataHandler 214 getQuery method AppDataHandler 153 JDBCHandler 195 MetaDataHandler 214 getQueryColumns method AppDataHandler 153 JDBCHandler 196 MetaDataHandler 214 getQueryContents method 248 getQueryResult method AppDataHandler 153 JDBCHandler 196 MetaDataHandler 215 getQueryTables method AppDataHandler 154 JDBCHandler 196 MetaDataHandler 215 getRegdAppDataHandler method 79 getRegdASCIIDataHandler method 80 getRegdEJBHandler method 80 getRegdJDBCHandler method 80 getRegdMetaDataHandler method 80 getRegdXMLDataHandler method 81 getRelations method ACJDesigner 81 AppDataHandler 154 JDBCHandler 197 MetaDataHandler 215 getRemarks method JDBCHandler 197 MetaDataHandler 215 getRemoteAppName method 177 getReportAuthor method 248 getReportComments method 249 getReportTitle method 249 getResizeFixRatio method 107 getResizeToFitContents method 249 getSectionId method 249 getSelectedTables method 197 getSelectiveTableFilter method 197 getSOImplementation method 198 getSourceFileName method 171 getStartRecordNumber method AppDataHandler 154 JDBCHandler 198 getStoredObjects method 198 getTable method AppDataHandler 154 JDBCHandler 198 MetaDataHandler 216 getTableCount method 198 getTableNames method AppDataHandler 155 JDBCHandler 199 MetaDataHandler 216 getTables method 199 getTableType method AppDataHandler 155 MetaDataHandler 216 getTargetOutputDevice method 101 getTemplateManager method 101 getTemplateReader method 101 getTemplateWidth method 249 getTemplateWriter method 102 getTextWrap method 249 264 e.Repor t Designer API Java Edition .

190 setting passwords for 202 setting URLs for 203 setting user names for 203 testing 200 testing for required 201 Index 265 . 108 graphs 250 grids displaying 86 setting defaults for 84 H hasBeenGenerated field 75 hasEmbeddedDatasource method 250 hasMultipleOutputFiles method 131 hasParameters method 250 help xx–xxii usage overview xx help topics xx HorizontalSpacing property setDHTMLProperty method 136 setHTMLProperty method 138 HTML reports generating 121 getting properties for 129 setting properties for 137 I IDataSource interface 206 identifiers duplicating control 238 getting for sections 249 getting parameter 248 getting template 243 images getting URLs for 246 setting default paths 85 setting URLs for 254 testing for URLs 251 installing online documentation xx instantiateZipStream method 132 interfaces ACJDesigner 70 AppDataHandler 146 ASCIIDataHandler 168 EJBDataHandler 174 JDBCHandler 182 OD_DHTML 222 OD_HTML 230 IObjectTable interface 156 IPrinter interface 100. 99 J JDBC connections disconnecting from 191 getting 192 getting default catalog for 191 getting passwords for 195 getting user names for 199 setting 189.getTmplMgr method 102 getUrl method 199 getUsername method 199 getVirtualOutput method 131 getVisible method 250 getWHEREClause method 250 graphics subsystems determining availability of 98. 103 isChart method 250 isConnected method AppDataHandler 155 EJBDataHandler 178 JDBCHandler 200 MetaDataHandler 217 isDataField method 251 isFormula method 251 isGrantable method JDBCHandler 200 MetaDataHandler 217 IsGUIVisible property 140 isImageURL method 251 isLabel method 251 isLine method 251 isNullable method AppDataHandler 156 JDBCHandler 200 MetaDataHandler 217 iStart interface 191 ITALIC parameter 253 itemStateChanged method 81 ITmplReader interface 101 ITmplWriter interface 102 IViewerInterface instances 98.

218 reading and parsing data for 218 testing connections for 218 writing to output stream 220 methods 15 ACJDesigner 71 ACJEngine 93 ACJOutputProcessor 112 AppDataHandler 147 ASCIIDataHandler 168 EJBDataHandler 174 JDBCHandler 183 MetaDataHandler 206 OD_DHTML 222 OD_HTML 230 TemplateManager 238 MRU files getting file names 79 storing 87 updating 77 multi-table registrations 149 266 e. 201 MetaDataHandler class 206 AWT vs. 105 loadTemplate method 81. Swing usage 4 MetaDataSrc type 206 meta-information getting data sources 213 getting data types 212 getting property sheets for 214 getting registered data sources for 80 implementing data sources for 206 loading data for 217. 106. 105 templates 81.Repor t Designer API Java Edition . 104. Swing usage 4 JDBCHandler class 182 JOI reports generating 123 getting properties for 130 setting file names for 138 setting properties for 138 setting source 139 L labels adding to data fields 84 creating for controls 254 getting 247 testing for 251 landscape mode 86 line controls 251 loading data sources 104. 82 LRX (Live Report Extension) xvii M main method 82 makeSelective method 200 manuallyConstructed method 218 Manuals directory xx mapping client keys to template keys 139 margins getting 247 setting 255 MaxContents property 140 MaxItems property 140 MaxPages property 140 measurement units 257 memory caching options for 105 freeing 104 menu bars 70 selecting items 76 setting up 88 messages displaying for queries 159 displaying in console 97 displaying progress or error 84. 82.JDBC data sources 182 extracting tables for 189 fetching result sets from 191 fetching tables from 201 getting default values 193 getting names 194 getting property sheets for 195 getting registered 80 getting tables from 199 getting URLs for 199 testing for null values 200 JDBC drivers getting names 193 setting 202 JDBCDataHandler class AWT vs.

146 getting stored 198 OD_DHTML class 222 OD_HTML class 230 offline reporting 206 online documentation xx syntax conventions xxiii typographical conventions xxii online help xx–xxii usage overview xx online reports xiii open server xvi. 200. 217 O Object class 238 objects 7.N naming conventions 146 newSystem method 102 newTemplate method 103 Notes property 137 null values 156. 255 page margins getting 247 setting 255 paintComponent method 82 parameter entry dialogs 132 displaying 132 parameter IDs getting 248 getting properties for 248 setting properties for 255 parameterized reports 98 generating 142 testing input entry for 132 parameters setting values for 256 testing for in templates 250 passTableData method 156 passwords getting 195 setting 202 paths getting main documentation 129 setting documentation 137 setting for default images 85 .PDF files xx Index 267 . xvii operators 159 orientation 86 output devices getting resize-to-fit option 107 getting target 101 proportionally incrementing 107 setting resize-to-fit option 107 specifying target 107 output files getting 130 getting number of 131 Output Processor getting 78 getting CSV properties for 128 getting DHTML properties for 128 getting email properties for 129 getting HTML properties for 129 getting JOI properties for 130 getting PDF properties for 130 getting preview device for 130 implementing 112 mapping client to template 139 setting CSV properties for 135 setting DHTML properties for 136 setting file buffer for 135 setting HTML properties for 137 setting JOI properties for 138 setting PDF properties for 140 setting raw report data for 141 OutputStream property setCSVProperty method 136 setDHTMLProperty method 136 setHTMLProperty method 138 setPDFProperty method 140 overrideResolution method 103 P packages 2 page counts 132 page dimensions getting 247 setting 254.

192 print method 103 print modes 86 printed documentation syntax conventions xxiii typographical conventions xxii PrinterJob property 140 printers getting current resolution for 131 getting properties for 131 setting properties for 140 setting resolution for 141 printing reports 103. 126 getting email properties for 129 printingDone method 104 privileges getting 213 getting grantee for 194.PDF reports generating 123 getting properties for 130 setting properties for 140 PLAIN parameter 253 portrait mode 86 PreserveColors property setDHTMLProperty method 136 setHTMLProperty method 138 PreserveFonts property setDHTMLProperty method 136 setHTMLProperty method 138 PreservePageBreaks property setDHTMLProperty method 136 setHTMLProperty method 138 PreservePrinterJob property 140 preview devices 130 Preview tab 70 enabling 76 preview windows counting available pages for 132 displaying TOCs in 134 displaying toolbars in 134 getting active page 132 getting zoom values for 133 removing toolbars 133 setting active page 133 setting next page for 134 setting previous page 134 setting zoom values for 134 primitive data types getting 151. 201 promptParams method 132 properties getting CSV 128 getting DHTML 128 getting email 129 getting HTML 129 getting JOI 130 getting parameter ID 248 getting PDF 130 getting printer 131 setting CSV 135 setting DHTML 136 setting email 137 setting HTML 137 setting JOI 138 setting parameter ID 255 setting PDF 140 setting printer 140 property sheets getting 177. 195 getting for meta-information 214 prv_getActivePage method 132 prv_getPageCount method 132 prv_getZoom method 133 prv_removeToolbarItem method 133 prv_setActivePage method 133 prv_setBackgroundTOC method 133 prv_setNextPage method 134 prv_setPrevPage method 134 prv_setZoom method 134 prv_showTOC method 134 prv_showToolbar method 134 268 e. 213 getting specific 195 testing column availability for 200.Repor t Designer API Java Edition . 215. 106. 212 getting grantor for 194. 217 processMsg method 178 processRemoteMsg method 178 product summary xiv product update information xviii programming interfaces xiv progress messages displaying 84.

105 Recipients property 137 record numbers getting end 152 getting first 154 refreshReport method 135 registerDataSet method 156 registerDataSources method 82 registering data sources 77. 103 resize-to-fit setting 107 resizing controls 249 Index 269 .prv_updateToolbar method 134 putNewZipEntry method 135 Q queries 146 displaying 159 enabling operators for 159 executing 154 getting contents of 248. xvi reporting engine 92 accessing templates 238 creating 96 getting GUI maintained 79 resetting 102. 142 generating CSV 118 generating DHTML 120 generating HTML 121 generating JOI 123 generating PDF 123 getting author of 248 getting email properties for 129 getting page dimensions 247 getting page margins 247 getting section ID for 249 getting title of 249 previewing 130 printing 103. 250 getting imported SQL 246 getting ORDER BY clause 247 getting SQL types 151 registering 201 setting ORDER BY clause for 254 setting predesigned SQL 254 setting WHERE clause for 258 updating 83 QuoteCharacter property 136 R raw report data 141 readObject method 218 readTemplate method 104. 158. 82 queries 201 tables 149. 171 user-defined functions 100 registerObjectAsTable method 157 registerObjectsWithEngine method 171 registerQuery method AppDataHandler 157 JDBCHandler 201 MetaDataHandler 218 RegisterTable method 157. 126 refreshing 135 retrieving pages for 135 setting author of 256 setting page dimensions 254. 218 resetStub method 105 resetting communication stubs 105 printer resolution 141 reporting engine 102. 158 registerUserDefTable method 158 relational databases 182 relative paths 85 release notes xviii removing toolbars 133 report examples xviii report server API xv ReportCast channels xv. 178. 103. 201. 157. 103 reporting solutions xiii reports xiii deploying 137 generating 98. 255 setting page margins 255 setting raw data output for 141 setting titles for 256 ReportTypes property 137 Requester API xiv requiresConnection method 158.

71. 187 TemplateManager 238. 108 search extension API xiv searches (help topics) xxi section IDs 249 selecting data sources 83 SenderEmail property 137 sending email 120 serialized fields ACJDesigner 8.Repor t Designer API Java Edition .resolution getting print 131 setting printer 141 updating screen 103. xvi. 108 result sets 159. 219 fetching from JDBC data sources 191 generating 154 retrieveTables method 201 retrieving data 106 running queries 154 S sample application xvii sample reports xviii saveTemplate method 82 saving templates 82. xvii setActiveDataSource method 83 setAlignment method 252 setAutoQuery method 83 setBounds method 252 setBufferSize method 135 setCacheOption method 105 setCatalogName method 219 setCommunicationStub method 106 setContextFactory method 179 setCSVProperty method 135 setDataField method 252 setDataSource method 106 setDatasourceName method 219 setDebugMode method ACJDesigner 84 ACJEngine 106 AppDataHandler 159 JDBCHandler 201 setDefaultAttachLabel method 84 setDefaultExitMode method 84 setDefaultGridSnap method 84 setDefaultHorzGap method 85 setDefaultImageRelativePath method 85 setDefaultLookAndFeel method 85 setDefaultLowercaseQuotes method 85 setDefaultNewTemplate method 86 setDefaultPrependSchema method 86 setDefaultPrintMode method 86 setDefaultShowGrid method 86 setDefaultTemplateEncoding method 86 setDHTMLProperty method 136 setDocsPath method 87 setDocumentationPath method 137 setDriver method 202 setEMAILProperty method 137 setExtraOperators method 159 setFillColor method 252 setFont method 253 setFontColor method 253 setFormat method 253 setFormula method 253 setGenerateOnDemand method OD_DHTML 226 OD_HTML 235 setHasBeenGenerated method 87 setHTMLProperty method 137 setIdentifierQuote method 219 setImageURL method 254 setImportedSQLQuery method 254 setJOIFileSource method 138 setJOIProperty method 138 setJOISource method 139 setJOIURLSource method 139 setLabel method 254 setLowercaseQuotes method 202 setMruList method 87 setORDERBYClause method 254 270 e. 87 schemas prepending to tables 202 setting default behavior for 86 screen resolution 103. 75 ACJEngine 92 AppDataHandler 11 ASCIIDataHandler 12 EJBDataHandler 13 JDBCHandler 182. 243 serialized objects 7 servers xv.

202 prepending schema names to 202 prepending schemas to 86 registering 149. 171 Index 271 . 216 getting registered data sources 155 getting relationships to columns 154. 157. 211 getting first record in 154 getting last record number for 152 getting names 199. 142 setReportTitle method 256 setResizeFixRatio method 107 setResultSetRange method AppDataHandler 159 JDBCHandler 203 MetaDataHandler 219 setSelectiveProperties method 203 setTableDefinition method AppDataHandler 160 EJBDataHandler 179 setTargetOutputDevice method 107 setTemplateFile method 87 setTemplateReader method 107 setTemplateWriter method 108 setTextWrap method 257 setUnitType method 257 setUrl method 203 setUsername method 203 setVisible method 257 setWallpaper method 257 setWHEREClause method 258 setX11GfxAvailibility method 108 setZoneHeight method 258 showMem field 75 showMenu method 88 SilentPrint property 140 SMTPServer property 137 Snap to Grid setting 84 Software Development Kit xiv sorting 247. 192. 215 lowercase characters in names 85. 254 sortVector method 160 SQL types 151 stateChanged method 88 stateless variables 104 stored objects 198 string formatting 253 structured output 130 stubs getting communication 99 resetting communication 105 Subject property 137 supportsStoredObjects method 203 Swing API 3 syncTmplMgr method 88 syntax conventions (documentation) xxiii T table names 146 Table of Contents displaying 134 setting backgrounds 133 TableOfContents property setDHTMLProperty method 136 setHTMLProperty method 138 setPDFProperty method 140 tables adding to metadata layers 209 creating EJB 176 duplicate column names in 146 extracting for JDBC data sources 189 fetching JDBC 201 getting column names 151. 158.setOutputDevice method 107 setOutputProperty method 139 setPageHeight method 254 setPageMargins method 255 setPageWidth method 255 setParamProperty method 255 setParamValue method 256 setPassword method 202 setPDFProperty method 140 setPrependSchema method 202 setPRINTERProperty method 140 setPrinterResolution method 141 setProperties method EJBDataHandler 179 JDBCHandler 202 setPropertiesFileName method 171 setQueryDisplay method 159 setRelations method AppDataHandler 159 MetaDataHandler 219 setReportAuthor method 256 setReportComments method 256 setReportData method 141.

Swing usage 4 templates accessing 238 connecting to data sources in 244 deleting 244 generating output from 112 getting columns 245 getting dimensions of 249 getting identifiers for 243 loading 81. 109 testing for embedded data sources 250 testing for parameters 250 temporary files 105 text alignment getting 245 setting 252 text wrapping 249. 82. 103 updating 104 Template Reader 101 Template Writer 102 TemplateManager class 238 AWT vs. 192 getting columns with same 170 getting delimiter strings for 152 getting for meta-information 212 typestyles 253 typographical conventions xxii syntax xxiii U updateDesigner method 88 updateOutputProperties method 88 updateRelations method 89 updateResolution method 108 updating queries 83 updating screen resolution 103. 257 thin viewer 99 third-party analysis tools xiv Title property getting 249 setting 256 TmplMgr variable 102 toolbars displaying 134 removing 133 updating 134 types getting 151. 87 setting default encoding for 86 storing structures 108. 200. 219 specirying domain of 204 testing for null values in 156. 217 testing for spaces in names 152 tabs 70 changed-state notification for 88 changing 81 displaying 76 Template Designer 70 constructing 76 exiting 84 quitting 89 selecting active tab 81 selecting menu items 76 updating 88 Template Manager 238 getting instances of 101. 105 mapping to client keys 139 overriding resolution parameter in 103 processing complex expressions in 100 saving 82.Repor t Designer API Java Edition .tables (continued) removing from metadata layers 209 setting relationships to columns 159. 102 instantiating 105 resetting 102. 108 URLs getting image 246 getting JDBC data source 199 setting as JOI source 139 setting for images 254 setting for JDBC connections 203 testing for image 251 user names getting 199 setting 203 user-defined functions registering 100 useTables method 204 V variables 15 clearing stateless 104 Viewer xvii 272 e. 104.

257 writefile method 142 writeObject method 220 writeTemplate method 108. 143 Index 273 .viewing online documentation xx Virtual Output objects 131 VisibleComponent property setDHTMLProperty method 136 setHTMLProperty method 138 setPDFProperty method 140 setPRINTERProperty method 140 X X11 Gfx subsystems determining availability of 98. 109 writeZip method 142. 108 XML data sources getting registered 81 Z ZipCompressed property setDHTMLProperty method 136 setHTMLProperty method 138 setPDFProperty method 140 zone height 258 zoom values getting 133 setting 134 W wallpaper 257 web browsers xvii web site (Actuate) xviii windowActivated method 89 windowClosed method 89 windowClosing method 89 windowDeactivated method 90 windowDeiconified method 90 windowIconified method 90 windowOpened method 90 wrapping text 249.

Repor t Designer API Java Edition .274 e.

Sign up to vote on this title
UsefulNot useful