Package io.substrait.relation

Class RelProtoConverter

java.lang.Object

io.substrait.relation.RelProtoConverter

All Implemented Interfaces:

RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

public class RelProtoConverter
extends Object
implements RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Converts from Rel to Rel

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull ExpressionProtoConverter	exprProtoConverter
protected final @NonNull ExtensionCollector	extensionCollector
protected final @NonNull ExtensionProtoConverter<?,?>	extensionProtoConverter
protected final @NonNull TypeProtoConverter	typeProtoConverter

Constructor Summary

Constructors

Constructor	Description
RelProtoConverter(@NonNull ExtensionCollector extensionCollector)	Constructor with custom ExtensionCollector.
RelProtoConverter(@NonNull ExtensionCollector extensionCollector, @NonNull ExtensionProtoConverter<?,?> extensionProtoConverter)	Constructor with custom ExtensionCollector and custom ExtensionProtoConverter.

Method Summary

Modifier and Type	Method	Description
ExpressionProtoConverter	getExpressionProtoConverter()
TypeProtoConverter	getTypeProtoConverter()
protected Expression	toProto(Expression expression)
RelRoot	toProto(Plan.Root relRoot)
Rel	toProto(Rel rel)
protected Type	toProto(Type type)
protected List<Expression>	toProto(List<Expression> expression)
Rel	visit(Aggregate aggregate, EmptyVisitationContext context)	Visit an aggregate relation.
Rel	visit(ConsistentPartitionWindow consistentPartitionWindow, EmptyVisitationContext context)	Visit a consistent partition window relation.
Rel	visit(Cross cross, EmptyVisitationContext context)	Visit a cross product relation.
Rel	visit(Expand expand, EmptyVisitationContext context)	Visit an expand relation (e.g., generators).
Rel	visit(ExtensionDdl ddl, EmptyVisitationContext context)	Visit an extension DDL relation.
Rel	visit(ExtensionLeaf extensionLeaf, EmptyVisitationContext context)	Visit an extension leaf relation.
Rel	visit(ExtensionMulti extensionMulti, EmptyVisitationContext context)	Visit an extension multi-input relation.
Rel	visit(ExtensionSingle extensionSingle, EmptyVisitationContext context)	Visit an extension single-input relation.
Rel	visit(ExtensionTable extensionTable, EmptyVisitationContext context)	Visit an extension table relation.
Rel	visit(ExtensionWrite write, EmptyVisitationContext context)	Visit an extension write relation.
Rel	visit(Fetch fetch, EmptyVisitationContext context)	Visit a fetch (limit/offset) relation.
Rel	visit(Filter filter, EmptyVisitationContext context)	Visit a filter relation.
Rel	visit(Join join, EmptyVisitationContext context)	Visit a logical join relation.
Rel	visit(LocalFiles localFiles, EmptyVisitationContext context)	Visit a local files scan relation.
Rel	visit(NamedDdl ddl, EmptyVisitationContext context)	Visit a named DDL relation.
Rel	visit(NamedScan namedScan, EmptyVisitationContext context)	Visit a named scan relation.
Rel	visit(NamedUpdate update, EmptyVisitationContext context)	Visit a named update relation.
Rel	visit(NamedWrite write, EmptyVisitationContext context)	Visit a named write relation.
Rel	visit(BroadcastExchange exchange, EmptyVisitationContext context)	Visit a broadcast exchange relation.
Rel	visit(HashJoin hashJoin, EmptyVisitationContext context)	Visit a physical hash join relation.
Rel	visit(MergeJoin mergeJoin, EmptyVisitationContext context)	Visit a physical merge join relation.
Rel	visit(MultiBucketExchange exchange, EmptyVisitationContext context)	Visit a multi-bucket exchange relation.
Rel	visit(NestedLoopJoin nestedLoopJoin, EmptyVisitationContext context)	Visit a physical nested loop join relation.
Rel	visit(RoundRobinExchange exchange, EmptyVisitationContext context)	Visit a round-robin exchange relation.
Rel	visit(ScatterExchange exchange, EmptyVisitationContext context)	Visit a scatter exchange relation.
Rel	visit(SingleBucketExchange exchange, EmptyVisitationContext context)	Visit a single-bucket exchange relation.
Rel	visit(Project project, EmptyVisitationContext context)	Visit a project relation.
Rel	visit(Set set, EmptyVisitationContext context)	Visit a set operation relation (e.g., UNION/INTERSECT).
Rel	visit(Sort sort, EmptyVisitationContext context)	Visit a sort relation.
Rel	visit(VirtualTableScan virtualTableScan, EmptyVisitationContext context)	Visit a virtual table scan relation.

Methods inherited from class java.lang.Object

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

Field Details

exprProtoConverter

protected final @NonNull ExpressionProtoConverter exprProtoConverter

typeProtoConverter

protected final @NonNull TypeProtoConverter typeProtoConverter

extensionProtoConverter

protected final @NonNull ExtensionProtoConverter<?,?> extensionProtoConverter

extensionCollector

protected final @NonNull ExtensionCollector extensionCollector

Constructor Details

RelProtoConverter

public RelProtoConverter(@NonNull ExtensionCollector extensionCollector)

Constructor with custom ExtensionCollector.

Parameters:

extensionCollector - the custom ExtensionCollector to use, must not be null

RelProtoConverter

public RelProtoConverter(@NonNull ExtensionCollector extensionCollector,
 @NonNull ExtensionProtoConverter<?,?> extensionProtoConverter)

Constructor with custom ExtensionCollector and custom ExtensionProtoConverter.

Parameters:

extensionCollector - the custom ExtensionCollector to use, must not be null

extensionProtoConverter - the custom ExtensionProtoConverter to use, must not be null

Method Details

getExpressionProtoConverter

public ExpressionProtoConverter getExpressionProtoConverter()

getTypeProtoConverter

public TypeProtoConverter getTypeProtoConverter()

toProto

public RelRoot toProto(Plan.Root relRoot)

toProto

public Rel toProto(Rel rel)

toProto

protected Expression toProto(Expression expression)

toProto

protected List<Expression> toProto(List<Expression> expression)

toProto

protected Type toProto(Type type)

visit

public Rel visit(Aggregate aggregate,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit an aggregate relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

aggregate - the aggregate node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(Fetch fetch,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a fetch (limit/offset) relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

fetch - the fetch node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(Filter filter,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a filter relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

filter - the filter node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(Join join,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a logical join relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

join - the join node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(Set set,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a set operation relation (e.g., UNION/INTERSECT).

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

set - the set node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(NamedScan namedScan,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a named scan relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

namedScan - the named scan node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(LocalFiles localFiles,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a local files scan relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

localFiles - the local files node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(ExtensionTable extensionTable,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit an extension table relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

extensionTable - the extension table node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(HashJoin hashJoin,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a physical hash join relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

hashJoin - the hash join node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(MergeJoin mergeJoin,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a physical merge join relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

mergeJoin - the merge join node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(NestedLoopJoin nestedLoopJoin,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a physical nested loop join relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

nestedLoopJoin - the nested loop join node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(ConsistentPartitionWindow consistentPartitionWindow,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a consistent partition window relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

consistentPartitionWindow - the window node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(NamedWrite write,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a named write relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

write - the named write node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(ExtensionWrite write,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit an extension write relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

write - the extension write node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(NamedDdl ddl,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a named DDL relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

ddl - the named DDL node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(ExtensionDdl ddl,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit an extension DDL relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

ddl - the extension DDL node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(NamedUpdate update,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a named update relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

update - the named update node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(ScatterExchange exchange,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a scatter exchange relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

exchange - the scatter exchange node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(SingleBucketExchange exchange,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a single-bucket exchange relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

exchange - the single-bucket exchange node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(MultiBucketExchange exchange,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a multi-bucket exchange relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

exchange - the multi-bucket exchange node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(RoundRobinExchange exchange,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a round-robin exchange relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

exchange - the round-robin exchange node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(BroadcastExchange exchange,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a broadcast exchange relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

exchange - the broadcast exchange node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(Project project,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a project relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

project - the project node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(Expand expand,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit an expand relation (e.g., generators).

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

expand - the expand node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(Sort sort,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a sort relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

sort - the sort node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(Cross cross,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a cross product relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

cross - the cross node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(VirtualTableScan virtualTableScan,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit a virtual table scan relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

virtualTableScan - the virtual table scan node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(ExtensionLeaf extensionLeaf,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit an extension leaf relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

extensionLeaf - the extension leaf node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(ExtensionSingle extensionSingle,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit an extension single-input relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

extensionSingle - the extension single node

context - visitation context

Returns:

visit result

Throws:

RuntimeException

visit

public Rel visit(ExtensionMulti extensionMulti,
 EmptyVisitationContext context)
          throws RuntimeException

Description copied from interface: RelVisitor

Visit an extension multi-input relation.

Specified by:

visit in interface RelVisitor<Rel,EmptyVisitationContext,RuntimeException>

Parameters:

extensionMulti - the extension multi node

context - visitation context

Returns:

visit result

Throws:

RuntimeException