io.evitadb.api.requestResponse.schema.dto.GlobalAttributeSchema 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
*
* 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.dto;
import io.evitadb.api.requestResponse.schema.GlobalAttributeSchemaContract;
import io.evitadb.utils.NamingConvention;
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.io.Serializable;
import java.util.Map;
/**
* Internal implementation of {@link GlobalAttributeSchemaContract}.
*/
@Immutable
@ThreadSafe
@EqualsAndHashCode(callSuper = true)
public final class GlobalAttributeSchema extends AttributeSchema implements GlobalAttributeSchemaContract {
@Serial private static final long serialVersionUID = -4016156218004708457L;
@Getter private final GlobalAttributeUniquenessType globalUniquenessType;
@Getter private final boolean representative;
public GlobalAttributeSchema(
@Nonnull String name,
@Nonnull Map nameVariants,
@Nullable String description,
@Nullable String deprecationNotice,
@Nullable AttributeUniquenessType unique,
@Nullable GlobalAttributeUniquenessType globalUniquenessType,
boolean filterable,
boolean sortable,
boolean localized,
boolean nullable,
boolean representative,
@Nonnull Class type,
@Nullable T defaultValue,
int indexedDecimalPlaces
) {
super(
name, nameVariants, description, deprecationNotice,
unique, filterable, sortable, localized, nullable,
type, defaultValue, indexedDecimalPlaces
);
this.globalUniquenessType = globalUniquenessType == null ? GlobalAttributeUniquenessType.NOT_UNIQUE : globalUniquenessType;
this.representative = representative;
}
/**
* This method is for internal purposes only. It could be used for reconstruction of GlobalAttributeSchema from
* different package than current, but still internal code of the Evita ecosystems.
*
* Do not use this method from in the client code!
*/
public static GlobalAttributeSchema _internalBuild(
@Nonnull String name,
@Nonnull Class type,
boolean localized
) {
return new GlobalAttributeSchema(
name, NamingConvention.generate(name),
null, null,
null, null, false, false, localized, false, false,
type, null,
0
);
}
/**
* This method is for internal purposes only. It could be used for reconstruction of GlobalAttributeSchema from
* different package than current, but still internal code of the Evita ecosystems.
*
* Do not use this method from in the client code!
*/
public static GlobalAttributeSchema _internalBuild(
@Nonnull String name,
@Nullable AttributeUniquenessType unique,
@Nullable GlobalAttributeUniquenessType uniqueGlobally,
boolean filterable,
boolean sortable,
boolean localized,
boolean nullable,
boolean representative,
@Nonnull Class type,
@Nullable T defaultValue
) {
return new GlobalAttributeSchema(
name, NamingConvention.generate(name),
null, null,
unique, uniqueGlobally, filterable, sortable, localized, nullable, representative,
type, defaultValue,
0
);
}
/**
* This method is for internal purposes only. It could be used for reconstruction of GlobalAttributeSchema from
* different package than current, but still internal code of the Evita ecosystems.
*
* Do not use this method from in the client code!
*/
public static GlobalAttributeSchema _internalBuild(
@Nonnull String name,
@Nullable String description,
@Nullable String deprecationNotice,
@Nullable AttributeUniquenessType unique,
@Nullable GlobalAttributeUniquenessType uniqueGlobally,
boolean filterable,
boolean sortable,
boolean localized,
boolean nullable,
boolean representative,
@Nonnull Class type,
@Nullable T defaultValue,
int indexedDecimalPlaces
) {
return new GlobalAttributeSchema(
name, NamingConvention.generate(name),
description, deprecationNotice,
unique, uniqueGlobally, filterable, sortable, localized, nullable, representative,
type, defaultValue,
indexedDecimalPlaces
);
}
/**
* This method is for internal purposes only. It could be used for reconstruction of GlobalAttributeSchema from
* different package than current, but still internal code of the Evita ecosystems.
*
* Do not use this method from in the client code!
*/
public static GlobalAttributeSchema _internalBuild(
@Nonnull String name,
@Nonnull Map nameVariants,
@Nullable String description,
@Nullable String deprecationNotice,
@Nullable AttributeUniquenessType unique,
@Nullable GlobalAttributeUniquenessType uniqueGlobally,
boolean filterable,
boolean sortable,
boolean localized,
boolean nullable,
boolean representative,
@Nonnull Class type,
@Nullable T defaultValue,
int indexedDecimalPlaces
) {
return new GlobalAttributeSchema(
name, nameVariants,
description, deprecationNotice,
unique, uniqueGlobally, filterable, sortable, localized, nullable, representative,
type, defaultValue,
indexedDecimalPlaces
);
}
@Override
public boolean isUnique() {
return super.isUnique() || isUniqueGlobally();
}
@Override
public boolean isUniqueWithinLocale() {
return super.isUniqueWithinLocale() || isUniqueGloballyWithinLocale();
}
@Override
public boolean isUniqueGlobally() {
return globalUniquenessType != GlobalAttributeUniquenessType.NOT_UNIQUE;
}
@Override
public boolean isUniqueGloballyWithinLocale() {
return globalUniquenessType == GlobalAttributeUniquenessType.UNIQUE_WITHIN_CATALOG_LOCALE;
}
@Override
public String toString() {
return "GlobalAttributeSchema{" +
"name='" + getName() + '\'' +
", unique=" + getUniquenessType() +
", uniqueGlobally=" + getGlobalUniquenessType() +
", filterable=" + isFilterable() +
", sortable=" + isSortable() +
", localized=" + isLocalized() +
", nullable=" + isNullable() +
", representative=" + isRepresentative() +
", type=" + getType() +
", indexedDecimalPlaces=" + getIndexedDecimalPlaces() +
'}';
}
}