org.springframework.data.cassandra.core.mapping.CassandraPersistentTupleMetadataVerifier Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-cassandra Show documentation

Cassandra support for Spring Data

There is a newer version: 4.3.2

Show newest version

/*
 * Copyright 2018-2019 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.mapping;

import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

import org.springframework.data.mapping.MappingException;
import org.springframework.util.StringUtils;

/**
 * Verifier for {@link CassandraPersistentEntity tuple entities}. Validates for a proper annotated domain classes to
 * ensure the meta-model is suitable for {@link com.datastax.driver.core.TupleValue} mapping.
 *
 * @author Mark Paluch
 * @since 2.1
 */
enum CassandraPersistentTupleMetadataVerifier implements CassandraPersistentEntityMetadataVerifier {

	INSTANCE;

	/* (non-Javadoc)
	 * @see org.springframework.data.cassandra.core.mapping.CassandraPersistentEntityMetadataVerifier#verify(org.springframework.data.cassandra.core.mapping.CassandraPersistentEntity)
	 */
	public void verify(CassandraPersistentEntity entity) throws MappingException {

		if (entity.getType().isInterface() || !entity.isAnnotationPresent(Tuple.class)) {
			return;
		}

		Set ordinals = new TreeSet<>();

		for (CassandraPersistentProperty tupleProperty : entity) {

			if (tupleProperty.isTransient()) {
				continue;
			}

			if (!ordinals.add(tupleProperty.getOrdinal())) {
				throw new MappingException(
						String.format("Duplicate ordinal [%d] in entity [%s]", tupleProperty.getOrdinal(), entity.getName()));
			}
		}

		if (ordinals.isEmpty()) {
			throw new MappingException(String.format(
					"Mapped tuple contains no persistent elements annotated with @Element in entity [%s]", entity.getName()));
		}

		List missingMappings = IntStream.range(0, ordinals.size()).boxed().collect(Collectors.toList());

		missingMappings.removeAll(ordinals);

		if (!missingMappings.isEmpty()) {
			throw new MappingException(String.format("Mapped tuple has no ordinal mapping in entity [%s] for ordinal(s): %s",
					entity.getName(), StringUtils.collectionToDelimitedString(missingMappings, ", ")));
		}
	}
}