org.opengts.war.report.event
Class EventSummaryReport

java.lang.Object
  extended by org.opengts.war.report.ReportData
      extended by org.opengts.war.report.event.EventSummaryReport

public class EventSummaryReport
extends ReportData


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
 
Constructor Summary
EventSummaryReport(ReportEntry rptEntry, RequestProperties reqState, ReportDeviceList devList)
          Event Summary Report Constructor
 
Method Summary
 DBDataIterator getBodyDataIterator()
          Creates and returns an iterator for the row data displayed in the body of this report.
 boolean getOrderAscending()
          Returns true if the key order is ascending
 ReportLayout getReportLayout()
          Gets the bound ReportLayout singleton instance for this report
static ReportLayout GetReportLayout()
          Gets the bound ReportLayout singleton instance for this report
 long getSelectionLimit()
          Returns the selection limit (events per device)
 EventData.LimitType getSelectionLimitType()
          Returns the limit type contraint
 boolean getSupportsKmlDisplay()
          Returns true if this report supports displaying KML
 boolean getSupportsMapDisplay()
          Returns true if this report supports displaying a map
 DBDataIterator getTotalsDataIterator()
          Creates and returns an iterator for the row data displayed in the total rows of this report.
protected  boolean isEventDataMatch(EventData ev)
          Callback for each EventData record selected.
 boolean isSelectionLimitTypeLAST()
          Returns true if the selection limit type is LimitType.LAST
 void postInitialize()
          Post report initialization
 
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, getPreferredFormat, getPrivateLabel, getProperties, getRefreshURL, getReportCallback, getReportColumns, getReportConstraints, getReportDataFieldsEnabled, getReportDeviceList, getReportEntry, getReportFactory, getReportHeaderGroup, getReportHeaderGroups, getReportIsPartial, getReportJob, getReportLimit, getReportName, getReportOption, getReportRecordCount, getReportSubtitle, getReportTitle, getReportType, getRequestProperties, getRuleSelector, getStatusCodes, getSupportsGraphDisplay, getTimeEnd, getTimeStart, getTimeZone, getTimeZoneString, getUser, getUserID, getValidGPSRequired, getWhereSelector, hasReportColumn, hasReportJob, hasReportOption, 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

EventSummaryReport

public EventSummaryReport(ReportEntry rptEntry,
                          RequestProperties reqState,
                          ReportDeviceList devList)
                   throws ReportException
Event Summary Report Constructor

Parameters:
rptEntry - The ReportEntry that generated this report
reqState - The session RequestProperties instance
devList - The list of devices
Throws:
ReportException
Method Detail

postInitialize

public void postInitialize()
Post report initialization

Overrides:
postInitialize in class ReportData

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

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.

Overrides:
isEventDataMatch in class ReportData
Parameters:
ev - The current EventData record to test
Returns:
True to accept record, false to skip record

getBodyDataIterator

public DBDataIterator getBodyDataIterator()
Creates and returns an iterator for the row data displayed in the body of this report.

Specified by:
getBodyDataIterator in class ReportData
Returns:
The body row data iterator

getTotalsDataIterator

public DBDataIterator getTotalsDataIterator()
Creates and returns an iterator for the row data displayed in the total rows of this report.

Specified by:
getTotalsDataIterator in class ReportData
Returns:
The total row data iterator

getSelectionLimitType

public EventData.LimitType getSelectionLimitType()
Returns the limit type contraint

Overrides:
getSelectionLimitType in class ReportData
Returns:
The limit type

isSelectionLimitTypeLAST

public boolean isSelectionLimitTypeLAST()
Returns true if the selection limit type is LimitType.LAST


getSelectionLimit

public long getSelectionLimit()
Returns the selection limit (events per device)

Overrides:
getSelectionLimit in class ReportData
Returns:
The selection limit

getOrderAscending

public boolean getOrderAscending()
Returns true if the key order is ascending

Overrides:
getOrderAscending in class ReportData
Returns:
True if the key order is ascending