Package com.apptus.esales.connector.report

Class TopSellingSearchesReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.TopSellingSearchesReport

public class TopSellingSearchesReport
extends Report

Report for search phrases associated with the products and variants that matches a filter. Each section of the report contains a search phrase together with the total number of times the search phrase has lead to a purchase of a product or variant that matches the filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TopSellingSearchesReport.Section	Sub class for TopSellingSearchesReport Contains a search phrase together with the total number of times the search phrase has lead to a purchase of a product or a variant that matches the filter specified in the report.

Method Summary

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

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

Method Detail

parse

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

Creates a TopSellingSearchesReport 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:

A TopSellingSearchesReport.

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

Returns:

All sections in this report, one for each search phrase, sorted descending by the number of purchased units associated with the phrase.

windowFirst

public int windowFirst()

Returns:

The lowest of the different ranks contained in this report.

windowLast

public int windowLast()

Returns:

The highest of the different ranks contained 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.