Package lumis.portal.analytics.automationflow.condition

Class FilterBySegmentationNode

java.lang.Object

lumis.portal.analytics.automationflow.FlowNode

lumis.portal.analytics.automationflow.condition.TrueFalseNode

lumis.portal.analytics.automationflow.condition.FilterBySegmentationNode

public class FilterBySegmentationNode
extends TrueFalseNode

Filters the flow by user segmentation.

Since:

12.0.0

Version:

$Revision: 23716 $ $Date: 2020-03-26 18:26:08 -0300 (Thu, 26 Mar 2020) $

Nested Class Summary

Nested classes/interfaces inherited from class lumis.portal.analytics.automationflow.FlowNode

FlowNode.FlowNodeExecutionResult

Field Summary

Fields inherited from class lumis.portal.analytics.automationflow.FlowNode

id

Constructor Summary

Constructors

Constructor	Description
FilterBySegmentationNode(String id, String name, UserSegmentationData userSegmentationData, String userSegmentationId, FlowNode trueNextNode)	Creates a new instance
FilterBySegmentationNode(org.json.JSONObject object, FlowEntry flowEntry)	Creates a new instance from the given JSON object.

Method Summary

Modifier and Type	Method	Description
boolean	evaluate(FlowContext flowContext)	Evaluates the given flow context.
FlowNode.FlowNodeExecutionResult	execute(FlowContext flowContext)	Executes this node and returns the next node to be executed.
org.json.JSONObject	toJSONObject()	Returns the JSON representation of this node.
boolean	validateStateAndLog(boolean checkAllNextNodes)	To permit edition when JSON flow is saved incorrectly in data base, the flow node constructor by JSON parameter need allows to load flow node variables without exception when something already is wrong.

Methods inherited from class lumis.portal.analytics.automationflow.condition.TrueFalseNode

addFalseNodeToJson, addTrueNodeToJson, getFalseNodeFromJson, getFollowUps, getTrueNodeFromJson

Methods inherited from class lumis.portal.analytics.automationflow.FlowNode

getAndValidateNotAnonymousUser, getFlowEntry, getId, getName, getNodeLogLabel, init, logError, logError

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterBySegmentationNode

public FilterBySegmentationNode(String id,
                                String name,
                                UserSegmentationData userSegmentationData,
                                String userSegmentationId,
                                FlowNode trueNextNode)

Creates a new instance

Parameters:

id - the node identifier

name - the node name

userSegmentationData - the user segmentation filter the flow context will be evaluated against

userSegmentationId - the user segmentation identifier

trueNextNode - the next node to be executed, if the condition evaluates to true.

Since:

12.0.0

FilterBySegmentationNode

public FilterBySegmentationNode(org.json.JSONObject object,
                                FlowEntry flowEntry)
                         throws PortalException

Creates a new instance from the given JSON object.

Parameters:

object - the JSON object.

flowEntry - the flow entry this node belongs to.

Throws:

PortalException

Since:

12.0.0

Method Detail

validateStateAndLog

public boolean validateStateAndLog(boolean checkAllNextNodes)

Description copied from class: FlowNode

To permit edition when JSON flow is saved incorrectly in data base, the flow node constructor by JSON parameter need allows to load flow node variables without exception when something already is wrong. So, to prevents exception on flow node execution and prevent to save flow when flow node is invalid state, this methods will check if all variables is OK and log otherwise.

Overrides:

validateStateAndLog in class TrueFalseNode

Parameters:

checkAllNextNodes - check all next nodes nodes.

Returns:

true if all variable state is OK.

toJSONObject

public org.json.JSONObject toJSONObject()

Description copied from class: FlowNode

Returns the JSON representation of this node. This method is the counterpart of #FlowNode(JSONObject) constructor.

Overrides:

toJSONObject in class TrueFalseNode

Returns:

the JSON representation of this node.

execute

public FlowNode.FlowNodeExecutionResult execute(FlowContext flowContext)
                                         throws PortalException

Description copied from class: FlowNode

Executes this node and returns the next node to be executed.

Overrides:

execute in class TrueFalseNode

Parameters:

flowContext - the flow context

Returns:

the next node to be executed

Throws:

PortalException

evaluate

public boolean evaluate(FlowContext flowContext)
                 throws PortalException

Description copied from class: TrueFalseNode

Evaluates the given flow context. Returns true if the context matches the condition or false otherwise.

Specified by:

evaluate in class TrueFalseNode

Parameters:

flowContext - the context

Returns:

true if the context matches the condition or false otherwise.

Throws:

PortalException