io.evitadb.api.requestResponse.schema.mutation.attribute.ReferenceAttributeSchemaMutation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation
Module contains external API of the evitaDB.
The newest version!
/*
 *
 *                         _ _        ____  ____
 *               _____   _(_) |_ __ _|  _ \| __ )
 *              / _ \ \ / / | __/ _` | | | |  _ \
 *             |  __/\ V /| | || (_| | |_| | |_) |
 *              \___| \_/ |_|\__\__,_|____/|____/
 *
 *   Copyright (c) 2023-2024
 *
 *   Licensed under the Business Source License, Version 1.1 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   https://github.com/FgForrest/evitaDB/blob/master/LICENSE
 *
 *   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 io.evitadb.api.requestResponse.schema.mutation.attribute;

import io.evitadb.api.exception.InvalidSchemaMutationException;
import io.evitadb.api.requestResponse.schema.AttributeSchemaContract;
import io.evitadb.api.requestResponse.schema.EntitySchemaContract;
import io.evitadb.api.requestResponse.schema.ReferenceSchemaContract;
import io.evitadb.api.requestResponse.schema.dto.ReferenceSchema;
import io.evitadb.api.requestResponse.schema.dto.ReflectedReferenceSchema;
import io.evitadb.api.requestResponse.schema.mutation.AttributeSchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.ReferenceSchemaMutator;
import io.evitadb.utils.Assert;

import javax.annotation.Nonnull;
import java.util.Collections;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * Interface with default method implementation, that contains shared logic for attribute schema modifications.
 *
 * @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2022
 */
public interface ReferenceAttributeSchemaMutation extends AttributeSchemaMutation, ReferenceSchemaMutator {

	/**
	 * Retrieves the attribute schema of a given attribute name from a reference schema.
	 *
	 * @param referenceSchema The reference schema to retrieve the attribute schema from.
	 * @param attributeName   The name of the attribute.
	 * @return The attribute schema of the specified attribute name, or null if not found.
	 */
	@Nonnull
	default Optional getReferenceAttributeSchema(
		@Nonnull ReferenceSchemaContract referenceSchema,
		@Nonnull String attributeName
	) {
		if (referenceSchema instanceof ReflectedReferenceSchema reflectedReferenceSchema) {
			final Optional result = reflectedReferenceSchema.getDeclaredAttribute(attributeName);
			if (result.isEmpty() && reflectedReferenceSchema.isReflectedReferenceAvailable()) {
				Assert.isTrue(
					reflectedReferenceSchema.getAttribute(attributeName).isEmpty(),
					() -> new InvalidSchemaMutationException(
						"Attribute inherited from original reference `" + reflectedReferenceSchema.getReflectedReferenceName() +
							"` in entity type `" + reflectedReferenceSchema.getReferencedEntityType() + "` " +
							"cannot be modified directly via. reflected reference schema!"
					)
				);
			}
			return result;
		} else {
			return referenceSchema.getAttribute(attributeName);
		}
	}

	/**
	 * Retrieves the attribute schema of a given attribute name from a reference schema.
	 *
	 * @param entitySchema    The entity schema where the reference schema is present.
	 * @param referenceSchema The reference schema to retrieve the attribute schema from.
	 * @param attributeName   The name of the attribute.
	 * @return The attribute schema of the specified attribute name, or null if not found.
	 */
	@Nonnull
	default AttributeSchemaContract getReferenceAttributeSchemaOrThrow(
		@Nonnull EntitySchemaContract entitySchema,
		@Nonnull ReferenceSchemaContract referenceSchema,
		@Nonnull String attributeName
	) {
		return getReferenceAttributeSchema(referenceSchema, attributeName)
			.orElseThrow(() -> new InvalidSchemaMutationException(
				"The attribute `" + attributeName + "` is not defined in entity `" + entitySchema.getName() +
					"` schema for reference with name `" + referenceSchema.getName() + "`!"
			));


	}

	/**
	 * Replaces existing attribute schema with updated one but only when those schemas differ. Otherwise,
	 * the non-changed, original reference schema is returned.
	 */
	@Nonnull
	default ReferenceSchemaContract replaceAttributeIfDifferent(
		@Nonnull ReferenceSchemaContract referenceSchema,
		@Nonnull AttributeSchemaContract existingAttributeSchema,
		@Nonnull AttributeSchemaContract updatedAttributeSchema
	) {
		if (existingAttributeSchema.equals(updatedAttributeSchema)) {
			// we don't need to update entity schema - the associated data already contains the requested change
			return referenceSchema;
		} else {
			if (referenceSchema instanceof ReflectedReferenceSchema reflectedReferenceSchema) {
				return reflectedReferenceSchema
					.withDeclaredAttributes(
						Stream.concat(
								reflectedReferenceSchema.getDeclaredAttributes().values().stream().filter(it -> !updatedAttributeSchema.getName().equals(it.getName())),
								Stream.of(updatedAttributeSchema)
							)
							.collect(
								Collectors.toMap(
									AttributeSchemaContract::getName,
									Function.identity()
								)
							)
					);
			} else {
				return ReferenceSchema._internalBuild(
					referenceSchema.getName(),
					referenceSchema.getNameVariants(),
					referenceSchema.getDescription(),
					referenceSchema.getDeprecationNotice(),
					referenceSchema.getReferencedEntityType(),
					referenceSchema.isReferencedEntityTypeManaged() ? Collections.emptyMap() : referenceSchema.getEntityTypeNameVariants(s -> null),
					referenceSchema.isReferencedEntityTypeManaged(),
					referenceSchema.getCardinality(),
					referenceSchema.getReferencedGroupType(),
					referenceSchema.isReferencedGroupTypeManaged() ? Collections.emptyMap() : referenceSchema.getGroupTypeNameVariants(s -> null),
					referenceSchema.isReferencedGroupTypeManaged(),
					referenceSchema.isIndexed(),
					referenceSchema.isFaceted(),
					Stream.concat(
							referenceSchema.getAttributes().values().stream().filter(it -> !updatedAttributeSchema.getName().equals(it.getName())),
							Stream.of(updatedAttributeSchema)
						)
						.collect(
							Collectors.toMap(
								AttributeSchemaContract::getName,
								Function.identity()
							)
						),
					referenceSchema.getSortableAttributeCompounds()
				);
			}
		}
	}

}