Package lumis.service.analytics.eventanalytics

Class EventFilterData

java.lang.Object

lumis.service.analytics.eventanalytics.EventFilterData

public class EventFilterData
extends Object

Event filter data.

Since:

11.0.0

Version:

$Revision: 24476 $ $Date: 2021-04-28 11:28:23 -0300 (Wed, 28 Apr 2021) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EventFilterData.IEventFilter	Event filter inner filter.

Method Summary

Modifier and Type	Method	Description
static EventFilterData	create(ServiceInstanceConfig serviceInstance, org.json.JSONObject jsonData)	Returns a parsed filter or null if the resulting filter is ano-op filter.
boolean	evaluate(FlowContext flowContext)	Evaluates this filter against the given flow context.
static ISearchQueryFilter	getAnalyticsServiceInstanceFilter(ServiceInstanceConfig analyticsServiceInstance)	Returns the appropriate filter for restricting events for the analytics service instance or null if no filter is required.
ISearchQueryFilter	getFilter()	Returns the big data filter.
org.json.JSONObject	getJson()	Returns the filter jsonData.
Map<String,Tuple2<CompositeDocumentTypeField,List<EventFilterData.IEventFilter>>>	getNestedObjectsFilters()	Returns the nested object filters of this event data filter (grouped by the nested object full identifier).

Methods inherited from class java.lang.Object

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

Method Detail

getAnalyticsServiceInstanceFilter

public static ISearchQueryFilter getAnalyticsServiceInstanceFilter(ServiceInstanceConfig analyticsServiceInstance)
                                                            throws PortalException

Returns the appropriate filter for restricting events for the analytics service instance or null if no filter is required.

Parameters:

analyticsServiceInstance - The analytics service instance.

Returns:

the appropriate filter for restricting events for the analytics service instance or null if no filter is required.

Throws:

PortalException

Since:

12.0.0

getFilter

public ISearchQueryFilter getFilter()
                             throws PortalException

Returns the big data filter.

Returns:

the big data filter.

Throws:

PortalException

Since:

11.0.0

create

public static EventFilterData create(ServiceInstanceConfig serviceInstance,
                                     org.json.JSONObject jsonData)
                              throws PortalException

Returns a parsed filter or null if the resulting filter is ano-op filter.

Parameters:

serviceInstance - the service instance.

jsonData - the JSON data.

Returns:

a parsed filter or null if the resulting filter is ano-op filter.

Throws:

PortalException

Since:

11.0.0

evaluate

public boolean evaluate(FlowContext flowContext)
                 throws PortalException

Evaluates this filter against the given flow context. Returns true if the given context matches this filter or false otherwise.

Parameters:

flowContext - the flow context.

Returns:

true if the given context matches this filter or false otherwise.

Throws:

PortalException

Since:

12.0.0

getNestedObjectsFilters

public Map<String,Tuple2<CompositeDocumentTypeField,List<EventFilterData.IEventFilter>>> getNestedObjectsFilters()

Returns the nested object filters of this event data filter (grouped by the nested object full identifier).

Returns:

the nested object filters of this event data filter (grouped by the nested object full identifier).

Since:

14.0.0

getJson

public org.json.JSONObject getJson()

Returns the filter jsonData.

Returns:

the filter jsonData

Since:

12.0.0