Deprecate redundant getReference(IdentifierProcessing) method.

kurtn718 · schauder · commit 18eda61f15d0 · 2023-03-23T10:45:49.000+01:00
Closes #1110 Original pull request #1458
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingBatchInsertStrategy.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingBatchInsertStrategy.java
@@ -79,7 +79,7 @@ public Object[] execute(String sql, SqlParameterSource[] sqlParameterSources) {
 			Map<String, Object> keys = keyList.get(i);
 			if (keys.size() > 1) {
 				if (idColumn != null) {
-					ids[i] = keys.get(idColumn.getReference(dialect.getIdentifierProcessing()));
+					ids[i] = keys.get(idColumn.getReference());
 				}
 			} else {
 				ids[i] = keys.entrySet().stream().findFirst() //
@@ -93,7 +93,7 @@ public Object[] execute(String sql, SqlParameterSource[] sqlParameterSources) {
 	private String[] getKeyColumnNames() {
 
 		return Optional.ofNullable(idColumn)
-				.map(idColumn -> new String[] { idColumn.getReference(dialect.getIdentifierProcessing()) })
+				.map(idColumn -> new String[] { idColumn.getReference() })
 				.orElse(new String[0]);
 	}
 }
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingInsertStrategy.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingInsertStrategy.java
@@ -79,13 +79,13 @@ public Object execute(String sql, SqlParameterSource sqlParameterSource) {
 				return null;
 			}
 
-			return keys.get(idColumn.getReference(dialect.getIdentifierProcessing()));
+			return keys.get(idColumn.getReference());
 		}
 	}
 
 	private String[] getKeyColumnNames() {
 		return Optional.ofNullable(idColumn)
-				.map(idColumn -> new String[] { idColumn.getReference(dialect.getIdentifierProcessing()) })
+				.map(idColumn -> new String[] { idColumn.getReference() })
 				.orElse(new String[0]);
 	}
 }
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcBackReferencePropertyValueProvider.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcBackReferencePropertyValueProvider.java
@@ -50,7 +50,7 @@ class JdbcBackReferencePropertyValueProvider implements PropertyValueProvider<Re
 	@Override
 	public <T> T getPropertyValue(RelationalPersistentProperty property) {
 		return (T) resultSet
-				.getObject(basePath.extendBy(property).getReverseColumnNameAlias().getReference(identifierProcessing));
+				.getObject(basePath.extendBy(property).getReverseColumnNameAlias().getReference());
 	}
 
 	public JdbcBackReferencePropertyValueProvider extendBy(RelationalPersistentProperty property) {
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcPropertyValueProvider.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcPropertyValueProvider.java
@@ -62,7 +62,7 @@ public boolean hasProperty(RelationalPersistentProperty property) {
 	}
 
 	private String getColumnName(RelationalPersistentProperty property) {
-		return basePath.extendBy(property).getColumnAlias().getReference(identifierProcessing);
+		return basePath.extendBy(property).getColumnAlias().getReference();
 	}
 
 	public JdbcPropertyValueProvider extendBy(RelationalPersistentProperty property) {
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/MapEntityRowMapper.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/MapEntityRowMapper.java
@@ -53,7 +53,7 @@ class MapEntityRowMapper<T> implements RowMapper<Map.Entry<Object, T>> {
 	@Override
 	public Map.Entry<Object, T> mapRow(ResultSet rs, int rowNum) throws SQLException {
 
-		Object key = rs.getObject(keyColumn.getReference(identifierProcessing));
+		Object key = rs.getObject(keyColumn.getReference());
 		return new HashMap.SimpleEntry<>(key, mapEntity(rs, key));
 	}
 
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlGenerator.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlGenerator.java
@@ -772,7 +772,7 @@ private Column getVersionColumn() {
 	}
 
 	private String renderReference(SqlIdentifier identifier) {
-		return identifier.getReference(renderContext.getIdentifierProcessing());
+		return identifier.getReference();
 	}
 
 	private List<OrderByField> extractOrderByFields(Sort sort) {
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlIdentifierParameterSource.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlIdentifierParameterSource.java
@@ -68,7 +68,7 @@ void addValue(SqlIdentifier name, Object value) {
 	void addValue(SqlIdentifier identifier, Object value, int sqlType) {
 
 		identifiers.add(identifier);
-		String name = BindParameterNameSanitizer.sanitize(identifier.getReference(identifierProcessing));
+		String name = BindParameterNameSanitizer.sanitize(identifier.getReference());
 		namesToValues.put(name, value);
 		registerSqlType(name, sqlType);
 	}
@@ -77,7 +77,7 @@ void addAll(SqlIdentifierParameterSource others) {
 
 		for (SqlIdentifier identifier : others.getIdentifiers()) {
 
-			String name = identifier.getReference(identifierProcessing);
+			String name = identifier.getReference();
 			addValue(identifier, others.getValue(name), others.getSqlType(name));
 		}
 	}
diff --git a/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/H2Dialect.java b/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/H2Dialect.java
@@ -47,7 +47,7 @@ public BindMarkersFactory getBindMarkersFactory() {
 
 	@Override
 	public String renderForGeneratedValues(SqlIdentifier identifier) {
-		return identifier.getReference(getIdentifierProcessing());
+		return identifier.getReference();
 	}
 
 	@Override
diff --git a/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/MySqlDialect.java b/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/MySqlDialect.java
@@ -95,7 +95,7 @@ public Boolean convert(Byte s) {
 
 	@Override
 	public String renderForGeneratedValues(SqlIdentifier identifier) {
-		return identifier.getReference(getIdentifierProcessing());
+		return identifier.getReference();
 	}
 
 	/**
diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java
@@ -65,8 +65,9 @@ public String toSql(IdentifierProcessing processing) {
 	}
 
 	@Override
+	@Deprecated(since="3.1", forRemoval = true)
 	public String getReference(IdentifierProcessing processing) {
-		return this.name;
+		return toSql(processing);
 	}
 
 	@Override
diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/NamingStrategy.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/NamingStrategy.java
@@ -84,7 +84,7 @@ default String getReverseColumnName(RelationalPersistentProperty property) {
 
 		Assert.notNull(property, "Property must not be null");
 
-		return property.getOwner().getTableName().getReference(IdentifierProcessing.NONE);
+		return property.getOwner().getTableName().getReference();
 	}
 
 	default String getReverseColumnName(PersistentPropertyPathExtension path) {
diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/PersistentPropertyPathExtension.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/PersistentPropertyPathExtension.java
@@ -482,7 +482,7 @@ private SqlIdentifier prefixWithTableAlias(SqlIdentifier columnName) {
 
 		SqlIdentifier tableAlias = getTableAlias();
 		return tableAlias == null ? columnName
-				: columnName.transform(name -> tableAlias.getReference(IdentifierProcessing.NONE) + "_" + name);
+				: columnName.transform(name -> tableAlias.getReference() + "_" + name);
 	}
 
 	@Override
diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java
@@ -66,6 +66,7 @@ public String toSql(IdentifierProcessing processing) {
 	}
 
 	@Override
+	@Deprecated(since="3.1", forRemoval = true)
 	public String getReference(IdentifierProcessing processing) {
 		throw new UnsupportedOperationException("Composite SQL Identifiers can't be used for reference name retrieval");
 	}
diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java
@@ -57,12 +57,13 @@ public SqlIdentifier transform(UnaryOperator<String> transformationFunction) {
 
 	@Override
 	public String toSql(IdentifierProcessing processing) {
-		return quoted ? processing.quote(getReference(processing)) : getReference(processing);
+		return quoted ? processing.quote(name) : name;
 	}
 
 	@Override
+	@Deprecated(since="3.1", forRemoval = true)
 	public String getReference(IdentifierProcessing processing) {
-		return name;
+		return toSql(processing);
 	}
 
 	@Override
diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java
@@ -26,7 +26,7 @@
  * from a {@link String name} with specifying whether the name should be quoted or unquoted.
  * <p>
  * {@link SqlIdentifier} renders its name using {@link IdentifierProcessing} rules. Use
- * {@link #getReference(IdentifierProcessing)} to refer to an object using the identifier when e.g. obtaining values
+ * {@link #getReference()} to refer to an object using the identifier when e.g. obtaining values
  * from a result or providing values for a prepared statement. {@link #toSql(IdentifierProcessing)} renders the
  * identifier for SQL statement usage.
  * <p>
@@ -39,6 +39,7 @@
  *
  * @author Jens Schauder
  * @author Mark Paluch
+ * @author Kurt Niemi
  * @since 2.0
  */
 public interface SqlIdentifier extends Streamable<SqlIdentifier> {
@@ -79,23 +80,26 @@ public String toString() {
 	 *
 	 * @param processing identifier processing rules.
 	 * @return
+	 * @deprecated since 3.1, use the #getReference() method instead.
 	 */
+	@Deprecated(since="3.1", forRemoval = true)
 	String getReference(IdentifierProcessing processing);
 
 	/**
-	 * Return the reference name without any further transformation. The reference name is used for programmatic access to
-	 * the object identified by this {@link SqlIdentifier}.
+	 * Use this method whenever accessing a column in a ResultSet and we do not want any quoting applied. The
+	 * reference name is used for programmatic access to the object identified by this {@link SqlIdentifier}.
 	 *
 	 * @return
 	 * @see IdentifierProcessing#NONE
 	 */
 	default String getReference() {
-		return getReference(IdentifierProcessing.NONE);
+		return toSql(IdentifierProcessing.NONE);
 	}
 
 	/**
-	 * Return the identifier for SQL usage after applying {@link IdentifierProcessing} rules. The identifier name is used
-	 * to construct SQL statements.
+	 * Use this method when rendering an identifier in SQL statements as in:
+	 * <pre><code>select yourColumn from someTable</code></pre>
+	 * {@link IdentifierProcessing} rules are applied to the identifier.
 	 *
 	 * @param processing identifier processing rules.
 	 * @return
diff --git a/spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifierUnitTests.java b/spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifierUnitTests.java
@@ -41,7 +41,8 @@ public void quotedSimpleObjectIdentifierWithAdjustableLetterCasing() {
 		SqlIdentifier identifier = new DerivedSqlIdentifier("someName", true);
 
 		assertThat(identifier.toSql(BRACKETS_LOWER_CASE)).isEqualTo("[somename]");
-		assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("someName");
+		assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("[somename]");
+		assertThat(identifier.getReference()).isEqualTo("someName");
 
 	}
 
@@ -52,7 +53,8 @@ public void unquotedSimpleObjectIdentifierWithAdjustableLetterCasing() {
 		String sql = identifier.toSql(BRACKETS_LOWER_CASE);
 
 		assertThat(sql).isEqualTo("somename");
-		assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("someName");
+		assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("somename");
+		assertThat(identifier.getReference()).isEqualTo("someName");
 	}
 
 	@Test // DATAJDBC-386
diff --git a/spring-data-relational/src/test/java/org/springframework/data/relational/core/sql/SqlIdentifierUnitTests.java b/spring-data-relational/src/test/java/org/springframework/data/relational/core/sql/SqlIdentifierUnitTests.java
@@ -40,7 +40,8 @@ public void quotedSimpleObjectIdentifier() {
 		SqlIdentifier identifier = quoted("someName");
 
 		assertThat(identifier.toSql(BRACKETS_LOWER_CASE)).isEqualTo("[someName]");
-		assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("someName");
+		assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("[someName]");
+		assertThat(identifier.getReference()).isEqualTo("someName");
 	}
 
 	@Test // DATAJDBC-386
@@ -51,6 +52,7 @@ public void unquotedSimpleObjectIdentifier() {
 
 		assertThat(sql).isEqualTo("someName");
 		assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("someName");
+		assertThat(identifier.getReference()).isEqualTo("someName");
 	}
 
 	@Test // DATAJDBC-386

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public Object[] execute(String sql, SqlParameterSource[] sqlParameterSources) {`
`79`	`79`	`Map<String, Object> keys = keyList.get(i);`
`80`	`80`	`if (keys.size() > 1) {`
`81`	`81`	`if (idColumn != null) {`
`82`		`- ids[i] = keys.get(idColumn.getReference(dialect.getIdentifierProcessing()));`
	`82`	`+ ids[i] = keys.get(idColumn.getReference());`
`83`	`83`	`}`
`84`	`84`	`} else {`
`85`	`85`	`ids[i] = keys.entrySet().stream().findFirst() //`
`@@ -93,7 +93,7 @@ public Object[] execute(String sql, SqlParameterSource[] sqlParameterSources) {`
`93`	`93`	`private String[] getKeyColumnNames() {`
`94`	`94`
`95`	`95`	`return Optional.ofNullable(idColumn)`
`96`		`- .map(idColumn -> new String[] { idColumn.getReference(dialect.getIdentifierProcessing()) })`
	`96`	`+ .map(idColumn -> new String[] { idColumn.getReference() })`
`97`	`97`	`.orElse(new String[0]);`
`98`	`98`	`}`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,13 +79,13 @@ public Object execute(String sql, SqlParameterSource sqlParameterSource) {`
`79`	`79`	`return null;`
`80`	`80`	`}`
`81`	`81`
`82`		`- return keys.get(idColumn.getReference(dialect.getIdentifierProcessing()));`
	`82`	`+ return keys.get(idColumn.getReference());`
`83`	`83`	`}`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`private String[] getKeyColumnNames() {`
`87`	`87`	`return Optional.ofNullable(idColumn)`
`88`		`- .map(idColumn -> new String[] { idColumn.getReference(dialect.getIdentifierProcessing()) })`
	`88`	`+ .map(idColumn -> new String[] { idColumn.getReference() })`
`89`	`89`	`.orElse(new String[0]);`
`90`	`90`	`}`
`91`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ class JdbcBackReferencePropertyValueProvider implements PropertyValueProvider<Re`
`50`	`50`	`@Override`
`51`	`51`	`public <T> T getPropertyValue(RelationalPersistentProperty property) {`
`52`	`52`	`return (T) resultSet`
`53`		`- .getObject(basePath.extendBy(property).getReverseColumnNameAlias().getReference(identifierProcessing));`
	`53`	`+ .getObject(basePath.extendBy(property).getReverseColumnNameAlias().getReference());`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`public JdbcBackReferencePropertyValueProvider extendBy(RelationalPersistentProperty property) {`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public boolean hasProperty(RelationalPersistentProperty property) {`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`private String getColumnName(RelationalPersistentProperty property) {`
`65`		`- return basePath.extendBy(property).getColumnAlias().getReference(identifierProcessing);`
	`65`	`+ return basePath.extendBy(property).getColumnAlias().getReference();`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`public JdbcPropertyValueProvider extendBy(RelationalPersistentProperty property) {`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ class MapEntityRowMapper<T> implements RowMapper<Map.Entry<Object, T>> {`
`53`	`53`	`@Override`
`54`	`54`	`public Map.Entry<Object, T> mapRow(ResultSet rs, int rowNum) throws SQLException {`
`55`	`55`
`56`		`- Object key = rs.getObject(keyColumn.getReference(identifierProcessing));`
	`56`	`+ Object key = rs.getObject(keyColumn.getReference());`
`57`	`57`	`return new HashMap.SimpleEntry<>(key, mapEntity(rs, key));`
`58`	`58`	`}`
`59`	`59`
Original file line number	Diff line number	Diff line change
`@@ -772,7 +772,7 @@ private Column getVersionColumn() {`
`772`	`772`	`}`
`773`	`773`
`774`	`774`	`private String renderReference(SqlIdentifier identifier) {`
`775`		`- return identifier.getReference(renderContext.getIdentifierProcessing());`
	`775`	`+ return identifier.getReference();`
`776`	`776`	`}`
`777`	`777`
`778`	`778`	`private List<OrderByField> extractOrderByFields(Sort sort) {`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ void addValue(SqlIdentifier name, Object value) {`
`68`	`68`	`void addValue(SqlIdentifier identifier, Object value, int sqlType) {`
`69`	`69`
`70`	`70`	`identifiers.add(identifier);`
`71`		`- String name = BindParameterNameSanitizer.sanitize(identifier.getReference(identifierProcessing));`
	`71`	`+ String name = BindParameterNameSanitizer.sanitize(identifier.getReference());`
`72`	`72`	`namesToValues.put(name, value);`
`73`	`73`	`registerSqlType(name, sqlType);`
`74`	`74`	`}`
`@@ -77,7 +77,7 @@ void addAll(SqlIdentifierParameterSource others) {`
`77`	`77`
`78`	`78`	`for (SqlIdentifier identifier : others.getIdentifiers()) {`
`79`	`79`
`80`		`- String name = identifier.getReference(identifierProcessing);`
	`80`	`+ String name = identifier.getReference();`
`81`	`81`	`addValue(identifier, others.getValue(name), others.getSqlType(name));`
`82`	`82`	`}`
`83`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public BindMarkersFactory getBindMarkersFactory() {`
`47`	`47`
`48`	`48`	`@Override`
`49`	`49`	`public String renderForGeneratedValues(SqlIdentifier identifier) {`
`50`		`- return identifier.getReference(getIdentifierProcessing());`
	`50`	`+ return identifier.getReference();`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public Boolean convert(Byte s) {`
`95`	`95`
`96`	`96`	`@Override`
`97`	`97`	`public String renderForGeneratedValues(SqlIdentifier identifier) {`
`98`		`- return identifier.getReference(getIdentifierProcessing());`
	`98`	`+ return identifier.getReference();`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,9 @@ public String toSql(IdentifierProcessing processing) {`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`@Override`
	`68`	`+ @Deprecated(since="3.1", forRemoval = true)`
`68`	`69`	`public String getReference(IdentifierProcessing processing) {`
`69`		`- return this.name;`
	`70`	`+ return toSql(processing);`
`70`	`71`	`}`
`71`	`72`
`72`	`73`	`@Override`