io.evitadb.api.requestResponse.data.structure.ReferenceAttributes 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.

There is a newer version: 2024.10.0

/*
 *
 *                         _ _        ____  ____
 *               _____   _(_) |_ __ _|  _ \| __ )
 *              / _ \ \ / / | __/ _` | | | |  _ \
 *             |  __/\ 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.data.structure;

import io.evitadb.api.exception.AttributeNotFoundException;
import io.evitadb.api.requestResponse.schema.AttributeSchemaContract;
import io.evitadb.api.requestResponse.schema.EntitySchemaContract;
import io.evitadb.api.requestResponse.schema.ReferenceSchemaContract;

import javax.annotation.Nonnull;
import java.io.Serial;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;

/**
 * Extension of {@link Attributes} for reference attributes.
 *
 * @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2023
 */
public class ReferenceAttributes extends Attributes {
	@Serial private static final long serialVersionUID = 7625562503185582905L;
	/**
	 * Definition of the reference schema.
	 */
	final ReferenceSchemaContract referenceSchema;

	public ReferenceAttributes(
		@Nonnull EntitySchemaContract entitySchema,
		@Nonnull ReferenceSchemaContract referenceSchema
	) {
		super(
			entitySchema,
			Collections.emptyList(),
			referenceSchema.getAttributes()
		);
		this.referenceSchema = referenceSchema;
	}

	public ReferenceAttributes(
		@Nonnull EntitySchemaContract entitySchema,
		@Nonnull ReferenceSchemaContract referenceSchema,
		@Nonnull Collection attributeValues,
		@Nonnull Map attributeTypes
	) {
		super(entitySchema, attributeValues, attributeTypes);
		this.referenceSchema = referenceSchema;
	}

	public ReferenceAttributes(
		@Nonnull EntitySchemaContract entitySchema,
		@Nonnull ReferenceSchemaContract referenceSchema,
		@Nonnull Map attributeValues,
		@Nonnull Map attributeTypes
	) {
		super(entitySchema, attributeValues, attributeTypes);
		this.referenceSchema = referenceSchema;
	}

	@Nonnull
	@Override
	protected AttributeNotFoundException createAttributeNotFoundException(@Nonnull String attributeName) {
		return new AttributeNotFoundException(attributeName, referenceSchema, entitySchema);
	}

}