io.evitadb.api.requestResponse.schema.mutation.attribute.UseGlobalAttributeSchemaMutation 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
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.EvitaSessionContract;
import io.evitadb.api.exception.InvalidSchemaMutationException;
import io.evitadb.api.requestResponse.cdc.Operation;
import io.evitadb.api.requestResponse.schema.AttributeSchemaContract;
import io.evitadb.api.requestResponse.schema.CatalogSchemaContract;
import io.evitadb.api.requestResponse.schema.EntitySchemaContract;
import io.evitadb.api.requestResponse.schema.GlobalAttributeSchemaContract;
import io.evitadb.api.requestResponse.schema.dto.EntitySchema;
import io.evitadb.api.requestResponse.schema.dto.GlobalAttributeSchema;
import io.evitadb.utils.Assert;
import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.ThreadSafe;
import java.io.Serial;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* Mutation is responsible for introducing a {@link GlobalAttributeSchemaContract} into an {@link EvitaSessionContract}.
*
* @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2022
*/
@ThreadSafe
@Immutable
@EqualsAndHashCode
@AllArgsConstructor
public class UseGlobalAttributeSchemaMutation implements EntityAttributeSchemaMutation {
@Serial private static final long serialVersionUID = 1555098941604228716L;
@Nonnull @Getter private final String name;
@Nullable
@Override
public S mutate(@Nullable CatalogSchemaContract catalogSchema, @Nullable S attributeSchema, @Nonnull Class schemaType) {
Assert.isPremiseValid(catalogSchema != null, "Catalog schema is mandatory!");
//noinspection unchecked
return (S) catalogSchema.getAttribute(name).orElse(null);
}
@Nullable
@Override
public EntitySchemaContract mutate(@Nonnull CatalogSchemaContract catalogSchema, @Nullable EntitySchemaContract entitySchema) {
Assert.isPremiseValid(entitySchema != null, "Entity schema is mandatory!");
final GlobalAttributeSchemaContract newAttributeSchema = mutate(catalogSchema, null, GlobalAttributeSchemaContract.class);
Assert.notNull(
newAttributeSchema,
() -> new InvalidSchemaMutationException(
"The attribute `" + name + "` is not defined in catalog `" + catalogSchema.getName() + "` schema!"
)
);
final AttributeSchemaContract existingAttributeSchema = entitySchema.getAttribute(name).orElse(null);
if (existingAttributeSchema != null && !(existingAttributeSchema instanceof GlobalAttributeSchema)) {
// ups, there is conflict in attribute settings
throw new InvalidSchemaMutationException(
"The attribute `" + name + "` already exists in entity `" + entitySchema.getName() + "` schema and" +
" has different definition. To alter existing attribute schema you need to use different mutations."
);
} else if (existingAttributeSchema == null || !existingAttributeSchema.equals(newAttributeSchema)) {
return EntitySchema._internalBuild(
entitySchema.version() + 1,
entitySchema.getName(),
entitySchema.getNameVariants(),
entitySchema.getDescription(),
entitySchema.getDeprecationNotice(),
entitySchema.isWithGeneratedPrimaryKey(),
entitySchema.isWithHierarchy(),
entitySchema.isWithPrice(),
entitySchema.getIndexedPricePlaces(),
entitySchema.getLocales(),
entitySchema.getCurrencies(),
Stream.concat(
entitySchema.getAttributes().values().stream().filter(it -> !it.getName().equals(name)),
Stream.of(newAttributeSchema)
)
.collect(
Collectors.toMap(
AttributeSchemaContract::getName,
Function.identity()
)
),
entitySchema.getAssociatedData(),
entitySchema.getReferences(),
entitySchema.getEvolutionMode(),
entitySchema.getSortableAttributeCompounds()
);
} else {
// the mutation must have been applied previously - return the schema we don't need to alter
return entitySchema;
}
}
@Nonnull
@Override
public Operation operation() {
return Operation.UPSERT;
}
@Override
public String toString() {
return "Use global attribute schema: " +
"name='" + name + '\'';
}
}