Spring/spring-data-cassandra
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATACASS-248 - Enable PrimaryKey annotations on property accessors.

Browse Source 
We now support @PrimaryKey and @PrimaryKeyColumn annotations on property accessors and mixed declarations. This change also fixes the assumption that declarations are solely allowed on fields.

Original pull request: #64.

(cherry picked from commit 2422986810)
Signed-off-by: John Blum <jblum@pivotal.io>
This commit is contained in:
Mark Paluch
2016-06-06 16:03:16 +02:00
committed by John Blum
parent 0d7ad1a99c
commit a53f72e7d6
4 changed files with 228 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
spring-data-cassandra/src/main/java/org/springframework/data/cassandra/mapping/BasicCassandraPersistentProperty.java
View File

@@ -32,6 +32,7 @@ import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.expression.BeanFactoryAccessor;
import org.springframework.context.expression.BeanFactoryResolver;
import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.dao.InvalidDataAccessApiUsageException;
import org.springframework.data.cassandra.util.SpelUtils;
import org.springframework.data.mapping.Association;
@@ -106,7 +107,7 @@ public class BasicCassandraPersistentProperty extends AnnotationBasedPersistentP
@Override
public boolean isCompositePrimaryKey() {
return getField().getType().isAnnotationPresent(PrimaryKeyClass.class);
return AnnotatedElementUtils.findMergedAnnotation(getType(), PrimaryKeyClass.class) != null;
}
public Class<?> getCompositePrimaryKeyType() {
@@ -114,7 +115,7 @@ public class BasicCassandraPersistentProperty extends AnnotationBasedPersistentP
return null;
}
return getField().getType();
return getType();
}
@Override
@@ -290,7 +291,7 @@ public class BasicCassandraPersistentProperty extends AnnotationBasedPersistentP
}
// else we're dealing with a single-column field
String defaultName = getField().getName(); // TODO: replace with naming strategy class
String defaultName = getName(); // TODO: replace with naming strategy class
String overriddenName = null;
boolean forceQuote = false;
@@ -396,7 +397,7 @@ public class BasicCassandraPersistentProperty extends AnnotationBasedPersistentP
if (!isCompositePrimaryKey()) {
throw new IllegalStateException(String.format("[%s] does not represent a composite primary key property",
getField()));
getName()));
}
return getCompositePrimaryKeyEntity().getCompositePrimaryKeyProperties();

22
spring-data-cassandra/src/main/java/org/springframework/data/cassandra/mapping/CassandraPersistentPropertyComparator.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2013-2014 the original author or authors
* Copyright 2013-2016 the original author or authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
*/
package org.springframework.data.cassandra.mapping;
import java.lang.reflect.Field;
import java.util.Comparator;
/**
@@ -25,6 +24,7 @@ import java.util.Comparator;
*
* @author Alex Shvid
* @author Matthew T. Adams
* @author Mark Paluch
*/
public enum CassandraPersistentPropertyComparator implements Comparator<CassandraPersistentProperty> {
@@ -60,12 +60,10 @@ public enum CassandraPersistentPropertyComparator implements Comparator<Cassandr
boolean leftIsPrimaryKey = left.isPrimaryKeyColumn();
boolean rightIsPrimaryKey = right.isPrimaryKeyColumn();
Field leftField = left.getField();
Field rightField = right.getField();
if (leftIsPrimaryKey && rightIsPrimaryKey) {
return CassandraPrimaryKeyColumnAnnotationComparator.IT.compare(leftField.getAnnotation(PrimaryKeyColumn.class),
rightField.getAnnotation(PrimaryKeyColumn.class));
return CassandraPrimaryKeyColumnAnnotationComparator.IT.compare(left.findAnnotation(PrimaryKeyColumn.class),
right.findAnnotation(PrimaryKeyColumn.class));
}
boolean leftIsKey = leftIsCompositePrimaryKey || leftIsPrimaryKey;
@@ -81,11 +79,11 @@ public enum CassandraPersistentPropertyComparator implements Comparator<Cassandr
// else, neither property is a composite primary key nor a primary key; compare @Column annotations
Column leftColumn = leftField.getAnnotation(Column.class);
Column rightColumn = rightField.getAnnotation(Column.class);
Column leftColumn = left.findAnnotation(Column.class);
Column rightColumn = right.findAnnotation(Column.class);
if (leftColumn == null && rightColumn == null) {
return leftField.getName().compareTo(rightField.getName());
return left.getName().compareTo(right.getName());
}
if (leftColumn != null && rightColumn != null) {
@@ -93,10 +91,10 @@ public enum CassandraPersistentPropertyComparator implements Comparator<Cassandr
}
if (leftColumn != null && rightColumn == null) {
return leftColumn.value().compareTo(rightField.getName());
return leftColumn.value().compareTo(left.getName());
}
// else leftColumn == null && rightColumn != null)
return leftField.getName().compareTo(rightColumn.value());
return left.getName().compareTo(rightColumn.value());
}
}

213
spring-data-cassandra/src/test/java/org/springframework/data/cassandra/mapping/MappingContextUnitTests.java Normal file
View File

@@ -0,0 +1,213 @@
/*
* Copyright 2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.cassandra.mapping;
import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;
import java.io.Serializable;
import java.util.List;
import org.junit.Test;
import org.springframework.cassandra.core.PrimaryKeyType;
import org.springframework.cassandra.core.cql.CqlIdentifier;
import org.springframework.data.mapping.model.MappingException;
/**
* Unit tests for {@link BasicCassandraMappingContext}.
*
* @author Matthew T. Adams
* @author Mark Paluch
*/
public class MappingContextUnitTests {
public static class Transient {}
@Table
public static class X {
@PrimaryKey String key;
}
@Table
public static class Y {
@PrimaryKey String key;
}
@Table
public static class PrimaryKeyOnProperty {
String key;
@PrimaryKey(value = "foo")
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
}
@Table
public static class PrimaryKeyColumnsOnProperty {
String firstname;
String lastname;
@PrimaryKeyColumn(ordinal = 1, type = PrimaryKeyType.PARTITIONED)
public String getFirstname() {
return firstname;
}
public void setFirstname(String firstname) {
this.firstname = firstname;
}
@PrimaryKeyColumn(name = "mylastname", ordinal = 2, type = PrimaryKeyType.CLUSTERED)
public String getLastname() {
return lastname;
}
public void setLastname(String lastname) {
this.lastname = lastname;
}
}
@Table
public static class PrimaryKeyOnPropertyWithPrimaryKeyClass {
CompositePrimaryKeyClassWithProperties key;
@PrimaryKey
public CompositePrimaryKeyClassWithProperties getKey() {
return key;
}
public void setKey(CompositePrimaryKeyClassWithProperties key) {
this.key = key;
}
}
@PrimaryKeyClass
public static class CompositePrimaryKeyClassWithProperties implements Serializable{
String firstname;
String lastname;
@PrimaryKeyColumn(ordinal = 1, type = PrimaryKeyType.PARTITIONED)
public String getFirstname() {
return firstname;
}
public void setFirstname(String firstname) {
this.firstname = firstname;
}
@PrimaryKeyColumn(name = "mylastname", ordinal = 2, type = PrimaryKeyType.CLUSTERED)
public String getLastname() {
return lastname;
}
public void setLastname(String lastname) {
this.lastname = lastname;
}
}
BasicCassandraMappingContext ctx = new BasicCassandraMappingContext();
@Test(expected = MappingException.class)
public void testGetPersistentEntityOfTransientType() {
CassandraPersistentEntity<?> entity = ctx.getPersistentEntity(Transient.class);
}
@Test
public void testGetExistingPersistentEntityHappyPath() {
ctx.getPersistentEntity(X.class);
assertTrue(ctx.contains(X.class));
assertNotNull(ctx.getExistingPersistentEntity(X.class));
assertFalse(ctx.contains(Y.class));
}
/**
* @see DATACASS-248
*/
@Test
public void primaryKeyOnPropertyShouldWork() {
CassandraPersistentEntity<?> persistentEntity = ctx.getPersistentEntity(PrimaryKeyOnProperty.class);
CassandraPersistentProperty idProperty = persistentEntity.getIdProperty();
assertThat(idProperty.getColumnName().toCql(), is(equalTo("foo")));
List<CqlIdentifier> columnNames = idProperty.getColumnNames();
assertThat(columnNames, hasSize(1));
assertThat(columnNames.get(0).toCql(), is(equalTo("foo")));
}
/**
* @see DATACASS-248
*/
@Test
public void primaryKeyColumnsOnPropertyShouldWork() {
CassandraPersistentEntity<?> persistentEntity = ctx.getPersistentEntity(PrimaryKeyColumnsOnProperty.class);
assertThat(persistentEntity.isCompositePrimaryKey(), is(false));
CassandraPersistentProperty firstname = persistentEntity.getPersistentProperty("firstname");
assertThat(firstname.isCompositePrimaryKey(), is(false));
assertThat(firstname.isPrimaryKeyColumn(), is(true));
assertThat(firstname.isPartitionKeyColumn(), is(true));
assertThat(firstname.getColumnName().toCql(), is(equalTo("firstname")));
CassandraPersistentProperty lastname = persistentEntity.getPersistentProperty("lastname");
assertThat(lastname.isPrimaryKeyColumn(), is(true));
assertThat(lastname.isClusterKeyColumn(), is(true));
assertThat(lastname.getColumnName().toCql(), is(equalTo("mylastname")));
}
/**
* @see DATACASS-248
*/
@Test
public void primaryKeyClassWithprimaryKeyColumnsOnPropertyShouldWork() {
CassandraPersistentEntity<?> persistentEntity = ctx.getPersistentEntity(PrimaryKeyOnPropertyWithPrimaryKeyClass.class);
CassandraPersistentEntity<?> primaryKeyClass = ctx.getPersistentEntity(CompositePrimaryKeyClassWithProperties.class);
assertThat(persistentEntity.isCompositePrimaryKey(), is(false));
assertThat(persistentEntity.getPersistentProperty("key").isCompositePrimaryKey(), is(true));
assertThat(primaryKeyClass.isCompositePrimaryKey(), is(true));
assertThat(primaryKeyClass.getCompositePrimaryKeyProperties(), hasSize(2));
CassandraPersistentProperty firstname = primaryKeyClass.getPersistentProperty("firstname");
assertThat(firstname.isPrimaryKeyColumn(), is(true));
assertThat(firstname.isPartitionKeyColumn(), is(true));
assertThat(firstname.isClusterKeyColumn(), is(false));
assertThat(firstname.getColumnName().toCql(), is(equalTo("firstname")));
CassandraPersistentProperty lastname = primaryKeyClass.getPersistentProperty("lastname");
assertThat(lastname.isPrimaryKeyColumn(), is(true));
assertThat(lastname.isPartitionKeyColumn(), is(false));
assertThat(lastname.isClusterKeyColumn(), is(true));
assertThat(lastname.getColumnName().toCql(), is(equalTo("mylastname")));
}
}

63
spring-data-cassandra/src/test/java/org/springframework/data/cassandra/test/integration/mappingcontext/MappingContextIntegrationTests.java
View File

@@ -1,63 +0,0 @@
/*
* Copyright 2013-2014 the original author or authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.cassandra.test.integration.mappingcontext;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import org.junit.Test;
import org.springframework.data.cassandra.mapping.CassandraPersistentEntity;
import org.springframework.data.cassandra.mapping.BasicCassandraMappingContext;
import org.springframework.data.cassandra.mapping.PrimaryKey;
import org.springframework.data.cassandra.mapping.Table;
import org.springframework.data.mapping.model.MappingException;
public class MappingContextIntegrationTests {
public static class Transient {}
@Table
public static class X {
@PrimaryKey
String key;
}
@Table
public static class Y {
@PrimaryKey
String key;
}
BasicCassandraMappingContext ctx = new BasicCassandraMappingContext();
@Test(expected = MappingException.class)
public void testGetPersistentEntityOfTransientType() {
CassandraPersistentEntity<?> entity = ctx.getPersistentEntity(Transient.class);
}
@Test
public void testGetExistingPersistentEntityHappyPath() {
ctx.getPersistentEntity(X.class);
assertTrue(ctx.contains(X.class));
assertNotNull(ctx.getExistingPersistentEntity(X.class));
assertFalse(ctx.contains(Y.class));
}
}