org.bytedeco.arrow_dataset

Class Expression

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_dataset.Expression

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::dataset")
 @NoOffset
 @Properties(inherit=arrow_dataset.class)
public class Expression
extends Pointer

An unbound expression which maps a single Datum to another Datum. An expression is one of - A literal Datum. - A reference to a single (potentially nested) field of the input Datum. - A call to a compute function, with arguments specified by other Expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Expression.Call
static class	Expression.Hash
static class	Expression.Parameter

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Expression()
Expression(Datum literal)
Expression(Expression.Call call)
Expression(Expression.Parameter parameter)
Expression(long size) Native array allocator.
Expression(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
ExpressionResult	Bind(Schema in_schema)
ExpressionResult	Bind(Schema in_schema, ExecContext arg1)
ExpressionResult	Bind(ValueDescr in)
ExpressionResult	Bind(ValueDescr in, ExecContext arg1) Bind this expression to the given input type, looking up Kernels and field types.
Expression.Call	call() Access a Call or return nullptr if this expression is not a call
ValueDescr	descr() The type and shape to which this expression will evaluate
boolean	Equals(Expression other)
FieldRef	field_ref() Access a FieldRef or return nullptr if this expression is not a field_ref
Expression	getPointer(long i)
long	hash()
boolean	IsBound() Return true if all an expression's field references have explicit ValueDescr and all of its functions' kernels are looked up.
boolean	IsNullLiteral() Return true if this expression is literal and entirely null.
boolean	IsSatisfiable() Return true if this expression could evaluate to true.
boolean	IsScalarExpression() Return true if this expression is composed only of Scalar literals, field references, and calls to ScalarFunctions.
Datum	literal() Access a Datum or return nullptr if this expression is not a literal
Expression	position(long position)
String	ToString()

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Expression

public Expression(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Expression

public Expression(long size)

Native array allocator. Access with Pointer.position(long).

Expression

public Expression()

Expression

public Expression(@ByVal
                  Expression.Call call)

Expression

public Expression(@ByVal
                  Datum literal)

Expression

public Expression(@ByVal
                  Expression.Parameter parameter)

Method Detail

position

public Expression position(long position)

Overrides:

position in class Pointer

getPointer

public Expression getPointer(long i)

Overrides:

getPointer in class Pointer

ToString

@StdString
public String ToString()

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           Expression other)

hash

@Cast(value="size_t")
public long hash()

Bind

@ByVal
public ExpressionResult Bind(@ByVal
                                     ValueDescr in,
                                     ExecContext arg1)

Bind this expression to the given input type, looking up Kernels and field types. Some expression simplification may be performed and implicit casts will be inserted. Any state necessary for execution will be initialized and returned.

Bind

@ByVal
public ExpressionResult Bind(@ByVal
                                     ValueDescr in)

Bind

@ByVal
public ExpressionResult Bind(@Const @ByRef
                                     Schema in_schema,
                                     ExecContext arg1)

Bind

@ByVal
public ExpressionResult Bind(@Const @ByRef
                                     Schema in_schema)

IsBound

@Cast(value="bool")
public boolean IsBound()

Return true if all an expression's field references have explicit ValueDescr and all of its functions' kernels are looked up.

IsScalarExpression

@Cast(value="bool")
public boolean IsScalarExpression()

Return true if this expression is composed only of Scalar literals, field references, and calls to ScalarFunctions.

IsNullLiteral

@Cast(value="bool")
public boolean IsNullLiteral()

Return true if this expression is literal and entirely null.

IsSatisfiable

@Cast(value="bool")
public boolean IsSatisfiable()

Return true if this expression could evaluate to true.

call

@Const
public Expression.Call call()

Access a Call or return nullptr if this expression is not a call

literal

@Const
public Datum literal()

Access a Datum or return nullptr if this expression is not a literal

field_ref

@Const
public FieldRef field_ref()

Access a FieldRef or return nullptr if this expression is not a field_ref

descr

@ByVal
public ValueDescr descr()

The type and shape to which this expression will evaluate