DATACASS-828 - Resolve selection projection and ordering of composite key properties into multiple columns.

We now resolve property names pointing to a composite key property into its individual column names to be applies in a SELECT projection or for ordering.

Author: mp911de

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/convert/QueryMapper.java

@@ -22,8 +22,8 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
-import java.util.stream.Collectors;
 
+import org.springframework.data.cassandra.core.mapping.BasicCassandraPersistentEntity;
 import org.springframework.data.cassandra.core.mapping.CassandraMappingContext;
 import org.springframework.data.cassandra.core.mapping.CassandraPersistentEntity;
 import org.springframework.data.cassandra.core.mapping.CassandraPersistentProperty;
@@ -167,8 +167,14 @@ public List<Selector> getMappedSelectors(Columns columns, CassandraPersistentEnt
 
 			Field field = createPropertyField(entity, column);
 
-			columns.getSelector(column).ifPresent(selector -> getCqlIdentifier(column, field)
-					.ifPresent(cqlIdentifier -> selectors.add(getMappedSelector(selector, cqlIdentifier))));
+			columns.getSelector(column).ifPresent(selector -> {
+
+				List<CqlIdentifier> mappedColumnNames = getCqlIdentifier(column, field);
+
+				for (CqlIdentifier mappedColumnName : mappedColumnNames) {
+					selectors.add(getMappedSelector(selector, mappedColumnName));
+				}
+			});
 		}
 
 		if (columns.isEmpty()) {
@@ -207,17 +213,15 @@ private Selector getMappedSelector(Selector selector, CqlIdentifier cqlIdentifie
 
 			FunctionCall functionCall = (FunctionCall) selector;
 
-			List<Object> mappedParameters = functionCall.getParameters().stream().map(obj -> {
+			FunctionCall mappedFunctionCall = FunctionCall.from(functionCall.getExpression(),
+					functionCall.getParameters().stream().map(obj -> {
 
-				if (obj instanceof Selector) {
-					return getMappedSelector((Selector) obj, cqlIdentifier);
-				}
-
-				return obj;
-			}) //
-					.collect(Collectors.toList());
+						if (obj instanceof Selector) {
+							return getMappedSelector((Selector) obj, cqlIdentifier);
+						}
 
-			FunctionCall mappedFunctionCall = FunctionCall.from(functionCall.getExpression(), mappedParameters.toArray());
+						return obj;
+					}).toArray());
 
 			return functionCall.getAlias() //
 					.map(mappedFunctionCall::as) //
@@ -252,11 +256,10 @@ public List<CqlIdentifier> getMappedColumnNames(Columns columns, CassandraPersis
 		for (ColumnName column : columns) {
 
 			Field field = createPropertyField(entity, column);
-
 			field.getProperty().ifPresent(seen::add);
 
 			columns.getSelector(column).filter(selector -> selector instanceof ColumnSelector)
-					.ifPresent(columnSelector -> getCqlIdentifier(column, field).ifPresent(columnNames::add));
+					.ifPresent(columnSelector -> columnNames.addAll(getCqlIdentifier(column, field)));
 		}
 
 		if (columns.isEmpty()) {
@@ -293,40 +296,49 @@ public Sort getMappedSort(Sort sort, CassandraPersistentEntity<?> entity) {
 
 			Field field = createPropertyField(entity, columnName);
 
-			Order mappedOrder = getCqlIdentifier(columnName, field)
-					.map(cqlIdentifier -> new Order(order.getDirection(), cqlIdentifier.toString())).orElse(order);
+			List<CqlIdentifier> mappedColumnNames = getCqlIdentifier(columnName, field);
 
-			mappedOrders.add(mappedOrder);
+			if (mappedColumnNames.isEmpty()) {
+				mappedOrders.add(order);
+			} else {
+				for (CqlIdentifier mappedColumnName : mappedColumnNames) {
+					mappedOrders.add(new Order(order.getDirection(), mappedColumnName.toString()));
+				}
+			}
 		}
 
 		return Sort.by(mappedOrders);
 	}
 
-	private Optional<CqlIdentifier> getCqlIdentifier(ColumnName column, Field field) {
+	private List<CqlIdentifier> getCqlIdentifier(ColumnName column, Field field) {
 
+		List<CqlIdentifier> identifiers = new ArrayList<>(1);
 		try {
 			if (field.getProperty().isPresent()) {
 
-				return field.getProperty().map(cassandraPersistentProperty -> {
+				CassandraPersistentProperty property = field.getProperty().get();
 
-					if (cassandraPersistentProperty.isCompositePrimaryKey()) {
-						throw new IllegalArgumentException(
-								"Cannot use composite primary key directly. Reference a property of the composite primary key");
-					}
+				if (property.isCompositePrimaryKey()) {
 
-					return cassandraPersistentProperty.getRequiredColumnName();
-				});
-			}
+					BasicCassandraPersistentEntity<?> primaryKeyEntity = mappingContext.getRequiredPersistentEntity(property);
 
-			if (column.getColumnName().isPresent()) {
-				return column.getColumnName().map(CqlIdentifier::fromCql);
+					primaryKeyEntity.forEach(it -> {
+						identifiers.add(it.getRequiredColumnName());
+					});
+				} else {
+					identifiers.add(property.getRequiredColumnName());
+				}
+			} else if (column.getColumnName().isPresent()) {
+				identifiers.add(CqlIdentifier.fromCql(column.getColumnName().get()));
+			} else {
+				column.getCqlIdentifier().ifPresent(identifiers::add);
 			}
 
-			return column.getCqlIdentifier();
-
 		} catch (IllegalStateException cause) {
 			throw new IllegalArgumentException(cause.getMessage(), cause);
 		}
+
+		return identifiers;
 	}
 
 	Field createPropertyField(@Nullable CassandraPersistentEntity<?> entity, ColumnName key) {

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/core/CassandraTemplateIntegrationTests.java

@@ -197,6 +197,21 @@ void shouldSelectProjectionWithCompositeKey() {
 		assertThat(loadedEntity.getComment()).isNotNull();
 	}
 
+	@Test // DATACASS-828
+	void shouldSelectClosedProjectionWithCompositeKey() {
+
+		CompositeKey key = new CompositeKey("Walter", "White");
+		TypeWithCompositeKey user = new TypeWithCompositeKey(key, "comment");
+
+		template.insert(user);
+
+		WithCompositeKeyProjection loaded = template.query(TypeWithCompositeKey.class).as(WithCompositeKeyProjection.class)
+				.firstValue();
+		assertThat(loaded).isNotNull();
+
+		assertThat(loaded.getKey()).isEqualTo(key);
+	}
+
 	@Test // DATACASS-343
 	void shouldSelectOneByQuery() {
 
@@ -733,6 +748,11 @@ static class TypeWithCompositeKey {
 		String comment;
 	}
 
+	interface WithCompositeKeyProjection {
+
+		CompositeKey getKey();
+	}
+
 	@Data
 	@PrimaryKeyClass
 	@AllArgsConstructor

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/core/convert/QueryMapperUnitTests.java

@@ -18,6 +18,7 @@
 import static org.assertj.core.api.Assertions.*;
 import static org.mockito.Matchers.any;
 import static org.mockito.Mockito.*;
+import static org.springframework.data.domain.Sort.Order.*;
 
 import lombok.AllArgsConstructor;
 import lombok.Data;
@@ -328,13 +329,15 @@ void shouldMapSortWithCompositePrimaryKeyClass() {
 		assertThat(mappedObject).contains(new Order(Direction.ASC, "first_name"));
 	}
 
-	@Test // DATACASS-343
-	void shouldFailMappingSortByCompositePrimaryKeyClass() {
+	@Test // DATACASS-828
+	void allowSortByCompositeKey() {
 
 		Sort sort = Sort.by("key");
+		Query.empty().columns(Columns.from("key"));
 
-		assertThatIllegalArgumentException().isThrownBy(
-				() -> queryMapper.getMappedSort(sort, mappingContext.getRequiredPersistentEntity(TypeWithKeyClass.class)));
+		Sort mappedSort = queryMapper.getMappedSort(sort,
+				mappingContext.getRequiredPersistentEntity(TypeWithKeyClass.class));
+		assertThat(mappedSort).isEqualTo(Sort.by(asc("first_name"), asc("lastname")));
 	}
 
 	@Test // DATACASS-343