Package com.apptus.esales.connector.report

Class SearchStatisticsReport

java.lang.Object

com.apptus.esales.connector.report.Report

com.apptus.esales.connector.report.SearchStatisticsReport

public class SearchStatisticsReport
extends Report

Report for Search statistics on the site. This report can be seen in the Search Statistics tab on the Reports page in eSales Manager and it is described in the Search statistics section on Apptus Zone (http://zone.apptus.com).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchStatisticsReport.SearchConversion	Class holding data for rank, count conversion rate and impact for a phrase.
static class	SearchStatisticsReport.SearchCount	Class holding data for rank, count and search rate for a phrase.

Constructor Summary

Constructors

Constructor	Description
SearchStatisticsReport(com.apptus.util.xml.XmlTree asXml, TimeInterval interval, Rate searchesWithHitsRate, List<SearchStatisticsReport.SearchCount> searchesWithHits, Rate searchesWithNoHitsRate, List<SearchStatisticsReport.SearchCount> searchesWithNoHits, List<SearchStatisticsReport.SearchConversion> searchesThatBoost, List<SearchStatisticsReport.SearchConversion> searchesThatLower, TimeZone tz)	Creates an SearchStatisticsReport.

Method Summary

Modifier and Type	Method	Description
void	exportToExcel(File file)	Writes the report to a file.
static SearchStatisticsReport	parse(com.apptus.util.xml.XmlScanner scanner, TimeZone tz)	Creates an SearchStatisticsReport from an XML document.
List<SearchStatisticsReport.SearchConversion>	searchesThatBoostConversion()
List<SearchStatisticsReport.SearchConversion>	searchesThatLowerConversion()
List<SearchStatisticsReport.SearchCount>	searchesWithHits()
Rate	searchesWithHitsTotalRate()
List<SearchStatisticsReport.SearchCount>	searchesWithNoHits()
Rate	searchesWithNoHitsTotalRate()

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

SearchStatisticsReport

public SearchStatisticsReport(com.apptus.util.xml.XmlTree asXml,
                              TimeInterval interval,
                              Rate searchesWithHitsRate,
                              List<SearchStatisticsReport.SearchCount> searchesWithHits,
                              Rate searchesWithNoHitsRate,
                              List<SearchStatisticsReport.SearchCount> searchesWithNoHits,
                              List<SearchStatisticsReport.SearchConversion> searchesThatBoost,
                              List<SearchStatisticsReport.SearchConversion> searchesThatLower,
                              TimeZone tz)

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

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

searchesWithHitsRate - The rate of searches that leads to at least one hit.

searchesWithHits - List of the most popular search phrases that has resulted in search hits.

searchesWithNoHitsRate - The rate of searches that does not lead to a no hit.

searchesWithNoHits - List of the most popular search phrases that has resulted in no hits.

searchesThatBoost - List of the search phrases that has largest positive impact on the conversion.

searchesThatLower - List of the search phrases that has largest negative impact on the conversion.

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

Method Detail

parse

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

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

searchesWithHits

public List<SearchStatisticsReport.SearchCount> searchesWithHits()

Returns:

List of the most popular search phrases that has resulted in search hits.

searchesWithHitsTotalRate

public Rate searchesWithHitsTotalRate()

Returns:

The rate of searches that leads to at least one hit or Rate.NaN if the rate can not be calculated.

searchesWithNoHits

public List<SearchStatisticsReport.SearchCount> searchesWithNoHits()

Returns:

List of the most popular search phrases that has resulted in no hits.

searchesWithNoHitsTotalRate

public Rate searchesWithNoHitsTotalRate()

Returns:

The rate of searches that does not lead to a no hit or Rate.NaN if the rate can not be calculated.

searchesThatBoostConversion

public List<SearchStatisticsReport.SearchConversion> searchesThatBoostConversion()

Returns:

List of the search phrases that has largest positive impact on the conversion.

searchesThatLowerConversion

public List<SearchStatisticsReport.SearchConversion> searchesThatLowerConversion()

Returns:

List of the search phrases that has largest negative impact on the conversion.

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.