Package lumis.service.analytics.eventanalytics.report.rest

Class EventAnalyticsReportRequest

java.lang.Object

lumis.service.analytics.eventanalytics.report.rest.EventAnalyticsReportRequest

All Implemented Interfaces:

IEventAnalyticsReportRequest

Direct Known Subclasses:

EventAnalyticsDashboardRequest

public class EventAnalyticsReportRequest
extends java.lang.Object
implements IEventAnalyticsReportRequest

Event analytics report request.

Since:

11.0.0

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventAnalyticsReportRequest.GroupByHolder

Constructor Summary

Constructors

Constructor	Description
EventAnalyticsReportRequest(org.json.JSONObject request)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	getCompareWithAmount()	Returns the compareWithAmount.
java.lang.String	getCompareWithType()	Returns the compareWithType.
EventFilterData	getEventFilter()	Returns the eventFilter.
java.util.List<EventAnalyticsReportRequest.GroupByHolder>	getGroupBys()	Returns the groupBy list in this request.
Tuple2<IAggregation,java.util.function.Function<java.lang.Object,java.lang.String>>	getInterval()	Returns the interval.
java.util.Map<java.lang.String,Tuple2<IAggregation,java.lang.Boolean>>	getMetrics()	Returns the metrics.
ServiceInstanceConfig	getServiceInstanceConfig()	Returns the serviceInstanceConfig.
protected static java.lang.String	getServiceInstanceFromRequest(org.json.JSONObject request)	Returns the service instance id from the request.
Tuple3<java.util.Date,java.util.Date,ISearchQueryFilter>	getTimeFrame()	Returns the timeFrame.
UserSegmentationData	getUserSegmentation()	Returns the userSegmentation.
boolean	isCompareValuesWithGreatestValue()	Returns whether the values must be compared with the greatest aggregation value.
boolean	isExcludeAdminAreaAccess()	Returns whether the report should omit administrative areas events
boolean	isStandard()	Returns whether this is a standard report.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventAnalyticsReportRequest

public EventAnalyticsReportRequest(org.json.JSONObject request)
                            throws PortalException

Constructor.

Parameters:

request - the request object.

Throws:

PortalException

Since:

11.0.0

Method Detail

getServiceInstanceFromRequest

protected static final java.lang.String getServiceInstanceFromRequest(org.json.JSONObject request)

Returns the service instance id from the request.

Parameters:

request - the request json.

Returns:

the service instance id from the request.

Since:

14.0.0

getMetrics

public java.util.Map<java.lang.String,Tuple2<IAggregation,java.lang.Boolean>> getMetrics()

Returns the metrics.

Specified by:

getMetrics in interface IEventAnalyticsReportRequest

Returns:

the metrics

Since:

11.0.0

getGroupBys

public java.util.List<EventAnalyticsReportRequest.GroupByHolder> getGroupBys()

Description copied from interface: IEventAnalyticsReportRequest

Returns the groupBy list in this request.

Specified by:

getGroupBys in interface IEventAnalyticsReportRequest

Returns:

the groupBy list. Returns an empty list if there is no groupBy. Never returns null.

getEventFilter

public EventFilterData getEventFilter()

Returns the eventFilter.

Specified by:

getEventFilter in interface IEventAnalyticsReportRequest

Returns:

the eventFilter

Since:

11.0.0

getInterval

public Tuple2<IAggregation,java.util.function.Function<java.lang.Object,java.lang.String>> getInterval()

Returns the interval.

Specified by:

getInterval in interface IEventAnalyticsReportRequest

Returns:

the interval

Since:

11.0.0

getServiceInstanceConfig

public ServiceInstanceConfig getServiceInstanceConfig()

Description copied from interface: IEventAnalyticsReportRequest

Returns the serviceInstanceConfig.

Specified by:

getServiceInstanceConfig in interface IEventAnalyticsReportRequest

Returns:

the serviceInstanceConfig

getUserSegmentation

public UserSegmentationData getUserSegmentation()

Description copied from interface: IEventAnalyticsReportRequest

Returns the userSegmentation.

Specified by:

getUserSegmentation in interface IEventAnalyticsReportRequest

Returns:

the userSegmentation

getTimeFrame

public Tuple3<java.util.Date,java.util.Date,ISearchQueryFilter> getTimeFrame()

Description copied from interface: IEventAnalyticsReportRequest

Returns the timeFrame.

Specified by:

getTimeFrame in interface IEventAnalyticsReportRequest

Returns:

the timeFrame

isStandard

public boolean isStandard()

Description copied from interface: IEventAnalyticsReportRequest

Returns whether this is a standard report.

Specified by:

isStandard in interface IEventAnalyticsReportRequest

Returns:

whether this is a standard report.

getCompareWithType

public java.lang.String getCompareWithType()

Returns the compareWithType.

Returns:

the compareWithType

Since:

12.1.0

getCompareWithAmount

public java.lang.Integer getCompareWithAmount()

Returns the compareWithAmount.

Returns:

the compareWithAmount

Since:

12.1.0

isCompareValuesWithGreatestValue

public boolean isCompareValuesWithGreatestValue()

Description copied from interface: IEventAnalyticsReportRequest

Returns whether the values must be compared with the greatest aggregation value.

Specified by:

isCompareValuesWithGreatestValue in interface IEventAnalyticsReportRequest

Returns:

whether the values must be compared with the greatest aggregation value.

isExcludeAdminAreaAccess

public boolean isExcludeAdminAreaAccess()

Returns whether the report should omit administrative areas events

Specified by:

isExcludeAdminAreaAccess in interface IEventAnalyticsReportRequest

Returns:

whether the report should omit administrative areas events