Package com.apptus.esales.connector.report

Class PanelConversionReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.PanelConversionReport

public class PanelConversionReport
extends Report

Report for panel performance, one section for each public panel path. This report can be seen in the Site tab in eSales Manager and it is described in the Panel conversion section on Apptus Zone (http://zone.apptus.com).

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	UNKNOWN_PANEL_TYPE

Constructor Summary

Constructors

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

Method Summary

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

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

Field Detail

UNKNOWN_PANEL_TYPE

public static final String UNKNOWN_PANEL_TYPE

See Also:

Constant Field Values

Constructor Detail

PanelConversionReport

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

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

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

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

sections - A list of PanelConversionReport.Section elements. One for each public panel path in the report.

Method Detail

parse

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

Creates a PanelConversionReport 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.

sections

public List<PanelConversionReport.Section> sections()

Returns:

All sections in this report. One for each public panel path.

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.