Package com.apptus.esales.connector.report

Class SessionStatisticsReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.SessionStatisticsReport

public class SessionStatisticsReport
extends Report

Report for Session statistics on the site. This report can be seen in the graphs in the Site Summary tab and in the Site Details tab on the Reports page in eSales Manager and it is described in the Session statistics section on Apptus Zone (http://zone.apptus.com).

Constructor Summary

Constructors

Constructor	Description
SessionStatisticsReport(com.apptus.util.xml.XmlTree asXml, Timeline<SessionStatistics> timeline, TimeInterval interval, Duration resolution, TimeZone tz)	Creates an SessionStatisticsReport.

Method Summary

Modifier and Type	Method	Description
void	exportToExcel(File file)	Writes the report to a file.
static SessionStatisticsReport	parse(com.apptus.util.xml.XmlScanner scanner, TimeZone tz)	Creates an SessionStatisticsReport from an XML document.
Duration	resolution()
Timeline<SessionStatistics>	timeline()

Methods inherited from class com.apptus.esales.connector.report.Report

exportToXml, exportToXml, isoDateTimeFormat, timeInterval

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionStatisticsReport

public SessionStatisticsReport(com.apptus.util.xml.XmlTree asXml,
                               Timeline<SessionStatistics> timeline,
                               TimeInterval interval,
                               Duration resolution,
                               TimeZone tz)

Creates an SessionStatisticsReport. Note that null is illegal for all input parameters.

Parameters:

asXml - An XmlTree to be used if the Report.exportToXml(java.io.File) method is called.

timeline - A timeline of SessionStatistics elements. Each containing common statistics data such as number of displays, clicks, payments, etc.

interval - The time interval for the data in this report.

resolution - The resolution for the data in this report.

tz - The time zone to use when presenting this report.

Method Detail

parse

public static SessionStatisticsReport parse(com.apptus.util.xml.XmlScanner scanner,
                                            TimeZone tz)
                                     throws com.apptus.util.xml.FormatException,
                                            com.apptus.util.xml.SourceException

Creates an SessionStatisticsReport from an XML document.

Parameters:

scanner - A scanner for the XML document to parse.

tz - The time zone to use when presenting this report.

Returns:

An AdPlacementReport.

Throws:

com.apptus.util.xml.FormatException - if the XML document does not match the expected format.

com.apptus.util.xml.SourceException - if the XML document contains errors like invalid XML or if the source is unreadable.

resolution

public Duration resolution()

Returns:

The resolution used for the data in this report.

timeline

public Timeline<SessionStatistics> timeline()

Returns:

A timeline of session statistics.

exportToExcel

public void exportToExcel(File file)
                   throws FileNotFoundException

Description copied from class: Report

Writes the report to a file. The report is written in plain text and ';' is used as separator.

Specified by:

exportToExcel in class Report

Parameters:

file - The file to write the report to.

Throws:

FileNotFoundException - if the file does not exists or if the file is inaccessible.