org.apache.spark.sql.connector.expressions.aggregate

Class UserDefinedAggregateFunc

Object

org.apache.spark.sql.internal.connector.ExpressionWithToString

org.apache.spark.sql.connector.expressions.aggregate.UserDefinedAggregateFunc

All Implemented Interfaces:

java.io.Serializable, AggregateFunc, Expression

@Evolving
public class UserDefinedAggregateFunc
extends org.apache.spark.sql.internal.connector.ExpressionWithToString
implements AggregateFunc

The general representation of user defined aggregate function, which implements AggregateFunc, contains the upper-cased function name, the canonical function name, the `isDistinct` flag and all the inputs. Note that Spark cannot push down aggregate with this function partially to the source, but can only push down the entire aggregate.

Since:

3.4.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.spark.sql.connector.expressions.Expression

EMPTY_EXPRESSION, EMPTY_NAMED_REFERENCE

Constructor Summary

Constructors

Constructor and Description
UserDefinedAggregateFunc(String name, String canonicalName, boolean isDistinct, Expression[] children)

Method Summary

Modifier and Type	Method and Description
String	canonicalName()
Expression[]	children() Returns an array of the children of this node.
boolean	equals(Object o)
int	hashCode()
boolean	isDistinct()
String	name()

Methods inherited from class org.apache.spark.sql.internal.connector.ExpressionWithToString

describe, references, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.spark.sql.connector.expressions.Expression

describe, references

Constructor Detail

UserDefinedAggregateFunc

public UserDefinedAggregateFunc(String name,
                                String canonicalName,
                                boolean isDistinct,
                                Expression[] children)

Method Detail

name

public String name()

canonicalName

public String canonicalName()

isDistinct

public boolean isDistinct()

children

public Expression[] children()

Description copied from interface: Expression

Returns an array of the children of this node. Children should not change.

Specified by:

children in interface Expression

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object