QgsExpressionNodeCondition class

An expression node for CASE WHEN clauses.

Reference

Base classes

class QgsExpressionNode: Abstract base class for all nodes that can appear in an expression.

Public types

class WhenThen: Represents a "WHEN... THEN..." portation of a CASE WHEN clause in an expression.

Constructors, destructors, conversion operators

QgsExpressionNodeCondition(QgsExpressionNodeCondition::WhenThenList* conditions, QgsExpressionNode* elseExp = nullptr): Create a new node with the given list of conditions and an optional elseExp expression.
QgsExpressionNodeCondition(const QgsExpressionNodeCondition::WhenThenList& conditions, QgsExpressionNode* elseExp = nullptr): Create a new node with the given list of conditions and an optional elseExp expression.

Public functions

auto clone() const -> QgsExpressionNode* override: Generate a clone of this node.
auto conditions() const -> WhenThenList: The list of WHEN THEN expression parts of the expression.
auto dump() const -> QString override: Dump this node into a serialized (part) of an expression.
auto elseExp() const -> QgsExpressionNode*: The ELSE expression used for the condition.
auto evalNode(QgsExpression* parent, const QgsExpressionContext* context) -> QVariant override: Abstract virtual eval method Errors are reported to the parent.
auto isStatic(QgsExpression* parent, const QgsExpressionContext* context) const -> bool override: Returns true if this node can be evaluated for a static value.
auto needsGeometry() const -> bool override: Abstract virtual method which returns if the geometry is required to evaluate this expression.
auto nodes() const -> QList<const QgsExpressionNode*> override: Returns a list of all nodes which are used in this expression.
auto nodeType() const -> QgsExpressionNode::NodeType override: Gets the type of this node.
auto prepareNode(QgsExpression* parent, const QgsExpressionContext* context) -> bool override: Abstract virtual preparation method Errors are reported to the parent.
auto referencedColumns() const -> QSet<QString> override: Abstract virtual method which returns a list of columns required to evaluate this node.
auto referencedFunctions() const -> QSet<QString> override: Returns a set of all functions which are used in this expression.
auto referencedVariables() const -> QSet<QString> override: Returns a set of all variables which are used in this expression.

Function documentation

QgsExpressionNode* QgsExpressionNodeCondition::clone() const override

Generate a clone of this node.

Returns	a deep copy of this node.

Ownership is transferred to the caller.

WhenThenList QgsExpressionNodeCondition::conditions() const

The list of WHEN THEN expression parts of the expression.

Returns	The list of WHEN THEN expression parts of the expression.

QString QgsExpressionNodeCondition::dump() const override

Dump this node into a serialized (part) of an expression.

The returned expression does not necessarily literally match the original expression, it's just guaranteed to behave the same way.

QgsExpressionNode* QgsExpressionNodeCondition::elseExp() const

The ELSE expression used for the condition.

Returns	The ELSE expression used for the condition.

QVariant QgsExpressionNodeCondition::evalNode(QgsExpression* parent, const QgsExpressionContext* context) override

Abstract virtual eval method Errors are reported to the parent.

bool QgsExpressionNodeCondition::isStatic(QgsExpression* parent, const QgsExpressionContext* context) const override

Returns true if this node can be evaluated for a static value.

This is used during the prepare() step and in case it returns true, the value of this node will already be evaluated and the result cached (and therefore not re-evaluated in subsequent calls to eval()). In case this returns true, prepareNode() will never be called.

bool QgsExpressionNodeCondition::needsGeometry() const override

Abstract virtual method which returns if the geometry is required to evaluate this expression.

Returns	true if a geometry is required to evaluate this expression

This needs to call needsGeometry() recursively on any child nodes.

QList<const QgsExpressionNode*> QgsExpressionNodeCondition::nodes() const override

Returns a list of all nodes which are used in this expression.

QgsExpressionNode::NodeType QgsExpressionNodeCondition::nodeType() const override

Gets the type of this node.

Returns	The type of this node

bool QgsExpressionNodeCondition::prepareNode(QgsExpression* parent, const QgsExpressionContext* context) override

Abstract virtual preparation method Errors are reported to the parent.

QSet<QString> QgsExpressionNodeCondition::referencedColumns() const override

Abstract virtual method which returns a list of columns required to evaluate this node.

Returns	A list of columns required to evaluate this expression

When reimplementing this, you need to return any column that is required to evaluate this node and in addition recursively collect all the columns required to evaluate child nodes.