org.opengts.extra.war.report.entity
Class EntityReport

java.lang.Object
  org.opengts.war.report.ReportData
      org.opengts.extra.war.report.entity.EntityReport

All Implemented Interfaces:

DBRecordHandler<Entity>

public class EntityReport
extends ReportData
implements DBRecordHandler<Entity>

Nested Class Summary

Nested classes/interfaces inherited from class org.opengts.war.report.ReportData

ReportData.ArrayDataIterator, ReportData.ListDataIterator

Field Summary

Fields inherited from class org.opengts.war.report.ReportData

CheckinAgeColorRangeDefault, CreationAgeColorRangeDefault, FORMAT_GRAPH, FORMAT_KML, FORMAT_MAP, FORMAT_PDF, GpsAgeColorRangeDefault, LoginAgeColorRangeDefault

Fields inherited from interface org.opengts.dbtools.DBRecordHandler

DBRH_SAVE, DBRH_SAVE_LAST, DBRH_SAVE_LAST_STOP, DBRH_SAVE_STOP, DBRH_SKIP, DBRH_STOP

Constructor Summary

EntityReport(ReportEntry rptEntry, RequestProperties reqState, ReportDeviceList devList)

Method Summary

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());
java.lang.String	getPushpinID()
ReportLayout	getReportLayout() Gets the bound ReportLayout singleton instance for this report
static ReportLayout	GetReportLayout() Gets the bound ReportLayout singleton instance for this report
int	getStatusCode()
boolean	getSupportsKmlDisplay() Returns true if this report supports displaying KML
boolean	getSupportsMapDisplay() Returns true if this report supports displaying a map
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.
int	handleDBRecord(Entity rcd) Callback handler for DBRecords retrieved from a database select
void	postInitialize() This method is called after all other ReportConstraints have been set.

Methods inherited from class org.opengts.war.report.ReportData

_countEventData, _getEventData, _getEventData, countEventData, countEventData, expandHeaderText, getAccount, getAccountID, getAutoReportURL, getCheckinAgeColorRange, getCheckinAgeColorRangeArray, getColumnCount, getCreationAgeColorRange, getCreationAgeColorRangeArray, getDataRowTemplate, getDevice, getDeviceCount, getEventData, getEventData, getEventData, getEventDataCount, getEventDataIterator, getEventMatchCount, getFirstDeviceID, getGpsAgeColorRange, getGpsAgeColorRangeArray, getGraphImageURL, getGraphLinkDescription, getGraphWindowSize, getKmlLinkDescription, getKmlURL, getLocale, getLoginAgeColorRange, getLoginAgeColorRangeArray, getMapIconSelector, getMapLinkDescription, getMapURL, getMapWindowSize, getMaximumEventDataCount, getOrderAscending, getPreferredFormat, getPrivateLabel, getProperties, getRefreshURL, getReportCallback, getReportColumns, getReportConstraints, getReportDataFieldsEnabled, getReportDeviceList, getReportEntry, getReportFactory, getReportHeaderGroup, getReportHeaderGroups, getReportIsPartial, getReportJob, getReportLimit, getReportName, getReportOption, getReportRecordCount, getReportSubtitle, getReportTitle, getReportType, getRequestProperties, getRuleSelector, getSelectionLimit, getSelectionLimitType, getStatusCodes, getSupportsGraphDisplay, getTimeEnd, getTimeStart, getTimeZone, getTimeZoneString, getUser, getUserID, getValidGPSRequired, getWhereSelector, hasReportColumn, hasReportJob, hasReportOption, isEventDataMatch, isSingleDeviceOnly, isSoapRequest, setAutoReportURL, setGraphImageURL, setKmlURL, setMapIconSelector, setMapURL, setPreferredFormat, setRefreshURL, setReportCallback, setReportColumns, setReportConstraints, setReportDeviceList, setReportHeaderGroups, setReportJob, setReportName, setReportOption, setReportRecordCount, setReportSubtitle, setReportTitle, showMapRouteLine, writeHtmlBody, writeJavaScript, writeReport, writeReport, writeReportStyle

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityReport

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

Throws:

ReportException

Method Detail

postInitialize

public void postInitialize()

Description copied from class: ReportData

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

Overrides:

postInitialize in class ReportData

getStatusCode

public int getStatusCode()

getPushpinID

public java.lang.String getPushpinID()

getSupportsMapDisplay

public boolean getSupportsMapDisplay()

Returns true if this report supports displaying a map

Overrides:

getSupportsMapDisplay in class ReportData

Returns:

True if this report supports displaying a map, false otherwise

getSupportsKmlDisplay

public boolean getSupportsKmlDisplay()

Returns true if this report supports displaying KML

Overrides:

getSupportsKmlDisplay in class ReportData

Returns:

True if this report supports displaying KML, false otherwise

GetReportLayout

public static ReportLayout GetReportLayout()

Gets the bound ReportLayout singleton instance for this report

Returns:

The bound ReportLayout

getReportLayout

public ReportLayout getReportLayout()

Gets the bound ReportLayout singleton instance for this report

Specified by:

getReportLayout in class ReportData

Returns:

The bound ReportLayout

getBodyDataIterator

public DBDataIterator getBodyDataIterator()

Description copied from class: ReportData

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

Specified by:

getBodyDataIterator in class ReportData

getTotalsDataIterator

public DBDataIterator getTotalsDataIterator()

Description copied from class: ReportData

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.

Specified by:

getTotalsDataIterator in class ReportData

handleDBRecord

public int handleDBRecord(Entity rcd)
                   throws DBException

Description copied from interface: DBRecordHandler

Callback handler for DBRecords retrieved from a database select

Specified by:

handleDBRecord in interface DBRecordHandler<Entity>

Parameters:

rcd - The DBRecord

Returns:

The implementation method should return one of the following values:
DBRH_SKIP - skip current record and continue
DBRH_STOP - skip current record and stop
DBRH_SAVE - save current record and continue
DBRH_SAVE_STOP - save current record and stop
DBRH_SAVE_LAST - save prior record and continue
Any saved records will be returned in an array to the original calling thread.

Throws:

DBException