Package com.apptus.esales.connector.report

Class ProductSalesByAttributeReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.ProductSalesByAttributeReport

public class ProductSalesByAttributeReport
extends Report

Report containing sales statistics aggregated by product attribute values during the specified time interval. The report contains a list of Sections. One section for each available attribute value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProductSalesByAttributeReport.Section	Sub class for ProductSalesByAttributeReport Contains sales data for a group of products with a common facet value.

Constructor Summary

Constructors

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

Method Summary

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

Constructor Detail

ProductSalesByAttributeReport

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

Creates a ProductSalesByAttributeReport. Note that null is illegal for all input parameters.

Parameters:

asXml - A XmlTree to be used if the Report.exportToXml(java.io.File) method is called.

sections - A list of ProductSalesByAttributeReport.Section elements. One for each attribute value in the report.

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

tz - Time zone.

Method Detail

parse

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

Creates a ProductSalesByAttributeReport from an XML document.

Parameters:

tz - Time zone.

scanner - A scanner for the XML document to parse.

Returns:

A ProductSalesByAttributeReport.

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<ProductSalesByAttributeReport.Section> sections()

Returns:

All sections in this report. One for each attribute value.

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.