Anda di halaman 1dari 300

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
About e.Reports Designer API Java Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
About Actuate e.Report Designer product . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
Online documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xx
Using online manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xx
Online help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xx
Using the Actuate online help system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xx
Typographical conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii
Syntax conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Class com.actuate.ereport. datasrcmgrs.appdatasrc. AppDataHandler . . . . . . . . . . . . . . 11
Class com.actuate.ereport. datasrcmgrs.asciidatasrc. ASCIIDataHandler . . . . . . . . . . . . .12
Class com.actuate.ereport. datasrcmgrs.ejbdatasrc. EJBDataHandler . . . . . . . . . . . . . . .13

Chapter 3
Class summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Package
com.actuate.ereport.
designer.ACJDesigner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
ACJDesigner constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
ACJDesigner.actionPerformed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
ACJDesigner.addDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77
ACJDesigner.addExternalFont . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77
ACJDesigner.addMruFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77
ACJDesigner.debugMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
ACJDesigner.debugMessageLN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
ACJDesigner.getActiveDataSource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
ACJDesigner.getClient. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78

i
ACJDesigner.getDataSources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
ACJDesigner.getDebugMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
ACJDesigner.getEngine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
ACJDesigner.getMruList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
ACJDesigner.getRegdAppDataHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
ACJDesigner.getRegdASCIIDataHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
ACJDesigner.getRegdEJBHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
ACJDesigner.getRegdJDBCHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
ACJDesigner.getRegdMetaDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
ACJDesigner.getRegdXMLDataHandler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
ACJDesigner.getRelations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
ACJDesigner.itemStateChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
ACJDesigner.loadTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
ACJDesigner.loadTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ACJDesigner.main . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ACJDesigner.paintComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ACJDesigner.registerDataSources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ACJDesigner.saveTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ACJDesigner.setActiveDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
ACJDesigner.setAutoQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
ACJDesigner.setDebugMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ACJDesigner.setDefaultAttachLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ACJDesigner.setDefaultExitMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ACJDesigner.setDefaultGridSnap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ACJDesigner.setDefaultHorzGap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
ACJDesigner.setDefaultImageRelativePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
ACJDesigner.setDefaultLookAndFeel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
ACJDesigner.setDefaultLowercaseQuotes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
ACJDesigner.setDefaultNewTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ACJDesigner.setDefaultPrependSchema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ACJDesigner.setDefaultPrintMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ACJDesigner.setdefaultshowgrid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ACJDesigner.setDefaultTemplateEncoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ACJDesigner.setDocsPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
ACJDesigner.setHasBeenGenerated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
ACJDesigner.setMruList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
ACJDesigner.setTemplateFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
ACJDesigner.showMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
ACJDesigner.stateChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
ACJDesigner.syncTmplMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
ACJDesigner.updateDesigner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
ACJDesigner.updateOutputProperties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
ACJDesigner.updateRelations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
ACJDesigner.windowActivated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

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

iii
ACJEngine.setTargetOutputDevice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
ACJEngine.setTemplateReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
ACJEngine.setTemplateWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
ACJEngine.setX11GfxAvailibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
ACJEngine.updateResolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
ACJEngine.writeTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
ACJEngine.writeTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
ACJEngine.writeTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Package
com.actuate.ereport.output.ACJOutputProcessor . . . . . . . . . . . 111
ACJOutputProcessor constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
ACJOutputProcessor.closeZipEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
ACJOutputProcessor.closeZipStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
ACJOutputProcessor.debugOutputProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
ACJOutputProcessor.generateCSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
ACJOutputProcessor.generateCSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
ACJOutputProcessor.generateCSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
ACJOutputProcessor.generateDHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
ACJOutputProcessor.generateDHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
ACJOutputProcessor.generateEMAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
ACJOutputProcessor.generateHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
ACJOutputProcessor.generateHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
ACJOutputProcessor.generateHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
ACJOutputProcessor.generateHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
ACJOutputProcessor.generateJOI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
ACJOutputProcessor.generateJOI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
ACJOutputProcessor.generatePDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
ACJOutputProcessor.generatePDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
ACJOutputProcessor.generatePDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
ACJOutputProcessor.generatePDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
ACJOutputProcessor.generatePDF_Ex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
ACJOutputProcessor.generatePDF_Ex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
ACJOutputProcessor.generatePRINTOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
ACJOutputProcessor.generatePRINTOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ACJOutputProcessor.generatePRINTOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ACJOutputProcessor.getCSVProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
ACJOutputProcessor.getDHTMLDevice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
ACJOutputProcessor.getDHTMLProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
ACJOutputProcessor.getDocumentationPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ACJOutputProcessor.getEMAILProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ACJOutputProcessor.getHTMLProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ACJOutputProcessor.getJOIProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
ACJOutputProcessor.getOutputFiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

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

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

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

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

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

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

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

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

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

xii
Introduction

About Actuate e.Reporting Suite 5


Actuate is the leading provider of information delivery solutions for
e.Business. e.Business customers use Actuate® e.Reporting Suite 5 to develop
and deploy high resolution structured content to hundreds of thousands of
users. 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.
Actuate’s customer list includes commercial banks, securities, financial
services, insurance, high tech, telecom, .com, internet, global 2000, and federal
government. OEMs, system integrators, and others building e.Business sites
for information delivery face challenges. Actuate e.Reporting Suite 5 offers the
following solutions.

Challenge Actuate solution


Delivering high resolution DHTML provides a fast, no-
information download option
Viewing structured content Supporting standard browsers
means there is no need to support
installations of plug-ins for hundreds
of thousands of users
Compromising information display Provides template-based design and
because of lack of integrated tools display
Exploding use of web-based content Ability to support a million hits per
delivery day per CPU
Delivering personalized secure Open security directory integration
information and page security

Introduction xiii
Challenge Actuate solution
Reusing existing integrated content Open server provides access to
content from other applications
Maintaining data integrity on hard PDF provides high-resolution
copy printed copy
Transferring information into other XML output provides access to data
applications across applications

Actuate tools and reports do the following:


■ 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 Use


Actuate e.Report Designer An object-oriented application used by
Professional 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 SDK (Software Actuate ActiveX Controls embed Actuate
Development Kit) included reporting functionality into custom
as part of Actuate e.Report applications.
Designer Professional 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.

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.
Actuate e.Report Designer A report development application used by
Java™ Edition 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.
Actuate e.Reporting Server 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.

Introduction xv
Product name Use
Actuate e.Reporting Server A server application that generates Live
Java™ Edition 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.
Actuate e.Reporting Server A server application designed to work
Progress Edition 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.
Actuate Advanced An application that adds two capabilities to
e.Reporting Server the basic e.Reporting Server, open server
and page security.
■ Open server supports the use of third-
party report generators with the Actuate
e.Reporting Server.
■ Page security supports personalized
viewing of parts of reports for various
users

xvi e.Repor t Designer API Java Edition


Product name Use
Actuate Advanced An application designed to work
e.Reporting Server Progress exclusively with Progress databases that
Edition adds two capabilities to the basic
e.Reporting Server, open server and page
security.
■ Open server supports the use of third-
party report generators with the Actuate
e.Reporting Server.
■ Page security supports personalized
viewing of parts of reports for various
users
Actuate e.Analysis 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.
Actuate End User Desktop 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.
Actuate Viewer Application for end users to find, view, and
print report documents. The ReportQuery™
capabilities are also part of the Actuate
Viewer.
Actuate Live Report Application for end users that works with
Extension (LRX) both Microsoft Internet Explorer and
Netscape Navigator to support report
viewing and printing on the Web.

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 See the following


Installation and upgrading Installation and upgrading guide
Configuring an EJB sample Configuring the EJB Sample
application with Sun J2EE Application with Sun J2EE 1.2.1
Configuring an EJB sample Configuring and running the EJB
application with Silverstream Sample Application with
Silverstream 3.7
Late-breaking information about the Release notes
software and documentation
Overview of Actuate reporting
concepts
How to build your first report Designing
e.Reports
How to design reports using the Java Edition
graphical user interface
Basic data source connection

Using the APIs


Overview of classes
Programming
Database reporting
e.Reports
Server solutions Java Edition

Using the Swing and AWT APIs

e.Report
Designer API
Java Edition

Introduction xix
For information about See the following
Terminology map
Glossary
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. For products without a Windows interface, such as the various
versions of Actuate e.Reporting Server, Actuate e.Report Designer Java
Edition, Actuate ReportCast, and Actuate e.Analysis, we provide HTML help
files. The HTML files install automatically with the product. These files can be
viewed with standard browsers.

Using online manuals


The online manuals install automatically with the product. On the product
CD, you can also find those files in the Manuals directory. Open the
introductory .PDF file to get an overview of the manuals. The items in the
table of contents and the page numbers in the index both contain links to the
appropriate topics in the text. In the index, you access the link by positioning
your cursor over the page number, not the topic.

Online help
Actuate products provide both context-sensitive online help about the product
and report-specific online help about the report you are viewing. Actuate
e.Reporting Suite makes it possible for developers to create customized report-
specific online help.

Using the Actuate online help system


Use two windows to access and view information in the e.Reporting Suite help
system. The window on the left displays the table of contents or the index of
the online help system. The window on the right displays the contents of the
online help topics.

xx e.Repor t Designer API Java Edition


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 these tabs to
switch views among the Table of Contents, Index, and Search. The Table of
Contents provides an overview of the help file contents. For example, in the
preceding window, you see the introduction to the documentation for the
e.Reporting Server product. The Search tab accesses any word in the help files.
The following two illustrations show an example of the Index and the result of
an Index search.The following illustration shows the result of the search as it
appears in the window on the right.
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. The topic displays in the
window on the right.

Introduction xxi
Use the Search tab to find all instances of a keyword in the help files. The
following illustration shows the results of a search for the keyword, templates.
The topics containing the keyword appear under Search. Double-click a topic
in the Search list to display the topic in the right window.

Typographical conventions
The following table describes the typographical conventions used in this
guide.

Item Convention Example


Code examples Sans serif Dim As String
File names Initial letter capitalized. Detail.roi
Except e. Report
Designer Java Edition,
where file names are
case sensitive

xxii e.Repor t Designer API Java Edition


Item Convention Example
Key combination A + sign between the Ctrl+Shift
keys means to press both
keys at the same time
Menu items Capitalized. No bold. File
Submenu items Separated from main File➛New
menu item with small
arrow
User input or user Sans serif M*16*
response

Syntax conventions
The following table describes the symbols used to present the syntax.

Symbol Description Example


[] Optional item [Alias<alias name>]
<> Argument you must <expression to format>
supply
{} Groups two or more {While | Until}
mutually exclusive
options or arguments
| Separates mutually Exit {Do | For |
exclusive options or Function | Sub}
arguments in a group

Introduction xxiii
xxiv e.Repor t Designer API Java Edition
Chapter

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

Chapter 1, Class hierarchy 1


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

2 e.R epor t D esigner API Java Edition


Interface Hierarchy
The following overview summarizes the public interfaces:
interface com.actuate.ereport.datasrcmgrs.appdatasrc.IObjectTable
interface com.actuate.ereport.datasrcmgrs.appdatasrc.Iterator

Differences between the AWT and SWING API


The following are the differences between e.Report Designer Java Edition API
for Swing and for AWT:
■ The e.Report Designer Java Edition API for Swing works with JDK 1.2 and
higher. e.Report Designer Java Edition API for Swing does not work with
JDK 1.1.x.
■ The e.Report Designer Java Edition API for AWT works with Java 1.1.6 and
higher.
■ The e.Report Designer Java Edition API for Swing supports the EJB data
source, the e.Report Designer Java Edition API for AWT does not.
■ The e.Report Designer Java Edition API for Swing is based on the Swing
user interface libraries.
■ The e.Report Designer Java Edition API for AWT is based on the AWT user
interface libraries.
■ The e.Report Designer Java Edition API for Swing requires a minimum of
64 MB of RAM to run. Memory requirements increase as the size of your
data and report increases.
■ The e.Report Designer Java Edition API for AWT requires a minimum of 32
MB. Memory requirements increase as the size of your data and report
increases.
The following describes the differences between e.Report Designer Java
Edition API for Swing and AWT.

AppDataHandler
In the SWING API, passTableData and registerDataSet take the second
argument as a Collection.
In the AWT API, passTableData and registerDataSet take the second argument
as a Vector.
In Java 2, a Vector extends Collection.

Chapter 1, Class hierarchy 3


ASCIIDataHandler
The AWT and SWING API are the same.

JDBCDataHandler
The AWT and SWING API are the same.

MetaDataHandler
The AWT and SWING API are the same.

EJBDataHandler
The class is present only in the SWING API.

ACJDesigner
In the SWING API, one of the constructors takes the first argument as a
javax.swing.JFrame.
In the AWT API, one of the constructors takes the first argument as a
java.awt.Frame.
In the SWING API, there is an additional method getRegdEJBDataHandler().
In the SWING API, there is an additional method setDefaultLookAndFeel.

ACJEngine
The AWT and SWING API are the same.

TemplateManager
In the SWING API, there is only one method called setPageMargins().
In the AWT API, there are two methods called setPageMargins(). The second
method in AWT takes 4 double arguments, the left, right, top and bottom
margins of the page.

4 e.R epor t D esigner API Java Edition


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

Chapter 1, Class hierarchy 5


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

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

Chapter 2, Serialized objects 7


Class com.actuate.ereport. designer.ACJDesigner
Class ACJDesigner implements Serializable.

Serialized fields
activeIDS
com.actuate.ereport.engine.IDataSource activeIDS
tp
javax.swing.JTabbedPane tp
erwD
com.actuate.ereport.designer.GuiTemplate erwD
erw
ACJEngine erw
vDSM
java.util.Vector vDSM
showMem
boolean showMem
rels
com.actuate.ereport.designer.relationships.Relations rels
prv
com.actuate.ereport.output.OD_Preview prv
bAutoWhere
boolean bAutoWhere
bAutoOrder
boolean bAutoOrder
bPrependSchema
boolean bPrependSchema
bLowercaseQuotes
boolean bLowercaseQuotes

8 e.R epor t D esigner API Java Edition


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

Chapter 2, Serialized objects 9


st
com.actuate.ereport.designer.SplashScreenThread st
fr
java.awt.Frame fr
c
int c
hasBeenGenerated
boolean hasBeenGenerated
Indicates that the On switching to preview the report has to be refreshed.
cWait
java.awt.Cursor cWait
cDefault
java.awt.Cursor cDefault

10 e.Repor t Designer API Java Edition


Class com.actuate.ereport.
datasrcmgrs.appdatasrc. AppDataHandler
Class AppDataHandler implements Serializable.

Serialized fields
vR
java.util.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.

Chapter 2, Serialized objects 11


Class com.actuate.ereport.
datasrcmgrs.asciidatasrc. ASCIIDataHandler
Class ASCIIDataHandler implements Serializable.

Serialized fields
tableRecords
java.util.Vector tableRecords
fileName
java.lang.String fileName
propertiesFileName
java.lang.String propertiesFileName
tableName
java.lang.String tableName
pp
com.actuate.ereport.datasrcmgrs.asciidatasrc.PropertyFileParser pp
vPropertiesOfAllTables
java.util.Vector vPropertiesOfAllTables
fp
com.actuate.ereport.datasrcmgrs.asciidatasrc.FileParser fp

12 e.Repor t Designer API Java Edition


Class com.actuate.ereport. datasrcmgrs.ejbdatasrc.
EJBDataHandler
Class EJBDataHandler implements Serializable.

Serialized fields
htColAccessors
java.util.Hashtable htColAccessors
htIC
java.util.Hashtable htIC
sRemoteAppJNDIName
java.lang.String sRemoteAppJNDIName
sContextFactory
java.lang.String sContextFactory
iRemoteApp
com.actuate.ereport.datasrcmgrs.ejbdatasrc.EJBAppRI iRemoteApp

Chapter 2, Serialized objects 13


14 e.Repor t Designer API Java Edition
Chapter

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

Chapter 3, Class summary 15


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

16 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 17


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

18 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 19


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

20 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 21


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

22 e.Repor t Designer API Java Edition


doesX11GfxExist()
Static method in class com.actuate.ereport.engine.ACJEngine
Returns the availability of the X11 Gfx subsystem when performing internal
validations.
doPreviewReset
Variable in class com.actuate.ereport.designer.ACJDesigner
driver
Variable in class com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCHandler
DriverName
Variable in class com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCHandler
EJBDataHandler
class com.actuate.ereport.datasrcmgrs.ejbdatasrc.EJBDataHandler
EJBDataHandler()
Constructor for class
com.actuate.ereport.datasrcmgrs.ejbdatasrc.EJBDataHandler
EJBDataHandler(String)
Constructor for class
com.actuate.ereport.datasrcmgrs.ejbdatasrc.EJBDataHandler
exportAsMetadata(Component, IDataSource, OutputStream, Vector)
Static method in class
com.actuate.ereport.datasrcmgrs.metadatasrc.MetaDataHandler
extractRelations(Component, DatabaseMetaData, Vector)
Method in class com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCHandler
fetchData(String, String, int, int)
Method in class
com.actuate.ereport.datasrcmgrs.appdatasrc.AppDataHandler
Not used. Returns Null.
fetchData(String, String, int, int)
Method in class com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCHandler
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.

Chapter 3, Class summary 23


fetchData(String, String, int, int)
Method in class
com.actuate.ereport.datasrcmgrs.metadatasrc.MetaDataHandler
This function is reserved for future versions of ACJEngine.
finalizeEngine()
Method in class com.actuate.ereport.engine.ACJEngine
generate(VirtualOutput, ProgressInterface, Properties)
Method in class com.actuate.ereport.output.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.
generate(VirtualOutput, ProgressInterface, Properties)
Method in class com.actuate.ereport.output.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.
generateCSV()
Method in class com.actuate.ereport.output.ACJOutputProcessor
Generates a CSV report using the properties individually set by the
setCSVProperty() method.
generateCSV(Object, Component, String)
Method in class com.actuate.ereport.output.ACJOutputProcessor
Deprecated. Use setCSVProperty() / generateCSV() instead.
generateCSV(Object, Component, String, String)
Method in class com.actuate.ereport.output.ACJOutputProcessor
Deprecated. Use setCSVProperty() / generateCSV() instead.
generateDHTML()
Method in class com.actuate.ereport.output.ACJOutputProcessor
Generates a DHTML report using the properties individually set by the
setDHTMLProperty() method.

24 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 25


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

26 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 27


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

28 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 29


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

30 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 31


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

32 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 33


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

34 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 35


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

36 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 37


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

38 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 39


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

40 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 41


getTables()
Method in class com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCHandler
A macro for fetching all tables from the active JDBC source.
getTableType(String)
Method in class
com.actuate.ereport.datasrcmgrs.appdatasrc.AppDataHandler
Not used. Returns Java Class.
getTableType(String)
Method in class
com.actuate.ereport.datasrcmgrs.metadatasrc.MetaDataHandler
getTargetOutputDevice()
Method in class com.actuate.ereport.engine.ACJEngine
getTemplateManager()
Method in class com.actuate.ereport.engine.ACJEngine
TemplateManager is the main class that lets the user manipulate most aspects
of the template.
getTemplateReader()
Method in class com.actuate.ereport.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.
getTemplateWidth()
Method in class com.actuate.ereport.engine.TemplateManager
Returns the width of the template in inches.
getTemplateWriter()
Method in class com.actuate.ereport.engine.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.
getTextWrap(Object)
Method in class com.actuate.ereport.engine.TemplateManager
Returns True if the Wrap Text property of the specified control is set; False
otherwise.

42 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 43


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

44 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 45


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

46 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 47


This is an empty constructor that is used for instantiating OD_DHTML using
Class.newInstance()
OD_HTML
class com.actuate.ereport.output.OD_HTML
This class is used for generating the output of the report in HTML format.
OD_HTML()
Constructor for class com.actuate.ereport.output.OD_HTML
This is an empty constructor that is used for instantiating OD_HTML using
Class.newInstance()
overrideResolution(int)
Method in class com.actuate.ereport.engine.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.
paintComponent(Graphics)
Method in class com.actuate.ereport.designer.ACJDesigner
passTableData(String, Collection)
Method in class
com.actuate.ereport.datasrcmgrs.appdatasrc.AppDataHandler
Used internally.
password
Variable in class com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCHandler
print()
Method in class com.actuate.ereport.engine.ACJEngine
This method is internally called to generate the entire report.
printingDone()
Method in class com.actuate.ereport.engine.ACJEngine
Notification received when the report generation process is complete.
processMsg(int, Object)
Method in class com.actuate.ereport.datasrcmgrs.ejbdatasrc.EJBDataHandler
processRemoteMsg(int, Object)
Method in class com.actuate.ereport.datasrcmgrs.ejbdatasrc.EJBDataHandler

48 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 49


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

50 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 51


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

52 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 53


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

54 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 55


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

56 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 57


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

58 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 59


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

60 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 61


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

62 e.Repor t Designer API Java Edition


setTargetOutputDevice(int)
Method in class com.actuate.ereport.engine.ACJEngine
setTemplateFile(String)
Method in class com.actuate.ereport.designer.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.
setTemplateReader(ITmplReader)
Method in class com.actuate.ereport.engine.ACJEngine
Specifies a custom implementation of the ITmplReader interface used to read
the contents of a report template from a file or input stream.
setTemplateWriter(ITmplWriter)
Method in class com.actuate.ereport.engine.ACJEngine
Specifies a custom implementation of the ITmplWriter interface used to write
the contents of a report template to a file or output stream.
setTextWrap(Object, boolean)
Method in class com.actuate.ereport.engine.TemplateManager
Sets the Word Wrap property of a specified control if True is passed. Unsets
this property if False is passed.
setUnitType(String)
Method in class com.actuate.ereport.engine.TemplateManager
Sets the measurement units to be used.
setUrl(String)
Method in class com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCHandler
Sets the JDBC URL to the string being passed.
setUsername(String)
Method in class com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCHandler
Sets the username to the string being passed.
setVisible(Object, boolean)
Method in class com.actuate.ereport.engine.TemplateManager
Sets the control's visibility as specified.
setWallpaper(String)
Method in class com.actuate.ereport.engine.TemplateManager

Chapter 3, Class summary 63


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

64 e.Repor t Designer API Java Edition


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

Chapter 3, Class summary 65


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

66 e.Repor t Designer API Java Edition


writeObject(ProgressBox, OutputStream)
Method in class
com.actuate.ereport.datasrcmgrs.metadatasrc.MetaDataHandler
Writes the metadata from the metadata data structure to an ASCII output
stream of the appropriate format.
writeTemplate(OutputStream)
Method in class com.actuate.ereport.engine.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.
writeTemplate(OutputStream, int)
Method in class com.actuate.ereport.engine.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(String, int)
Method in class com.actuate.ereport.engine.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.
writeZip(byte[], ZipOutputStream)
Static method in class com.actuate.ereport.output.ACJOutputProcessor
writeZip(String, ZipOutputStream)
Static method in class com.actuate.ereport.output.ACJOutputProcessor

Chapter 3, Class summary 67


68 e.Repor t Designer API Java Edition
Package

com.actuate.ereport.
Package

designer.ACJDesigner

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 69
Class ACJDesigner
java.lang.Object
|
+--java.awt.Component
|
+--java.awt.Container
|
+--javax.swing.JComponent
|
+--javax.swing.JPanel
|
+--com.actuate.ereport.designer.ACJDesigner
_____________________________________________________________________

All implemented interfaces


javax.accessibility.Accessible, java.awt.event.ActionListener,
javax.swing.event.ChangeListener, java.util.EventListener,
java.awt.image.ImageObserver, java.awt.event.ItemListener,
java.awt.MenuContainer, java.io.Serializable,
java.awt.event.WindowListener
public class ACJDesigner extends javax.swing.JPanel
Implements javax.swing.event.ChangeListener,
java.awt.event.WindowListener, java.awt.event.ItemListener,
java.awt.event.ActionListener.
This class represents the outermost shell of the Template Designer used by
e.Report Designer - Java Edition. It contains a menu bar if executed as an
application, and a tab panel consisting of two tabs, the Designer and the
Preview. This class contains important references to the engine, registered data
sources, and the client output manager ACJOutputProcessor. All designer
related public APIs are accessible through this class.

See also
Serialized objects

70 e.Repor t Designer API Java Edition


Field summary
Method Type
Field summary boolean
hasBeenGenerated boolean
Indicates that the On switching to
Preview the report has to be refreshed.
showMem boolean

Constructor summary
ACJDesigner()
An empty constructor; created for backward compatibility.
public ACJDesigner(javax.swing.JFrame fResizable, ACJEngine erw, boolean
isDesign, boolean isPreview)(javax.swing.JFrame fResizable, ACJEngine
e.Report Designer API Java Edition, boolean isDesign, boolean isPreview)
The default constructor.

Method summary
Method Description
ACJDesigner Notification received when a menu item is
.actionPerformed selected.

ACJDesigner Registers a single data source; note that


.addDataSource this function should be called only after
authentication of login information.
ACJDesigner This installs any additional fonts if
.addExternalFont required in the Font dialog box.

ACJDesigner Updates the list of MRU files in the menu


.addMruFile structure with a filename to be inserted at a
specified index.

ACJDesigner Returns the active selected data source for


.getActiveDataSource() data extraction.

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 71
Method Description
ACJDesigner Returns an instance of
.getActiveDataSource() ACJOutputProcessor used by
ACJDesigner; used internally.
ACJDesigner Returns a vector containing all registered
.getDataSources() data sources.
ACJDesigner Returns the current debug mode.
ACJDesigner.getDebugMode()
ACJDesigner Returns the reference of ACJEngine
.getEngine() maintained by the GUI.
ACJDesigner Returns an array of file names stored in the
.getMruList() MRU list.
ACJDesigner..getRegdAppDat Returns the instance of the registered
aHandler() AppDataHandler data source.
ACJDesigner Returns the instance of the registered
.getRegdASCIIDataHandler() ASCIIDataHandler data source.
ACJDesigner Returns the instance of the registered
.getRegdEJBHandler() EJBHandler data source.
ACJDesigner Returns the instance of the registered
.getRegdJDBCHandler() JDBCHandler data source.
ACJDesigner Returns the instance of the registered
.getRegdMetaDataHandler() MetadataHandler data source.
ACJDesigner Returns the instance of the registered
.getRegdXMLDataHandler() XMLDataHandler data source.
ACJDesigner Returns a vector of Relations strings. Used
.getRelations() internally.
ACJDesigner Notification received when the active tab is
.itemStateChanged changed via the menu option.
ACJDesigner Requests the Designer to load a template
.loadTemplate into the user interface.
ACJDesigner Requests the Designer to load a template
.loadTemplate into the user interface using the specified
encoding 'templateEncoding'.
ACJDesigner
.main

72 e.Repor t Designer API Java Edition


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

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

74 e.Repor t Designer API Java Edition


Method Description
ACJDesigner Forces the Designer to reflect changes
.updateDesigner() made to the template via the API.
ACJDesigner Updates the preview device with default
.updateOutputProperties() output properties.
ACJDesigner Used internally.
.updateRelations()
ACJDesigner
.windowActivated
ACJDesigner
.windowClosed
ACJDesigner Notification received when an attempt is
.windowClosing made to close the parent frame.
ACJDesigner
.windowDeactivated
ACJDesigner
.windowDeiconified
ACJDesigner
.windowIconified
ACJDesigner
.windowOpened

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.

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 75
ACJDesigner constructor

ACJDesigner
public ACJDesigner()
An empty constructor; created for backward compatibility.
public ACJDesigner(javax.swing.JFrame fResizable,
ACJEngine erw,
boolean isDesign,
boolean isPreview)
The default constructor. Constructs the designer shell using a variety of
options which can be embedded within an existing application.
In the AWT API, the constructor takes the first argument as a java.awt.Frame.

fCloseNotification
Handle of the parent frame (can be null).

erw
A reference to an instance of the engine instantiated by an external wrapper.

isDesign
Specifies whether the Designer tab should be displayed.

isPreview
Specifies whether the Preview tab should be displayed.

ACJDesigner.actionPerformed
public void actionPerformed(java.awt.event.ActionEvent ae)
Notification received when a menu item is selected.

Specified by
actionPerformed in interface java.awt.event.ActionListener
Updates the preview device with default output properties. This function is
called internally by GuiTemplate.

76 e.Repor t Designer API Java Edition


ACJDesigner.addDataSource
public void addDataSource(com.actuate.ereport.engine.IDataSource ids)
Registers a single data source. Note that this function should be called only
after authentication of login information.

ids
An implementation of the IDataSource interface.

See also
JDBCHandler, AppDataHandler, MetaDataHandler

ACJDesigner.addExternalFont
public void addExternalFont(java.lang.String s)
Installs any additional fonts if required in the Font dialog box.

s
The name of the external font to be added.

Returns
A reference to the client output device maintained internally.

ACJDesigner.addMruFile
public void addMruFile(int fileNo,
java.lang.String mruFileName)
Updates the list of MRU files in the menu structure with a filename to be
inserted at a specified index. This function is called internally by GuiTemplate.

fileNo
Index in the internal array of MRU filenames.

mruFileName
The filename to be inserted at the specified index.

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 77
ACJDesigner.debugMessage
public static void debugMessage(java.lang.String sMsg)
Used internally.

ACJDesigner.debugMessageLN
public static void debugMessageLN(java.lang.String sMsg)
Used internally.
public static void debugMessageLN()
Used internally.

ACJDesigner.getActiveDataSource
public com.actuate.ereport.engine.IDataSource getActiveDataSource()
Returns the active selected data source for data extraction.

Returns
A reference to the active implementation of IDataSource used by the designer.

ACJDesigner.getClient
public ACJOutputProcessor getClient()
Returns an instance of ACJOutputProcessor used by ACJDesigner; used
internally.

ACJDesigner.getDataSources
public java.util.Vector getDataSources()
Returns a vector containing all registered data sources.

78 e.Repor t Designer API Java Edition


ACJDesigner.getDebugMode
public static boolean getDebugMode()
Returns the current debug mode.

ACJDesigner.getEngine
public ACJEngine getEngine()
Returns the reference of ACJEngine maintained by the GUI.

Returns
A reference to the engine maintained internally by the designer.

ACJDesigner.getMruList
public java.lang.String[] getMruList()
Returns an array of filenames stored in the MRU list. This function is called
internally by GuiTemplate.

Returns
The array of filenames stored in the MRU list.

ACJDesigner.getRegdAppDataHandler
public AppDataHandler getRegdAppDataHandler()
Returns an instance of the registered AppDataHandler data source.
Method is only in the SWING API. It is not in the AWT API.

Returns
A reference to the internally maintained instance of AppDataHandler.

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 79
ACJDesigner.getRegdASCIIDataHandler
public ASCIIDataHandler getRegdASCIIDataHandler()
Returns an instance of the registered ASCIIDataHandler data source.

Returns
A reference to the internally maintained instance of ASCIIDataHandler.

ACJDesigner.getRegdEJBHandler
public com.actuate.ereport.engine.IDataSource getRegdEJBHandler()
Returns an instance of the registered EJBHandler data source.

Returns
A reference to the internally maintained instance of EJBHandler.

ACJDesigner.getRegdJDBCHandler
public JDBCHandler getRegdJDBCHandler()
Returns an instance of the registered JDBCHandler data source.

Returns
A reference to the internally maintained instance of JDBCHandler.

ACJDesigner.getRegdMetaDataHandler
public MetaDataHandler getRegdMetaDataHandler()
Returns an instance of the registered MetadataHandler data source.

80 e.Repor t Designer API Java Edition


Returns
A reference to the internally maintained instance of MetaDataHandler.

ACJDesigner.getRegdXMLDataHandler
public com.actuate.ereport.engine.IDataSource getRegdXMLDataHandler()
Returns an instance of the registered XMLDataHandler data source.

Returns
A reference to the internally maintained instance of JDBCHandler.

ACJDesigner.getRelations
public java.util.Vector getRelations()
Returns a vector of Relations strings used internally.

Returns
A vector of relations stored as strings.

ACJDesigner.itemStateChanged
public void itemStateChanged(java.awt.event.ItemEvent ie)
Notification received when the active tab is changed via the menu option.

Specified by
itemStateChanged in interface java.awt.event.ItemListener.

ACJDesigner.loadTemplate
public void loadTemplate(java.lang.String urlORfile)
Requests the Designer to load a template into the user interface.

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 81
urlORfile
The URL or file location where the template can be found.

ACJDesigner.loadTemplate
public void loadTemplate(java.lang.String urlORfile,
int templateEncoding)
Requests the Designer to load a template into the user interface using the
specified encoding 'templateEncoding'.

urlORfile
The URL or file location where the template can be found.

templateEncoding
A constant; either ACJConstants.ASCII or ACJConstants.UTF8.

ACJDesigner.main
public static void main(java.lang.String[] s)

ACJDesigner.paintComponent
public void paintComponent(java.awt.Graphics g)

ACJDesigner.registerDataSources
public void registerDataSources(java.util.Vector vDSM)
Registers a vector of data sources for selection via the GUI.

ACJDesigner.saveTemplate
public void saveTemplate(java.lang.String urlORfile)
Requests the Designer to save the template to a file.

82 e.Repor t Designer API Java Edition


urlORfile
The URL or file location where the template is to be stored.
public void saveTemplate(java.lang.String urlORfile,
int templateEncoding)
Requests the Designer to save the template to a file using the specified
encoding 'templateEncoding'.

urlORfile
The URL or file location where the template is to be stored.

templateEncoding
A constant; either ACJConstants.ASCII or ACJConstants.UTF8.

ACJDesigner.setActiveDataSource
public void setActiveDataSource(com.actuate.ereport.engine.IDataSource ds)
Selects one of the registered data sources for data extraction.

ids
An implementation of the IDataSource interface.

See also
JDBCHandler, AppDataHandler, MetaDataHandler

ACJDesigner.setAutoQuery
public void setAutoQuery(boolean bAutoWhere,
boolean bAutoOrder)
Specifies whether it is required to automatically update the WHERE and/or
ORDERBY clauses based on template contents.

bAutoWhere
Indicates that the WHERE clause should be automatically updated internally
for joins based on table relations.

bAutoOrder
Indicates that the ORDERBY clause should be automatically updated based on
the grouping criteria.

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 83
ACJDesigner.setDebugMode
public static void setDebugMode(boolean b)
Specifies whether progress or error messages are to be displayed in the console
window.

ACJDesigner.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.

ACJDesigner.setDefaultExitMode
public void setDefaultExitMode(int exitMode)
Sets the default File - Exit action.

exitMode
Any combination of ACJConstants.DISPOSE_WINDOW,
ACJConstants.EXIT_JVM, and ACJConstants.NONE.

ACJDesigner.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.

showGrid
Indicates whether the grid should be displayed.

84 e.Repor t Designer API Java Edition


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.

iSpaceInPixels
Specifies the default pixel width between controls which are arranged
horizontally.

bPrependSchema
A boolean value indicating whether the table name should be prefixed with
the schema.

ACJDesigner.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.

ACJDesigner.setDefaultLookAndFeel
public void setDefaultLookAndFeel(java.lang.String sLookNFeel)
This method is used only in the SWING API. It is not in the AWT API.

ACJDesigner.setDefaultLowercaseQuotes
public void setDefaultLowercaseQuotes(boolean bLowercaseQuotes)
Specifies that if a table or column has lowercase characters embedded in it,
then the Quote Identifier is prepended and appended to it by default.

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 85
bPrependSchema
A boolean value indicating whether the all-lowercase tablename should be
surrounded by quotes.

ACJDesigner.setDefaultNewTemplate
public void setDefaultNewTemplate(boolean isBlankTemplate)
Deprecated. Specifies whether a new template is blank (default = True) or
should be read from a file 'startup.erw'. Otherwise, Actuate e.Report Designer
creates a default startup skeleton template.

ACJDesigner.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, as expected by ORACLE8.

ACJDesigner.setDefaultPrintMode
public void setDefaultPrintMode(boolean bLandscape)
Specifies whether to generate preview or printer output in landscape format
(True) or portrait format (False).

ACJDesigner.setdefaultshowgrid
public void setDefaultShowGrid(boolean showGrid)
Sets the default value to show the grid when designing templates.

ACJDesigner.setDefaultTemplateEncoding
public void setDefaultTemplateEncoding(int templateEncoding)

86 e.Repor t Designer API Java Edition


Sets the default template 'templateEncoding'. Currently supported
templateEncodings are ACJConstants.ASCII and ACJConstants.UTF8.

ACJDesigner.setDocsPath
public void setDocsPath(java.lang.String sDoc)
Specifies the name of the user guide file.

sDoc
The filename of the user guide.

ACJDesigner.setHasBeenGenerated
public void setHasBeenGenerated(boolean hasBeenGenerated)

ACJDesigner.setMruList
public void setMruList(java.lang.String[] ml)
Specifies an array of filenames to be stored in the MRU list. This function is
called internally by GuiTemplate.

mruList
An array of filenames containing templates.

ACJDesigner.setTemplateFile
public void setTemplateFile(java.lang.String urlORfile)
When a template is loaded externally, specifies the filename to be used by the
GUI when the Save Template option is selected from the menu.

urlORfile
The URL or file location where the template can be found.

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 87
ACJDesigner.showMenu
public void showMenu()
Constructs the menu structure used in the menu bar. Used internally by
ACJDesigner.

ACJDesigner.stateChanged
public void stateChanged(javax.swing.event.ChangeEvent e)
Notification received just before the Designer's tab is changed; used internally.

Specified by
stateChanged in interface javax.swing.event.ChangeListener

ACJDesigner.syncTmplMgr
public void syncTmplMgr()
Used internally.

ACJDesigner.updateDesigner
public void updateDesigner()
Forces the Designer to reflect changes made to the template via the API.

ACJDesigner.updateOutputProperties
public void updateOutputProperties()

88 e.Repor t Designer API Java Edition


ACJDesigner.updateRelations
public void updateRelations()
Used internally.

ACJDesigner.windowActivated
public void windowActivated(java.awt.event.WindowEvent ev)

Specified by
windowActivated in interface java.awt.event.WindowListener

ACJDesigner.windowClosed
public void windowClosed(java.awt.event.WindowEvent ev)

Specified by
windowClosed in interface java.awt.event.WindowListener

ACJDesigner.windowClosing
public void windowClosing(java.awt.event.WindowEvent ev)
Notification received when an attempt is made to close the parent frame. This
notification is used to prompt the user to save the existing template before
quitting.

Specified by
windowClosing in interface java.awt.event.WindowListener

Pa c k a g e c o m . a c t u a t e . e r e p o r t . d e s i g n e r. A C J D e s i g n e r 89
ACJDesigner.windowDeactivated
public void windowDeactivated(java.awt.event.WindowEvent ev)

Specified by
windowDeactivated in interface java.awt.event.WindowListener

Specified by
windowOpened in interface java.awt.event.WindowListener

ACJDesigner.windowDeiconified
public void windowDeiconified(java.awt.event.WindowEvent ev)

Specified by
windowDeiconified in interface java.awt.event.WindowListener

ACJDesigner.windowIconified
public void windowIconified(java.awt.event.WindowEvent ev)

Specified by
windowIconified in interface java.awt.event.WindowListener

ACJDesigner.windowOpened
public void windowOpened(java.awt.event.WindowEvent ev)

90 e.Repor t Designer API Java Edition


Package

com.actuate.ereport.
Package

engine.ACJEngine

Pa ck a g e c o m .a c t u a t e. e r e p o r t. e n g i n e. AC J E n i g n e 91
Class ACJEngine
java.lang.Object
|
+--com.actuate.ereport.engine.ACJEngine
_____________________________________________________________________
public class ACJEngine
extends java.lang.Object
This class forms the heart of the reporting engine. Users must instantiate this
class as the first step in using ACJEngine for data reporting. This class contains
references of key objects such as the active data source, from which data is
extracted for generating reports, the Template Manager, which handles the
template skeleton structure, the Expression Evaluator, which is capable of
processing formulae embedded inside the report, and a communication stub,
which provides an interface for buffered raw report data to be fetched by the
output devices.

Field summary
Type Field
boolean DEBUG
A boolean variable used for internal
debugging.

Constructor summary
ACJEngine()
The default constructor creates an instance of the report engine and initializes
it by calling newSystem() internally.

92 e.Repor t Designer API Java Edition


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

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

94 e.Repor t Designer API Java Edition


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

Pa ck a g e c o m .a c t u a t e. e r e p o r t. e n g i n e. AC J E n i g n e 95
Method Description
ACJEngine Specifies a custom implementation of the
.setTemplateWriter ITmplWriter interface used to write the
contents of a report template to a file or
output stream.
ACJEngine Specifies whether the X11 Graphics
.setX11GfxAvailibility subsystem is available so font creation and
other tasks can be safely carried out.
ACJEngine This function is used to update the value of
.updateResolution() the resolution parameter stored in a
template with the value of the current screen
resolution.
ACJEngine This method attempts to write the contents
.writeTemplate of the entire template structure maintained
by the Template Manager to a specified file
using the default ANSI encoding type.
ACJEngine This method attempts to write the contents
.writeTemplate of the entire template structure maintained
by the Template Manager to a specified file
using the specified encoding type.
ACJEngine This method attempts to write the contents
.writeTemplate of the entire template structure maintained
by the Template Manager to a specified file
using the specified encoding type.

Field detail

DEBUG
public boolean DEBUG
A boolean variable used for internal debugging.

ACJDesigner constructor

ACJEngine
public ACJEngine()

96 e.Repor t Designer API Java Edition


The default constructor creates an instance of the report engine and initializes
it by calling newSystem() internally.

See also
ACJEngine.newSystem()

ACJEngine.autoConnectDatasource
public void autoConnectDatasource(boolean bAutoConnect)
If this flag is set to True, a template with an embedded data source attempts to
connect to that data source and update the active data source reference in the
engine.

ACJEngine.debugMessage
public static void debugMessage(java.lang.String sMsg)
This function is used internally for debugging. It is a flagged version of
System.out.print(...). 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.

ACJEngine.debugMessageLN
public static void debugMessageLN(java.lang.String sMsg)
This function is used internally for debugging. It is a flagged version of
System.out.println(...). 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
public static void debugMessageLN()

Pa ck a g e c o m .a c t u a t e. e r e p o r t. e n g i n e. AC J E n i g n e 97
This function is used internally for debugging. It is a flagged version of
System.out.println(...). It allows a debug flag to be used to turn on or off all
console messages.

ACJEngine.disconnect
public void disconnect()
throws java.lang.Exception
This method was called internally by the engine in previous releases of
ACJEngine. It should not be explicitly called from an external class although
the method is defined as public. This method is not used in ACJEngine 3.xx. It
has been provided only for backward compatibility.

ACJEngine.doesX11GfxExist
public static boolean doesX11GfxExist()
Returns the availability of the X11 Gfx subsystem while performing internal
validations.

ACJEngine.finalizeEngine
public void finalizeEngine()
throws java.lang.Throwable

ACJEngine.generateReport
public com.actuate.ereport.common.IViewerInterface generateReport()
throws java.lang.Exception
Generates a report and returns the IViewerInterface instance required by
ACJOutputProcessor. Alternatively, you can call getDATReader(boolean b) or
getCommunicationStub(). These calls do not generate the report immediately,
however. They generate the report only when you request the data from the
report. These calls are useful when working with reports that use parameters.
The following initialization is required before generating a report:

98 e.Repor t Designer API Java Edition


1 The template should be read properly.
2 ACJEngine should have a valid data source and should be connected to it.
3 If the template under consideration has any parameters, the parameter
values should be set properly.

Returns
An implementation of IViewerInterface communication interface

Throws
An exception occurs if the report generation process is abnormally terminated.
Abnormal termination usually occurs because of a fatal error.

ACJEngine.getColValue
public java.lang.Object getColValue(java.lang.Object TableId,
java.lang.Object ColumnName)
throws java.lang.Exception
This function is not used. It is provided for backward compatibility only.
When generating the report, data is returned for a specified column in the
Current Tuple in the result set structure represented by ITable.

ACJEngine.getCommunicationStub
public com.actuate.ereport.common.IViewerInterface
getCommunicationStub()
throws java.lang.Exception
Returns an implementation of the IViewerInterface. For normal report
generation, the default implementation is
com.actuate.ereport.engine.stub.DefaultReadWriteStub. For a thin viewer,
which generates a finished report from a raw report, the default
implementation is com.actuate.ereport.engine.stub.DefaultReadOnlyStub.

Returns
An implementation of the IViewerInterface communication stub.

Pa ck a g e c o m .a c t u a t e. e r e p o r t. e n g i n e. AC J E n i g n e 99
ACJEngine.getData source
public com.actuate.ereport.engine.IDatasource getDataSource()
Returns an instance of the active data source implementation that is currently
registered with ACJEngine. A report template that is used in generating
reports must use fields from this data source only.

Returns
A generic instance of the active data source.

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

ACJEngine.getEvaluater
public com.actuate.ereport.engine.expreval.ExprEvaluator getEvaluater()
Returns the internal reference of ExprEvaluator that is required to register
user-defined functions. The ExprEvaluator package is responsible for
processing complex expressions embedded inside a template.

Returns
An instance of the expression evaluator maintained by ACJEngine.

ACJEngine.getOutputDevice
public com.actuate.ereport.engine.IPrinter getOutputDevice()
This function should not be used. It is provided only for backward
compatibility. This function returns an instance of the actual IPrinter report
generation interface implementation. Typically, this function is used when the
default output generation mechanism is overridden.

100 e.Repor t Designer API Java Edition


Returns
An implementation of the IPrinter interface.

ACJEngine.getTargetOutputDevice
public int getTargetOutputDevice()

ACJEngine.getTemplateManager
public TemplateManager getTemplateManager()
TemplateManager is the main class that lets the user manipulate most aspects
of the template. You must get an instance of the Template Manager using this
method before you can access the template via the public API. Note that this
instance is destroyed whenever a call to the newSystem() or newTemplate()
methods is made. When the instance is destroyed, you must re-query the
engine for the instance of the newly created Template Manager.

Returns
An instance of the Template Manager internally maintained by the engine.

ACJEngine.getTemplateReader
public com.actuate.ereport.engine.ITmplReader getTemplateReader()
This API should not be used. 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.

Returns
An instance of the default ITmplReader implementation.

Packa ge com.actua te.ere po r t.en gin e.AC JEnig ne 101


ACJEngine.getTemplateWriter
public com.actuate.ereport.engine.ITmplWriter getTemplateWriter()
This API should not be used. It is provided for backward compatibility only.
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.

Returns
An instance of the default ITmplWriter implementation.

ACJEngine.getTmplMgr
public com.actuate.ereport.engine.TmplMgr getTmplMgr()
This function returns a reference to the internal Template Manager instance
variable maintained by ACJEngine. It is called internally and must not be
called from an external source. Its return type has been declared public
because it is required from classes in other packages.

Returns
A reference to the internal Template Manager instance variable used for
manipulating the template structure.

ACJEngine.newSystem
public void newSystem()
This function is called when all variables in the engine need to be reset.
Internally, this function removes the active data source, clears dynamic tables,
resets the Expression Evaluator, destroys the contents of the entire template
structure (including report header/footer, page header/footer, and the default
section), and resets the instance of the Template Manager maintained by the
engine.

102 e.Repor t Designer API Java Edition


See also
ACJEngine.newTemplate()

ACJEngine.newTemplate
public void newTemplate()
This function is called when all variables in the engine need to be reset.
Internally, this function clears dynamic tables, resets the Expression Evaluator,
destroys the contents of the entire template structure (including report
header/footer, page header/footer, and the default section) and resets the
instance of the Template Manager maintained by the engine.

See also
ACJEngine.newSystem()

ACJEngine.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. The call to this
method should be made after the call to the readTemplate method.

ACJEngine.print
public void print()
throws java.lang.Exception
This method is internally called to generate the entire report. It is called
internally by the generateReport() API after query parameter values are
substituted. This method internally calls the print() function in the Template
Manager, which autogenerates a query, fetches a record set from the active
Data source, formats the data, and notifies the IPrinter implementation for
different printing messages.

Packa ge com.actua te.ere po r t.en gin e.AC JEnig ne 103


Throws
An exception occurs whenever the report generation process is abnormally
terminated. Abnormal termination usually occurs because of a fatal error.

ACJEngine.printingDone
public void printingDone()
Notification received when the report generation process is complete. This
function is specifically implemented to clear all stateless variables. It explicitly
frees memory locked by unused objects.

ACJEngine.readTemplate
public void readTemplate(java.lang.String template)
throws java.lang.Exception
Reads a template from specified filename.

template
A valid path indicating a template file containing a template written in an
ANSI format.

ACJEngine.readTemplate
public void readTemplate(java.lang.String template, int fileMode)
throws java.lang.Exception
Reads a template from specified filename using the specified encoding.
Updates the contents of the Template Manager. Any data source embedded in
the template is loaded and set as the active data source.

template
Path of the template file to be read.

fileMode
Encoding type. Permissible values are ACJConstants.ASCII, and
ACJConstants.UTF8.

104 e.Repor t Designer API Java Edition


ACJEngine.readTemplate
public void readTemplate(java.io.InputStream template)
throws java.lang.Exception
Reads a template from a specified input stream. Used in cases where loading a
template from a local file is not a viable option.

template
Input stream from which a template is to be read. This function instantiates
Template Manager and reads the template.

template
A valid input stream from which a template formatted using ANSI encoding
can be loaded.
public void readTemplate(java.io.InputStream template, int streamMode)
throws java.lang.Exception
Reads a template from the specified input stream. Used in cases where loading
a template from a local file is not a viable option. Any data source embedded
inside a template is automatically loaded and set as the active data source.

template
Input stream from which template is to be read.

streamMode
Encoding type. Valid types are ACJConstants.ASCII and ACJConstants.UTF8.
This function instantiates Template Manager and reads the template.

ACJEngine.resetStub
public void resetStub()

ACJEngine.setCacheOption
public void setCacheOption(boolean filecache,
java.lang.String tempfile)
Specifies whether the temporary file is generated by ACJEngine during report
generation. Indicates whether the temporary file should be stored in memory

Packa ge com.actua te.ere po r t.en gin e.AC JEnig ne 105


or in a file on disk. Default action is to store in memory. If you have a large
data set, however, you should use the file option to save memory.

filecache
Stores temporary files to disk if True is passed. Keeps data in memory if False
is passed.

tempfile
Path of a temporary file. Valid only if the first parameter is True.

ACJEngine.setCommunicationStub
public void setCommunicationStub(com.actuate.ereport.engine.stub.BaseStub
stub)
This function was called internally in previous versions of ACJEngine. It is no
longer used and must not be used from outside ACJEngine. It has only been
provided for backward compatibility. Sets the internal reference of the
IViewerInterface implementation.

ACJEngine.setDataSource
public void setDataSource(com.actuate.ereport.engine.IDataSource ds)
throws java.lang.Exception
Users must specify the implementation of the data source to be used for data
retrieval when generating reports. Default implementations of the data source
interface (IDataSource) provided are JDBCHandler, AppDataHandler, and
MetaDataHandler.

ACJEngine.setDebugMode
public static void setDebugMode(boolean b)
Specifies whether progress or error messages are to be displayed in the console
window.

b
Turns on or off the engine-related debugging messages that appear in the
console window.

106 e.Repor t Designer API Java Edition


ACJEngine.setOutputDevice
public void setOutputDevice(com.actuate.ereport.engine.IPrinter ip)
This function is not used. It is provided only for backward compatibility. This
function lets a user specify a customized implementation of the IPrinter report
generation interface.

ACJEngine.setResizeFixRatio
public void setResizeFixRatio(float fResizeFixRatio)
Sets the proportional increment required to fix the resize-to-fit feature for other
output devices.

ACJEngine.getResizeFixRatio
public float getResizeFixRatio()
Returns the proportional increment required to fix the resize-to-fit feature for
other output devices.

ACJEngine.setTargetOutputDevice
public void setTargetOutputDevice(int iTargetOutputDevice)

ACJEngine.setTemplateReader
public void setTemplateReader(com.actuate.ereport.engine.ITmplReader it)
This API is not used. It is provided for backward compatibility only. Specifies a
custom implementation of the ITmplReader interface used to read the contents
of a report template from a file or input stream.

Packa ge com.actua te.ere po r t.en gin e.AC JEnig ne 107


ACJEngine.setTemplateWriter
public void setTemplateWriter(com.actuate.ereport.engine.ITmplWriter it)
This API is not used. It is provided for backward compatibility only. Specifies a
custom implementation of the ITmplWriter interface used to write the contents
of a report template to a file or output stream.

ACJEngine.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.

ACJEngine.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. The call to this
method should be made after the call to the readTemplate method.

ACJEngine.writeTemplate
public void writeTemplate(java.lang.String template, int fileMode)
throws java.lang.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.

template
Output file name to which template is to be saved.

fileMode
Encoding type. Permissible values are ACJConstants.ASCII and
ACJConstants.UTF8.

108 e.Repor t Designer API Java Edition


ACJEngine.writeTemplate
public void writeTemplate(java.io.OutputStream os)
throws java.lang.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.

os
Output stream to which the template is to be saved.

ACJEngine.writeTemplate
public void writeTemplate(java.io.OutputStream os, int streamMode)
throws java.lang.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.

os
Output stream to which template is to be saved.

streamMode
Encoding type. Permissible values are ACJConstants.ASCII and
ACJConstants.UTF8.

Packa ge com.actua te.ere po r t.en gin e.AC JEnig ne 109


110 e.Repor t Designer API Java Edition
Package

com.actuate.ereport.
Package

output.
ACJOutputProcessor

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 111


Class ACJOutputProcessor
java.lang.Object
|
+--com.actuate.ereport.output.ACJOutputProcessor
_____________________________________________________________________
public class ACJOutputProcessor extends java.lang.Object
This class provides APIs for generating the report output from the template
file. You can write your own code to read the template file and generate the
report. After setting the raw report data in ACJOutputProcessor, you can
generate the output in the required format without having to make use of the
designer. You do not need GUI components for generating the report. You can
set the properties for the output devices using the setXXXProperty methods
provided in this class and then call the required generate methods.

Constructor summary
ACJOutputProcessor()
A default constructor.

Method summary
Method Description
ACJOutputProcessor
.closeZipEntry
ACJOutputProcessor
.closeZipStream
ACJOutputProcessor Undocumented feature.
.debugOutputProps()
ACJOutputProcessor Generates a CSV report using the properties
.generateCSV() individually set by the setCSVProperty()
method.
ACJOutputProcessor Deprecated. Use setCSVProperty() /
.generateCSV generateCSV() instead.
ACJOutputProcessor Deprecated. Use setCSVProperty() /
.generateCSV generateCSV() instead.
ACJOutputProcessor Generates a DHTML report using the
.generateDHTML() properties individually set by the
setDHTMLProperty() method.

112 e.Repor t Designer API Java Edition


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

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 113


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

114 e.Repor t Designer API Java Edition


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

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 115


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

116 e.Repor t Designer API Java Edition


Method Description
ACJOutputProcessor Sets the source of report data to a specified
.setJOIURLSource URL.
ACJOutputProcessor Wrapper to map the existing client keys to the
.setOutputProperty keys in the template.
ACJOutputProcessor Attempts to set an individual property used
.setPDFProperty by the PDF output device while generating a
PDF report.
ACJOutputProcessor Attempts to set an individual property used
.setPRINTERProperty by the printer output device while printing a
report.
ACJOutputProcessor Sets and resets the printer resolution.
.setPrinterResolution
ACJOutputProcessor Sets the raw report data (generated using
.setReportData ACJEngine.generateReport()) as the actual
data that ACJOutputProcessor will use to
generate output.
ACJOutputProcessor Sets the report data generated to the
.setReportData ACJEngine client module for output of
report.
ACJOutputProcessor
.writefile
ACJOutputProcessor
.writeZip
ACJOutputProcessor
.writeZip

ACJOutputProcessor constructor

ACJOutputProcessor
public ACJOutputProcessor()
A default constructor.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 117


ACJOutputProcessor.closeZipEntry
public static void closeZipEntry(java.util.zip.ZipOutputStream zos)
throws java.lang.Exception

ACJOutputProcessor.closeZipStream
public static void closeZipStream(java.util.zip.ZipOutputStream zos)
throws java.lang.Exception

ACJOutputProcessor.debugOutputProps
public void debugOutputProps()
Undocumented feature

Throws
java.lang.RuntimeException. A runtime exception occurs if there is an error
when generating the HTML report.

ACJOutputProcessor.generateCSV
public void generateCSV()
throws java.lang.Exception
Generates a CSV report using the properties individually set by the
'setCSVProperty()' method.

Throws
java.lang.RuntimeException. A runtime exception occurs if there is an error
when generating the CSV report.

118 e.Repor t Designer API Java Edition


ACJOutputProcessor.generateCSV
public void generateCSV(java.lang.Object sFilename,
java.awt.Component cProgressParent,
java.lang.String cSeparator)
Deprecated. Use setCSVProperty() / generateCSV() instead. Exports the
current report to a CSV file specified by the given name.

sFilename
Filename to which the output should be saved.

cProgressParent
An AWT component visible on screen. If Null is passed, ACJOutputProcessor
internally creates a dummy component.

cSeparator
Specifies the separator string. If Null is passed a comma ( , ) is used.

ACJOutputProcessor.generateCSV
public void generateCSV(java.lang.Object sFilename,
java.awt.Component cProgressParent,
java.lang.String cSeparator,
java.lang.String cTextQual)
Deprecated. Use setCSVProperty() / generateCSV() instead. Exports the
current report to a CSV file specified by the given name.

sFilename
Filename to which the output should be saved.

cProgressParent
An AWT component visible on screen. If Null is passed, ACJOutputProcessor
internally creates a dummy component.

cSeparator
Specifies the separator string. If Null is passed a comma ( , ) is used.

cTextQual
Specifies the text qualifier string. If Null is passed, no qualifier is set.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 119


ACJOutputProcessor.generateDHTML
public void generateDHTML(java.lang.Object outputDesc,
java.awt.Component cOffscreenImages,
boolean preserveFonts,
boolean preserveColors,
boolean useHorSpacing,
boolean isTOC,
boolean gzip)
Deprecated. Use setDHTMLProperty() / generateDHTML() instead.

ACJOutputProcessor.generateDHTML
public void generateDHTML()
throws java.lang.Exception
Generates a DHTML report using the properties individually set by the
setDHTMLProperty() method.

Throws
java.lang.RuntimeException. A runtime exception occurs if there is an error
when generating the DHTML report.

ACJOutputProcessor.generateEMAIL
public void generateEMAIL()
throws java.lang.Exception
Transmits the listed set of e-mails to the recipients via an SMTP server with
other properties as set by setEMAILProperty().

Throws
java.lang.RuntimeException. A runtime exception occurs if there is an error
when generating or sending the report.

120 e.Repor t Designer API Java Edition


ACJOutputProcessor.generateHTML
public void generateHTML()
throws java.lang.Exception
Generates an HTML report using the properties individually set by the
setHTMLProperty() method.

ACJOutputProcessor.generateHTML
public void generateHTML(java.lang.Object outputDesc,
java.awt.Component cOffscreenImages,
boolean preserveFonts,
boolean preserveColors)
Deprecated. Use setHTMLProperty() / generateHTML() instead. Exports the
current report to an HTML file with the given filename. Exports optional
additional files appended by an ID, depending on the report type and content.

sFilename
Filename where output should be saved.

cOffscreenImages
Any on screen AWT component. Needed by ACJEngine if charts, graphs or
images are present in the template. If Null is passed, ACJOutputProcessor
creates them internally only if charts, graphs or images are present in the
template.

preserveFonts
Preserves the report's original fonts if True is passed. Otherwise, creates all text
using the default font. Useful when trying to reduce the size of the output.

preserveColors
Preserves the report's original colors if True is passed. Otherwise, uses black
and white colors for the entire report. Useful when trying to reduce the size of
the output.

ACJOutputProcessor.generateHTML
public void generateHTML(java.lang.Object outputDesc,
java.awt.Component cOffscreenImages,

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 121


boolean preserveFonts,
boolean preserveColors,
boolean useHorSpacing,
boolean isTOC)
Deprecated. Use setHTMLProperty() / generateHTML() instead. Exports the
current report to an HTML file with the given filename. Exports optional
additional files appended by an ID, depending on the report type and content.

sFilename
Filename where output should be saved.

cOffscreenImages
Any on screen AWT component. Needed by ACJEngine if charts, graphs or
images are present in the template. If Null is passed, ACJOutputProcessor
creates them internally only if charts, graphs or images are present in the
template.

preserveFonts
Preserves the report's original fonts if True is passed. Otherwise, creates all text
using the default font. Useful when trying to reduce the size of the output.

preserveColors
Preserves the report's original colors if True is passed. Otherwise, uses black
and white colors for the entire report. Useful when trying to reduce the size of
the output.

useHorSpacing
Tries to preserve horizontal spacing between controls if True is passed.
Otherwise, ignores horizontal spacing between controls.

isTOC
Generates a Table of Contents if True is passed. Does not generate a Table of
Contents if False is passed.

ACJOutputProcessor.generateHTML
public void generateHTML(java.lang.Object outputDesc,
java.awt.Component cOffscreenImages,
boolean preserveFonts,
boolean preserveColors,
boolean useHorSpacing,
boolean isTOC,
boolean gzip)

122 e.Repor t Designer API Java Edition


Deprecated. Use setHTMLProperty() / generateHTML() instead.

ACJOutputProcessor.generateJOI
public void generateJOI(java.lang.String sFilename)
Exports the current report to a JOI file specified by the argument. JOI is a raw
ACJEngine data file that lets users create report executables.

ACJOutputProcessor.generateJOI
public void generateJOI()
throws java.lang.Exception
Generates a JOI report using the properties individually set by the
setJOIProperty() method.

Throws
java.lang.RuntimeException. A runtime exception occurs if there is an error
when generating the JOI report.

ACJOutputProcessor.generatePDF
public void generatePDF()
throws java.lang.Exception
Generates a PDF report using the properties individually set by the
setPDFProperty() method.

Throws
java.lang.RuntimeException. A runtime exception occurs if there is an error
when generating the PDF report.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 123


ACJOutputProcessor.generatePDF
public void generatePDF(java.lang.Object outputDesc,
java.awt.Component cOffscreenImages)
Deprecated. Use setPDFProperty() / generatePDF() instead. Exports the
current report to a PDF file specified by filename.

outputDesc
Filename string to which output should be saved, or an instance of an output
stream.

cOffscreenImages
Any visible AWT component. Needed by ACJEngine if charts, graphs or
images are present in the template. If Null is passed, ACJEngine generates an
instance internally only if charts, graphs or images are present in the template.

ACJOutputProcessor.generatePDF
public void generatePDF(java.lang.Object outputDesc,
java.awt.Component cOffscreenImages,
boolean isTOC)
Deprecated. Use setPDFProperty() / generatePDF() instead. Exports the
current report to a PDF file specified by filename.

outputDesc
Filename string to which output should be saved, or an instance of an output
stream.

cOffscreenImages
Any visible AWT component. Needed by ACJEngine if charts, graphs or
images are present in the template. If Null is passed, ACJEngine generates an
instance internally only if charts, graphs or images are present in the template.

isTOC
Specifies whether a Table of Contents is to be generated.

124 e.Repor t Designer API Java Edition


ACJOutputProcessor.generatePDF
public void generatePDF(java.lang.Object outputDesc,
java.awt.Component cOffscreenImages,
boolean isTOC,
boolean gzip)
Deprecated. Use setPDFProperty() / generatePDF() instead. Exports the
current report to a PDF file specified by filename.

outputDesc
Filename string to which output should be saved, or an instance of an output
stream.

cOffscreenImages
Any visible AWT component. Needed by ACJEngine if charts, graphs or
images are present in the template. If Null is passed, ACJEngine internally
generates an instance only if charts, graphs or images are present in the
template.

isTOC
Specifies whether a Table of Contents is to be generated.

ACJOutputProcessor.generatePDF_Ex
public void generatePDF_Ex(java.lang.Object outputDesc,
java.awt.Component cOffscreenImages,
int maxIds,
int maxPages,
int maxContents)
Deprecated. Use setPDFProperty() / generatePDF() instead. Extended API for
generating PDF reports. Required for very large reports.

maxIds
Every object rendered on a PDF page is represented as an ID. The default value
is 65,536 bytes.

maxPages
Every page in a PDF file is represented by an ID. Specifies the maximum
number of pages required for preallocation.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 125


maxContents
For an indexed report with a Table of Contents, each item in the Table of
Contents is stored as a content. Specifies the maximum number of contents
required for preallocation, rounded up.

ACJOutputProcessor.generatePDF_Ex
public void generatePDF_Ex(java.lang.Object outputDesc,
java.awt.Component cOffscreenImages,
int maxIds,
int maxPages,
int maxContents,
boolean isTOC)
Deprecated. Use setPDFProperty() / generatePDF() instead. Extended API for
generating PDF reports. Required for very large reports.

maxIds
Every object rendered on a PDF page is represented as an ID. The default value
is 65,536 bytes.

maxPages
Every page in a PDF file is represented by an ID. Specifies the maximum
number of pages required for preallocation, rounded up.

maxContents
For an indexed report with a Table of Contents, each item in the Table of
Contents is stored as a content. Specifies the maximum number of contents
required for preallocation, rounded up.

isTOC
Generates a Table of Contents if True is passed; none if False is passed.

ACJOutputProcessor.generatePRINTOUT
public java.awt.print.PrinterJob generatePRINTOUT()
throws java.lang.Exception
Prints a hard copy of the report using properties individually set by
setPRINTERProperty().
In the SWING API, the generatePRINTOUT() methods return
java.awt.print.PrinterJob.

126 e.Repor t Designer API Java Edition


In the AWT API, the generatePRINTOUT() methods return a
java.awt.PrintJob.

Throws
java.lang.RuntimeException. A runtime exception occurs if there is an error
when printing the report.

ACJOutputProcessor.generatePRINTOUT
public java.awt.print.PrinterJob generatePRINTOUT(boolean isGui,
java.awt.print.PrinterJob pj,
boolean preservePrintjob,
boolean silentPrint)
Deprecated. Use setPRINTERProperty() / generatePRINTOUT() instead.
In the SWING API, the generatePRINTOUT() methods return
java.awt.print.PrinterJob.
In the AWT API, the generatePRINTOUT() methods return a
java.awt.PrintJob.

ACJOutputProcessor.generatePRINTOUT
public java.awt.print.PrinterJob generatePRINTOUT(boolean isGui,
java.awt.print.PrinterJob pj,
boolean preservePrintjob,
boolean silentPrint,
java.awt.Component bVisibleComponent)
Deprecated. Use setPrinterProperty() / generatePRINTOUT() instead. Prints a
hard copy of the report to the printer specified in the printer specifications/
setup dialog box.
In the SWING API, the generatePRINTOUT() methods return
java.awt.print.PrinterJob.
In the AWT API, the generatePRINTOUT() methods return a
java.awt.PrintJob.

isGui
Specifies whether the preview device is showing; if the device is showing, it
has a parent frame.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 127


pj
Passes an old instance of a print job for batch printing.

preservePrintjob
Indicates whether the PrinterJob should be destroyed or retained for another
process.

silentPrint
If True is passed, printing occurs without displaying a print dialog box.
Otherwise, the dialog box displays before printing.

bVisibleComponent
The component used to get the print job.

ACJOutputProcessor.getCSVProperty
public java.lang.Object getCSVProperty(java.lang.String sProperty)
Attempts to retrieve an individual property used by the CSV output device
when generating a CSV report.

sProperty
The property to be retrieved. Properties are: FileName (String), OutputStream
(OutputStream), CharacterSeparator (String), and QuoteCharacter (String).

ACJOutputProcessor.getDHTMLDevice
public com.actuate.ereport.output.OD_DHTML getDHTMLDevice()
Used internally.

ACJOutputProcessor.getDHTMLProperty
public java.lang.Object getDHTMLProperty(java.lang.String sProperty)
Attempts to retrieve an individual property to be used by the DHTML output
report.

128 e.Repor t Designer API Java Edition


sProperty
The property to be retrieved. Properties are: FileName (String), OutputStream
(OutputStream), BufferSize (Integer), VisibleComponent (Component),
TableOfContents (Boolean), ZipCompressed (Boolean), PreserveColors
(Boolean), PreserveFonts (Boolean), PreservePageBreaks (Boolean), and
HorizontalSpacing (Boolean).

ACJOutputProcessor.getDocumentationPath
public java.lang.String getDocumentationPath()
Gets the path to the main documentation file.

ACJOutputProcessor.getEMAILProperty
public java.lang.Object getEMAILProperty(java.lang.String sProperty)
Attempts to retrieve an individual property used by the printer output device
when printing a report.

sProperty
The property to be retrieved. Properties are: SMTPServer (String),
SenderEmail (String), Recipients (Vectpr), Subject (String), Notes (String),
ReportTypes(Integer - ACJConstants.PDF+HTML+DHTML, etc.), and
FilesToAttach (Vector).

ACJOutputProcessor.getHTMLProperty
public java.lang.Object getHTMLProperty(java.lang.String sProperty)
Attempts to retrieve an individual property to be used by the HTML output
report.

sProperty
The property to be retrieved. Properties are: FileName (String), OutputStream
(OutputStream), BufferSize (Integer), VisibleComponent (Component),
TableOfContents (Boolean), ZipCompressed (Boolean), PreserveColors
(Boolean), PreserveFonts (Boolean), PreservePageBreaks (Boolean), and
HorizontalSpacing (Boolean).

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 129


ACJOutputProcessor.getJOIProperty
public java.lang.Object getJOIProperty(java.lang.String sProperty)
Attempts to retrieve an individual property used by the JOI Handler while
generating a JOI report.

sProperty
The FileName (String) property to be retrieved.

ACJOutputProcessor.getOutputFiles
public java.lang.String[] getOutputFiles()
Returns a list of files generated for a structured output; for example, HTML
with Table of Contents or images.

ACJOutputProcessor.getPDFProperty
public java.lang.Object getPDFProperty(java.lang.String sProperty)
Attempts to retrieve an individual property used by the PDF output device
when generating a PDF report.

sProperty
The property to be retrieved. Properties are: FileName (String), OutputStream
(OutputStream), BufferSize (Integer), VisibleComponent (Component),
TableOfContents (Boolean), ZipCompressed (Boolean), MaxPages (Integer),
MaxItems (Integer), and MaxContents (Integer).

ACJOutputProcessor.getPreviewDevice
public javax.swing.JPanel getPreviewDevice()
Returns an instance of the preview device. A handle of OD_Preview is needed
before the preview device can be embedded inside a container, such as a frame
or panel. The handle is also needed before the preview device can be
controlled through the API in this class. All publicly available APIs to control
the preview device are available through ACJOutputProcessor. Publicly
available APIs are only accessible after making a call to getPreviewDevice().

130 e.Repor t Designer API Java Edition


In the SWING API, getPreviewDevice() returns javax.swing.JPanel.
In the AWT API, getPreviewDevice() returns a java.awt.Panel.

ACJOutputProcessor.getPRINTERProperty
public java.lang.Object getPRINTERProperty(java.lang.String sProperty)
Attempts to retrieve an individual property used by the printer output device
when printing a report.

sProperty
The property to be retrieved. Properties are: PrinterJob (PrintJob),
VisibleComponent (Component), IsGUIVisible (Boolean), PreservePrinterJob
(Boolean), and SilentPrint (Boolean).

ACJOutputProcessor.getPrinterResolution
public double getPrinterResolution()
Returns the current resolution for the printer device only when printer
resolution is set through setPrinterResolution. Otherwise, zero is returned.

ACJOutputProcessor.getVirtualOutput
public com.actuate.ereport.output.VirtualOutput getVirtualOutput()
Returns an instance of the VirtualOutput object. Used internally.

ACJOutputProcessor.hasMultipleOutputFiles
public boolean hasMultipleOutputFiles()
Returns True if more than a single output file is generated.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 131


ACJOutputProcessor.instantiateZipStream
public static java.util.zip.ZipOutputStream
instantiateZipStream(java.io.OutputStream os)
throws java.lang.Exception

ACJOutputProcessor.promptParams
public boolean promptParams()
Indicates whether the parameter entry dialog displays when the report output
is required.

ACJOutputProcessor.promptParams
public void promptParams(boolean bPromptParams)
Specifies whether the parameter entry dialog displays when the report output
is required.

ACJOutputProcessor.prv_getActivePage
public int prv_getActivePage()
Returns the active page in the preview window.

ACJOutputProcessor.prv_getPageCount
public int prv_getPageCount()
Returns the count of available pages in the preview. If the report is indexed,
returns the total number of pages buffered for the currently selected node in
the Table Of Contents.

132 e.Repor t Designer API Java Edition


ACJOutputProcessor.prv_getZoom
public int prv_getZoom()
Returns the zoom factor in the preview device as a percentage value. Possible
return values are 50, 75, 100, and 200.

ACJOutputProcessor.prv_removeToolbarItem
public void prv_removeToolbarItem(java.lang.String sName)
throws java.lang.Exception
Removes a single item from the toolbar in the preview window.

sName
A name representing the toolbar item. Permissible values are Export, Zoom,
Printer, Navigation, Refresh, TOC, and Margins.

Throws
java.lang.RuntimeException. An error occurs if an attempt is made to remove
an icon other than those in the list of removeable items above.

ACJOutputProcessor.prv_setActivePage
public boolean prv_setActivePage(int p)
Sets the active page in the preview window.

ACJOutputProcessor.prv_setBackgroundTOC
public void prv_setBackgroundTOC(java.awt.Color bgClr)
Sets the background color of the Table of Contents in the preview window.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 133


ACJOutputProcessor.prv_setZoom
public void prv_setZoom(int z)
Sets the zoom factor in the preview device as a percentage value. Possible
values are 50, 75, 100 and 200.

ACJOutputProcessor.prv_showToolbar
public void prv_showToolbar()
Shows the toolbar in the preview window.

ACJOutputProcessor.prv_updateToolbar
public void prv_updateToolbar()

ACJOutputProcessor.prv_setNextPage
public void prv_setNextPage()
Sets the active page to the next page. The next page may be a subpage split on
the current page.

ACJOutputProcessor.prv_setPrevPage
public void prv_setPrevPage()
Sets the active page to the previous page. The previous page may be a subpage
split on the current page.

ACJOutputProcessor.prv_showTOC
public void prv_showTOC()

134 e.Repor t Designer API Java Edition


Shows the Table Of Contents panel in the ACJEngine client window.

ACJOutputProcessor.putNewZipEntry
public static void putNewZipEntry(java.lang.String filenm,
java.util.zip.ZipOutputStream zos)
throws java.lang.Exception

ACJOutputProcessor.refreshReport
public void refreshReport(boolean regenerate)
throws java.lang.Exception
Re-retrieves the current page. If True is passed, the report is regenerated, then
the page is retrieved.

regenerate
If True is passed, the report is regenerated. Otherwise, existing report data is
used.

ACJOutputProcessor.setBufferSize
public void setBufferSize(int bufferSize)
Sets the buffer size in bytes for delayed filewrites. The default is 65,536 bytes.
Setting a higher buffer reduces the time it takes to write a file but increases
memory usage.

ACJOutputProcessor.setCSVProperty
public void setCSVProperty(java.lang.String sProperty,
java.lang.Object oValue)
throws java.lang.Exception
Attempts to set an individual property used by the CSV output device when
generating a CSV report. If a property is omitted, a default value is used.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 135


sProperty
The property to be set. Properties are: FileName (String), OutputStream
(OutputStream), CharacterSeparator (String), and QuoteCharacter (String).

oValue
The corresponding value for the property to be set. Ensure that the correct data
type is used when setting the value.

Throws
java.lang.RuntimeException. An exception is generated if an invalid property,
an invalid data type value, or a Null property is set.

ACJOutputProcessor.setDHTMLProperty
public void setDHTMLProperty(java.lang.String sProperty,
java.lang.Object oValue)
throws java.lang.Exception
Attempts to set an individual property used by the DHTML output device
when generating an DHTML report. If a property is omitted, a default value is
used.

sProperty
The property to be set. Properties are: FileName (String), OutputStream
(OutputStream), BufferSize (Integer), VisibleComponent (Component),
TableOfContents (Boolean), ZipCompressed (Boolean), PreserveColors
(Boolean), PreserveFonts (Boolean), PreservePageBreaks (Boolean), and
HorizontalSpacing (Boolean).

oValue
The corresponding value for the property to be set. Ensure that the correct data
type is used when setting the value.

Throws
java.lang.RuntimeException. An exception is generated if an invalid property,
an invalid data type value, or a Null property is set.

136 e.Repor t Designer API Java Edition


ACJOutputProcessor.setDocumentationPath
public void setDocumentationPath(java.lang.String sDocPath)
Sets the path to the main documentation file.

ACJOutputProcessor.setEMAILProperty
public void setEMAILProperty(java.lang.String sProperty,
java.lang.Object oValue)
throws java.lang.Exception
Attempts to set an individual property used by the emailing system while
deploying reports. If a specific property is omitted, a default value is used.

sProperty
The property to be set. Properties are: SMTPServer (String), SenderEmail
(String), Recipients (Vector), Subject (String), Notes (String),
ReportTypes(Integer - ACJConstants.PDF+HTML+DHTML etc.) and
FilesToAttach (Vector).

oValue
The corresponding value for the property to be set. Ensure that the correct data
type is used when setting the value.

Throws
java.lang.RuntimeException. An exception is generated if an invalid property,
an invalid value data type value or a Null property is set.

ACJOutputProcessor.setHTMLProperty
public void setHTMLProperty(java.lang.String sProperty,
java.lang.Object oValue)
throws java.lang.Exception
Attempts to set an individual property used by the HTML output device while
generating an HTML report. If a specific property is omitted, a default value is
used.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 137


sProperty
The property to be set. Properties are: FileName (String), OutputStream
(OutputStream), BufferSize (Integer), VisibleComponent (Component),
TableOfContents (Boolean), ZipCompressed (Boolean), PreserveColors
(Boolean), PreserveFonts (Boolean), PreservePageBreaks (Boolean), and
HorizontalSpacing (Boolean).

oValue
The corresponding value for the property to be set. Ensure that the correct data
type is used when setting the value.

Throws
java.lang.RuntimeException. An exception is generated if an invalid property,
an invalid value data type or a Null property is set.

ACJOutputProcessor.setJOIFileSource
public void setJOIFileSource(java.io.File JOIFile)
throws java.lang.Exception
Sets the source of report data to the specified filename. Used for report
executables. Note that loading a JOI file from a file on the local system is
handled differently than loading a JOI file from a URL. Be sure to use the
appropriate API.

JOIFile
Filename on the file system where the JOI file is located.

ACJOutputProcessor.setJOIProperty
public void setJOIProperty(java.lang.String sProperty,
java.lang.Object oValue)
throws java.lang.Exception
Attempts to set an individual property used by the JOI Handler when
generating a JOI report. If a specific property is omitted, a default value is
used.

sProperty
The property FileName (String) to be set.

138 e.Repor t Designer API Java Edition


oValue
The corresponding value for the property to be set. Ensure that the correct data
type is used when setting the value.

Throws
java.lang.RuntimeException. An exception is generated if an invalid property,
an invalid data type value or a Null property is set.

ACJOutputProcessor.setJOISource
public void setJOISource(java.lang.String sJOIorURL)
throws java.lang.Exception
A macro that accepts a string representation of a JOI filename or the location of
a JOI filename via a URL (http:, ftp:, or file:). Internally calls setJOIURLSource
or setJOIFileSource.

sDATorURL
Either a JOI local filename or a JOI file at a URL.

ACJOutputProcessor.setJOIURLSource
public void setJOIURLSource(java.net.URL JOIURL)
throws java.lang.Exception
Sets the source of report data to the specified URL. Used for report
executables. Note that loading a JOI file from a file on the local system is
handled differently than loading a JOI file from a URL. Be sure to use the
appropriate API.

JOIURL
URL location of the JOI file.

ACJOutputProcessor.setOutputProperty
public void setOutputProperty(java.lang.String sOutputDevice,
java.lang.String sProperty,
java.lang.Object oValue)

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 139


Wrapper to map the existing client keys to the keys in the template.

ACJOutputProcessor.setPDFProperty
public void setPDFProperty(java.lang.String sProperty,
java.lang.Object oValue)
throws java.lang.Exception
Attempts to set an individual property used by the PDF output device when
generating a PDF report. If a specific property is omitted, a default value used.

sProperty
The property to be set. Properties are: FileName (String), OutputStream
(OutputStream), BufferSize (Integer), VisibleComponent (Component),
TableOfContents (Boolean), ZipCompressed (Boolean), MaxPages (Integer),
MaxItems (Integer), and MaxContents (Integer).

oValue
The corresponding value for the property to be set. Ensure that the correct data
type is used when setting the value.

Throws
java.lang.RuntimeException. An exception is generated if an invalid property,
an invalid data type value or a Null property is set.

ACJOutputProcessor.setPRINTERProperty
public void setPRINTERProperty(java.lang.String sProperty,
java.lang.Object oValue)
throws java.lang.Exception
Attempts to set an individual property used by the printer output device when
printing a report. If a specific property is omitted, a default value is used.

sProperty
The property to be set. Properties are: PrinterJob (PrinterJob),
VisibleComponent (Component), IsGUIVisible (Boolean), PreservePrinterJob
(Boolean), and SilentPrint (Boolean).
SilentPrint is not available in AWT since the IsGUIVisible option must always
be True for the generatePrintout() method to work.

140 e.Repor t Designer API Java Edition


oValue
The corresponding value for the property to be set. Ensure that the correct data
type is used when setting the value.

Throws
java.lang.RuntimeException. An exception is generated if an invalid property,
an invalid data type value, or a Null property is set.

ACJOutputProcessor.setPrinterResolution
public void setPrinterResolution(boolean showDialog,
double resolution)
Sets and resets the printer resolution. This method is used to force printer
resolution to a predefined value.

showDialog

Set this parameter to True to enable setting correct resolution, when the JVM
resolution returned through PrintJob is not correct. When ShowDialog is True,
a printer resolution dialog displays before printing.

resolution
The required value for the printer resolution. This parameter is ignored if
showDialog is True.

ACJOutputProcessor.setReportData
public boolean setReportData
(com.actuate.ereport.common.IViewerInterface ivi)
throws java.lang.Exception
Sets the raw report data generated using ACJEngine.generateReport() as the
actual data that ACJOutputProcessor uses to generate output.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 141


ACJOutputProcessor.setReportData
public boolean setReportData
(com.actuate.ereport.common.IViewerInterface ivi,
java.awt.Component c)
throws java.lang.Exception
Sets the report data generated to the ACJEngine client module for output of
report. If report data is not available, forces a report generation.

ivi
Raw ACJEngine report data generated by ACJEngine.generateReport().

c
If the report is contains parameters, pass Visible to display the Enter Parameter
Values dialog box. Pass Null to bypass displaying the dialog box.

Returns
True if report data was successfully set to the ACJEngine client module. False
otherwise.

ACJOutputProcessor.writefile
public static void writefile(java.util.zip.ZipOutputStream zos,
java.util.Vector filenms)
throws java.lang.Exception

ACJOutputProcessor.writeZip
public static void writeZip(java.lang.String fnm,
java.util.zip.ZipOutputStream zos)
throws java.lang.Exception

142 e.Repor t Designer API Java Edition


ACJOutputProcessor.writeZip
public static void writeZip(byte[] b,
java.util.zip.ZipOutputStream zos)
throws java.lang.Exception
public com.actuate.ereport.output.OD_HTML getHTMLDevice()
Used internally.

Pa cka ge com.actua te.erepo r t.ou tput.ACJOutpu tProcessor 143


144 e.Repor t Designer API Java Edition
Package

com.actuate.ereport.
Package

datasrcmgrs.appdatasrc.
AppDataHandler

Package co m.a ctu ate.erep or t.d atasrcmgrs.app data src.Ap pDa taHa nd ler 145
Class AppDataHandler
java.lang.Object
|
+--com.actuate.ereport.engine.MetadataAdapter
|
+--com.actuate.ereport.datasrcmgrs.appdatasrc.AppDataHandler
_____________________________________________________________________

All Implemented Interfaces


com.actuate.ereport.engine.IDataSource,
com.actuate.ereport.engine.IMetaData, java.io.Serializable

Direct known subclasses


ASCIIDataHandler, EJBDataHandler
public class AppDataHandler
extends com.actuate.ereport.engine.MetadataAdapter
Implements com.actuate.ereport.engine.IDataSource, java.io.Serializable.
This is the main class that implements the interface between ACJEngine and
an application data source. Use this class to define the data structure and to
pass the data objects to ACJEngine. Note that each table name must be unique.
A column name must be unique within that table; however, duplicate column
names in different tables are permitted. AppDataSrc uses an object/relational
mapping architecture to describe the structure of your object to ACJEngine.
Think of your object and its variables and methods as analogous to a database
table with columns.This structure makes it possible to convey object oriented
information in a relational form to ACJEngine. This relational form can then be
used to execute SQL-like queries to generate reports.

See also
Serialized objects

Constructor summary
AppDataHandler()
The default constructor.

146 e.Repor t Designer API Java Edition


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

Package co m.a ctu ate.erep or t.d atasrcmgrs.app data src.Ap pDa taHa nd ler 147
Method Description
AppDataHandler
.getQueryResult

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

148 e.Repor t Designer API Java Edition


Method Description
AppDataHandler An application data source does not require
.requiresConnection() a connection the way a JDBC data source
does. Returns False.
AppDataHandler Indicates if console messages should be
.setDebugMode displayed as the QueryProcessor processes
the various joins and projects the result set.
AppDataHandler Attempts to register additional operators
.setExtraOperators that can be used in processing the WHERE
clause.
AppDataHandler Enables or disables the query display.
.setQueryDisplay
AppDataHandler Sets all relations as a vector of strings.
.setRelations
AppDataHandler
.setResultSetRange
AppDataHandler Used internally.
.setTableDefinition
AppDataHandler
.sortVector

AppDataHandler constructor
AppDataHandler
public AppDataHandler()
A default constructor.

AppDataHandler.allowMultipleTableRegistering
public void allowMultipleTableRegistering(boolean
bAllowMultipleTablesForSameClass)
Allows multiple tables to be registered using the same class.

bAllowMultipleTablesForSameClass - if true
Allows multiple tables to be registered.

Package co m.a ctu ate.erep or t.d atasrcmgrs.app data src.Ap pDa taHa nd ler 149
AppDataHandler.connect
public void connect()
throws java.lang.Exception
Not used. An application data source does not require a connection the way a
JDBC data source does.

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

AppDataHandler.disconnect
public void disconnect()
throws java.lang.Exception
Not used. An application data source does not require a connection the way a
JDBC data source does.

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

AppDataHandler.fetchData
public java.lang.Object fetchData(java.lang.String sTable,
java.lang.String sColumn,
int iStart,
int iCount)
throws java.lang.Exception
Not used. Returns Null.

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

150 e.Repor t Designer API Java Edition


AppDataHandler.getCatalogName
public java.lang.String getCatalogName()
throws java.lang.Exception
Not used. Returns Default Catalog.

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

AppDataHandler.getColumnNames
public java.util.Vector getColumnNames(java.lang.String sTableName)
throws java.lang.Exception
Returns a vector of column names that have been registered for the specified
table name.

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

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

AppDataHandler.getDataType
public int getDataType(java.lang.String sTable,
java.lang.String sColumn)
throws java.lang.Exception
Returns the SQL equivalent of a primitive data type. String = VARCHAR, int =
INTEGER, long = BIGINT, double = DOUBLE, boolean = BIT, Date = DATE,
BIGDECIMAL = DECIMAL, float = REAL, short = SMALLINT, Time = TIME,
TimeStamp = TIMESTAMP, byte = TINYINT, Image = LONGVARBINARY,
Character = CHAR.

Package co m.a ctu ate.erep or t.d atasrcmgrs.app data src.Ap pDa taHa nd ler 151
Overrides
getDataType in class com.actuate.ereport.engine.MetadataAdapter

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

AppDataHandler.getEndRecordNumber
public int getEndRecordNumber()

AppDataHandler.getIdentifierQuote
public java.lang.String getIdentifierQuote()
Returns a " ' " as the delimiter string for special data types such as dates, as
well as when table names have spaces in them.

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

AppDataHandler.getName
public java.lang.String getName()
Identifies the name of the data source. Returns Application DataSource.

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

152 e.Repor t Designer API Java Edition


AppDataHandler.getPropertySheet
public com.actuate.ereport.engine.IPropertySheet getPropertySheet()
Not used. Returns Null.

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

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

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

AppDataHandler.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

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

Package co m.a ctu ate.erep or t.d atasrcmgrs.app data src.Ap pDa taHa nd ler 153
Specified by
getQueryResult in interface com.actuate.ereport.engine.IDataSource

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

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

AppDataHandler.getRelations
public java.util.Vector getRelations()
throws java.lang.Exception
Returns all relations as a vector of strings. The format for each relation is:
TABLE1.COL1-TABLE2.COL2, RELATIONTYPE.

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

AppDataHandler.getStartRecordNumber
public int getStartRecordNumber()

AppDataHandler.getTable
public com.actuate.ereport.engine.ITable getTable(java.util.Hashtable
htQuery,
java.lang.String sReaders)
throws java.lang.Exception
Executes the query and returns the result set.

154 e.Repor t Designer API Java Edition


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

AppDataHandler.getTableNames
public java.util.Vector getTableNames()
throws java.lang.Exception
Returns a list of all table names registered with the data source.

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

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

AppDataHandler.getTableType
public java.lang.String getTableType(java.lang.String sTable)
throws java.lang.Exception
Not used. Returns Java Class.

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

AppDataHandler.isConnected
public boolean isConnected()
throws java.lang.Exception
Not used. An application data source does not require a connection the way a
JDBC data source does. Returns True.

Package co m.a ctu ate.erep or t.d atasrcmgrs.app data src.Ap pDa taHa nd ler 155
Specified by
isConnected in interface com.actuate.ereport.engine.IDataSource

AppDataHandler.isNullable
public java.lang.String isNullable(java.lang.String sTable,
java.lang.String sColumn)
throws java.lang.Exception
Returns Yes if Null is a valid default value for the specified table or column;
No otherwise.

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

AppDataHandler.passTableData
public void passTableData(java.lang.String sTableName,
java.util.Collection cAllRecords)
Used internally.
In the AWT API, passTableData takes the second argument as a vector.

AppDataHandler.registerDataSet
public void registerDataSet(java.lang.String sTableName,
java.util.Collection cAllRecords)
Passes the data objects from your application to ACJEngine. The default
implementation of IObjectTable is that of a vector.

tableName
The name you have given for the object when calling registerObjectAsTable.

data
A java.util.Collection of objects containing the objects you want ACJEngine to
query and from which it is to extract the result set.
In the AWT API, registerDataSet takes the second argument as a vector.

156 e.Repor t Designer API Java Edition


AppDataHandler.registerObjectAsTable
public void registerObjectAsTable(java.lang.Object oInstanceOfClass,
java.lang.String sTableName,
java.util.Vector vColsDefn)
Defines your application object and its structure to ACJEngine in the form of a
table.

Parameters
oInstanceOfClass
An instance of a class you are trying to define as a table. This class must be
defined as public or this method fails.

sTableName
The name you designate for this class. Normally used to provide a more user
friendly name than the actual class name.

vColsDefn
A vector of class variables or methods to be defined as columns of this table.

AppDataHandler.registerQuery
public void registerQuery(java.lang.Object queryId,
java.lang.String query)
throws java.lang.Exception
Predefined query implementation.

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

AppDataHandler.RegisterTable
public void
RegisterTable(com.actuate.ereport.datasrcmgrs.appdatasrc.IObjectTable
iot,
java.lang.String sTableName)
Deprecated. Use registerUserDefTable() instead.

Package co m.a ctu ate.erep or t.d atasrcmgrs.app data src.Ap pDa taHa nd ler 157
AppDataHandler.RegisterTable
public void RegisterTable(java.util.Vector vAllRecords,
java.lang.String sTableName,
java.util.Vector vColsDefn,
java.lang.String primaryKey)
Deprecated. Use registerObjectAsTable() instead.

AppDataHandler.registerUserDefTable
public void
registerUserDefTable(com.actuate.ereport.datasrcmgrs.appdatasrc.IObject
Table iot,
java.lang.String sTableName)
Defines your application object and its structure to ACJEngine in the form
of a table.

iot
An implementation of the IObjectTable class to be defined as a table.

sTableName
The name of the table represented by this IObjectTable implementation.

AppDataHandler.requiresConnection
public boolean requiresConnection()
An application data source does not require a connection the way a JDBC data
source does. Returns False.

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

158 e.Repor t Designer API Java Edition


AppDataHandler.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.

AppDataHandler.setExtraOperators
public void setExtraOperators(java.util.Vector vOperators)
throws java.lang.Exception
Attempts to register additional operators that can be used in processing the
WHERE clause.

AppDataHandler.setQueryDisplay
public void setQueryDisplay(boolean bDisplay)
Enables or disables the query display.

AppDataHandler.setRelations
public void setRelations(java.util.Vector vR)
Sets all relations as a vector of strings. The format for each relation is:
TABLE1.COL1-TABLE2.COL2, RELATIONTYPE.

AppDataHandler.setResultSetRange
public void setResultSetRange(int startRecordNo,
int endRecordNo)

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

Package co m.a ctu ate.erep or t.d atasrcmgrs.app data src.Ap pDa taHa nd ler 159
AppDataHandler.setTableDefinition
public void setTableDefinition(java.lang.String sTableName,
java.lang.Class cTableClass,
java.util.Vector vColsDefn)
throws java.lang.Exception
Used internally.

AppDataHandler.sortVector
public static void sortVector(java.util.Vector v)

160 e.Repor t Designer API Java Edition


Interface

com.actuate.ereport.
Interface

datasrcmgrs.appdatasrc
Public interfaces:
■ IObjectTable
■ Iterator

Interface com.actuate.erepor t.datasrcmgrs.appdatasrc 161


Interface IObjectTable
public interface IObjectTable

Method Summary
Method Description
getColumns() This method returns the list of the fields or
methods representing the columns in the
table.
getValue(java.lang.Object o, An implementation of this method returns
java.lang.String colName) the value represented by the specified
column <colName> in the corresponding
object <o>, which is an instance of this table.
hasColumn(java.lang.String This method returns True if the column
col) indicated by <col> exists; False otherwise.
iterator() Returns the iterator that represents this table
object.

getColumns
public java.util.Vector getColumns()
This method returns the list of the fields or methods representing the columns
in the table.

getValue
public java.lang.Object getValue(java.lang.Object o, java.lang.String colName)
throws java.lang.Exception
An implementation of this method returns the value represented by the
specified column in the corresponding object, which is an instance of this
table.

162 e.Repor t Designer API Java Edition


Parameters
colName
The name of the column whose data value is to be retrieved.

o
An instance of this table class. The data must be retrieved from this instance.

hasColumn
public boolean hasColumn(java.lang.String col)
This method must return True if the column indicated by <col> exists; False
otherwise.

Parameter
col
The name of the column to be verified.

Returns
boolean True if the column exists; False otherwise.

iterator
public Iterator iterator()
Return the Iterator that represents this table object.

Returns
Iterator. An instance of com.actuate.ereport.datasrcmgrs.appdatasrc.Iterator.

Interface com.actuate.erepor t.datasrcmgrs.appdatasrc 163


Interface Iterator
public interface Iterator

Method Summary
Method Description
hasNext() This method returns a boolean indicating
whether further traversal in this table is possible.
next() An implementation of this method should return
the current record and advance the cursor to the
next record in the data set.
remove() This method is never called
resetCursor() This method is called to cause the table class to
reset the cursor to the starting position of the data
set. the data can then be refetched.

hasNext
public boolean hasNext()
This method returns a boolean indicating whether further traversal in this
table is possible.

Returns
boolean True if there are more records; False otherwise.

next
public java.lang.Object next()
throws java.util.NoSuchElementException
An implementation of this method returns the current record and advances
the cursor to the next record in the data set.

164 e.Repor t Designer API Java Edition


Returns
Object. An instance of the table class that has been registered.

Throws
java.util.NoSuchElementException when the end of the data set is
encountered.

remove
public void remove()
throws java.lang.Exception
This method is never called. It is presented for compatibility with the class
java.util.Iterator.

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. The data can then be refetched.

Interface com.actuate.erepor t.datasrcmgrs.appdatasrc 165


166 e.Repor t Designer API Java Edition
Package

com.actuate.ereport.
Package

datasrcmgrs.asciidatasrc.
ASCIIDataHandler

Packag e co m.a ctu ate.erep or t.d atasrcmgrs.ascii data src.ASCIIDa taHa nd ler 167
Class ASCIIDataHandler
java.lang.Object
|
+--com.actuate.ereport.engine.MetadataAdapter
|
+--com.actuate.ereport. datasrcmgrs.appdatasrc. AppDataHandler
|
+--com.actuate.ereport.datasrcmgrs.asciidatasrc.ASCIIDataHandler
_____________________________________________________________________

All Implemented Interfaces


com.actuate.ereport.engine.IDataSource,
com.actuate.ereport.engine.IMetaData, java.io.Serializable
public class ASCIIDataHandler
extends AppDataHandler
This class is used to register the extracted ASCII data from a specified data file.
The ASCII data in the data file is described using a property file in a specified
format.

See also
Serialized objects

Constructor summary
ASCIIDataHandler()

Method summary
Method Description
ASCIIDataHandler
.checkIfExists
ASCIIDataHandler Constructor used to initialize the
.connect ASCII data source.
ASCIIDataHandler This constructor is used
.connect internally.

168 e.Repor t Designer API Java Edition


Method Description
ASCIIDataHandler Function to count the number of
.getPropertiesFileName columns having the same data
type.
ASCIIDataHandler
.getCurrentPropertiesAsString()
ASCIIDataHandler
.getPropertiesFileName()
ASCIIDataHandler
.getSourceFileName()
ASCIIDataHandler Function that registers all the
.getPropertiesFileName tables with ACJEngine.
ASCIIDataHandler
.setPropertiesFileName

ASCIIDataHandler constructor

ASCIIDataHandler
public ASCIIDataHandler()

ASCIIDataHandler.checkIfExists
public static boolean checkIfExists(java.lang.String sName)

ASCIIDataHandler.connect
public void connect(ACJEngine erw,
java.lang.String fileName,
java.lang.String propertyFileName)
throws java.lang.Exception
Constructor used to initialize the ASCII data source.

erw

Packag e co m.a ctu ate.erep or t.d atasrcmgrs.ascii data src.ASCIIDa taHa nd ler 169
An instance of the ACJEngine engine.

sfileName
The file containing the ASCII text data.

propertyFileName
The file containing information required to parse the text file. This file is
generated by the ASCII data wizard.

ASCIIDataHandler.connect
public void connect(ACJEngine erw,
java.lang.String fileName,
java.util.Vector vPropertiesOfAllTables)
throws java.lang.Exception
This constructor is used internally.

erw
An instance of the ACJEngine engine.

fileName
The file containing the ASCII text data.

vPropertiesOfAllTables
Vector describing the data in the ASCII data file.

ASCIIDataHandler.getColumnCount
public int getColumnCount(java.util.Vector vDataTypes,
java.lang.String dataType)
Function to count the number of columns having the same data type.

vDataTypes
Vector of column data types for a particular table.

dataType
The datatype for which the count is needed.

170 e.Repor t Designer API Java Edition


Returns
Count of the columns that have the specified data type; 0 is used if the
specified data type is not present in this table.

ASCIIDataHandler.getCurrentPropertiesAsString
public java.lang.String getCurrentPropertiesAsString()

ASCIIDataHandler.getPropertiesFileName
public java.lang.String getPropertiesFileName()

ASCIIDataHandler.getSourceFileName
public java.lang.String getSourceFileName()

ASCIIDataHandler.registerObjectsWithEngine
public void registerObjectsWithEngine()
Function that registers all the tables with ACJEngine.

ASCIIDataHandler.setPropertiesFileName
public void setPropertiesFileName(java.lang.String sPropertiesFile)

Packag e co m.a ctu ate.erep or t.d atasrcmgrs.ascii data src.ASCIIDa taHa nd ler 171
172 e.Repor t Designer API Java Edition
Package

com.actuate.ereport.
Package

datasrcmgrs.ejbdatasrc.
EJBDataHandler

Pa cka ge com.actua te.erepo r t.da tasrcmgrs.e jbda tasrc.EJBDa taHa nd ler 173
Class EJBDataHandler
The class is only in the SWING API. It is not in the AWT API.

java.lang.Object
|
+--com.actuate.ereport.engine.MetadataAdapter
|
+--+--com.actuate.ereport.datasrcmgrs.appdatasrc.AppDataHandler
|
+--com.actuate.ereport.datasrcmgrs.ejbdatasrc.EJBDataHandler
_____________________________________________________________________

All Implemented Interfaces


com.actuate.ereport.engine.IDataSource,
com.actuate.ereport.engine.IMetaData, java.io.Serializable
public class EJBDataHandler
extends AppDataHandler

See also
Serialized objects

Constructor summary
EJBDataHandler()
EJBDataHandler(java.lang.String sRemoteAppJNDIName)

Method summary
Method Description
.addTableDefinition Adds a single remote table entry data set
.addTableData that contains all records for a single table.
EJBDataHandler Adds a single local or remote table entry
.addTableDefinition definition that describes the entire table, its
columns, accessors, and so on.
EJBDataHandler
.clearSchemaAndData()

174 e.Repor t Designer API Java Edition


Method Description
EJBDataHandler Initializes the system by connecting to the
.connectToRemoteApp remote EJB application.
EJBDataHandler
.setContextFactory()
EJBDataHandler Identifies the name of this data source.
.getName() Returns Application DataSource.
EJBDataHandler
.getProperties()
EJBDataHandler Returns the default implementation of the
.getPropertySheet() EJBDataSource property sheet.
EJBDataHandler
.getRemoteAppName()
EJBDataHandler Notifies the system if the EJB data source
.isConnected() connection is active.
EJBDataHandler
.processMsg
EJBDataHandler
.processRemoteMsg
EJBDataHandler An application data source does not
.requiresConnection() require a connection the way a JDBC data
source does. Returns False.
EJBDataHandler Sets the context factory.
.setContextFactory
EJBDataHandler
.setProperties
EJBDataHandler Used internally.
.setTableDefinition

EJBDataHandler constructor

EJBDataHandler
public EJBDataHandler()

Pa cka ge com.actua te.erepo r t.da tasrcmgrs.e jbda tasrc.EJBDa taHa nd ler 175
EJBDataHandler
public EJBDataHandler(java.lang.String sRemoteAppJNDIName)

EJBDataHandler.addTableData
public void addTableData(java.lang.String sT,
java.util.Vector vAllRecords)
throws java.lang.Exception
Adds a single remote table entry data set that contains all records for a single
table.

EJBDataHandler.addTableDefinition
public void addTableDefinition(java.lang.String sT,
java.lang.Class cT,
java.lang.String[] saCA)
throws java.lang.Exception
Adds a single local or remote table entry definition that describes the entire
table, its columns, accessors, and so on.

EJBDataHandler.clearSchemaAndData
public void clearSchemaAndData()

EJBDataHandler.connectToRemoteApp
public void connectToRemoteApp(java.lang.String sRemoteAppJNDIName)
throws java.lang.Exception
Initializes the system by connecting to the remote EJB application.

176 e.Repor t Designer API Java Edition


EJBDataHandler.getContextFactory
public java.lang.String getContextFactory()

EJBDataHandler.getName
public java.lang.String getName()
Identifies the name of this data source. Returns Application DataSource.

Overrides
AppDataHandler.getName

EJBDataHandler.getProperties
public java.util.Hashtable getProperties()

EJBDataHandler.getPropertySheet
public com.actuate.ereport.engine.IPropertySheet getPropertySheet()
Returns the default implementation of the EJBDataSource property sheet.

Overrides
AppDataHandler.getPropertySheet

EJBDataHandler.getRemoteAppName
public java.lang.String getRemoteAppName()

Pa cka ge com.actua te.erepo r t.da tasrcmgrs.e jbda tasrc.EJBDa taHa nd ler 177
EJBDataHandler.isConnected
public boolean isConnected()
throws java.lang.Exception
Notifies the system if the EJB data source connection is active.

Overrides
AppDataHandler.isConnected

EJBDataHandler.processMsg
public java.lang.Object processMsg(int msgID,
java.lang.Object oParams)
throws java.rmi.RemoteException

EJBDataHandler.processRemoteMsg
public java.lang.Object processRemoteMsg(int msgID,
java.lang.Object oParams)
throws java.lang.Exception

EJBDataHandler.requiresConnection
public boolean requiresConnection()
An application data source does not require a connection the way a JDBC data
source does. Returns False.

Overrides
AppDataHandler.requiresConnection

178 e.Repor t Designer API Java Edition


EJBDataHandler.setContextFactory
public void setContextFactory(java.lang.String sContextFactory)
Sets the context factory.

EJBDataHandler.setProperties
public void setProperties(java.util.Hashtable htIC)

EJBDataHandler.setTableDefinition
public void setTableDefinition(java.lang.String sTableName,
java.lang.Class cTableClass,
java.util.Vector vColsDefn)
throws java.lang.Exception

Description copied from class: AppDataHandler


Used internally.

Overrides
AppDataHandler.setTableDefinition

Pa cka ge com.actua te.erepo r t.da tasrcmgrs.e jbda tasrc.EJBDa taHa nd ler 179
180 e.Repor t Designer API Java Edition
Package

com.actuate.ereport.
Package

datasrcmgrs.jdbcdatasrc.
JDBCHandler

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 181
Class JDBCHandler
java.lang.Object
|
+--com.actuate.ereport.engine.MetadataAdapter
|
+--com.actuate.ereport.datasrcmgrs.jdbcdatasrc.JDBCHandler
_____________________________________________________________________

All Implemented Interfaces


com.actuate.ereport.engine.IDataSource,
com.actuate.ereport.engine.IMetaData
public class JDBCHandler
extends com.actuate.ereport.engine.MetadataAdapter
Implements com.actuate.ereport.engine.IDataSource.
This class implements the interface between ACJEngine and any JDBC data
source, such as a relational database.

Field summary
Type Method
static int ALIAS
java.sql.Connection dbconnection
java.sql.Driver driver
java.lang.String DriverName
java.lang.String password
static int SYNONYM
static int SYSTEM
static int TABLE
Original Class Implementation
java.lang.String url
java.lang.String username
static int VIEW

182 e.Repor t Designer API Java Edition


Constructor summary
JDBCHandler()
An empty constructor.

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

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 Description
JDBCHandler Returns a result set containing all data for a
.fetchData specified table and column for iCount objects.
iStart is currently not used and will be
supported in a future version.
JDBCHandler Returns the default catalog associated with
.getCatalogName() the JDBC connection
JDBCHandler Returns a vector with all the column names of
.getColumnNames the table name that is passed to the method.
JDBCHandler
.getConnection()
JDBCHandler
.getCurrentTableSelection()
JDBCHandler Returns the java.sql.Types equivalent data
.getDataType type for the specified column.
JDBCHandler Returns the current debugMode status.
.getDebugMode()
JDBCHandler Returns the default value for the specified
.getDefaultValue fully qualified column.
JDBCHandler Returns the name of the active JDBC driver.
.getDriverName()
JDBCHandler
.getEndRecordNumber()
JDBCHandler Returns the grantee of privileges for the
.getGrantee specified fully qualified column.
JDBCHandler Returns the grantor of privileges for the
.getGrantor specified fully qualified column.
JDBCHandler Returns the identifier quote string for the
.getIdentifierQuote() specified database.
JDBCHandler Returns the name of the data source.
.getName()
JDBCHandler Returns the password for the active JDBC
.getPassword() data source connection.
JDBCHandler Returns a comma-separated list of privileges
.getPrivileges associated with a column.
JDBCHandler Returns an instance of the property sheet.
.getPropertySheet() Used internally.

184 e.Repor t Designer API Java Edition


Method Description
JDBCHandler
.getQuery
JDBCHandler
.getQueryTables
JDBCHandler
.getQueryResult
JDBCHandler
.getQueryTables
JDBCHandler Returns a vector of relations in a string
.getRelations() format; not implemented in JDBCHandler.
JDBCHandler Returns the remarks for the specified fully
.getRemarks qualified column.
JDBCHandler
.getSelectedTables()
JDBCHandler Used internally.
.getSelectiveTableFilter()
JDBCHandler
.getSOImplementation()
JDBCHandler
.getStartRecordNumber()
JDBCHandler Returns a structure containing stored objects.
.getStartRecordNumber()
JDBCHandler Used internally.
.getTable
JDBCHandler
.getTableCount()
JDBCHandler Returns a vector with all the table names
.getTableNames() available from the data source.
JDBCHandler A macro for fetching all tables from the active
.getTables() JDBC source.
JDBCHandler Returns the URL for the JDBC data source.
.getUrl()
JDBCHandler Returns the username for the active JDBC
.getUsername() data source connection.
JDBCHandler Returns True if connected to a JDBC data
.isConnected() 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 Description
JDBCHandler Indicates if this column can be granted
.isGrantable privileges.
JDBCHandler Indicates that this column can have a Null
.isNullable value.
JDBCHandler
.makeSelective()
JDBCHandler
.registerQuery
JDBCHandler Indicates that the JDBC data source requires
.requiresConnection() an active connection to work with.
JDBCHandler Fetches all the requested tables from the
.retrieveTables() active JDBC connection.
JDBCHandler Specifies whether progress or error messages
.setDebugMode are to be displayed in the console window.
JDBCHandler Sets the JDBC driver to the string being
.setDriver passed.
JDBCHandler Specifies that if the table or column has
.setLowercaseQuotes lowercase characters embedded in it, then the
quote identifier is prepended and appended
to it.
JDBCHandler Sets the password to the string being passed.
.setPassword
JDBCHandler Specifies whether the schema name should be
.setPrependSchema prepended to the table name in the FROM
clause, as expected by ORACLE.
JDBCHandler
.setProperties
JDBCHandler
.setResultSetRange
JDBCHandler
.setSelectiveProperties
JDBCHandler Sets the JDBC URL to the string being passed.
.setUrl
JDBCHandler Sets the username to the string being passed.
.setUsername

186 e.Repor t Designer API Java Edition


Method Description
JDBCHandler.
.supportsStoredObjects()
JDBCHandler Specifies a domain of tables to work with.
.useTables 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


JDBCHandler.connect
public void connect()
throws java.lang.Exception
Connects to the JDBC data source using the driver, URL, username, and
password.

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

JDBCHandler.Connect
public boolean Connect(java.sql.Connection c,
boolean extractTables)
Deprecated as of ACJEngine 3.0.

JDBCHandler.connect
public boolean connect(java.sql.Connection c,
boolean extractTables)
Passes an existing connection and specifies whether all tables are to be
extracted.

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
Deprecated as of ACJEngine 3.0.

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 189
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
JDBCHandler.isConnected
public boolean isConnected()
throws java.lang.Exception
Returns True if connected to a JDBC data source; False otherwise.

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

JDBCHandler.isGrantable
public boolean isGrantable(java.lang.String sTable,
java.lang.String sColumn)
throws java.lang.Exception
Indicates whether this column can be granted privileges.

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

JDBCHandler.isNullable
public java.lang.String isNullable(java.lang.String sTable,
java.lang.String sColumn)
throws java.lang.Exception
Indicates that this column can have a Null value.

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

JDBCHandler.makeSelective
public void makeSelective()

200 e.Repor t Designer API Java Edition


JDBCHandler.registerQuery
public void registerQuery(java.lang.Object queryId,
java.lang.String query)
throws java.lang.Exception

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

JDBCHandler.requiresConnection
public boolean requiresConnection()
Indicates that the JDBC data source requires an active connection.

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

JDBCHandler.retrieveTables
public java.util.Vector retrieveTables()
Fetches all the requested tables from the active JDBC connection.

JDBCHandler.setDebugMode
public static void setDebugMode(boolean b)
Specifies whether progress or error messages are to be displayed in the console
window.

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 201
JDBCHandler.setDriver
public void setDriver(java.lang.String d)
Sets the JDBC driver to the string being passed.

JDBCHandler.setLowercaseQuotes
public void setLowercaseQuotes(boolean bLowercaseQuotes)
Specifies that if the table or column has lowercase characters embedded in it,
then the quote identifier is prepended and appended to it.

JDBCHandler.setPassword
public void setPassword(java.lang.String p)
Sets the password to the string being passed.

JDBCHandler.setPrependSchema
public void setPrependSchema(boolean bPrependSchema)
Specifies whether the schema name should be prepended to the table name in
the FROM clause, as expected by ORACLE.

JDBCHandler.setProperties
public void setProperties(java.lang.String sDriver,
java.lang.String sUrl,
java.lang.String sUser,
java.lang.String sPassword)

202 e.Repor t Designer API Java Edition


JDBCHandler.setResultSetRange
public void setResultSetRange(int startRecordNo,
int endRecordNo)

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

JDBCHandler.setSelectiveProperties
public void setSelectiveProperties(int iFilter,
java.util.Vector vTables)

JDBCHandler.setUrl
public void setUrl(java.lang.String u)
Sets the JDBC URL to the string being passed

JDBCHandler.setUsername
public void setUsername(java.lang.String u)
Sets the username to the string being passed.

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

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 203
JDBCHandler.useTables
public void useTables(java.util.Vector v)
Specifies a domain of tables to work with. This method can be used in
conjunction with the connect(...) API when you know which tables you want
to work with in the Template Designer.
Used internally for debugging.

204 e.Repor t Designer API Java Edition


Package

com.actuate.ereport.
Chapter 0

datasrcmgrs.metadatasrc.
MetaDataHandler

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 205
Class MetaDataHandler
java.lang.Object
|
+--com.actuate.ereport.engine.MetadataAdapter
|
+--com.actuate.ereport.datasrcmgrs.metadatasrc.MetaDataHandler
_____________________________________________________________________

All implemented interfaces


com.actuate.ereport.engine.IDataSource,
com.actuate.ereport.engine.IMetaData
public class MetaDataHandler
extends com.actuate.ereport.engine.MetadataAdapter
Implements com.actuate.ereport.engine.IDataSource.
This class implements the MetaData data source. MetaDataSrc is a special type
of data source used for offline reporting, storing relations information, and so
on. The class extends the (@link com.actuate.ereport.engine.MetadataAdapter
MetadataAdapter} and implements IDataSource.

Constructor summary
MetaDataHandler()
The default constructor.

Method summary
Method Description
MetaDataHandler Sequentially adds one table with all
.addTable associated columns to the metadata layer.
Returns True if successful, False if a hashtable
key collision occurs.
MetaDataHandler Removes all tables along with all associated
.clearMetaData() columns from the metadata layer.
MetaDataHandler This method is required to connect to a data
.connect() source. It is not implemented for
MetaDataHandler, however, since
MetaDataHandler does not require an active
data source connection.

206 e.Repor t Designer API Java Edition


Method Description
MetaDataHandler This method is required to disconnect from a
.disconnect() data source. It is not implemented for
MetaDataHandler, however, since
MetaDataHandler does not require an active
data source connection.
MetaDataHandler
.exportAsMetadata
MetaDataHandler This function is reserved for future versions of
.fetchData ACJEngine.
MetaDataHandler Returns the name of the catalog for the data
.getCatalogName() source structure.
MetaDataHandler Returns the names of all columns for a
.getColumnNames specified table.
MetaDataHandler Returns the name of the data source.
.getDatasourceName()
MetaDataHandler Returns the data type for a fully qualified
.getDataType column.
MetaDataHandler Returns the default value for a given column.
.getDefaultValue
MetaDataHandler Returns the grantee of privileges for the
.getGrantee specified column.
MetaDataHandler Returns the grantor of privileges for the
.getGrantor specified column.
MetaDataHandler
.getIdentifierQuote()
MetaDataHandler Returns the data source name as
.getName() MetaDataSource.
MetaDataHandler Returns a comma-separated list of privileges
.getPrivileges for a column.
MetaDataHandler Returns the default implementation of the
.getPropertySheet() metadata property sheet. Used internally.
MetaDataHandler
.getQuery
MetaDataHandler
.getQueryColumns
MetaDataHandler
.getQueryResult

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 207
Method Description
MetaDataHandler
.getQueryTables
MetaDataHandler Returns a vector of all relations in a string
.getRelations() format.
MetaDataHandler Determines whether a column can be granted
.getRemarks privileges.
MetaDataHandler Interface implementation used internally by
.getTable the engine.
MetaDataHandler Returns the names of all tables in the data
.getTableNames() source structure.
MetaDataHandler
.getTableType
MetaDataHandler Specifies whether the metadata information
.isConnected() has been set up by loading from an EMD file.
MetaDataHandler Determines whether a column can be granted
.isGrantable privileges.
MetaDataHandler Specifies whether the given column can have
.isNullable a Null value.
MetaDataHandler Specifies that the metadata has been
.manuallyConstructed() constructed manually.
MetaDataHandler Reads and parses the metadata from an ASCII
.readObject input stream into the metadata data structure.
MetaDataHandler
.registerQuery
MetaDataHandler Always returns False, indicating that
.requiresConnection() MetaDataHandler does not require a
connection.
MetaDataHandler Sets the name of the catalog for the data
.setCatalogName source structure to the specified name.
MetaDataHandler Sets the name of the data source.
.setDatasourceName
MetaDataHandler
.setIdentifierQuote
MetaDataHandler Sets all relations as a vector of strings.
.setRelations

208 e.Repor t Designer API Java Edition


Method Description
MetaDataHandler
.setResultSetRange
MetaDataHandler Writes the metadata from the metadata data
.writeObject structure to an ASCII output stream of the
appropriate format.

MetaDataHandler constructor

MetaDataHandler
public MetaDataHandler()
The default constructor.

MetaDataHandler.addTable
public boolean addTable(com.actuate.ereport.engine.TableDescriptor td,
java.util.Vector vColumns)
Sequentially adds one table with all associated columns to the metadata layer.
Returns True if successful, False if a hashtable key collision occurs.

MetaDataHandler.clearMetaData
public void clearMetaData()
Removes all tables along with all associated columns from the metadata layer.

MetaDataHandler.connect
public void connect()
throws java.lang.Exception

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 209
This method is required to connect to a data source. It is not implemented for
MetaDataHandler, however, since the MetaDataHandler doesn't require an
active data source connection.

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

MetaDataHandler.disconnect
public void disconnect()
throws java.lang.Exception
This method is required to disconnect from a data source. It is not
implemented for MetaDataHandler, however, since the MetaDataHandler
does not require an active data source connection.

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

MetaDataHandler.exportAsMetadata
public static void exportAsMetadata(java.awt.Component cProgress,
com.actuate.ereport.engine.IDataSource ids,
java.io.OutputStream os,
java.util.Vector vR)
throws java.lang.Exception

MetaDataHandler.fetchData
public java.lang.Object fetchData(java.lang.String sTable,
java.lang.String sColumn,
int iStart,
int iCount)
throws java.lang.Exception
This function is reserved for future versions of ACJEngine.

210 e.Repor t Designer API Java Edition


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

MetaDataHandler.getCatalogName
public java.lang.String getCatalogName()
throws java.lang.Exception
Returns the name of the catalog for the data source structure.

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

MetaDataHandler.getColumnNames
public java.util.Vector getColumnNames(java.lang.String sTable)
throws java.lang.Exception
Returns the names of all columns for a specified table.

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

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

MetaDataHandler.getDatasourceName
public java.lang.String getDatasourceName()
Returns the name of the data source.

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 gr s. 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
MetaDataHandler.getDataType
public int getDataType(java.lang.String sTable,
java.lang.String sColumn)
throws java.lang.Exception
Returns the data type for a fully qualified column.

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

MetaDataHandler.getDefaultValue
public java.lang.Object getDefaultValue(java.lang.String sTable,
java.lang.String sColumn)
throws java.lang.Exception
Returns the default value for a given column.

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

MetaDataHandler.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 column.

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

212 e.Repor t Designer API Java Edition


MetaDataHandler.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 column.

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

MetaDataHandler.getIdentifierQuote
public java.lang.String getIdentifierQuote()

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

MetaDataHandler.getName
public java.lang.String getName()
Returns the data source name as MetaDataSource.

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

MetaDataHandler.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 for a column.

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 213
Overrides
getPrivileges in class com.actuate.ereport.engine.MetadataAdapter

MetaDataHandler.getPropertySheet
public com.actuate.ereport.engine.IPropertySheet getPropertySheet()
Returns the default implementation of the metadata property sheet. This
method is used internally.

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

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

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

MetaDataHandler.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

214 e.Repor t Designer API Java Edition


MetaDataHandler.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

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

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

MetaDataHandler.getRelations
public java.util.Vector getRelations()
throws java.lang.Exception
Returns a vector of all relations in a string format. The format for each relation
is: TABLE1.COL1-TABLE2.COL2, RELATIONTYPE.

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

MetaDataHandler.getRemarks
public java.lang.String getRemarks(java.lang.String sTable,
java.lang.String sColumn)
throws java.lang.Exception
Determines whether a column can be granted privileges.

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 215
Overrides
getRemarks in class com.actuate.ereport.engine.MetadataAdapter

MetaDataHandler.getTable
public com.actuate.ereport.engine.ITable getTable(java.util.Hashtable
querycontents,
java.lang.String readers)
throws java.lang.Exception
Interface implementation used internally by the engine.

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

MetaDataHandler.getTableNames
public java.util.Vector getTableNames()
throws java.lang.Exception
Returns the names of all tables in the data source structure.

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

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

MetaDataHandler.getTableType
public java.lang.String getTableType(java.lang.String sTable)
throws java.lang.Exception

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

216 e.Repor t Designer API Java Edition


MetaDataHandler.isConnected
public boolean isConnected()
throws java.lang.Exception
Specifies whether the metadata information has been set up by loading from a
EMD file.

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

MetaDataHandler.isGrantable
public boolean isGrantable(java.lang.String sTable,
java.lang.String sColumn)
throws java.lang.Exception
Determines whether a column can be granted privileges.

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

MetaDataHandler.isNullable
public java.lang.String isNullable(java.lang.String sTable,
java.lang.String sColumn)
throws java.lang.Exception
Specifies whether the given column can have a Null value.

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

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 217
MetaDataHandler.manuallyConstructed
public void manuallyConstructed()
Specifies that the metadata has been constructed manually. Usually, this flag is
internally set when data is loaded from a metadata file.

MetaDataHandler.readObject
public boolean readObject(java.io.InputStream is)
throws java.lang.Exception
Reads and parses the metadata from an ASCII input stream into the metadata
data structure.

MetaDataHandler.registerQuery
public void registerQuery(java.lang.Object queryId,
java.lang.String query)
throws java.lang.Exception

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

MetaDataHandler.requiresConnection
public boolean requiresConnection()
Always returns False, indicating that the MetaDataHandler does not require a
connection.

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

218 e.Repor t Designer API Java Edition


MetaDataHandler.setCatalogName
public void setCatalogName(java.lang.String sCatalog)
Sets the name of the catalog for the data source structure to the specified name.

MetaDataHandler.setDatasourceName
public void setDatasourceName(java.lang.String dsName)

MetaDataHandler.setIdentifierQuote
public void setIdentifierQuote(java.lang.String sQ)

MetaDataHandler.setRelations
public void setRelations(java.util.Vector vR)
Sets all relations as a vector of strings. The format for each relation is:
TABLE1.COL1-TABLE2.COL2, RELATIONTYPE.

MetaDataHandler.setResultSetRange
public void setResultSetRange(int startRecordNo,
int endRecordNo)

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

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 219
MetaDataHandler.writeObject
public void writeObject(com.actuate.ereport.output.ProgressBox pb,
java.io.OutputStream os)
throws java.lang.Exception
Writes the metadata from the metadata data structure to an ASCII output
stream of the appropriate format.
Sets the name of the data source.

220 e.Repor t Designer API Java Edition


Package

com.actuate.ereport.
Chapter 0

output.OD_DHTML

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 221
Class OD_DHTML
java.lang.Object
|
+--com.actuate.ereport.output.OD_HTML
_____________________________________________________________________

All implemented interfaces


com.actuate.ereport.output.IOutputFormat
public class OD_DHTML extends java.lang.Object
implements com.actuate.ereport.output.IOutputFormat
This class is used for generating the output of the report in HTML format. This
class is called from VirtualOutput. It is an implementation of IOutputFormat It
retrieves the list of controls for each page that it recieves from VirtualOutput
and renders them.

Constructor summary
OD_DHTML()
This is an empty constructor that is used for instantiating OD_DHTML using
Class.newInstance()

Method summary
Method Description
OD_DHTML.generate 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
OD_DHTML. Used to generate the main container page for
generateMainFrameSet reports containing TOC.
OD_DHTML. Once the generate method successfully creates
generateReportPage and instantiates the data stream, It calls this
method to handle the formatting and writing of
controls to the output stream
OD_DHTML. Writes the Table Of contents if specified to the Html
generateTOCPage file

222 e.Repor t Designer API Java Edition


Method Description
OD_DHTML.getImage This method is used to fetch individual images
from the report.
OD_DHTML.getImage Similar to getImage(Object, long) except that the
second argument is an Object representing the
index of the image.
OD_DHTML. This method is used to specify the mode of report
setGenerateOnDemand generation and the entity requesting for the
report.

OD_DHTML constructor

OD_DHTML
public OD_DHTML()
This is an empty constructor that is used for instantiatingOD_HTML
OD_DHTML using Class.newInstance()

OD_DHTML.generate
public java.lang.Object generate(com.actuate.ereport.output.VirtualOutput vo,
com.actuate.ereport.output.ProgressInterface pi,
java.util.Properties properties)
throws java.lang.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.

Specified by
generate in interface com.actuate.ereport.output.IOutputFormat

outputDesc
The output destination for html file. The possible values are String,
OutputStream. In case of output stream non indexed report should be
generated.

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 223
vo
The virtual output storage from which data can be extracted.

toc
If true, indexed report will be generated else non indexed report will be
generated. This must be set to false if OutputStream is used as outputDesc.

forceGui
If true, whenever the system needs gui support it will try to locate that support
or create new component as needed.

component
For java 1.x.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.

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.Repor t Designer API Java Edition


OD_DHTML.generateMainFrameSet
public void generateMainFrameSet(java.lang.Object outputDesc)
throws java.lang.Exception
Used to generate the main container page for reports containing TOC. The
main page holds the TOC page and the Report Page.

The
OutputStream to which the report is being written.

Throws
a RuntimeException if there is a problem writing the TOC to the
OutputStream.

OD_DHTML.generateReportPage
public void generateReportPage(java.lang.Object outputDesc)
throws java.lang.Exception
Once the generate method successfully creates and instantiates the data
stream, it calls this method to handle the formatting and writing of controls to
the output stream.

toc - boolean toc


a boolean indicating whether the table of contents is to be displayed or not

Throws
java.lang.Exception throws an Exception if it is unable to write to the output.

OD_DHTML.generateTOCPage
public void generateTOCPage(java.lang.Object outputDesc)
throws java.lang.Exception
Writes the Table Of contents if specified to the Html file

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 225
Throws
java.lang.Exception if the toc cannot be written

OD_DHTML.getImage
public void getImage(java.lang.Object outputDesc, long ptr)
throws java.lang.Exception
This method is used to fetch individual images from the report. The arguments
are the Outputstream and the index of the image. When used in Multiple File
Serving, the images are requested by the browser, and are accordingly fetched.
However this call must only be made after the report has completely been
generated otherwise you get a NullPointerException. Internally calls
getImage(Object, Object)

outputDesc
Output Descriptor. Should be the OutputStream to which the image is to be
written.

ptr
The index of the image in the report.

Throws
a RuntimeException if it cannot write the Image to the OutputStream

OD_DHTML.getImage
public void getImage(java.lang.Object outputDesc,java.lang.Object ptr)
throws java.lang.Exception
Similar to getImage(Object, long) except that the second argument is an Object
representing the index of the image.

OD_DHTML.setGenerateOnDemand
public void setGenerateOnDemand(boolean bServerBased,
java.lang.String sRequestorName)

226 e.Repor t Designer API Java Edition


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, TOC page and images contained
in the report are requested for separately.

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 . 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 .M e t a D a t a H a n d l e r 227
228 e.Repor t Designer API Java Edition
Package

com.actuate.ereport.
Chapter 0

output.OD_HTML

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 229
Class OD_HTML
java.lang.Object
|
+--com.actuate.ereport.output.OD_HTML
_____________________________________________________________________

All implemented interfaces


com.actuate.ereport.output.IOutputFormat
public class OD_HTML extends java.lang.Object
implements com.actuate.ereport.output.IOutputFormat
This class is used for generating the output of the report in HTML format. 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. Just fonts and colors are preserved if required but other
styles such as alignment, size of the control etc. are not preserved as HTML
doesn't have any support for these properties. These have been supported in
PDF & DHTML.

Constructor summary
OD_HTML()
This is an empty constructor that is used for instantiating OD_HTML using
Class.newInstance()

Method summary
Method Description
OD_HTML.generate 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
OD_HTML. Used to generate the main container page for
generateMainFrameSet reports containing TOC
OD_HTML. Once the generate method successfully creates
generateReportPage and instantiates the data stream, It calls this
method to handle the formatting and writing of
controls to the output stream

230 e.Repor t Designer API Java Edition


Method Description
OD_HTML. Writes the Table Of contents if specified to the
generateTOCPage Html file
OD_HTML.getImage This method is used to fetch individual images
from the report.
OD_HTML.getImage Similar to getImage(Object, long) except that the
second argument is an Object representing the
index of the image.
OD_HTML. This method is used to specify the mode of
setGenerateOnDemand report generation and the entity requesting for
the report.

OD_HTML constructor

OD_HTML
public OD_HTML()
This is an empty constructor that is used for instantiating OD_HTML using
Class.newInstance()

OD_HTML.generate
public java.lang.Object generate(com.actuate.ereport.output.VirtualOutput vo,
com.actuate.ereport.output.ProgressInterface pi,
java.util.Properties properties)
throws java.lang.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.

Specified by
generate in interface com.actuate.ereport.output.IOutputFormat

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 231
outputDesc
The output destination for html file. The possible values are String,
OutputStream. In case of output stream non indexed report should be
generated.

vo
The virtual output storage from which data can be extracted.

toc
If true, indexed report will be generated else non indexed report will be
generated. This must be set to false if OutputStream is used as outputDesc.

forceGui
If true, whenever the system needs gui support it will try to locate that support
or create new component as needed.

component
For java 1.x.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.

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.Repor t Designer API Java Edition


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.generateMainFrameSet
public void generateMainFrameSet(java.lang.Object outputDesc)
throws java.lang.Exception
Used to generate the main container page for reports containing TOC. The
main page holds the TOC page and the Report Page.

The
OutputStream to which the report is being written.

Throws
a RuntimeException if there is a problem writing the TOC to the
OutputStream.

OD_HTML.generateReportPage
public void generateReportPage(java.lang.Object outputDesc)
throws java.lang.Exception
Once the generate method successfully creates and instantiates the data
stream, It calls this method to handle the formatting and writing of controls to
the output stream

toc - boolean toc


a boolean indicating whether the table of contents is to be displayed or not

Throws
java.lang.Exception - Throws an Exception if it is unable to write to the output.

OD_HTML.generateTOCPage
public void generateTOCPage(java.lang.Object outputDesc)
throws java.lang.Exception

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 gr s. m e ta d a ta s r c .M e t a D a t a H a n d l e r 233
Writes the Table Of contents if specified to the Html file

Throws
java.lang.Exception - if the toc cannot be written

OD_HTML.getImage
public void getImage(java.lang.Object outputDesc, long ptr)
throws java.lang.Exception
This method is used to fetch individual images from the report. The arguments
are the Outputstream and the index of the image. When used in Multiple File
Serving, the images are requested by the browser, and are accordingly fetched.
However this call must only be made after the report has completely been
generated otherwise you get a NullPointerException. Internally calls
getImage(Object, Object)

outputDesc
Output Descriptor. Should be the OutputStream to which the image is to be
written.

ptr
The index of the image in the report.

Throws
a RuntimeException if it cannot write the Image to the OutputStream

OD_HTML.getImage
public void getImage(java.lang.Object outputDesc, java.lang.Object ptr)
throws java.lang.Exception
Similar to getImage(Object, long) except that the second argument is an Object
representing the index of the image.

234 e.Repor t Designer API Java Edition


OD_HTML.setGenerateOnDemand
public void setGenerateOnDemand(boolean bServerBased,
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, TOC page and images contained
in the report are requested for separately.

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 . 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 .M e t a D a t a H a n d l e r 235
236 e.Repor t Designer API Java Edition
Package

com.actuate.ereport.
Chapter 0

engine.TemplateManager

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 237
Class TemplateManager
java.lang.Object
|
+--com.actuate.ereport.engine.TemplateManager
_____________________________________________________________________
public class TemplateManager
extends java.lang.Object
This is the main class to access the template in ACJEngine. Most aspects of the
template can be controlled using this class. An ACJEngine template has
several logical parts: Section, Zone, Group, Control, and so on. Central to
accessing these parts is a control ID. Each piece of the template has a control ID
that uniquely identifies it within the template. Duplicate control IDs are not
allowed. Most of the methods in this class work a generic object class. You can,
however, pass the control ID within double quotation marks as a string
constant to refer to a particular control.

Field summary
Type Field
com.actuate.ereport.engine tmplMgr
.TmplMgr Used internally

Method summary
Method Description
TemplateManager Changes the control ID specified by the old
.changeID control ID and replaces it with the new ID.
TemplateManager Returns a set of control IDs, section IDs, and
.collapseTemplate zone IDs contained inside the entire template
based on filter criteria specified by boolean
variables.
TemplateManager Attempts to connect to the data source
.connectToDatasource() embedded inside the template.
TemplateManager Creates a generic control and returns a
.createControl handle to it.
TemplateManager Creates a new control with the specified ID
.createControl and the specified parent.

238 e.Repor t Designer API Java Edition


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

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 239
Method Description
TemplateManager Returns the page width in inches.
.getPageWidth()
TemplateManager Returns a list of parameter IDs using which
.getParameterIds() properties can be set or retrieved.
TemplateManager Returns an individual property for the
.getParamProperty specified parameter ID.

TemplateManager Returns a Hashtable with values of SELECT,


.getQueryContents FROM, WHERE and ORDER BY parts of the
sections's query. No corresponding set
function is available because SELECT and
FROM clauses cannot be modified through
the API.
TemplateManager Returns the report's Author property.
.getReportAuthor()
TemplateManager Returns the report's Comments property.
.getReportComments()
TemplateManager Returns the report's Title property.
.getReportTitle()
TemplateManager Returns True if control is set for resizing to fit
.getResizeToFitContents the contents; False otherwise.
TemplateManager Returns the section ID of the section that
.getSectionId contains the specified field.
TemplateManager Returns the width of the template in inches.
.getTemplateWidth()
TemplateManager Returns True if the Wrap Text property of the
.getTextWrap specified control is set; False otherwise.
TemplateManager Returns True if control is set to visible; False
.getVisible otherwise.
TemplateManager Returns the current value of the WHERE
.getWHEREClause clause of the specified section's query.
TemplateManager Indicates that the loaded template contains
.hasEmbeddedDatasource() an embedded data source.
TemplateManager Indicates whether any parameters exist in
.hasParameters() this template which can be resolved.

240 e.Repor t Designer API Java Edition


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

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

242 e.Repor t Designer API Java Edition


Method Description
TemplateManager Sets the WHERE clause of the specified
.setWHEREClause section's query. The new WHERE clause
overwrites the existing WHERE clause.
TemplateManager Sets the height of a zone in inches.
.setZoneHeight

Field detail

tmplMgr
public com.actuate.ereport.engine.TmplMgr tmplMgr
Used internally.

TemplateManager.changeID
public java.lang.String changeID(java.lang.Object OldId,
java.lang.Object NewId)
Changes the old control ID to the new ID.

TemplateManager.collapseTemplate
public java.util.Vector collapseTemplate(boolean IncRpHdr,
boolean IncPgHdr,
boolean IncSections,
boolean IncGrpHdrs,
boolean IncDetail,
boolean IncFields,
boolean IncGrpFtrs,
boolean IncPgFtr,
boolean IncRpFtr)
Returns a set of control IDs, section IDs, and zone IDs contained inside the
entire template based on a filter criteria specified by boolean variables.

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 243
TemplateManager.connectToDatasource
public void connectToDatasource()
throws java.lang.Exception
Attempts to connect to the data source embedded inside the template.

TemplateManager.createControl
public java.lang.Object createControl(java.lang.Object id)
Creates a generic control and returns a handle to it. Users should first create a
generic control and then set its type: data field, label, and so on.

TemplateManager.createControl
public java.lang.Object createControl(java.lang.Object newID,
java.lang.Object parentID)
Creates a new control with specified ID and the specified parent.

TemplateManager.createRuntimeParams
public boolean createRuntimeParams()

TemplateManager.destroyTemplate
public void destroyTemplate()
Use this method to cleanly destroy any template that may be loaded into the
Template Manager.

244 e.Repor t Designer API Java Edition


TemplateManager.getAlignment
public int getAlignment(java.lang.Object Id)
Returns the text alignment property of the control. Possible return values are:
NONE = 0, LEFT = 1, RIGHT = 2, BOTTOM = 8, TOP = 16,
VERTICALCENTER = 32, HORIZONTALCENTER = 64, TOPLEFT (TOP |
LEFT), TOPRIGHT = ( RIGHT | TOP ), TOPCENTER = (
HORIZONTALCENTER | TOP ), BOTTOMLEFT = ( LEFT | BOTTOM ),
BOTTOMRIGHT = ( RIGHT | BOTTOM ), BOTTOMCENTER = (
HORIZONTALCENTER | BOTTOM ), CENTER = ( VERTICALCENTER |
HORIZONTALCENTER ).

TemplateManager.getBounds
public com.actuate.ereport.engine.lib.Bounds getBounds(java.lang.Object Id)
Returns the width and height of a control.

TemplateManager.getDataField
public java.lang.String getDataField(java.lang.Object a)
Returns a string in Table.Column format.

TemplateManager.getFillColor
public java.awt.Color getFillColor(java.lang.Object Id)
Returns the fill/background color of a control.

TemplateManager.getFont
public com.actuate.ereport.common.FontExt getFont(java.lang.Object Id)

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 245
Returns a FontExt object, which is an enhanced class to describe a font.
FontExt not only provides more information than the regular Font class, but is
also designed to provide a Java platform-independent way to deal with fonts.

TemplateManager.getFontColor
public java.awt.Color getFontColor(java.lang.Object Id)
Returns the color used to display the text of this control.

TemplateManager.getFormat
public java.lang.String getFormat(java.lang.Object Id)
Returns a string normally used by Java to define string formatting.

TemplateManager.getFormula
public java.lang.String getFormula(java.lang.Object a)
Returns the formula that has been assigned to the specified control.

TemplateManager.getImageURL
public java.lang.String getImageURL(java.lang.Object Id)
Returns the URL of the image referred to in this control.

TemplateManager.getImportedSQLQuery
public java.lang.String getImportedSQLQuery(java.lang.Object sectionId)
Returns the imported SQL query for the section if already set through
setImportedSQLQuery. Otherwise, returns Null.

246 e.Repor t Designer API Java Edition


TemplateManager.getLabel
public java.lang.String getLabel(java.lang.Object Id)
Returns the string value of this label control.

TemplateManager.getORDERBYClause
public java.lang.String getORDERBYClause(java.lang.Object SectionId)
Returns the current value of the ORDER BY clause of the specified section's
query.

TemplateManager.getPageHeight
public double getPageHeight()
Returns the page height in inches.

TemplateManager.getPageMargins
public com.actuate.ereport.engine.lib.Bounds getPageMargins()
Returns the page margins as a Bounds structure.

See also
Bounds

TemplateManager.getPageWidth
public double getPageWidth()
Returns the page width in inches.

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 247
TemplateManager.getParameterIds
public java.lang.String[] getParameterIds()
Returns a list of parameter IDs using properties that can be set or retrieved.

TemplateManager.getParamProperty
public java.lang.Object getParamProperty(java.lang.String sParamID,
java.lang.String sProperty)
throws java.lang.RuntimeException
Returns an individual property for the specified parameter ID.

sParamID
The ID of the parameter for which a property should be retrieved.

sProperty
The name of the property. Acceptable values are Description, Type, Value, and
Format.

TemplateManager.getQueryContents
public java.util.Hashtable getQueryContents(java.lang.Object sectionId)
throws java.lang.Exception
Returns a hashtable with values of SELECT, FROM, WHERE and ORDER BY
parts of the sections's query. No corresponding set function is available
because SELECT and FROM clauses cannot be modified through the API. For
WHERE and ORDER BY clauses, use TemplateManager.setWHEREClause()
and TemplateManager.setORDERBYClause() respectively.

TemplateManager.getReportAuthor
public java.lang.String getReportAuthor()
Returns the report's Author property.

248 e.Repor t Designer API Java Edition


TemplateManager.getReportComments
public java.lang.String getReportComments()
Returns the report's Comments property.

TemplateManager.getReportTitle
public java.lang.String getReportTitle()
Returns the report's Title property.

TemplateManager.getResizeToFitContents
public boolean getResizeToFitContents(java.lang.Object Id)
Returns True if the control is set for resizing to fit the contents; otherwise,
False. This method is valid only for controls inside the zones.

TemplateManager.getSectionId
public java.lang.String getSectionId(java.lang.Object FieldId)
Returns the section ID of the section that contains the specified field.

TemplateManager.getTemplateWidth
public double getTemplateWidth()
Returns the width of the template in inches.

TemplateManager.getTextWrap
public boolean getTextWrap(java.lang.Object Id)

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 249
Returns True if the wrap text property of specified control is set; False
otherwise.

TemplateManager.getVisible
public boolean getVisible(java.lang.Object Id)
Returns True if the control is set to visible; False otherwise.

TemplateManager.getWHEREClause
public java.lang.String getWHEREClause(java.lang.Object Id)
Returns the current value of the WHERE clause of the specified section's
query.

TemplateManager.hasEmbeddedDatasource
public boolean hasEmbeddedDatasource()
Indicates that the loaded template contains an embedded data source.

TemplateManager.hasParameters
public boolean hasParameters()
Indicates whether any parameters exist in this template that can be resolved.

TemplateManager.isChart
public boolean isChart(java.lang.Object Id)
Returns True if the control specified by the control ID is a chart object; False
otherwise.

250 e.Repor t Designer API Java Edition


TemplateManager.isDataField
public boolean isDataField(java.lang.Object Id)
Returns True if the control specified by the control ID is a data field; False
otherwise.

TemplateManager.isFormula
public boolean isFormula(java.lang.Object Id)
Returns True if the control specified by the control ID is a formula; False
otherwise.

TemplateManager.isImageURL
public boolean isImageURL(java.lang.Object Id)
Returns True if the control specified by the control ID is an image URL; False
otherwise.

TemplateManager.isLabel
public boolean isLabel(java.lang.Object Id)
Returns True if the control specified by the control ID is a label; False
otherwise.

TemplateManager.isLine
public boolean isLine(java.lang.Object Id)
Returns True if the control specified by the control ID is a line; False otherwise.

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 251
TemplateManager.setAlignment
public void setAlignment(java.lang.Object Id,
int val)
Sets the text alignment property of the control. Possible return values are:
NONE = 0, LEFT = 1, RIGHT = 2, BOTTOM = 8, TOP = 16,
VERTICALCENTER = 32, HORIZONTALCENTER = 64, TOPLEFT
(TOP | LEFT), TOPRIGHT = ( RIGHT | TOP ), TOPCENTER =
( HORIZONTALCENTER | TOP ), BOTTOMLEFT = ( LEFT | BOTTOM ),
BOTTOMRIGHT = ( RIGHT | BOTTOM ), BOTTOMCENTER =
( HORIZONTALCENTER | BOTTOM ), and CENTER =
( VERTICALCENTER | HORIZONTALCENTER ).

TemplateManager.setBounds
public void setBounds(java.lang.Object d,
com.actuate.ereport.engine.lib.Bounds rect)
Sets the width and height of a control.

TemplateManager.setDataField
public void setDataField(java.lang.Object FieldId,
java.lang.Object SectionId,
java.lang.String Colname)
Sets the value of a field control.

TemplateManager.setFillColor
public void setFillColor(java.lang.Object Id,
java.awt.Color c)
Sets the fill/background color of a control.

252 e.Repor t Designer API Java Edition


TemplateManager.setFont
public void setFont(java.lang.Object Id,
java.lang.String FontName,
int Style,
int size)
Sets the font used to display the text inside the control. The font name is the
font family: Serif, SansSerif, and so on. Styles include Plain, Bold, and Italic.

TemplateManager.setFontColor
public void setFontColor(java.lang.Object Id,
java.awt.Color c)

TemplateManager.setFormat
public void setFormat(java.lang.Object Id,
java.lang.String format)
Sets a string which is normally used by Java to define string formatting.

TemplateManager.setFormula
public void setFormula(java.lang.Object Id,
java.lang.String formula,
java.lang.Object resetZone)
Sets the formula for a given control.

Id
The identifier of a control.

formula
A formula string.

Rest
Criteria; must be a valid zone contained within the control's section.

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 253
TemplateManager.setImageURL
public void setImageURL(java.lang.Object FieldId,
java.lang.String url)
Sets the URL of the image referred to in this control.

TemplateManager.setImportedSQLQuery
public void setImportedSQLQuery(java.lang.Object sectionId,
java.lang.String query)
Sets the predesigned SQL query to be used by the section. When setting the
query through this API, make sure that the fields used in the template will be
provided in the result set of this query.

TemplateManager.setLabel
public void setLabel(java.lang.Object FieldId,
java.lang.String label)
Sets the value of a label control.

TemplateManager.setORDERBYClause
public void setORDERBYClause(java.lang.Object SectionId,
java.lang.String colssort)
Sets the value of the ORDER BY clause of the specified section's query with
given value.

TemplateManager.setPageHeight
public void setPageHeight(double h)
Sets the page height in inches.

254 e.Repor t Designer API Java Edition


TemplateManager.setPageMargins
public void setPageMargins(com.actuate.ereport.engine.lib.Bounds m)
Sets the left, right, top, 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, double right, double top, double
bottom)
Sets the left, right, top, and bottom margins of the page.

TemplateManager.setPageWidth
public void setPageWidth(double w)
Sets the page width in inches.

TemplateManager.setParamProperty
public void setParamProperty(java.lang.String sParamID,
java.lang.String sProperty,
java.lang.Object oValue)
throws java.lang.RuntimeException
Sets an individual property for the specified parameter ID.

sParamID
The ID of the parameter for which a property is to be set.

sProperty
The names of property acceptable values are: Description, Type, Value, and
Format.

oValue
The value of the property; corresponding acceptable class types are String,
String, and Object.

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 255
TemplateManager.setParamValue
public boolean setParamValue(java.lang.String sName,
java.lang.Object sDefValue)
Sets the value of the parameter specified. Used to bypass the Enter Parameter
Values dialog box and instead specify parameter values through the API.

TemplateManager.setReportAuthor
public void setReportAuthor(java.lang.String sAuthor)
Sets the report's Author property.

TemplateManager.setReportComments
public void setReportComments(java.lang.String sComments)
Sets the report's Comments property.

TemplateManager.setReportTitle
public void setReportTitle(java.lang.String sTitle)
Sets the report's Title property.

TemplateManager.setResizeToFitContents
public void setResizeToFitContents(java.lang.Object Id,
boolean val)
Allows the control to resize vertically when set to True. Default value is False.
This value can be set only for controls inside the zones.

256 e.Repor t Designer API Java Edition


TemplateManager.setTextWrap
public void setTextWrap(java.lang.Object Id,
boolean val)
Sets the Word Wrap property of the specified control if True is passed; unsets it
if False is passed.

TemplateManager.setUnitType
public void setUnitType(java.lang.String sUnits)
Sets the measurement units to be used.

TemplateManager.setVisible
public void setVisible(java.lang.Object Id,
boolean val)
Sets the control's visibility as specified.

TemplateManager.setWallpaper
public void setWallpaper(java.lang.String URL,
double leftOffset,
double topOffset)
Used to set the wallpaper at a specified location.

URL
The file URL for the watermark image.
Double leftOffset is the left offset, from the margin, for the watermark double.
TopOffset is the top offset, from the margin, for the watermark.

TemplateManager.setWallpaper
public void setWallpaper(java.lang.String URL)
Used to set the wallpaper which is tiled.

P a c k a g e c o m . a c t u a t e . e r e p o r t . e n g i n e . Te m p l a t e M a n a g e r 257
URL
The file URL for the wallpaper image.

TemplateManager.setWHEREClause
public void setWHEREClause(java.lang.Object Id,
java.lang.String filterexpr)
Sets the WHERE clause of the specified section's query. The new WHERE
clause overwrites the existing WHERE clause.

TemplateManager.setZoneHeight
public void setZoneHeight(java.lang.Object Id,
double h)
Sets the height of a zone in inches.

258 e.Repor t Designer API Java Edition


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

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

260 e.Repor t Designer API Java Edition


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

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

262 e.Repor t Designer API Java Edition


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

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

264 e.Repor t Designer API Java Edition


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

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

266 e.Repor t Designer API Java Edition


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

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

268 e.Repor t Designer API Java Edition


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

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

270 e.Repor t Designer API Java Edition


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

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

272 e.Repor t Designer API Java Edition


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

Index 273
274 e.Repor t Designer API Java Edition