org.springframework.data.cassandra.core.convert.UpdateMapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-cassandra Show documentation
Show all versions of spring-data-cassandra Show documentation
Cassandra support for Spring Data
/*
* Copyright 2017-2021 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
*
* https://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.core.convert;
import static org.springframework.data.cassandra.core.query.Update.*;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import org.springframework.data.cassandra.core.mapping.CassandraPersistentEntity;
import org.springframework.data.cassandra.core.query.Filter;
import org.springframework.data.cassandra.core.query.Update;
import org.springframework.data.cassandra.core.query.Update.*;
import org.springframework.data.mapping.PersistentProperty;
import org.springframework.data.util.TypeInformation;
import org.springframework.util.Assert;
import com.datastax.oss.driver.api.core.type.DataType;
import com.datastax.oss.driver.api.core.type.ListType;
import com.datastax.oss.driver.api.core.type.SetType;
import com.datastax.oss.protocol.internal.ProtocolConstants;
/**
* Map {@link org.springframework.data.cassandra.core.query.Update} to CQL-specific data types.
*
* @author Mark Paluch
* @see org.springframework.data.cassandra.core.query.Filter
* @see org.springframework.data.cassandra.core.query.Update
* @see org.springframework.data.cassandra.core.mapping.CassandraPersistentEntity
* @see org.springframework.data.mapping.PersistentProperty
* @see org.springframework.data.util.TypeInformation
* @since 2.0
*/
public class UpdateMapper extends QueryMapper {
/**
* Creates a new {@link UpdateMapper} with the given {@link CassandraConverter}.
*
* @param converter must not be {@literal null}.
*/
public UpdateMapper(CassandraConverter converter) {
super(converter);
}
/**
* Map a {@link Update} with a {@link CassandraPersistentEntity type hint}. Update mapping translates property names
* to column names and maps {@link AssignmentOp update operation} values to simple Cassandra values.
*
* @param update must not be {@literal null}.
* @param entity must not be {@literal null}.
* @return the mapped {@link Filter}.
*/
public Update getMappedObject(Update update, CassandraPersistentEntity entity) {
Assert.notNull(update, "Update must not be null");
Assert.notNull(entity, "CassandraPersistentEntity must not be null");
Collection assignmentOperations = update.getUpdateOperations();
List mapped = new ArrayList<>(assignmentOperations.size());
for (AssignmentOp assignmentOp : assignmentOperations) {
Field field = createPropertyField(entity, assignmentOp.getColumnName());
field.getProperty().filter(it -> it.getOrdinal() != null).ifPresent(it -> {
throw new IllegalArgumentException(
String.format("Cannot reference tuple value elements, property [%s]", field.getMappedKey()));
});
mapped.add(getMappedUpdateOperation(assignmentOp, field));
}
return of(mapped);
}
private AssignmentOp getMappedUpdateOperation(AssignmentOp assignmentOp, Field field) {
if (assignmentOp instanceof SetOp) {
return getMappedUpdateOperation(field, (SetOp) assignmentOp);
}
if (assignmentOp instanceof RemoveOp) {
return getMappedUpdateOperation(field, (RemoveOp) assignmentOp);
}
if (assignmentOp instanceof IncrOp) {
return new IncrOp(field.getMappedKey(), ((IncrOp) assignmentOp).getValue());
}
if (assignmentOp instanceof AddToOp) {
return getMappedUpdateOperation(field, (AddToOp) assignmentOp);
}
if (assignmentOp instanceof AddToMapOp) {
return getMappedUpdateOperation(field, (AddToMapOp) assignmentOp);
}
throw new IllegalArgumentException(String.format("UpdateOp [%s] not supported", assignmentOp));
}
private AssignmentOp getMappedUpdateOperation(Field field, SetOp updateOp) {
Object rawValue = updateOp.getValue();
if (updateOp instanceof SetAtKeyOp) {
SetAtKeyOp op = (SetAtKeyOp) updateOp;
Assert.state(op.getValue() != null,
() -> String.format("SetAtKeyOp for %s attempts to set null", field.getProperty()));
Optional> typeInformation = field.getProperty()
.map(PersistentProperty::getTypeInformation);
Optional> keyType = typeInformation.map(TypeInformation::getComponentType);
Optional> valueType = typeInformation.map(TypeInformation::getMapValueType);
Object mappedKey = keyType.map(typeInfo -> getConverter().convertToColumnType(op.getKey(), typeInfo))
.orElseGet(() -> getConverter().convertToColumnType(op.getKey()));
Object mappedValue = valueType.map(typeInfo -> getConverter().convertToColumnType(op.getValue(), typeInfo))
.orElseGet(() -> getConverter().convertToColumnType(op.getValue()));
return new SetAtKeyOp(field.getMappedKey(), mappedKey, mappedValue);
}
ColumnType descriptor = getColumnType(field, rawValue,
updateOp instanceof SetAtIndexOp ? ColumnTypeTransformer.COLLECTION_COMPONENT_TYPE
: ColumnTypeTransformer.AS_IS);
if (updateOp instanceof SetAtIndexOp) {
SetAtIndexOp op = (SetAtIndexOp) updateOp;
Assert.state(op.getValue() != null,
() -> String.format("SetAtIndexOp for %s attempts to set null", field.getProperty()));
Object mappedValue = getConverter().convertToColumnType(op.getValue(), descriptor);
return new SetAtIndexOp(field.getMappedKey(), op.getIndex(), mappedValue);
}
if (rawValue instanceof Collection && descriptor.isCollectionLike()) {
Collection collection = (Collection) rawValue;
if (collection.isEmpty()) {
int protocolCode = field.getProperty()
.map(property -> getConverter().getColumnTypeResolver().resolve(property).getDataType())
.map(DataType::getProtocolCode).orElse(ProtocolConstants.DataType.LIST);
if (protocolCode == ProtocolConstants.DataType.SET) {
return new SetOp(field.getMappedKey(), Collections.emptySet());
}
return new SetOp(field.getMappedKey(), Collections.emptyList());
}
}
Object mappedValue = rawValue == null ? null : getConverter().convertToColumnType(rawValue, descriptor);
return new SetOp(field.getMappedKey(), mappedValue);
}
private AssignmentOp getMappedUpdateOperation(Field field, RemoveOp updateOp) {
Object value = updateOp.getValue();
ColumnType descriptor = getColumnType(field, value, ColumnTypeTransformer.AS_IS);
boolean mapLike = false;
if (field.getProperty().isPresent() && field.getProperty().get().isMapLike()) {
descriptor = getColumnType(field, value, value instanceof Collection ? ColumnTypeTransformer.ENCLOSING_MAP_KEY_SET
: ColumnTypeTransformer.MAP_KEY_TYPE);
mapLike = true;
}
Object mappedValue = getConverter().convertToColumnType(value, descriptor);
if (mapLike && !(mappedValue instanceof Collection)) {
mappedValue = Collections.singleton(mappedValue);
}
return new RemoveOp(field.getMappedKey(), mappedValue);
}
@SuppressWarnings("unchecked")
private AssignmentOp getMappedUpdateOperation(Field field, AddToOp updateOp) {
Iterable