io.evitadb.api.requestResponse.schema.builder.AssociatedDataSchemaBuilder 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.
/*
*
* _ _ ____ ____
* _____ _(_) |_ __ _| _ \| __ )
* / _ \ \ / / | __/ _` | | | | _ \
* | __/\ 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.builder;
import io.evitadb.api.requestResponse.data.Versioned;
import io.evitadb.api.requestResponse.schema.AssociatedDataSchemaContract;
import io.evitadb.api.requestResponse.schema.AssociatedDataSchemaEditor;
import io.evitadb.api.requestResponse.schema.CatalogSchemaContract;
import io.evitadb.api.requestResponse.schema.EntitySchemaContract;
import io.evitadb.api.requestResponse.schema.EntitySchemaEditor;
import io.evitadb.api.requestResponse.schema.dto.AssociatedDataSchema;
import io.evitadb.api.requestResponse.schema.mutation.AssociatedDataSchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.EntitySchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.associatedData.CreateAssociatedDataSchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.associatedData.ModifyAssociatedDataSchemaDeprecationNoticeMutation;
import io.evitadb.api.requestResponse.schema.mutation.associatedData.ModifyAssociatedDataSchemaDescriptionMutation;
import io.evitadb.api.requestResponse.schema.mutation.associatedData.SetAssociatedDataSchemaLocalizedMutation;
import io.evitadb.api.requestResponse.schema.mutation.associatedData.SetAssociatedDataSchemaNullableMutation;
import io.evitadb.exception.GenericEvitaInternalError;
import lombok.experimental.Delegate;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.Serial;
import java.io.Serializable;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.function.BooleanSupplier;
/**
* Internal {@link AssociatedDataSchemaContract} builder used solely from within {@link EntitySchemaEditor}.
*
* @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2021
*/
public final class AssociatedDataSchemaBuilder implements AssociatedDataSchemaEditor, InternalSchemaBuilderHelper {
@Serial private static final long serialVersionUID = 4286814145998208599L;
private final CatalogSchemaContract catalogSchema;
private final EntitySchemaContract entitySchema;
private final AssociatedDataSchemaContract baseSchema;
private final List mutations = new LinkedList<>();
private MutationImpact updatedSchemaDirty = MutationImpact.NO_IMPACT;
private int lastMutationReflectedInSchema = 0;
private AssociatedDataSchemaContract updatedSchema;
AssociatedDataSchemaBuilder(
@Nonnull CatalogSchemaContract catalogSchema,
@Nonnull EntitySchemaContract entitySchema,
@Nonnull AssociatedDataSchemaContract existingSchema
) {
this.catalogSchema = catalogSchema;
this.entitySchema = entitySchema;
this.baseSchema = existingSchema;
}
AssociatedDataSchemaBuilder(
@Nonnull CatalogSchemaContract catalogSchema,
@Nonnull EntitySchemaContract entitySchema,
@Nonnull String name,
@Nonnull Class ofType
) {
this.catalogSchema = catalogSchema;
this.entitySchema = entitySchema;
this.baseSchema = AssociatedDataSchema._internalBuild(
name, ofType
);
this.mutations.add(
new CreateAssociatedDataSchemaMutation(
baseSchema.getName(),
baseSchema.getDescription(),
baseSchema.getDeprecationNotice(),
baseSchema.getType(),
baseSchema.isLocalized(),
baseSchema.isNullable()
)
);
}
@Override
@Nonnull
public AssociatedDataSchemaBuilder localized() {
this.updatedSchemaDirty = updateMutationImpact(
this.updatedSchemaDirty,
addMutations(
this.catalogSchema, this.entitySchema, this.mutations,
new SetAssociatedDataSchemaLocalizedMutation(
getName(),
true
)
)
);
return this;
}
@Override
@Nonnull
public AssociatedDataSchemaBuilder localized(@Nonnull BooleanSupplier decider) {
this.updatedSchemaDirty = updateMutationImpact(
this.updatedSchemaDirty,
addMutations(
this.catalogSchema, this.entitySchema, this.mutations,
new SetAssociatedDataSchemaLocalizedMutation(
getName(),
decider.getAsBoolean()
)
)
);
return this;
}
@Override
@Nonnull
public AssociatedDataSchemaBuilder nullable() {
this.updatedSchemaDirty = updateMutationImpact(
this.updatedSchemaDirty,
addMutations(
this.catalogSchema, this.entitySchema, this.mutations,
new SetAssociatedDataSchemaNullableMutation(
getName(),
true
)
)
);
return this;
}
@Nonnull
@Override
public AssociatedDataSchemaEditor nullable(@Nonnull BooleanSupplier decider) {
this.updatedSchemaDirty = updateMutationImpact(
this.updatedSchemaDirty,
addMutations(
this.catalogSchema, this.entitySchema, this.mutations,
new SetAssociatedDataSchemaNullableMutation(
getName(),
decider.getAsBoolean()
)
)
);
return this;
}
@Override
@Nonnull
public AssociatedDataSchemaBuilder withDescription(@Nullable String description) {
this.updatedSchemaDirty = updateMutationImpact(
this.updatedSchemaDirty,
addMutations(
this.catalogSchema, this.entitySchema, this.mutations,
new ModifyAssociatedDataSchemaDescriptionMutation(
getName(),
description
)
)
);
return this;
}
@Override
@Nonnull
public AssociatedDataSchemaBuilder deprecated(@Nonnull String deprecationNotice) {
this.updatedSchemaDirty = updateMutationImpact(
this.updatedSchemaDirty,
addMutations(
this.catalogSchema, this.entitySchema, this.mutations,
new ModifyAssociatedDataSchemaDeprecationNoticeMutation(
getName(),
deprecationNotice
)
)
);
return this;
}
@Override
@Nonnull
public AssociatedDataSchemaBuilder notDeprecatedAnymore() {
this.updatedSchemaDirty = updateMutationImpact(
this.updatedSchemaDirty,
addMutations(
this.catalogSchema, this.entitySchema, this.mutations,
new ModifyAssociatedDataSchemaDeprecationNoticeMutation(
getName(),
null
)
)
);
return this;
}
/**
* Builds new instance of immutable {@link AssociatedDataSchema} filled with updated configuration.
*/
@Delegate(types = AssociatedDataSchemaContract.class)
@Nonnull
public AssociatedDataSchemaContract toInstance() {
if (this.updatedSchema == null || this.updatedSchemaDirty != MutationImpact.NO_IMPACT) {
// if the dirty flat is set to modified previous we need to start from the base schema again
// and reapply all mutations
if (this.updatedSchemaDirty == MutationImpact.MODIFIED_PREVIOUS) {
this.lastMutationReflectedInSchema = 0;
}
// if the last mutation reflected in the schema is zero we need to start from the base schema
// else we can continue modification last known updated schema by adding additional mutations
AssociatedDataSchemaContract currentSchema = this.lastMutationReflectedInSchema == 0 ?
this.baseSchema : this.updatedSchema;
// apply the mutations not reflected in the schema
for (int i = lastMutationReflectedInSchema; i < this.mutations.size(); i++) {
final EntitySchemaMutation mutation = this.mutations.get(i);
currentSchema = ((AssociatedDataSchemaMutation) mutation).mutate(currentSchema);
if (currentSchema == null) {
throw new GenericEvitaInternalError("Attribute unexpectedly removed from inside!");
}
}
this.updatedSchema = currentSchema;
this.updatedSchemaDirty = MutationImpact.NO_IMPACT;
this.lastMutationReflectedInSchema = this.mutations.size();
}
return this.updatedSchema;
}
/**
* Returns collection of {@link EntitySchemaMutation} instances describing what changes occurred in the builder
* and which should be applied on the existing parent schema in particular version.
* Each mutation increases {@link Versioned#version()} of the modified object and allows to detect race
* conditions based on "optimistic locking" mechanism in very granular way.
*/
@Nonnull
public Collection toMutation() {
return this.mutations;
}
}