Package com.apptus.esales.connector.report

Class AdConversionReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.AdConversionReport

public class AdConversionReport
extends Report

Report for ads. Each section of the report contains all attributes for an ad together with average conversion rate for the campaign and timelines for conversion rates regarding this ad. This report can be seen in the Ads tab on the Reports page in eSales Manager and it is described in the documentation on Apptus Zone in the Ad conversion section.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
AdConversionReport(com.apptus.util.xml.XmlTree asXml, List<AdConversionReport.Section> sections, TimeInterval interval, Duration resolution, TimeZone tz)	Creates an AdConversionReport.

Method Summary

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

Methods inherited from class java.lang.Object

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

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

exportToXml, exportToXml, isoDateTimeFormat, timeInterval

Constructor Detail

AdConversionReport

public AdConversionReport(com.apptus.util.xml.XmlTree asXml,
                          List<AdConversionReport.Section> sections,
                          TimeInterval interval,
                          Duration resolution,
                          TimeZone tz)

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

sections - A list of AdConversionReport.Section elements. One for each ad in the report.

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 AdConversionReport parse(com.apptus.util.xml.XmlScanner scanner,
                                       TimeZone tz)
                                throws com.apptus.util.xml.FormatException,
                                       com.apptus.util.xml.SourceException

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

resolution

public Duration resolution()

Returns:

The resolution used for the data in this report.

sections

public List<AdConversionReport.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.