[CALCITE-3262] Refine doc of SubstitutionVisitor.java

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.21.0
• Component/s: core
• Labels: pull-request-available
• Assignee: Jin Xing
• Reporter: Jin Xing
• Created: 19/Aug/19 04:11
• Updated: 08/Jan/20 04:01
• Resolved: 21/Aug/19 17:37

Description

Current doc of SubstitutionVisitor.java says the supported core relational operators are @link org.apache.calcite.rel.logical.LogicalTableScan, and so on.
But with convertTableAccess=true (https://github.com/apache/calcite/blob/master/core/src/main/java/org/apache/calcite/sql2rel/SqlToRelConverter.java#L5636), it's a EnumerableTableScan under MutableScan, which is inconsistent with the doc.
And what's more, MutableRels and SubstitutionVisitor supporting scope doesn't limit to be org.apache.calcite.rel.logical.LogicalXXX.
So I think it might make sense to update/refine the doc to say that the supported core relational operators are

 * {@link org.apache.calcite.rel.core.TableScan},
 * {@link org.apache.calcite.rel.core.Filter},
 * {@link org.apache.calcite.rel.core.Project},
 * {@link org.apache.calcite.rel.core.Join},
 * {@link org.apache.calcite.rel.core.Union},
 * {@link org.apache.calcite.rel.core.Aggregate}.</p>

Issue Links

• links to: GitHub Pull Request #1388
• links to: GitHub Pull Request #1734