org.opengts.war.report
Class ReportData

java.lang.Object
  org.opengts.war.report.ReportData

Direct Known Subclasses:

AccountReport, AntxDailyReport, AntxDayDetailReport, AntxDayValueSummaryReport, AuditReport, DailySummaryReport, DeviceReport, DiagnosticReport, DigitalIOReport, DriverReport, EntityReport, EventCountReport, EventDetailReport, EventSummaryReport, FuelSummaryReport, GeozoneDepartReport, GeozoneReport, MotionReport, NearbyDevicesReport, PropertyReport, SessionStatusReport, TripReport, UnassignedDevicesReport

public abstract class ReportData
extends java.lang.Object

Nested Class Summary

class	ReportData.ArrayDataIterator This is an implementation of DBDataIterator that iterates through an array of row objects
protected class	ReportData.ListDataIterator This is an implementation of DBDataIterator that iterates through an array of row objects

Field Summary

static ReportLayout.AgeColorRange[]	CheckinAgeColorRangeDefault
static ReportLayout.AgeColorRange[]	CreationAgeColorRangeDefault
static java.lang.String	FORMAT_GRAPH
static java.lang.String	FORMAT_KML
static java.lang.String	FORMAT_MAP
static java.lang.String	FORMAT_PDF
static ReportLayout.AgeColorRange[]	GpsAgeColorRangeDefault
static ReportLayout.AgeColorRange[]	LoginAgeColorRangeDefault

Constructor Summary

ReportData(ReportEntry rptEntry, RequestProperties reqState, ReportDeviceList devList)
Constructor

ReportData(ReportFactory rptFact, RequestProperties reqState, Account acct, User user, ReportDeviceList devList)

Method Summary

protected long	_countEventData(Device deviceDB, long timeStart, long timeEnd) Returns the count of EventData records based on the EventData constraints
protected EventData[]	_getEventData(Device deviceDB, DBRecordHandler<EventData> rcdHandler) Returns an array EventData records for the specified Device
protected EventData[]	_getEventData(Device deviceDB, long timeStart, long timeEnd, DBRecordHandler<EventData> rcdHandler) Returns an array EventData records for the specified Device
protected long	countEventData(Device deviceDB) Returns the count of EventData records based on the EventData constraints
protected long	countEventData(Device deviceDB, long timeStart, long timeEnd) Returns the count of EventData records based on the EventData constraints
java.lang.String	expandHeaderText(java.lang.String text) Replaces ${key} fields with the representative text
Account	getAccount() Gets the current Account
java.lang.String	getAccountID() Gets the current Account-ID
URIArg	getAutoReportURL() Get the auto report URL
abstract DBDataIterator	getBodyDataIterator() Gets the details data interator for this report. The subclass of this object must implement this method. For simple EventData record data, this method could simply return: new ArrayDataIterator(this.getEventData());
ReportLayout.AgeColorRange	getCheckinAgeColorRange(long age) Gets the check-in age color for the specified age
ReportLayout.AgeColorRange[]	getCheckinAgeColorRangeArray() Gets the check-in age color range array
int	getColumnCount() Gets the report column count
ReportLayout.AgeColorRange	getCreationAgeColorRange(long age) Gets the creation age color for the specified age
ReportLayout.AgeColorRange[]	getCreationAgeColorRangeArray() Gets the creation age color range array
DataRowTemplate	getDataRowTemplate() Gets the DataRowTemplate instance
Device	getDevice(java.lang.String deviceID) Gets the Device instance for the specified ID
int	getDeviceCount() Gets the device list size
protected EventData[]	getEventData(DBRecordHandler<EventData> rcdHandler) Returns an array EventData records based on the predefined ReportDeviceList and constraints
protected EventData[]	getEventData(Device deviceDB, DBRecordHandler<EventData> rcdHandler) Returns an array EventData records for the specified Device
protected EventData[]	getEventData(Device deviceDB, long timeStart, long timeEnd, DBRecordHandler<EventData> rcdHandler) Returns an array EventData records for the specified Device
long	getEventDataCount() Returns the actual counted EventData records from the last query (including all devices)
DBDataIterator	getEventDataIterator() Creates and returns an iterator over the EventData records based on the defined selection criteria
long	getEventMatchCount() Returns the number of EventData records matched by "isEventDataMatch()", or the rule selector.
java.lang.String	getFirstDeviceID() Gets the first device id in the list
ReportLayout.AgeColorRange	getGpsAgeColorRange(long age) Gets the GPS age color for the specified age
ReportLayout.AgeColorRange[]	getGpsAgeColorRangeArray() Gets the GPS age color range array
URIArg	getGraphImageURL() Sets the Graph image URL (OBSOLETE)
java.lang.String	getGraphLinkDescription() Gets the Graph link description (if any)
MapDimension	getGraphWindowSize() Gets the Graph window size
java.lang.String	getKmlLinkDescription() Gets the Google KML link description
URIArg	getKmlURL() Gets the Google KML URL
java.util.Locale	getLocale() Gets the current PrivateLabel Locale
ReportLayout.AgeColorRange	getLoginAgeColorRange(long age) Gets the log-in age color for the specified age
ReportLayout.AgeColorRange[]	getLoginAgeColorRangeArray() Gets the log-in age color range array
java.lang.String	getMapIconSelector() Gets the map icon selector
java.lang.String	getMapLinkDescription() Gets the Map link description
URIArg	getMapURL() Gets the Map URL
MapDimension	getMapWindowSize() Gets the Map window size
long	getMaximumEventDataCount() Return the largest counted EventData records from the last query for a single device
boolean	getOrderAscending() Returns true if the data records are to be in ascending order
java.lang.String	getPreferredFormat() Gets the preferred report format
PrivateLabel	getPrivateLabel() Gets the current PrivateLabel instance
RTProperties	getProperties() Returns the ReportFactory properties
URIArg	getRefreshURL() Gets the report refresh URL
ReportCallback	getReportCallback() Gets the ReportCallback instance (if specified)
ReportColumn[]	getReportColumns() Gets the report columns
ReportConstraints	getReportConstraints() Gets the ReportConstraints for this report
boolean	getReportDataFieldsEnabled() Return true if report data fields should be enabled. Report data fields are those that are calculated as the report is generated.
ReportDeviceList	getReportDeviceList() Gets the device list
ReportEntry	getReportEntry() Returns the report entry which created this report
ReportFactory	getReportFactory() Returns the report factory which ctreated this report
ReportHeaderGroup	getReportHeaderGroup(int col) Sets the report header group at the specified column
ReportHeaderGroup[]	getReportHeaderGroups() Gets the report header groups
boolean	getReportIsPartial() Returns true if the actual number of report records would have exceeded the maximum nuber of allowed report records, indicating that this report contains only partial data.
java.lang.Object	getReportJob() Gets the ReportJob for this report (if any)
abstract ReportLayout	getReportLayout() Gets the report layout
long	getReportLimit() Returns the report limit constraint.
java.lang.String	getReportName() Gets the name of this report
ReportOption	getReportOption() Gets the report options
int	getReportRecordCount() Gets the report record count
java.lang.String	getReportSubtitle() Gets the report sub-title
java.lang.String	getReportTitle() Gets the report title
java.lang.String	getReportType() Gets the report type
RequestProperties	getRequestProperties() Gets the current RequestProperties instance
java.lang.String	getRuleSelector() Returns the 'rule' selector constraint
long	getSelectionLimit() Returns the selection limit constraint.
EventData.LimitType	getSelectionLimitType() Returns the selection limit type constraint
int[]	getStatusCodes() Returns the status codes constraint
boolean	getSupportsGraphDisplay() Returns true if this report supports displaying a graph
boolean	getSupportsKmlDisplay() Returns true if this report supports displaying KML
boolean	getSupportsMapDisplay() Returns true if this report supports displaying a map
long	getTimeEnd() Returns the time end constraint
long	getTimeStart() Returns the time start constraint
java.util.TimeZone	getTimeZone() Gets the selected TimeZone
java.lang.String	getTimeZoneString() Gets the selected TimeZone as a String
abstract DBDataIterator	getTotalsDataIterator() Gets the totals data interator for this report. The subclass of this object must implement this method. For simple EventData record data, this method may simply return null.
User	getUser() Gets the current User
java.lang.String	getUserID() Gets the current User-ID
boolean	getValidGPSRequired() Returns the "valid GPS required" constraint
java.lang.String	getWhereSelector() Returns the 'WHERE' selector constraint
boolean	hasReportColumn(java.lang.String name) Returns true if this report has the named column
boolean	hasReportJob() Returns true if this instance defines a ReportJob
boolean	hasReportOption() Returns true if this report has report options
protected boolean	isEventDataMatch(EventData ev) Callback for each EventData record selected.
boolean	isSingleDeviceOnly() Returns true if this report handles only a single device at a time
boolean	isSoapRequest() Returns true if this is a "SOAP" request
void	postInitialize() This method is called after all other ReportConstraints have been set.
void	setAutoReportURL(URIArg autoReportURL) Set the auto report URL
void	setGraphImageURL(URIArg graphURL) Sets the Graph image URL
void	setKmlURL(URIArg kmlURL) Sets the Google KML URL
void	setMapIconSelector(java.lang.String iconSel) Sets the map icon selector
void	setMapURL(URIArg mapURL) Sets the Map URL
void	setPreferredFormat(java.lang.String format) Sets the preferred report format
void	setRefreshURL(URIArg refreshURL) Sets the report refresh URL
void	setReportCallback(ReportCallback rptCB) Sets the ReportCallback instance
void	setReportColumns(ReportColumn[] columns) Sets the report columns
void	setReportConstraints(ReportConstraints rc) Sets the ReportConstraints for this report
protected void	setReportDeviceList(ReportDeviceList devList) Sets the device list
void	setReportHeaderGroups(ReportHeaderGroup[] rhg) Sets the report header groups
void	setReportJob(java.lang.Object rj) Sets the ReportJob for this report (if any)
void	setReportName(java.lang.String name) Sets the name of this report
void	setReportOption(ReportOption rptOpt) Sets the report options
void	setReportRecordCount(int count, boolean isPartial) Sets the report record count
void	setReportSubtitle(java.lang.String title) Sets the report sub-title
void	setReportTitle(java.lang.String title) Sets the report title
boolean	showMapRouteLine(boolean isFleet) Returns true if the map route-line is to be displayed, false otherwise
void	writeHtmlBody(java.io.PrintWriter pw, RequestProperties reqState) Writes the report html body content
void	writeJavaScript(java.io.PrintWriter pw, RequestProperties reqState) Writes any required report JavaScript
int	writeReport(java.lang.String format, OutputProvider out) Writes the report
int	writeReport(java.lang.String format, OutputProvider out, int indentLevel) Writes the report
void	writeReportStyle(java.lang.String format, OutputProvider out) Writes report style attributes

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_MAP

public static final java.lang.String FORMAT_MAP

See Also:

Constant Field Values

FORMAT_KML

public static final java.lang.String FORMAT_KML

See Also:

Constant Field Values

FORMAT_PDF

public static final java.lang.String FORMAT_PDF

See Also:

Constant Field Values

FORMAT_GRAPH

public static final java.lang.String FORMAT_GRAPH

See Also:

Constant Field Values

GpsAgeColorRangeDefault

public static final ReportLayout.AgeColorRange[] GpsAgeColorRangeDefault

CreationAgeColorRangeDefault

public static final ReportLayout.AgeColorRange[] CreationAgeColorRangeDefault

CheckinAgeColorRangeDefault

public static final ReportLayout.AgeColorRange[] CheckinAgeColorRangeDefault

LoginAgeColorRangeDefault

public static final ReportLayout.AgeColorRange[] LoginAgeColorRangeDefault

Constructor Detail

ReportData

public ReportData(ReportFactory rptFact,
                  RequestProperties reqState,
                  Account acct,
                  User user,
                  ReportDeviceList devList)
           throws ReportException

Throws:

ReportException

ReportData

public ReportData(ReportEntry rptEntry,
                  RequestProperties reqState,
                  ReportDeviceList devList)
           throws ReportException

Constructor

Throws:

ReportException

Method Detail

hasReportJob

public boolean hasReportJob()

Returns true if this instance defines a ReportJob

getReportJob

public java.lang.Object getReportJob()

Gets the ReportJob for this report (if any)

setReportJob

public void setReportJob(java.lang.Object rj)

Sets the ReportJob for this report (if any)

getReportEntry

public ReportEntry getReportEntry()

Returns the report entry which created this report

getReportFactory

public ReportFactory getReportFactory()

Returns the report factory which ctreated this report

getProperties

public RTProperties getProperties()

Returns the ReportFactory properties

setReportName

public void setReportName(java.lang.String name)

Sets the name of this report

getReportName

public java.lang.String getReportName()

Gets the name of this report

getReportType

public java.lang.String getReportType()

Gets the report type

setReportTitle

public void setReportTitle(java.lang.String title)

Sets the report title

getReportTitle

public java.lang.String getReportTitle()

Gets the report title

setReportSubtitle

public void setReportSubtitle(java.lang.String title)

Sets the report sub-title

getReportSubtitle

public java.lang.String getReportSubtitle()

Gets the report sub-title

expandHeaderText

public java.lang.String expandHeaderText(java.lang.String text)

Replaces ${key} fields with the representative text

getRequestProperties

public RequestProperties getRequestProperties()

Gets the current RequestProperties instance

isSoapRequest

public boolean isSoapRequest()

Returns true if this is a "SOAP" request

getTimeZone

public java.util.TimeZone getTimeZone()

Gets the selected TimeZone

getTimeZoneString

public java.lang.String getTimeZoneString()

Gets the selected TimeZone as a String

getPrivateLabel

public PrivateLabel getPrivateLabel()

Gets the current PrivateLabel instance

getLocale

public java.util.Locale getLocale()

Gets the current PrivateLabel Locale

setMapIconSelector

public void setMapIconSelector(java.lang.String iconSel)

Sets the map icon selector

getMapIconSelector

public java.lang.String getMapIconSelector()

Gets the map icon selector

getAccount

public Account getAccount()

Gets the current Account

getAccountID

public java.lang.String getAccountID()

Gets the current Account-ID

getUser

public User getUser()

Gets the current User

getUserID

public java.lang.String getUserID()

Gets the current User-ID

getPreferredFormat

public java.lang.String getPreferredFormat()

Gets the preferred report format

setPreferredFormat

public void setPreferredFormat(java.lang.String format)

Sets the preferred report format

isSingleDeviceOnly

public boolean isSingleDeviceOnly()

Returns true if this report handles only a single device at a time

Returns:

True If this report handles only a single device at a time

setReportDeviceList

protected void setReportDeviceList(ReportDeviceList devList)
                            throws ReportException

Sets the device list

Throws:

ReportException

getReportDeviceList

public ReportDeviceList getReportDeviceList()

Gets the device list

getDeviceCount

public int getDeviceCount()

Gets the device list size

getFirstDeviceID

public java.lang.String getFirstDeviceID()

Gets the first device id in the list

getDevice

public Device getDevice(java.lang.String deviceID)
                 throws DBException

Gets the Device instance for the specified ID

Throws:

DBException

setReportHeaderGroups

public void setReportHeaderGroups(ReportHeaderGroup[] rhg)

Sets the report header groups

getReportHeaderGroups

public ReportHeaderGroup[] getReportHeaderGroups()

Gets the report header groups

getReportHeaderGroup

public ReportHeaderGroup getReportHeaderGroup(int col)

Sets the report header group at the specified column

setReportColumns

public void setReportColumns(ReportColumn[] columns)

Sets the report columns

getReportColumns

public ReportColumn[] getReportColumns()

Gets the report columns

getColumnCount

public int getColumnCount()

Gets the report column count

hasReportColumn

public boolean hasReportColumn(java.lang.String name)

Returns true if this report has the named column

hasReportOption

public boolean hasReportOption()

Returns true if this report has report options

getReportOption

public ReportOption getReportOption()

Gets the report options

setReportOption

public void setReportOption(ReportOption rptOpt)

Sets the report options

setReportConstraints

public void setReportConstraints(ReportConstraints rc)

Sets the ReportConstraints for this report

Parameters:

rc - The ReportConstraints

getReportConstraints

public ReportConstraints getReportConstraints()

Gets the ReportConstraints for this report

Returns:

The ReportConstraints

getReportDataFieldsEnabled

public boolean getReportDataFieldsEnabled()

Return true if report data fields should be enabled.
Report data fields are those that are calculated as the report is generated. (not used by all report types).

Returns:

True if the report data fields should be enabled

getGpsAgeColorRangeArray

public ReportLayout.AgeColorRange[] getGpsAgeColorRangeArray()

Gets the GPS age color range array

getGpsAgeColorRange

public ReportLayout.AgeColorRange getGpsAgeColorRange(long age)

Gets the GPS age color for the specified age

getCreationAgeColorRangeArray

public ReportLayout.AgeColorRange[] getCreationAgeColorRangeArray()

Gets the creation age color range array

getCreationAgeColorRange

public ReportLayout.AgeColorRange getCreationAgeColorRange(long age)

Gets the creation age color for the specified age

getCheckinAgeColorRangeArray

public ReportLayout.AgeColorRange[] getCheckinAgeColorRangeArray()

Gets the check-in age color range array

getCheckinAgeColorRange

public ReportLayout.AgeColorRange getCheckinAgeColorRange(long age)

Gets the check-in age color for the specified age

getLoginAgeColorRangeArray

public ReportLayout.AgeColorRange[] getLoginAgeColorRangeArray()

Gets the log-in age color range array

getLoginAgeColorRange

public ReportLayout.AgeColorRange getLoginAgeColorRange(long age)

Gets the log-in age color for the specified age

getRuleSelector

public java.lang.String getRuleSelector()

Returns the 'rule' selector constraint

Returns:

The 'rule' selector constraint

getWhereSelector

public java.lang.String getWhereSelector()

Returns the 'WHERE' selector constraint

Returns:

The 'WHERE' selector constraint

getSelectionLimitType

public EventData.LimitType getSelectionLimitType()

Returns the selection limit type constraint

Returns:

The selection limit type constraint

getSelectionLimit

public long getSelectionLimit()

Returns the selection limit constraint.

Returns:

The selection limit constraint

getReportLimit

public long getReportLimit()

Returns the report limit constraint.

Returns:

The report limit constraint

getTimeStart

public long getTimeStart()

Returns the time start constraint

Returns:

The time start constraint

getTimeEnd

public long getTimeEnd()

Returns the time end constraint

Returns:

The time end constraint

getValidGPSRequired

public boolean getValidGPSRequired()

Returns the "valid GPS required" constraint

Returns:

The "valid GPS required" constraint

getStatusCodes

public int[] getStatusCodes()

Returns the status codes constraint

Returns:

The status codes constraint

getOrderAscending

public boolean getOrderAscending()

Returns true if the data records are to be in ascending order

Returns:

True if the data records are to be in ascending order

getReportCallback

public ReportCallback getReportCallback()

Gets the ReportCallback instance (if specified)

Returns:

The ReportCallback instance, or null if not set

setReportCallback

public void setReportCallback(ReportCallback rptCB)
                       throws ReportException

Sets the ReportCallback instance

Parameters:

rptCB - The ReportCallback instance

Throws:

ReportException

getEventDataIterator

public DBDataIterator getEventDataIterator()

Creates and returns an iterator over the EventData records based on the defined selection criteria

Returns:

The EventData row data iterator

getEventData

protected EventData[] getEventData(DBRecordHandler<EventData> rcdHandler)

Returns an array EventData records based on the predefined ReportDeviceList and constraints

Parameters:

rcdHandler - The callback DBRecordHandler. If specified, the returned EventData array may be null.

Returns:

An array of EventData records for the device (may be null if a callback DBRecordHandler has been specified).

getEventData

protected EventData[] getEventData(Device deviceDB,
                                   DBRecordHandler<EventData> rcdHandler)

Returns an array EventData records for the specified Device

Parameters:

deviceDB - The Device for which EventData records will be selected

rcdHandler - The callback DBRecordHandler. If specified, the returned EventData array may be null.

Returns:

An array of EventData records for the device (may be null if a callback DBRecordHandler has been specified).

getEventData

protected EventData[] getEventData(Device deviceDB,
                                   long timeStart,
                                   long timeEnd,
                                   DBRecordHandler<EventData> rcdHandler)

Returns an array EventData records for the specified Device

Parameters:

deviceDB - The Device for which EventData records will be selected

timeStart - The Start time

timeEnd - The End time

rcdHandler - The callback DBRecordHandler. If specified, the returned EventData array may be null.

Returns:

An array of EventData records for the device (may be null if a callback DBRecordHandler has been specified).

isEventDataMatch

protected boolean isEventDataMatch(EventData ev)

Callback for each EventData record selected. This method can be overridden by the subclass to allow for additional criteria selection.

Parameters:

ev - The current EventData record to test

Returns:

True to accept record, false to skip record

_getEventData

protected EventData[] _getEventData(Device deviceDB,
                                    DBRecordHandler<EventData> rcdHandler)

Returns an array EventData records for the specified Device

Parameters:

deviceDB - The Device for which EventData records will be selected

rcdHandler - The callback DBRecordHandler. If specified, the returned EventData array may be null.

Returns:

An array of EventData records for the device (may be null if a callback DBRecordHandler has been specified).

_getEventData

protected EventData[] _getEventData(Device deviceDB,
                                    long timeStart,
                                    long timeEnd,
                                    DBRecordHandler<EventData> rcdHandler)

Returns an array EventData records for the specified Device

Parameters:

deviceDB - The Device for which EventData records will be selected

rcdHandler - The callback DBRecordHandler. If specified, the returned EventData array may be null.

Returns:

An array of EventData records for the device (may be null if a callback DBRecordHandler has been specified).

getEventDataCount

public long getEventDataCount()

Returns the actual counted EventData records from the last query (including all devices)

getEventMatchCount

public long getEventMatchCount()

Returns the number of EventData records matched by "isEventDataMatch()", or the rule selector.

getMaximumEventDataCount

public long getMaximumEventDataCount()

Return the largest counted EventData records from the last query for a single device

countEventData

protected long countEventData(Device deviceDB)

Returns the count of EventData records based on the EventData constraints

countEventData

protected long countEventData(Device deviceDB,
                              long timeStart,
                              long timeEnd)

Returns the count of EventData records based on the EventData constraints

_countEventData

protected long _countEventData(Device deviceDB,
                               long timeStart,
                               long timeEnd)

Returns the count of EventData records based on the EventData constraints

setReportRecordCount

public void setReportRecordCount(int count,
                                 boolean isPartial)

Sets the report record count

getReportRecordCount

public int getReportRecordCount()

Gets the report record count

getReportIsPartial

public boolean getReportIsPartial()

Returns true if the actual number of report records would have exceeded the maximum nuber of allowed report records, indicating that this report contains only partial data.

setAutoReportURL

public void setAutoReportURL(URIArg autoReportURL)

Set the auto report URL

getAutoReportURL

public URIArg getAutoReportURL()

Get the auto report URL

getSupportsGraphDisplay

public boolean getSupportsGraphDisplay()

Returns true if this report supports displaying a graph

Returns:

True if this report supports displaying a graph, false otherwise

writeJavaScript

public void writeJavaScript(java.io.PrintWriter pw,
                            RequestProperties reqState)
                     throws java.io.IOException

Writes any required report JavaScript

Throws:

java.io.IOException

writeHtmlBody

public void writeHtmlBody(java.io.PrintWriter pw,
                          RequestProperties reqState)
                   throws java.io.IOException

Writes the report html body content

Throws:

java.io.IOException

getGraphLinkDescription

public java.lang.String getGraphLinkDescription()

Gets the Graph link description (if any)

getGraphWindowSize

public MapDimension getGraphWindowSize()

Gets the Graph window size

setGraphImageURL

public void setGraphImageURL(URIArg graphURL)

Sets the Graph image URL

getGraphImageURL

public URIArg getGraphImageURL()

Sets the Graph image URL (OBSOLETE)

getSupportsMapDisplay

public boolean getSupportsMapDisplay()

Returns true if this report supports displaying a map

Returns:

True if this report supports displaying a map, false otherwise

showMapRouteLine

public boolean showMapRouteLine(boolean isFleet)

Returns true if the map route-line is to be displayed, false otherwise

Parameters:

isFleet - True if this maps represents a Group/Fleet of devices

setMapURL

public void setMapURL(URIArg mapURL)

Sets the Map URL

getMapURL

public URIArg getMapURL()

Gets the Map URL

getMapLinkDescription

public java.lang.String getMapLinkDescription()

Gets the Map link description

getMapWindowSize

public MapDimension getMapWindowSize()

Gets the Map window size

getSupportsKmlDisplay

public boolean getSupportsKmlDisplay()

Returns true if this report supports displaying KML

Returns:

True if this report supports displaying KML, false otherwise

setKmlURL

public void setKmlURL(URIArg kmlURL)

Sets the Google KML URL

getKmlURL

public URIArg getKmlURL()

Gets the Google KML URL

getKmlLinkDescription

public java.lang.String getKmlLinkDescription()

Gets the Google KML link description

setRefreshURL

public void setRefreshURL(URIArg refreshURL)

Sets the report refresh URL

getRefreshURL

public URIArg getRefreshURL()

Gets the report refresh URL

postInitialize

public void postInitialize()

This method is called after all other ReportConstraints have been set. The report has this opportunity to make any changes to the ReportConstraints before the report is actually generated

getReportLayout

public abstract ReportLayout getReportLayout()

Gets the report layout

getDataRowTemplate

public DataRowTemplate getDataRowTemplate()

Gets the DataRowTemplate instance

writeReportStyle

public void writeReportStyle(java.lang.String format,
                             OutputProvider out)
                      throws ReportException

Writes report style attributes

Throws:

ReportException

writeReport

public int writeReport(java.lang.String format,
                       OutputProvider out)
                throws ReportException

Writes the report

Throws:

ReportException

writeReport

public int writeReport(java.lang.String format,
                       OutputProvider out,
                       int indentLevel)
                throws ReportException

Writes the report

Throws:

ReportException

getBodyDataIterator

public abstract DBDataIterator getBodyDataIterator()

Gets the details data interator for this report.
The subclass of this object must implement this method.
For simple EventData record data, this method could simply return:
new ArrayDataIterator(this.getEventData());

getTotalsDataIterator

public abstract DBDataIterator getTotalsDataIterator()

Gets the totals data interator for this report.
The subclass of this object must implement this method.
For simple EventData record data, this method may simply return null.