Module com.darkcollective.relix.symbol

Package com.darkcollective.relix.symbol.function

Class ScalarFunctionSymbol.Builder

java.lang.Object

com.darkcollective.relix.symbol.function.ScalarFunctionSymbol.Builder

Enclosing class:

ScalarFunctionSymbol

public static final class ScalarFunctionSymbol.Builder
extends Object

Fluent builder for ScalarFunctionSymbol.

Instances are obtained via ScalarFunctionSymbol.builder(String). The builder is single-use; call build() once to produce the immutable record.

Method Summary

Modifier and Type	Method	Description
ScalarFunctionSymbol.Builder	body(Operand body)	Sets the body expression for a user-defined function.
ScalarFunctionSymbol	build()	Constructs the ScalarFunctionSymbol from the current builder state.
ScalarFunctionSymbol.Builder	namespace(String namespace)	Sets the namespace (default: "default").
ScalarFunctionSymbol.Builder	parameter(String name, ScalarType type)	Appends a parameter to the end of the parameter list.
ScalarFunctionSymbol.Builder	property(FunctionProperty property)	Adds a single optimizer hint flag.
ScalarFunctionSymbol.Builder	provenance(Provenance provenance)	Sets the provenance (default: Provenance.USER).
ScalarFunctionSymbol.Builder	returnType(ScalarType returnType)	Sets the return type (default: ScalarType.ANY).
ScalarFunctionSymbol.Builder	shadowPolicy(ShadowPolicy shadowPolicy)	Sets the shadow policy (default: ShadowPolicy.PERMITTED).

Methods inherited from class java.lang.Object

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

Method Details

namespace

public ScalarFunctionSymbol.Builder namespace(String namespace)

Sets the namespace (default: "default").

Parameters:

namespace - must not be blank

Returns:

this builder

provenance

public ScalarFunctionSymbol.Builder provenance(Provenance provenance)

Sets the provenance (default: Provenance.USER).

Parameters:

provenance - must not be null

Returns:

this builder

shadowPolicy

public ScalarFunctionSymbol.Builder shadowPolicy(ShadowPolicy shadowPolicy)

Sets the shadow policy (default: ShadowPolicy.PERMITTED).

Parameters:

shadowPolicy - must not be null

Returns:

this builder

parameter

public ScalarFunctionSymbol.Builder parameter(String name,
 ScalarType type)

Appends a parameter to the end of the parameter list.

Parameters:

name - the parameter name; must not be blank

type - the parameter type; must not be null

Returns:

this builder

returnType

public ScalarFunctionSymbol.Builder returnType(ScalarType returnType)

Sets the return type (default: ScalarType.ANY).

Parameters:

returnType - must not be null

Returns:

this builder

property

public ScalarFunctionSymbol.Builder property(FunctionProperty property)

Adds a single optimizer hint flag.

Parameters:

property - must not be null

Returns:

this builder

body

public ScalarFunctionSymbol.Builder body(Operand body)

Sets the body expression for a user-defined function.

Parameters:

body - the scalar expression body; must not be null

Returns:

this builder

build

public ScalarFunctionSymbol build()

Constructs the ScalarFunctionSymbol from the current builder state.

Returns:

a new immutable ScalarFunctionSymbol