Package com.apptus.esales.connector.report

Class ProductSalesByTimeReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.ProductSalesByTimeReport

public class ProductSalesByTimeReport
extends Report

Report containing aggregated sales statistics. This report contains five Timeline's:

• purchasedUnits - A timeline with the number of purchased units.
• abandonedUnits - A timeline with the number of abandoned units.
• revenue - A timeline with aggregated net selling price.
• margin - A timeline with the aggregated margin.
• discount - A timeline with the aggregated discount.

Each timeline has a number of slots with data. The number of slots depends on the specified time line type.

Constructor Summary

Constructors

Constructor	Description
ProductSalesByTimeReport(com.apptus.util.xml.XmlTree asXml, TimeInterval interval, Timeline<Double> discount, Timeline<Integer> purchasedUnits, Timeline<Integer> abandonedUnits, Timeline<Double> revenue, Timeline<Double> margin, TimelineType<?> timelineType, TimeZone tz)	Creates a ProductSalesByTimeReport.

Method Summary

Modifier and Type	Method	Description
Timeline<Integer>	abandonedUnits()
Timeline<Double>	discount()
void	exportToExcel(File file)	Writes the report to a file.
Timeline<Double>	margin()
static ProductSalesByTimeReport	parse(com.apptus.util.xml.XmlScanner scanner, TimeZone tz)	Creates a ProductSalesByTimeReport from an XML document.
Timeline<Integer>	purchasedUnits()
Timeline<Double>	revenue()
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

ProductSalesByTimeReport

public ProductSalesByTimeReport(com.apptus.util.xml.XmlTree asXml,
                                TimeInterval interval,
                                Timeline<Double> discount,
                                Timeline<Integer> purchasedUnits,
                                Timeline<Integer> abandonedUnits,
                                Timeline<Double> revenue,
                                Timeline<Double> margin,
                                TimelineType<?> timelineType,
                                TimeZone tz)

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

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

discount - A Timeline of discount values.

purchasedUnits - A Timeline containing the number of purchased units.

abandonedUnits - A Timeline containing the number of abandoned units.

revenue - A Timeline of revenue values.

margin - A Timeline of margin values.

timelineType - The timeline type used for this report.

tz - Time zone.

Method Detail

parse

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

Creates a ProductSalesByTimeReport from an XML document.

Parameters:

scanner - A scanner for the XML document to parse.

tz - Time zone.

Returns:

A ProductSalesByTimeReport.

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.

discount

public Timeline<Double> discount()

Returns:

A Timeline of discount values.

purchasedUnits

public Timeline<Integer> purchasedUnits()

Returns:

A Timeline of purchased units values.

abandonedUnits

public Timeline<Integer> abandonedUnits()

Returns:

A Timeline of abandoned units values.

revenue

public Timeline<Double> revenue()

Returns:

A Timeline of revenue values.

margin

public Timeline<Double> margin()

Returns:

A Timeline of margin values.

timelineType

public TimelineType<?> timelineType()

Returns:

The timeline type used in this report.

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.