DATAJDBC-309 - Introduce RenderContext and RenderNamingStrategy.

Introduce naming strategy to customize table and column naming.

Author: mp911de

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/ComparisonVisitor.java

@@ -31,15 +31,17 @@
  */
 class ComparisonVisitor extends FilteredSubtreeVisitor {
 
+	private final RenderContext context;
 	private final Comparison condition;
 	private final RenderTarget target;
 	private final StringBuilder part = new StringBuilder();
 	private @Nullable PartRenderer current;
 
-	ComparisonVisitor(Comparison condition, RenderTarget target) {
+	ComparisonVisitor(RenderContext context, Comparison condition, RenderTarget target) {
 		super(it -> it == condition);
 		this.condition = condition;
 		this.target = target;
+		this.context = context;
 	}
 
 	/*
@@ -50,13 +52,13 @@ class ComparisonVisitor extends FilteredSubtreeVisitor {
 	Delegation enterNested(Visitable segment) {
 
 		if (segment instanceof Expression) {
-			ExpressionVisitor visitor = new ExpressionVisitor();
+			ExpressionVisitor visitor = new ExpressionVisitor(context);
 			current = visitor;
 			return Delegation.delegateTo(visitor);
 		}
 
 		if (segment instanceof Condition) {
-			ConditionVisitor visitor = new ConditionVisitor();
+			ConditionVisitor visitor = new ConditionVisitor(context);
 			current = visitor;
 			return Delegation.delegateTo(visitor);
 		}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/ConditionVisitor.java

@@ -39,8 +39,13 @@
  */
 class ConditionVisitor extends TypedSubtreeVisitor<Condition> implements PartRenderer {
 
+	private final RenderContext context;
 	private StringBuilder builder = new StringBuilder();
 
+	ConditionVisitor(RenderContext context) {
+		this.context = context;
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.relational.core.sql.render.TypedSubtreeVisitor#enterMatched(org.springframework.data.relational.core.sql.Visitable)
@@ -57,27 +62,27 @@ Delegation enterMatched(Condition segment) {
 	private DelegatingVisitor getDelegation(Condition segment) {
 
 		if (segment instanceof AndCondition) {
-			return new MultiConcatConditionVisitor((AndCondition) segment, builder::append);
+			return new MultiConcatConditionVisitor(context, (AndCondition) segment, builder::append);
 		}
 
 		if (segment instanceof OrCondition) {
-			return new MultiConcatConditionVisitor((OrCondition) segment, builder::append);
+			return new MultiConcatConditionVisitor(context, (OrCondition) segment, builder::append);
 		}
 
 		if (segment instanceof IsNull) {
-			return new IsNullVisitor(builder::append);
+			return new IsNullVisitor(context, builder::append);
 		}
 
 		if (segment instanceof Comparison) {
-			return new ComparisonVisitor((Comparison) segment, builder::append);
+			return new ComparisonVisitor(context, (Comparison) segment, builder::append);
 		}
 
 		if (segment instanceof Like) {
-			return new LikeVisitor((Like) segment, builder::append);
+			return new LikeVisitor((Like) segment, context, builder::append);
 		}
 
 		if (segment instanceof In) {
-			return new InVisitor(builder::append);
+			return new InVisitor(context, builder::append);
 		}
 
 		return null;

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/ExpressionVisitor.java

@@ -33,10 +33,13 @@
  */
 class ExpressionVisitor extends TypedSubtreeVisitor<Expression> implements PartRenderer {
 
+	private final RenderContext context;
+
 	private CharSequence value = "";
 	private PartRenderer partRenderer;
 
-	ExpressionVisitor() {
+	ExpressionVisitor(RenderContext context) {
+		this.context = context;
 	}
 
 	/*
@@ -48,13 +51,17 @@ Delegation enterMatched(Expression segment) {
 
 		if (segment instanceof SubselectExpression) {
 
-			SelectStatementVisitor visitor = new SelectStatementVisitor();
+			SelectStatementVisitor visitor = new SelectStatementVisitor(context);
 			partRenderer = visitor;
 			return Delegation.delegateTo(visitor);
 		}
 
 		if (segment instanceof Column) {
-			value = ((Column) segment).getTable().getReferenceName() + "." + ((Column) segment).getReferenceName();
+
+			RenderNamingStrategy namingStrategy = context.getNamingStrategy();
+			Column column = (Column) segment;
+
+			value = namingStrategy.getReferenceName(column.getTable()) + "." + namingStrategy.getReferenceName(column);
 		} else if (segment instanceof BindMarker) {
 
 			if (segment instanceof Named) {
@@ -75,7 +82,7 @@ Delegation enterMatched(Expression segment) {
 	Delegation enterNested(Visitable segment) {
 
 		if (segment instanceof Condition) {
-			ConditionVisitor visitor = new ConditionVisitor();
+			ConditionVisitor visitor = new ConditionVisitor(context);
 			partRenderer = visitor;
 			return Delegation.delegateTo(visitor);
 		}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/FilteredSingleConditionRenderSupport.java

@@ -30,17 +30,20 @@
  */
 abstract class FilteredSingleConditionRenderSupport extends FilteredSubtreeVisitor {
 
+	private final RenderContext context;
 	private PartRenderer current;
 
 	/**
 	 * Creates a new {@link FilteredSingleConditionRenderSupport} given the filter {@link Predicate}.
 	 *
+	 * @param context
 	 * @param filter filter predicate to identify when to {@link #enterMatched(Visitable)
 	 *          enter}/{@link #leaveMatched(Visitable) leave} the {@link Visitable segment} that this visitor is
 	 *          responsible for.
 	 */
-	FilteredSingleConditionRenderSupport(Predicate<Visitable> filter) {
+	FilteredSingleConditionRenderSupport(RenderContext context, Predicate<Visitable> filter) {
 		super(filter);
+		this.context = context;
 	}
 
 	/*
@@ -51,13 +54,13 @@ abstract class FilteredSingleConditionRenderSupport extends FilteredSubtreeVisit
 	Delegation enterNested(Visitable segment) {
 
 		if (segment instanceof Expression) {
-			ExpressionVisitor visitor = new ExpressionVisitor();
+			ExpressionVisitor visitor = new ExpressionVisitor(context);
 			current = visitor;
 			return Delegation.delegateTo(visitor);
 		}
 
 		if (segment instanceof Condition) {
-			ConditionVisitor visitor = new ConditionVisitor();
+			ConditionVisitor visitor = new ConditionVisitor(context);
 			current = visitor;
 			return Delegation.delegateTo(visitor);
 		}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/FromClauseVisitor.java

@@ -26,22 +26,24 @@
  */
 class FromClauseVisitor extends TypedSubtreeVisitor<From> {
 
-	private final StringBuilder builder = new StringBuilder();
+	private final FromTableVisitor visitor;
 	private final RenderTarget parent;
-
+	private final StringBuilder builder = new StringBuilder();
 	private boolean first = true;
-	private final FromTableVisitor visitor = new FromTableVisitor(it -> {
 
-		if (first) {
-			first = false;
-		} else {
-			builder.append(", ");
-		}
+	FromClauseVisitor(RenderContext context, RenderTarget parent) {
+
+		this.visitor = new FromTableVisitor(context, it -> {
+
+			if (first) {
+				first = false;
+			} else {
+				builder.append(", ");
+			}
 
-		builder.append(it);
-	});
+			builder.append(it);
+		});
 
-	FromClauseVisitor(RenderTarget parent) {
 		this.parent = parent;
 	}
 

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/FromTableVisitor.java

@@ -28,10 +28,12 @@
  */
 class FromTableVisitor extends TypedSubtreeVisitor<Table> {
 
+	private final RenderContext context;
 	private final RenderTarget parent;
 
-	FromTableVisitor(RenderTarget parent) {
+	FromTableVisitor(RenderContext context, RenderTarget parent) {
 		super();
+		this.context = context;
 		this.parent = parent;
 	}
 
@@ -44,7 +46,7 @@ Delegation enterMatched(Table segment) {
 
 		StringBuilder builder = new StringBuilder();
 
-		builder.append(segment.getName());
+		builder.append(context.getNamingStrategy().getName(segment));
 		if (segment instanceof Aliased) {
 			builder.append(" AS ").append(((Aliased) segment).getAlias());
 		}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/InVisitor.java

@@ -30,7 +30,8 @@ class InVisitor extends TypedSingleConditionRenderSupport<In> {
 	private final StringBuilder part = new StringBuilder();
 	private boolean needsComma = false;
 
-	InVisitor(RenderTarget target) {
+	InVisitor(RenderContext context, RenderTarget target) {
+		super(context);
 		this.target = target;
 	}
 

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/IsNullVisitor.java

@@ -29,7 +29,8 @@ class IsNullVisitor extends TypedSingleConditionRenderSupport<IsNull> {
 	private final RenderTarget target;
 	private final StringBuilder part = new StringBuilder();
 
-	IsNullVisitor(RenderTarget target) {
+	IsNullVisitor(RenderContext context, RenderTarget target) {
+		super(context);
 		this.target = target;
 	}
 

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/JoinVisitor.java

@@ -29,12 +29,14 @@
  */
 class JoinVisitor extends TypedSubtreeVisitor<Join> {
 
+	private final RenderContext context;
 	private final RenderTarget parent;
 	private final StringBuilder joinClause = new StringBuilder();
 	private boolean inCondition = false;
 	private boolean hasSeenCondition = false;
 
-	JoinVisitor(RenderTarget parent) {
+	JoinVisitor(RenderContext context, RenderTarget parent) {
+		this.context = context;
 		this.parent = parent;
 	}
 
@@ -58,7 +60,7 @@ Delegation enterMatched(Join segment) {
 	Delegation enterNested(Visitable segment) {
 
 		if (segment instanceof Table && !inCondition) {
-			joinClause.append(((Table) segment).getName());
+			joinClause.append(context.getNamingStrategy().getName(((Table) segment)));
 			if (segment instanceof Aliased) {
 				joinClause.append(" AS ").append(((Aliased) segment).getAlias());
 			}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/LikeVisitor.java

@@ -30,12 +30,14 @@
  */
 class LikeVisitor extends FilteredSubtreeVisitor {
 
+	private final RenderContext context;
 	private final RenderTarget target;
 	private final StringBuilder part = new StringBuilder();
 	private @Nullable PartRenderer current;
 
-	LikeVisitor(Like condition, RenderTarget target) {
+	LikeVisitor(Like condition, RenderContext context, RenderTarget target) {
 		super(it -> it == condition);
+		this.context = context;
 		this.target = target;
 	}
 
@@ -47,13 +49,13 @@ class LikeVisitor extends FilteredSubtreeVisitor {
 	Delegation enterNested(Visitable segment) {
 
 		if (segment instanceof Expression) {
-			ExpressionVisitor visitor = new ExpressionVisitor();
+			ExpressionVisitor visitor = new ExpressionVisitor(context);
 			current = visitor;
 			return Delegation.delegateTo(visitor);
 		}
 
 		if (segment instanceof Condition) {
-			ConditionVisitor visitor = new ConditionVisitor();
+			ConditionVisitor visitor = new ConditionVisitor(context);
 			current = visitor;
 			return Delegation.delegateTo(visitor);
 		}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/MultiConcatConditionVisitor.java

@@ -32,14 +32,14 @@ class MultiConcatConditionVisitor extends FilteredSingleConditionRenderSupport {
 	private final String concat;
 	private final StringBuilder part = new StringBuilder();
 
-	MultiConcatConditionVisitor(AndCondition condition, RenderTarget target) {
-		super(it -> it == condition);
+	MultiConcatConditionVisitor(RenderContext context, AndCondition condition, RenderTarget target) {
+		super(context, it -> it == condition);
 		this.target = target;
 		this.concat = " AND ";
 	}
 
-	MultiConcatConditionVisitor(OrCondition condition, RenderTarget target) {
-		super(it -> it == condition);
+	MultiConcatConditionVisitor(RenderContext context, OrCondition condition, RenderTarget target) {
+		super(context, it -> it == condition);
 		this.target = target;
 		this.concat = " OR ";
 	}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/NaiveSqlRenderer.java

@@ -28,8 +28,10 @@
 public class NaiveSqlRenderer {
 
 	private final Select select;
+	private final RenderContext context;
 
-	private NaiveSqlRenderer(Select select) {
+	private NaiveSqlRenderer(Select select, RenderContext context) {
+		this.context = context;
 
 		Assert.notNull(select, "Select must not be null!");
 
@@ -43,7 +45,18 @@ private NaiveSqlRenderer(Select select) {
 	 * @return the renderer.
 	 */
 	public static NaiveSqlRenderer create(Select select) {
-		return new NaiveSqlRenderer(select);
+		return new NaiveSqlRenderer(select, new SimpleRenderContext(NamingStrategies.asIs()));
+	}
+
+	/**
+	 * Creates a new {@link NaiveSqlRenderer} using a {@link RenderContext}.
+	 *
+	 * @param select must not be {@literal null}.
+	 * @param context must not be {@literal null}.
+	 * @return the renderer.
+	 */
+	public static NaiveSqlRenderer create(Select select, RenderContext context) {
+		return new NaiveSqlRenderer(select, context);
 	}
 
 	/**
@@ -63,7 +76,7 @@ public static String render(Select select) {
 	 */
 	public String render() {
 
-		SelectStatementVisitor visitor = new SelectStatementVisitor();
+		SelectStatementVisitor visitor = new SelectStatementVisitor(context);
 		select.visit(visitor);
 
 		return visitor.getRenderedPart().toString();