Package com.apptus.esales.connector.report

Class AdPlacementReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.AdPlacementReport

public class AdPlacementReport
extends Report

Report for ads. Each section of the report contains all attributes for an ad together with a list of number of registered clicks and displays for this ad on different public panel paths.. This report can be seen in the Ads tab on the Reports page in eSales Manager and it is described in the Placement section on Apptus Zone (http://zone.apptus.com).

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	exportToExcel(File file)	Writes the report to a file.
static AdPlacementReport	parse(com.apptus.util.xml.XmlScanner scanner, TimeZone tz)	Creates an AdPlacementReport from an XML document.
List<AdPlacementReport.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

AdPlacementReport

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

Creates an AdPlacementReport. 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 AdPlacementReport.Section elements. One for each ad in the report.

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

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

Method Detail

parse

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

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

sections

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