Package org.apache.spark.sql.connector.expressions

Class GetArrayItem

Object

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

org.apache.spark.sql.connector.expressions.GetArrayItem

All Implemented Interfaces:

Serializable, Expression

@Evolving
public class GetArrayItem
extends org.apache.spark.sql.internal.connector.ExpressionWithToString

Get array item expression.

Since:

4.1.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	Description
GetArrayItem(Expression childArray, Expression ordinal, boolean failOnError)	Creates GetArrayItem expression.

Method Summary

Modifier and Type	Method	Description
Expression	childArray()
Expression[]	children()	Returns an array of the children of this node.
boolean	failOnError()
Expression	ordinal()

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

describe, references, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

GetArrayItem

public GetArrayItem(Expression childArray,
 Expression ordinal,
 boolean failOnError)

Creates GetArrayItem expression.

Parameters:

childArray - Array that is source to get element from. Child of this expression.

ordinal - Ordinal of element. Zero-based indexing.

failOnError - Whether expression should throw exception for index out of bound or to return null.

Method Details

childArray

public Expression childArray()

ordinal

public Expression ordinal()

failOnError

public boolean failOnError()

children

public Expression[] children()

Description copied from interface: Expression

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