ru.metrika4j.impl
Class ReportBuilderImpl

java.lang.Object
  ru.metrika4j.impl.ReportBuilderImpl

All Implemented Interfaces:

ReportBuilder

public class ReportBuilderImpl
extends java.lang.Object
implements ReportBuilder

Author:

asuilin

Nested Class Summary

Nested classes/interfaces inherited from interface ru.metrika4j.ReportBuilder

ReportBuilder.Group, ReportBuilder.TableMode

Constructor Summary

ReportBuilderImpl(java.lang.String path, int counterId, ApiContext apiContext)

Method Summary

Report	build() Выполняет фактическое построение отчёта.
ReportBuilder	groupBy(ReportBuilder.Group group) Задаёт группировку данных по времени.
ReportBuilder	reverseSortBy(java.lang.String field) Задаёт сортировку по убыванию по произвольному полю отчёта
ReportBuilder	sortBy(java.lang.String field) Задаёт сортировку по возрастанию по произвольному полю отчёта
ReportBuilder	withDateFrom(MetrikaDate date) Задаёт нижнюю границу временного интервала, по которому будет построен отчёт.
ReportBuilder	withDateTo(MetrikaDate date) Задаёт верхнюю границу временного интервала, по которому будет построен отчёт.
ReportBuilder	withGoal(java.lang.Integer goalId) Задаёт идентификатор цели, для получения целевого отчёта.
ReportBuilder	withItemsPerPage(java.lang.Integer numberOfItems) Задаёт количество записей на одну "страницу" отчёта
ReportBuilder	withMirrorId(java.lang.Integer mirrorId) Задаёт фильтрацию по указанному зеркалу сайта.
ReportBuilder	withParameter(java.lang.String name, java.lang.String value) Задаёт входной параметр отчёта с произвольным именем.
ReportBuilder	withTableMode(ReportBuilder.TableMode tm) Задаёт представление результатов отчета - в виде таблиц или в виде дерева.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportBuilderImpl

public ReportBuilderImpl(java.lang.String path,
                         int counterId,
                         ApiContext apiContext)

Method Detail

withDateFrom

public ReportBuilder withDateFrom(MetrikaDate date)

Description copied from interface: ReportBuilder

Задаёт нижнюю границу временного интервала, по которому будет построен отчёт. Если границы не заданы, будет построен отчёт за последнюю неделю

Specified by:

withDateFrom in interface ReportBuilder

See Also:

ReportBuilder.withDateTo(MetrikaDate)

withDateTo

public ReportBuilder withDateTo(MetrikaDate date)

Description copied from interface: ReportBuilder

Задаёт верхнюю границу временного интервала, по которому будет построен отчёт. Если границы не заданы, будет построен отчёт за последнюю неделю

Specified by:

withDateTo in interface ReportBuilder

See Also:

ReportBuilder.withDateFrom(MetrikaDate)

withGoal

public ReportBuilder withGoal(java.lang.Integer goalId)

Description copied from interface: ReportBuilder

Задаёт идентификатор цели, для получения целевого отчёта.

Specified by:

withGoal in interface ReportBuilder

See Also:

Goal

groupBy

public ReportBuilder groupBy(ReportBuilder.Group group)

Description copied from interface: ReportBuilder

Задаёт группировку данных по времени. Если группировка не задана, по умолчанию данные группируются по дням

Specified by:

groupBy in interface ReportBuilder

sortBy

public ReportBuilder sortBy(java.lang.String field)

Description copied from interface: ReportBuilder

Задаёт сортировку по возрастанию по произвольному полю отчёта

Specified by:

sortBy in interface ReportBuilder

Parameters:

field - имя поля в отчете (имена полей перечислены в документации на каждый отчёт)

See Also:

ReportBuilder.reverseSortBy(String)

reverseSortBy

public ReportBuilder reverseSortBy(java.lang.String field)

Description copied from interface: ReportBuilder

Задаёт сортировку по убыванию по произвольному полю отчёта

Specified by:

reverseSortBy in interface ReportBuilder

Parameters:

field - имя поля в отчете (имена полей перечислены в документации на каждый отчёт)

See Also:

ReportBuilder.sortBy(String)

withTableMode

public ReportBuilder withTableMode(ReportBuilder.TableMode tm)

Description copied from interface: ReportBuilder

Задаёт представление результатов отчета - в виде таблиц или в виде дерева. По умолчанию результаты представляются в виде таблицы.

Specified by:

withTableMode in interface ReportBuilder

withMirrorId

public ReportBuilder withMirrorId(java.lang.Integer mirrorId)

Description copied from interface: ReportBuilder

Задаёт фильтрацию по указанному зеркалу сайта. Применяется для отчетов по содержанию.

Specified by:

withMirrorId in interface ReportBuilder

Parameters:

mirrorId - числовой идентификатор зеркала, 0 - основной сайт; 1 и более - порядковый номер из массива зеркал (см. параметр mirrors в описании счётчика); отрицательное число - будут выведены данные для сайтов и адресов, не указанных в настройках счётчика.

withParameter

public ReportBuilder withParameter(java.lang.String name,
                                   java.lang.String value)

Description copied from interface: ReportBuilder

Задаёт входной параметр отчёта с произвольным именем.

Specified by:

withParameter in interface ReportBuilder

Parameters:

name - Имя параметра

value - Значение параметра

withItemsPerPage

public ReportBuilder withItemsPerPage(java.lang.Integer numberOfItems)

Description copied from interface: ReportBuilder

Задаёт количество записей на одну "страницу" отчёта

Specified by:

withItemsPerPage in interface ReportBuilder

build

public Report build()

Description copied from interface: ReportBuilder

Выполняет фактическое построение отчёта. Функция в ходе работы обращается за данными к серверам Яндекс .Метрики.

Specified by:

build in interface ReportBuilder