Module com.darkcollective.relix.symbol

Package com.darkcollective.relix.symbol.function

Class RelationFunctionSymbol.Builder

java.lang.Object

com.darkcollective.relix.symbol.function.RelationFunctionSymbol.Builder

Enclosing class:

RelationFunctionSymbol

public static final class RelationFunctionSymbol.Builder
extends Object

Fluent builder for RelationFunctionSymbol. Single-use; call build() once to produce the immutable record.

Method Summary

Modifier and Type	Method	Description
RelationFunctionSymbol.Builder	body(RelNode body)	Sets the relational-algebra body expression.
RelationFunctionSymbol	build()	Constructs the RelationFunctionSymbol from the current state.
RelationFunctionSymbol.Builder	namespace(String namespace)	Sets the namespace (default: "default").
RelationFunctionSymbol.Builder	parameter(ParameterDefinition parameter)	Appends a parameter — scalar or relation — to the end of the parameter list.
RelationFunctionSymbol.Builder	parameter(String name, ScalarType type)	Appends a parameter to the end of the parameter list.
RelationFunctionSymbol.Builder	provenance(Provenance provenance)	Sets the provenance (default: Provenance.USER).
RelationFunctionSymbol.Builder	returnSchema(Schema schema)	Sets the resolved return schema (default: absent).
RelationFunctionSymbol.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 RelationFunctionSymbol.Builder namespace(String namespace)

Sets the namespace (default: "default").

Parameters:

namespace - must not be blank

Returns:

this builder

provenance

public RelationFunctionSymbol.Builder provenance(Provenance provenance)

Sets the provenance (default: Provenance.USER).

Parameters:

provenance - must not be null

Returns:

this builder

shadowPolicy

public RelationFunctionSymbol.Builder shadowPolicy(ShadowPolicy shadowPolicy)

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

Parameters:

shadowPolicy - must not be null

Returns:

this builder

parameter

public RelationFunctionSymbol.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

parameter

public RelationFunctionSymbol.Builder parameter(ParameterDefinition parameter)

Appends a parameter — scalar or relation — to the end of the parameter list.

Parameters:

parameter - the parameter; must not be null

Returns:

this builder

body

public RelationFunctionSymbol.Builder body(RelNode body)

Sets the relational-algebra body expression.

Parameters:

body - the body; must not be null

Returns:

this builder

returnSchema

public RelationFunctionSymbol.Builder returnSchema(Schema schema)

Sets the resolved return schema (default: absent).

Parameters:

schema - the body's output schema; must not be null

Returns:

this builder

build

public RelationFunctionSymbol build()

Constructs the RelationFunctionSymbol from the current state.

Returns:

a new immutable RelationFunctionSymbol