io.evitadb.api.proxy.ProxyReferenceFactory 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.proxy;

import io.evitadb.api.EvitaSessionContract;
import io.evitadb.api.exception.EntityClassInvalidException;
import io.evitadb.api.requestResponse.data.EntityContract;
import io.evitadb.api.requestResponse.data.ReferenceContract;
import io.evitadb.api.requestResponse.data.SealedEntity;
import io.evitadb.api.requestResponse.schema.EntitySchemaContract;

import javax.annotation.Nonnull;
import java.util.Map;

/**
 * Interface is used to create proxy instances of sealed entity references when client code calls query method on
 * {@link EvitaSessionContract} interface providing their custom class/contract as requested type.
 *
 * @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2023
 */
public interface ProxyReferenceFactory {

	/**
	 * Creates proxy instance of sealed entity that implements `expectedType` contract. Entity proxy respects
	 * request context used in the query that fetched {@link SealedEntity}.
	 *
	 * @param mainType                contract of the main entity proxy
	 * @param expectedType            contract that the proxy should implement
	 * @param entity                  owner entity
	 * @param referencedEntitySchemas the entity schemas of entities that might be referenced by the reference schema
	 * @param reference               reference instance to create proxy for
	 * @param                      type of contract that the proxy should implement
	 * @return proxy instance of sealed entity
	 * @throws EntityClassInvalidException if the proxy contract is not valid
	 */
	@Nonnull
	 T createEntityReferenceProxy(
		@Nonnull Class mainType,
		@Nonnull Class expectedType,
		@Nonnull EntityContract entity,
		@Nonnull Map referencedEntitySchemas,
		@Nonnull ReferenceContract reference
	) throws EntityClassInvalidException;

}