/*
* Copyright 2012-2015 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.rest.core.support;
import static org.springframework.data.rest.core.support.DomainObjectMerger.NullHandlingPolicy.*;
import java.util.Optional;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.convert.ConversionService;
import org.springframework.data.mapping.Association;
import org.springframework.data.mapping.PersistentEntity;
import org.springframework.data.mapping.PersistentProperty;
import org.springframework.data.mapping.PersistentPropertyAccessor;
import org.springframework.data.mapping.SimpleAssociationHandler;
import org.springframework.data.mapping.SimplePropertyHandler;
import org.springframework.data.mapping.model.ConvertingPropertyAccessor;
import org.springframework.data.repository.support.Repositories;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
/**
* Component to be able to merge the first level of two objects.
*
* @author Jon Brisbin
* @author Oliver Gierke
* @author Willie Wheeler
*/
public class DomainObjectMerger {
private final Repositories repositories;
private final ConversionService conversionService;
/**
* Creates a new {@link DomainObjectMerger} for the given {@link Repositories} and {@link ConversionService}.
*
* @param repositories must not be {@literal null}.
* @param conversionService must not be {@literal null}.
*/
@Autowired
public DomainObjectMerger(Repositories repositories, ConversionService conversionService) {
Assert.notNull(repositories, "Repositories must not be null!");
Assert.notNull(conversionService, "ConversionService must not be null!");
this.repositories = repositories;
this.conversionService = conversionService;
}
/**
* Merges the given target object into the source one.
*
* @param from can be {@literal null}.
* @param target can be {@literal null}.
* @param nullPolicy how to handle {@literal null} values in the source object.
*/
public void merge(Object from, Object target, final NullHandlingPolicy nullPolicy) {
if (from == null || target == null) {
return;
}
final PersistentEntity<?, ?> sourceEntity = repositories.getPersistentEntity(from.getClass());
final PersistentPropertyAccessor sourceWrapper = new ConvertingPropertyAccessor(
sourceEntity.getPropertyAccessor(from), conversionService);
final PersistentEntity<?, ?> targetEntity = repositories.getPersistentEntity(from.getClass());
final PersistentPropertyAccessor targetWrapper = new ConvertingPropertyAccessor(
targetEntity.getPropertyAccessor(target), conversionService);
targetEntity.doWithProperties(new SimplePropertyHandler() {
/*
* (non-Javadoc)
* @see org.springframework.data.mapping.SimplePropertyHandler#doWithPersistentProperty(org.springframework.data.mapping.PersistentProperty)
*/
@Override
public void doWithPersistentProperty(PersistentProperty<?> persistentProperty) {
Optional<Object> sourceValue = sourceWrapper.getProperty(persistentProperty);
Optional<Object> targetValue = targetWrapper.getProperty(persistentProperty);
if (targetEntity.isIdProperty(persistentProperty)) {
return;
}
if (sourceValue.equals(targetValue)) {
return;
}
if (nullPolicy == APPLY_NULLS || sourceValue.isPresent()) {
targetWrapper.setProperty(persistentProperty, sourceValue);
}
}
});
targetEntity.doWithAssociations(new SimpleAssociationHandler() {
/*
* (non-Javadoc)
* @see org.springframework.data.mapping.SimpleAssociationHandler#doWithAssociation(org.springframework.data.mapping.Association)
*/
@Override
public void doWithAssociation(Association<? extends PersistentProperty<?>> association) {
PersistentProperty<?> persistentProperty = association.getInverse();
Optional<Object> fromVal = sourceWrapper.getProperty(persistentProperty);
if (!isNullOrEmpty(fromVal) && !fromVal.equals(targetWrapper.getProperty(persistentProperty))) {
targetWrapper.setProperty(persistentProperty, fromVal);
}
}
});
}
/**
* Returns whether the given source is {@literal null} or considered empty, which means it's an {@link Iterable} or
* array and doesn't have any elements.
*
* @param source can be {@literal null}.
* @return
*/
static boolean isNullOrEmpty(Optional<Object> source) {
return source.map(it -> {
if (it instanceof Iterable) {
return !((Iterable<?>) it).iterator().hasNext();
}
if (ObjectUtils.isArray(it)) {
return ObjectUtils.isEmpty((Object[]) it);
}
return false;
}).orElse(true);
}
/**
* Strategy to express whether {@literal null} values should be ignored or set on the target domain object.
*/
public static enum NullHandlingPolicy {
APPLY_NULLS, IGNORE_NULLS;
}
}