Package com.apptus.esales.connector.report

Class SessionSummaryReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.SessionSummaryReport

public class SessionSummaryReport
extends Report

Report with a summary of session statistics for the entire site as well as grouped by searches and recommendations. This report can be seen at the top of the Site Summary tab on the Reports page in eSales Manager and it is described in the Session summary section on Apptus Zone (http://zone.apptus.com).

Constructor Summary

Constructors

Constructor	Description
SessionSummaryReport(com.apptus.util.xml.XmlTree asXml, TimeInterval interval, Summary site, Summary search, Summary recommendation, TimeZone tz)	Creates an SessionSummaryReport.

Method Summary

Modifier and Type	Method	Description
void	exportToExcel(File file)	Writes the report to a file.
static SessionSummaryReport	parse(com.apptus.util.xml.XmlScanner scanner, TimeZone tz)	Creates an SessionSummaryReport from an XML document.
Summary	recommendation()
Summary	search()
Summary	site()

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

SessionSummaryReport

public SessionSummaryReport(com.apptus.util.xml.XmlTree asXml,
                            TimeInterval interval,
                            Summary site,
                            Summary search,
                            Summary recommendation,
                            TimeZone tz)

Creates an SessionSummaryReport. 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.

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

site - A summary containing bounce rate, number of visits, number of orders and conversion rate for the site.

search - A summary containing number of visits, number of orders and conversion rate for the search panels.

recommendation - A summary containing number of visits, number of orders and conversion rate for the recommendation panels.

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

Method Detail

parse

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

Creates an SessionSummaryReport 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.

site

public Summary site()

Returns:

A summary containing bounce rate, number of visits, number of orders and conversion rate for the site.

search

public Summary search()

Returns:

A summary containing number of visits, number of orders and conversion rate for the search panels.

recommendation

public Summary recommendation()

Returns:

A summary containing number of visits, number of orders and conversion rate for the recommendation panels.

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.