Package com.apptus.esales.connector.report

Class AdOrderValueReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.AdOrderValueReport

public class AdOrderValueReport
extends Report

Report for ads. Each section of the report contains all attributes for an ad together with timelines for click through rate and average order value for this ad. This report can be seen in the Ads tab on the Reports page in eSales Manager and it is described in the Order Value section on Apptus Zone (http://zone.apptus.com) .

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdOrderValueReport.Section	Sub class for AdOrderValueReport.

Constructor Summary

Constructors

Constructor	Description
AdOrderValueReport(com.apptus.util.xml.XmlTree asXml, List<AdOrderValueReport.Section> sections, TimeInterval interval, TimelineType<?> timelineType, TimeZone tz)	Creates an AdOrderValueReport.

Method Summary

Modifier and Type	Method	Description
void	exportToExcel(File file)	Writes the report to a file.
static AdOrderValueReport	parse(com.apptus.util.xml.XmlScanner scanner, TimeZone tz)	Creates an AdOrderValueReport from an XML document.
List<AdOrderValueReport.Section>	sections()
TimelineType<?>	timelineType()

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

AdOrderValueReport

public AdOrderValueReport(com.apptus.util.xml.XmlTree asXml,
                          List<AdOrderValueReport.Section> sections,
                          TimeInterval interval,
                          TimelineType<?> timelineType,
                          TimeZone tz)

Creates an AdOrderValueReport.

Parameters:

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

sections - A list of AdOrderValueReport.Section elements. One for each ad in the report. Can not be null.

interval - The time interval for the data in this report. Can not be null.

timelineType - The timeline type for the data in this report. Can not be null.

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

Method Detail

parse

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

Creates an AdOrderValueReport 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 AdConversionReport.

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.

timelineType

public TimelineType<?> timelineType()

Returns:

The timeline type for the data in this report.

sections

public List<AdOrderValueReport.Section> sections()

Returns:

All sections in this report. One for each ad.

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.